REST API›Wallet & Transact›Transaction request

POST

Create transaction request

Create a transaction request for an MPC (TSS) wallet. To learn more about transacting from other wallet types, see Withdraw Overview.

TRX (trx, ttrx) MPC wallets support native transfers, TRC-20 tokens, consolidation, staking, and resource delegation via delegateResource and undelegateResource intents.

Path Params

  • walletId string required
    The ID of the wallet

Body Params

object

Request body for creating a transaction request. Specifies the intent and optional metadata for the transaction.
  • apiVersion string enum
    Full or Light to differentiate between the different transaction request flows.
    litefull
  • idempotencyKey string
    The combination of the idempotencyKey, version and walletId has to be unique. If no idempotencyKey is specified then it remains undefined for the txRequest. Note, version is an internal field that is auto incremented on every update to a txRequest.
  • intent object required
    intent object
    • intentType string enum required
      The type of the intent
      paymenttransferTokenconsolidateconsolidateTokenfanoutstakeunstakedelegateundelegateswitchValidatorclaimstakeClaimRewardspledgevoteDelegationvotecreateAccountupdateAccountaddTrustLineremoveTrustLinesignMessagesignTypedStructuredDataenableTokenauthorizeaccelerationfillNoncewalletRecoverycontractCalldeactivatecustomTxcloseAssociatedTokenAccountstakeWithCallDataunstakeWithCallDataswitchValidatorWithCallDatafeeAddressTransfertokenApprovaltransferStakevalidatorRegistrationincreaseStakedecreaseStakesignalExitwithdrawStakespotTransferbridgeFundsenableBridginggoUnstakecreateBtcDelegationtransferAccepttransferRejecttransferAcknowledgetransferOfferWithdrawncosignDelegationProposalcosignDelegationAcceptallocationRequestcantonCommandallocationAllocateallocationOfferWithdrawnallocationRejectcantonEndInvestorOnboardingOffercantonEndInvestorOnboardingAcceptcantonEndInvestorOnboardingRejectcantonParticipantOnboardingRequestdefi-depositdefi-redeemdefi-approvedefi-withdrawdelegateResourceundelegateResourceexportimportimporttoc
    • comment string
      Only visible to users on the wallet and not shared publicly
    • sequenceId string
      A unique wallet identifier applied to transfers and transactions at creation
    • nonce string or number
      The nonce of the transaction
  • videoApprovers array of strings
  • preview boolean
    When set to true, the transaction request is returned without being stored in the DB.

Responses

200
OK

Response Body

