Ctrl+K

Get transaction requests by enterprise

get/api/v2/admin/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

  • txRequestIdsarray[string]
    If provided, only the specified transaction requests 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.
  • intentTypesarray[string]
    If provided, only transaction requests with the specified intent types will be returned.
    Enum: payment consolidate consolidateToken fanout vote createAccount updateAccount addTrustLine removeTrustLine signMessage signTypedStructuredData enableToken acceleration transferToken fillNonce walletRecovery contractCall customTx closeAssociatedTokenAccount transferAcknowledge transferAccept transferReject stake unstake delegate undelegate switchValidator claim stakeClaimRewards pledge voteDelegation authorize deactivate createBtcDelegation goUnstake stakeWithCallData unstakeWithCallData
  • excludeIntentTypesarray[string]
    If provided, transaction requests with the specified intent types will be excluded.
    Enum: payment consolidate consolidateToken fanout vote createAccount updateAccount addTrustLine removeTrustLine signMessage signTypedStructuredData enableToken acceleration transferToken fillNonce walletRecovery contractCall customTx closeAssociatedTokenAccount transferAcknowledge transferAccept transferReject stake unstake delegate undelegate switchValidator claim stakeClaimRewards pledge voteDelegation authorize deactivate createBtcDelegation goUnstake stakeWithCallData unstakeWithCallData
  • statesarray[string]
    If provided, only transaction requests of the specified state will be returned. - `canceled`: Canceled by a wallet spender before approval or sending. - `delivered`: Inserted into the send queue (or rejected by BitGo through circuit breakers). This state is only used with apiVersion "full". - `failed` : Catch-all state indicating an unrecoverable failure (such as a duplicate key error when creating a transfer). - `initialized`: First state when a transaction request is created (before any policy evaluation occurs). - `pendingApproval`: Triggered a policy that requires approval to proceed. - `pendingDelivery`: Requires further action to proceed (such as pending signature, or accepting/rejecting due to triggering a circuit breaker). This state is only used with apiVersion "full". - `pendingUserCommitment`: Ready to receive your user commitments. This state is only used with apiVersion "lite" and EdDSA assets with commitment signing states. - `pendingUserGShare`: Ready to receive your gShare. - `pendingUserRShare`: Ready to receive your rShare. - `pendingUserSignature`: Ready to receive your user signature (get the unsigned transaction from BitGo and sign it). This state is only used with apiVersion "lite" and EdDSA assets without commitment signing states. - `readyToSend`: Ready send (share combination is complete). - `rejected`: Rejected by an approver. - `signed`: All transactions in the transaction request were signed. All future updates will be in the transfer document.
    Enum: pendingApproval canceled rejected initialized pendingDelivery delivered pendingUserSignature pendingUserCommitment pendingUserRShare pendingUserGShare readyToSend signed failed
  • latestboolean
    If provided, only the latest transaction request version will be returned.
  • limitstring<number>Default: 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
  • prevIdstring
    Return the next batch of results, based on the "nextBatchPrevId" value from the previous batch.
    Example: 59cd72485007a239fb00282ed480da1f
    Pattern: ^[0-9a-f]{32}$
  • versionstring<number>
  • 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
  • dateLtstring<date-time>
    Optional get transaction requests less than date
  • dateGtestring<date-time>
    Optional get transaction requests greater than or equal to date
  • includeEvmKeyringTxRequestsboolean
    If true, include transaction requests for all EVM keyring related wallets (main + derived).

200 Response

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.
txRequestsrequired
intentOne of
The intent of the transaction request
unsignedTxs array[object]
Holds all unsigned transactions that will be used to fulfill the TxRequest for MPC wallets.
signatureShares array[object]
Only used for MPC coins. This is used to collect signature shares from and exchange them with the user.
commitmentShares array[object]
Only used for MPC coins on EdDSA curve. This is used to collect commitment shares from and exchange them with the user.
txHashes array[string]
The hashes of all transactions from the TxRequest that have been signed and are pending broadcast.
apiVersion string
The API version of the transaction request
Allowed values: lite full
txRequestId string <uuid>required
A unique ID for the TxRequest document across all wallets. The combination of the txRequestId and version will always be unique.
Example: 123e4567-e89b-12d3-a456-426614174000
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 advanced 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.
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
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.
intents array required
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.

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