Ctrl+K

Get transaction requests by enterprise filtering by wallet permissions

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

Supports both lite and full transaction requests. Use the apiVersion query parameter to filter by version.

Path Parameters

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

Query Parameters

  • apiVersionstring
    If present, filters transaction requests by the specified API version (lite or full). If not provided, returns all transaction requests regardless of API version.
    Enum: lite full
  • walletTypesarray[string]
    If present, filters transaction requests by the specified wallet types
    Enum: backing cold custodial custodialPaired hot advanced trading
  • 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 switchValidatorWithCallData
  • 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
  • walletPermissionsarray[string]
    If present, filters transaction requests by wallet permissions. If not present will default to view permissions
    Enum: admin spend
  • limitstring<number>
    Example: 5
  • prevIdstring
    Example: 59cd72485007a239fb00282ed480da1f
    Pattern: ^[0-9a-f]{32}$
  • sortBystring
    Optional field to sort by.
    Enum: id createdDate
  • sortDirectionstring
    Optional direction of sorting.
    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

200 Response

nextBatchPrevId string
txRequests array[object] required
transactions array[object]
The transactions associated with the transaction request
messages array[object]
The messages associated with the transaction request
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.
intent
The intent of the transaction request
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

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