Ctrl+K

Get transaction requests by enterprise

get/api/v2/enterprise/{enterpriseId}/txrequests

Get a paginated list of transaction requests filtered by enterprise.

Path Parameters

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

Query Parameters

  • prevIdstring
    Return the next batch of results, based on the "nextBatchPrevId" value from the previous batch.
    Example: "59cd72485007a239fb00282ed480da1f"
    Pattern: ^[0-9a-f]{32}$
  • limitintegerDefault: 25
    Maximum number of results to return. If the result set is truncated, use the "nextBatchPrevId" value to get the next batch.
  • latestboolean
    If provided, only the latest transaction request version will be returned.
  • statesarray[string]
    If provided, only transaction requests of the specified state will be returned.
    Enum: initialized pendingApproval pendingUserCommitment pendingUserRShare pendingUserGShare readyToSend pendingUserSignature pendingDelivery signed delivered canceled rejected failed
  • txRequestIdsarray[string]
    If provided, only transaction requests specified will be returned.
  • idempotencyKeysarray[string]
    If provided, only transaction requests with the matching idempotencyKeys will be returned.
  • sequenceIdsarray[string]
    A "sequenceId" is a unique and arbitrary wallet identifier applied to transfers and transactions at creation. It is optional but highly recommended. With a "sequenceId" you can easily reference transfers and transactions—for example, to safely retry sending. Because the system only confirms one send request per "sequenceId" (and fails all subsequent attempts), you can retry sending without the risk of double spending. The "sequenceId" is only visible to users on the wallet and is not shared publicly.
  • walletIdsarray[string]
    Filter by wallets.
    Example: "59cd72485007a239fb00282ed480da1f"
    Pattern: ^[0-9a-f]{32}$
  • 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

200 Response

txRequestsrequired
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
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: {}
createdDate string <date-time>required
The date and time the version 1 TxRequest document was created.
Example: {}
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.
intentAny ofrequired
intentsrequired
pendingApprovalId string
The id of the Pending Approval that was created for the TxRequest if one was required.
unsignedTxs array[object]
signatureShares array[object]
commitmentShares array[object]
txHashes array[string]
nextBatchPrevId string

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