ONE OF

  • intent object
    The intent of the transaction request

    ONE OF

    • unspents array of strings
    • intentType string enum required
      Must be "consolidate".
      consolidate
    • receiveAddress string required
      Destination address for consolidated funds. Must be a wallet-owned address.
    • senderAddressIndex number
      Index of the wallet address to use as the sender.
    • consolidateId string
      Opaque identifier used to correlate consolidation requests.
    • recipients array of objects
      recipients object
      • tokenData object
        tokenData object
        • tokenQuantity string required
        • tokenType string required
        • tokenId string
        • tokenName string required
        • tokenContractAddress string
        • decimals number
      • address object required
        address object
        • address string
        • option map of objects
          option object
          • <key> object
      • amount object required
        amount object
        • value string required
        • symbol string required
      • data string
    • keepAlive boolean
      When true, leaves a small amount in the source address to keep it alive.
    • nonce string or number
      Override the on-chain nonce for this transaction.
  • unsignedTxs array of objects
    unsignedTxs object
    • parsedTx object required
      parsedTx object
      • inputs array of objects required
        inputs object
        • valueString string required
        • _id string
        • address string
        • chain number
        • derivationIndex number
        • index number
        • value number
      • minerFee string or number required
      • outputs array of objects required
        outputs object
        • valueString string required
        • address string
        • change boolean
        • coinName string
        • data string
        • isPayGo boolean
        • value number
        • wallet string
        • walletV1 string
        • baseAddress string
        • enterprise string
      • spendAmount string or number required
      • gasPrice number
      • hasUnvalidatedData boolean
      • payGoFee string or number
      • spendAmounts array of objects
        spendAmounts object
        • <key> object
      • type string
    • serializedTxHex string required
      The unsigned transaction as a hex string.
    • signableHex string required
      The portion of a transaction used to generate a signature (may or may not be the same as serializedTxHex) as a hex string.
    • derivationPath string
      A bip32 path.
    • coinSpecific object
      Coin specific information.
      coinSpecific object
      • nonceAddress string
      • stakingAddress string
      • signature string
      • <key> object
    • feeInfo object
      feeInfo object
      • fee string or number required
      • feeString string required
  • signatureShares array of objects
    signatureShares object
    • vssProof string
      The VSS proof of the signature share
    • privateShareProof string
      The private share proof
    • publicShare string
      The public share
    • from string enum required
      The source of the signature share.
      userbackupbitgo
    • to string enum required
      The recipient of the signature share.
      userbackupbitgo
    • share string required
      The signature share
  • commitmentShares array of objects
    commitmentShares object
    • type string enum required
      The type of the commitment share
      commitment
    • from string enum required
      The source of the commitment share
      userbackupbitgo
    • to string enum required
      The recipient of the commitment share.
      userbackupbitgo
    • share string required
      The commitment share.
  • txHashes array of strings
  • apiVersion string enum
    The API version of the transaction request
    litefull
  • 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.
  • idempotencyKey string
    The idempotency key of the transaction request
  • walletId string required
    The id of the Wallet the TxRequest is for.
  • walletType string enum
    The type describes who owns the keys to the wallet associated to the TxRequest.
    backingcoldcustodialcustodialPairedhotadvancedtrading
  • 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.

    matches ^[0-9a-f]{32}$

  • state string enum required
    pendingApprovalcanceledrejectedinitializedpendingDeliverydeliveredpendingUserSignaturependingUserCommitmentpendingUserRSharependingUserGSharereadyToSendsignedfailed
  • date string date-time required
    The date and time this version of the TxRequest document was created.
  • createdDate string date-time required
    The date and time the version 1 TxRequest document was created.
  • 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 object
    The intent of the transaction request
  • intents array of objects 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.
  • initiatedByDAppClient boolean
    True when the txRequest was initiated by a dApp OAuth client (e.g. Narval).
  • txChannel object
    Immutable DeFi / marketplace channel classification (DEFI-300).
    txChannel object
    • clientId string
      OAuth dApp client id (Narval).
    • connector string enum
      External entry connector (narval, walletconnect). Omitted for internal BitGo flows.
      narvalwalletconnect
    • defiAction string enum
      approvedepositwithdraw
    • protocol string enum
      DeFi protocol (morpho, aave, concrete).
      morphoaaveconcrete
    • source string enum required
      internalexternal
    • type string enum required
      defi
    • vaultId string
    • walletConnectRequestId string
      defi-service walletconnect_requests.id when supplied on the intent.
201
Created

Response Body

ONE OF

  • intent object
    The intent of the transaction request

    ONE OF

    • unspents array of strings
    • intentType string enum required
      Must be "consolidate".
      consolidate
    • receiveAddress string required
      Destination address for consolidated funds. Must be a wallet-owned address.
    • senderAddressIndex number
      Index of the wallet address to use as the sender.
    • consolidateId string
      Opaque identifier used to correlate consolidation requests.
    • recipients array of objects
      recipients object
      • tokenData object
        tokenData object
        • tokenQuantity string required
        • tokenType string required
        • tokenId string
        • tokenName string required
        • tokenContractAddress string
        • decimals number
      • address object required
        address object
        • address string
        • option map of objects
          option object
          • <key> object
      • amount object required
        amount object
        • value string required
        • symbol string required
      • data string
    • keepAlive boolean
      When true, leaves a small amount in the source address to keep it alive.
    • nonce string or number
      Override the on-chain nonce for this transaction.
  • unsignedTxs array of objects
    unsignedTxs object
    • parsedTx object required
      parsedTx object
      • inputs array of objects required
        inputs object
        • valueString string required
        • _id string
        • address string
        • chain number
        • derivationIndex number
        • index number
        • value number
      • minerFee string or number required
      • outputs array of objects required
        outputs object
        • valueString string required
        • address string
        • change boolean
        • coinName string
        • data string
        • isPayGo boolean
        • value number
        • wallet string
        • walletV1 string
        • baseAddress string
        • enterprise string
      • spendAmount string or number required
      • gasPrice number
      • hasUnvalidatedData boolean
      • payGoFee string or number
      • spendAmounts array of objects
        spendAmounts object
        • <key> object
      • type string
    • serializedTxHex string required
      The unsigned transaction as a hex string.
    • signableHex string required
      The portion of a transaction used to generate a signature (may or may not be the same as serializedTxHex) as a hex string.
    • derivationPath string
      A bip32 path.
    • coinSpecific object
      Coin specific information.
      coinSpecific object
      • nonceAddress string
      • stakingAddress string
      • signature string
      • <key> object
    • feeInfo object
      feeInfo object
      • fee string or number required
      • feeString string required
  • signatureShares array of objects
    signatureShares object
    • vssProof string
      The VSS proof of the signature share
    • privateShareProof string
      The private share proof
    • publicShare string
      The public share
    • from string enum required
      The source of the signature share.
      userbackupbitgo
    • to string enum required
      The recipient of the signature share.
      userbackupbitgo
    • share string required
      The signature share
  • commitmentShares array of objects
    commitmentShares object
    • type string enum required
      The type of the commitment share
      commitment
    • from string enum required
      The source of the commitment share
      userbackupbitgo
    • to string enum required
      The recipient of the commitment share.
      userbackupbitgo
    • share string required
      The commitment share.
  • txHashes array of strings
  • apiVersion string enum
    The API version of the transaction request
    litefull
  • 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.
  • idempotencyKey string
    The idempotency key of the transaction request
  • walletId string required
    The id of the Wallet the TxRequest is for.
  • walletType string enum
    The type describes who owns the keys to the wallet associated to the TxRequest.
    backingcoldcustodialcustodialPairedhotadvancedtrading
  • 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.

    matches ^[0-9a-f]{32}$

  • state string enum required
    pendingApprovalcanceledrejectedinitializedpendingDeliverydeliveredpendingUserSignaturependingUserCommitmentpendingUserRSharependingUserGSharereadyToSendsignedfailed
  • date string date-time required
    The date and time this version of the TxRequest document was created.
  • createdDate string date-time required
    The date and time the version 1 TxRequest document was created.
  • 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 object
    The intent of the transaction request
  • intents array of objects 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.
  • initiatedByDAppClient boolean
    True when the txRequest was initiated by a dApp OAuth client (e.g. Narval).
  • txChannel object
    Immutable DeFi / marketplace channel classification (DEFI-300).
    txChannel object
    • clientId string
      OAuth dApp client id (Narval).
    • connector string enum
      External entry connector (narval, walletconnect). Omitted for internal BitGo flows.
      narvalwalletconnect
    • defiAction string enum
      approvedepositwithdraw
    • protocol string enum
      DeFi protocol (morpho, aave, concrete).
      morphoaaveconcrete
    • source string enum required
      internalexternal
    • type string enum required
      defi
    • vaultId string
    • walletConnectRequestId string
      defi-service walletconnect_requests.id when supplied on the intent.
400
Bad Request

Response Body

ONE OF

  • name string enum required
    Error code
    DuplicateSequenceIdError
  • context map of objects
    Properties that apply to a specific error name
    context object
    • <key> object
  • error string required
    Human-readable error message
  • requestId string required
    Client request id
401
Unauthorized

Response Body

object

  • name string
    Error code
  • context map of objects required
    Properties that apply to a specific error name
    context object
    • <key> object
  • error string required
    Human-readable error message
  • requestId string required
    Client request id
403
Forbidden

Response Body

object

  • name string
    Error code
  • context map of objects required
    Properties that apply to a specific error name
    context object
    • <key> object
  • error string required
    Human-readable error message
  • requestId string required
    Client request id
404
Not Found

Response Body

object

  • name string
    Error code
  • context map of objects required
    Properties that apply to a specific error name
    context object
    • <key> object
  • error string required
    Human-readable error message
  • requestId string required
    Client request id