Ctrl+K

Get transaction requests ready for signature

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

Path Parameters

  • walletIdstringRequired
    Example: "59cd72485007a239fb00282ed480da1f"
    Pattern: ^[0-9a-f]{32}$
    Min length: >= 1 characters

Query Parameters

  • limitstring or stringDefault: 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.
  • walletPermissionsarray[string]
    If provided, the result will be filtered by the users wallet permissions.
    Enum: admin spend
  • 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
  • prevIdstring
    Return the next batch of results, based on the "nextBatchPrevId" value from the previous batch.
    Example: "59cd72485007a239fb00282ed480da1f"
    Pattern: ^[0-9a-f]{32}$
    Min length: >= 1 characters
  • sortBystringRequired
    Sorts by specified field, default sorting by id.
    Enum: id createdDate
  • sortDirectionstringRequired
    Sorts order by field in specified sort direction, default ascending.
    Enum: ASC DESC

200 Response

txRequests array[object] required
transactions array[object]
The transactions associated with the transaction request
apiVersion string
The API version of the transaction request
Allowed values: lite full
txRequestId string required
A unique ID for the TxRequest document across all wallets. The combination of the txRequestId and version will always be unique.
idempotencyKey string
The idempotency key of the transaction request
walletId string required
The id of the Wallet the TxRequest is for.
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
walletType string
The type describes who owns the keys to the wallet associated to the TxRequest.
Allowed values: backing cold custodial custodialPaired hot trading
version number required
The version of the transaction request
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: pendingApproval canceled rejected initialized pendingDelivery delivered pendingUserSignature pendingUserCommitment pendingUserRShare pendingUserGShare readyToSend signed failed
date string <date-time>required
The date and time this version of the TxRequest document was created.
Example: 2021-01-01T00:00:00.000Z
createdDate string <date-time>required
The date and time the version 1 TxRequest document was created.
Example: 2021-01-01T00:00:00.000Z
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.
intentOne of
The intent of the transaction request
intentsrequired
The list of intents for the transaction request
pendingApprovalId string
The id of the Pending Approval that was created for the TxRequest if one was required.
policiesChecked boolean
latest boolean required
Indicates if this is the latest transaction request
isCanceled boolean
True, if the transaction request is canceled.
bitgoRangeProofChallenge object
ntildeProof object required
The ntildeProof value is only required when creating the initial config.
ntilde string required
Range proof challenge value
h1 string required
Range proof challenge value
h2 string required
Range proof challenge value
totalCount number
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

400 Response

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

401 Response

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

403 Response

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

404 Response

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