Sign in
latestOpenAPI 3.0.32026-08-224982,0272.8 MB

e445c15e5bee

Transaction request

List transaction requests by wallet

Get a paginated list of transaction requests filtered by wallet. Use only with MPC wallets.

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

Path parameters

walletIdstring required
Example:59cd72485007a239fb00282ed480da1f

Query parameters

txRequestIdsstring[]

If provided, only the specified transaction requests will be returned.

idempotencyKeysstring[]

If provided, only transaction requests with the matching idempotencyKeys will be returned.

sequenceIdsstring[]

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.

intentTypesstring[]

If provided, only transaction requests with the specified intent types will be returned.

excludeIntentTypesstring[]

If provided, transaction requests with the specified intent types will be excluded.

statesstring[]

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.
latestboolean

If provided, only the latest transaction request version will be returned.

limitstring number

Maximum number of results to return. If the result set is truncated, use the "nextBatchPrevId" value to get the next batch.

prevIdstring
Example:59cd72485007a239fb00282ed480da1f

Return the next batch of results, based on the "nextBatchPrevId" value from the previous batch.

versionstring number
sortBy'id' | 'createdDate'

Sorts by specified field, default sorting by id.

sortDirection'ASC' | 'DESC'

Sorts order by field in specified sort direction, default ascending.

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).

Response

OK

nextBatchPrevIdstring 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 response

{
  "txRequests": [
    {
      "intent": {
        "messageRaw": "for EVM: test message"
      },
      "txRequestId": "123e4567-e89b-12d3-a456-426614174000",
      "walletId": "59cd72485007a239fb00282ed480da1f",
      "enterpriseId": "59cd72485007a239fb00282ed480da1f",
      "date": "2021-01-01T00:00:00.000Z",
      "createdDate": "2021-01-01T00:00:00.000Z"
    }
  ]
}