Sign in
Transaction request

Get transaction requests by enterprise filtering by wallet permissions

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

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

Path parameters

enterpriseIdstring required
Example:59cd72485007a239fb00282ed480da1f

Query parameters

apiVersion'lite' | 'full'

If present, filters transaction requests by the specified API version (lite or full). If not provided, returns all transaction requests regardless of API version.

walletTypesstring[]

If present, filters transaction requests by the specified wallet types

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.
walletPermissionsstring[]

If present, filters transaction requests by wallet permissions. If not present will default to view permissions

limitstring number
Example:5
prevIdstring
Example:59cd72485007a239fb00282ed480da1f
sortBy'id' | 'createdDate'

Optional field to sort by.

sortDirection'ASC' | 'DESC'

Optional direction of sorting.

dateLtstring date-time

Optional get transaction requests less than date

dateGtestring date-time

Optional get transaction requests greater than or equal to date

Response

OK

nextBatchPrevIdstring

Example response

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

Changes

Changed in 3 of the 17 revisions of this API.7

  • 1ebd03e70ace1See the full diff
    • ○

      added the enum value cancel to the property items/ of the query request parameter excludeIntentTypes

      request-parameter-property-enum-value-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 42597b3507554See the full diff
    • ○

      added the enum value finalizeUnwrap to the property items/ of the query request parameter excludeIntentTypes

      request-parameter-property-enum-value-added

    • ○

      added the enum value unwrap to the property items/ of the query request parameter excludeIntentTypes

      request-parameter-property-enum-value-added

    • ○

      added the enum value wrap to the property items/ of the query request parameter excludeIntentTypes

      request-parameter-property-enum-value-added

    • ○

      added the enum value wrapApprove to the property items/ of the query request parameter excludeIntentTypes

      request-parameter-property-enum-value-added

  • ee916dca32502See the full diff
    • ○

      added the optional property txRequests/items/allOf[subschema #2: TransactionRequestBase]/cancelReason to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property txRequests/items/allOf[subschema #2: TransactionRequestBase]/organizationId to the response with the 200 status

      response-optional-property-added

    This revision also has 17 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog