Get transaction requests ready for signature

get/api/v2/wallet/{walletId}/txrequests/awaitingsignature

Path Parameters

  • walletIdstringRequired
    Example: "59cd72485007a239fb00282ed480da1f"
    Pattern: ^[0-9a-f]{32}$

Query Parameters

  • limitintegerDefault: 25
    Maximum number of results to return. If the result set is truncated, use the 'nextBatchPrevId' value to get the next batch.
    Minimum: >= 1
    Maximum: <= 500
  • txRequestIdsarray[string]
    If provided, only transaction requests specified will be returned.
  • signingStagestring
    If provided, only transaction requests in a particular signing stage will be returned.
    Enum: 1-eddsa 2-eddsa 3-eddsa 1-ecdsa 2-ecdsa 3-ecdsa
  • sortBystring
    Sorts by specified field, default sorting by id.
    Enum: id createdDate
  • sortDirectionstring
    Sorts order by field in specified sort direction, default ascending.
    Enum: ASC DESC
  • prevIdstring
    Return the next batch of results, based on the 'nextBatchPrevId' value from the previous batch.
    Example: "59cd72485007a239fb00282ed480da1f"
    Pattern: ^[0-9a-f]{32}$
  • walletPermissionsarray[string]
    If provided, the result will be filtered by the users wallet permissions.
    Enum: spend admin

200 Response

txRequests array[object] required
txRequestId string required
A unique ID for the TxRequest document across all wallets. The combination of the txRequestId and version will always be unique.
version number required
The version of the document. Data changes are done only with inserts and incrementing the version.
latest boolean required
A boolean flag that indicates whether the document is the latest version of the TxRequest.
walletId string required
The id of the Wallet the TxRequest is for.
walletType string
The type describes who owns the keys to the wallet associated to the TxRequest.
Allowed values: cold custodial custodialPaired hot trading distributedCustody
enterpriseId string
If the wallet that owns the TxRequest is owned by an enterprise then this is the Id of said enterprise.
state string required
Allowed values: initialized pendingApproval pendingUserCommitment pendingUserRShare pendingUserGShare readyToSend pendingUserSignature pendingDelivery signed delivered canceled rejected failed
date string <date-time>required
The date and time this version of the TxRequest document was created.
Example: 2018-05-05T19:46:22.019Z
createdDate string <date-time>required
The date and time the version 1 TxRequest document was created.
Example: 2018-05-05T19:46:22.019Z
userId string required
The Id of the User that produced this version of the TxRequest document. Could have created a new document or updated an existing document.
initiatedBy string required
The Id of the User that originally created the TxRequest document (initiated the TxRequest).
updatedBy string required
The Id of the User that last updated the TxRequest document. This is an alias for the userId field.
intentAny ofrequired
intentsrequired
pendingApprovalId string
The id of the Pending Approval that was created for the TxRequest if one was required.
isCanceled boolean
True, if the transaction request is canceled.
transactions array[object] required
Transaction information.
messages array[object]
Messages for the transaction request.
bitgoRangeProofChallenge object
ntilde string required
Range proof challenge value.
h1 string required
Range proof challenge value.
h2 string required
Range proof challenge value.
ntildeProof object
paillierBlumProof object
nextBatchPrevId string <uuid>
When a result set is truncated, this field returns the id of the last object in the previous batch. To get the next batch of results, pass this value via the 'prevId' query parameter.
Example: 585951a5df8380e0e3063e9f
totalCount integer

400 Response

error string required
Human-readable error message
requestId string required
Client request id
context object
Properties that apply to a specific error name
name string required
Error code