Allows users to update an existing transaction request given they have spender permissions on the wallet. Use only with TSS wallets.
Path Parameters
walletIdstringRequired
Example: "59cd72485007a239fb00282ed480da1f"
Pattern: ^[0-9a-f]{32}$
idstringRequired
Example: "59cd72485007a239fb00282ed480da1f"
Pattern: ^[0-9a-f]{32}$
Request Body
statestringrequired
For transaction request full, the current state must be "pendingApproval" or "pendingDelivery". For transaction request lite, the current state must be "pendingApproval", "pendingUserCommitment", "pendingUserGShare", "pendingUserRShare", or "pendingUserSignature".
Allowed value: canceled
200 Response
Any of
txRequestIdstringrequired
A unique ID for the TxRequest document across all wallets. The combination of the txRequestId and version will always be unique.
versionnumberrequired
The version of the document. Data changes are done only with inserts and incrementing the version.
latestbooleanrequired
A boolean flag that indicates whether the document is the latest version of the TxRequest.
walletIdstringrequired
The id of the Wallet the TxRequest is for.
walletTypestring
The type describes who owns the keys to the wallet associated to the TxRequest.
The date and time this version of the TxRequest document was created.
Example: {}
createdDatestring<date-time>required
The date and time the version 1 TxRequest document was created.
Example: {}
userIdstringrequired
The Id of the User that produced this version of the TxRequest document. Could have created a new document or updated an existing document.
intentAny ofrequired
intentTypestringrequired
Allowed value: stake
sequenceIdstring
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 BitGo 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. It is the responsibility of the caller to keep track of this ID.
Example: abc123
commentstring
The "comment" is only visible to users on the wallet and is not shared publicly.
noncestring
The 'nonce' of a transaction (optional)
stakingRequestIdstringrequired
poolKeyHashstringrequired
The pool key hash to which the coins will be delegated to.
intentsrequired
intentTypestringrequired
Allowed value: stake
sequenceIdstring
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 BitGo 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. It is the responsibility of the caller to keep track of this ID.
Example: abc123
commentstring
The "comment" is only visible to users on the wallet and is not shared publicly.
noncestring
The 'nonce' of a transaction (optional)
stakingRequestIdstringrequired
poolKeyHashstringrequired
The pool key hash to which the coins will be delegated to.
pendingApprovalIdstring
The id of the Pending Approval that was created for the TxRequest if one was required.
isCanceledboolean
True, if the transaction request is canceled.
unsignedTxsarray[object]
Holds all unsigned transactions that will be used to fulfill the TxRequest for TSS wallets.
serializedTxHexstringrequired
The unsigned transaction as a hex string.
signableHexstringrequired
The portion of a transaction used to generate a signature (may or may not be the same as serializedTxHex) as a hex string.
derivationPathstring
A bip32 path.
feeInfoobject
coinSpecificobject
Coin specific information.
parsedTxobject
The parsed transaction information.
signatureSharesarray[object]
Only used for TSS coins. This is used to collect signature shares from and exchange them with the user.
fromstringrequired
The source of the signature share.
Allowed values: userbackupbitgo
Example: user
tostringrequired
The recipient of the signature share.
Allowed values: userbackupbitgo
Example: user
sharestringrequired
The signature share.
commitmentSharesarray[object]
Only used for TSS coins on EdDSA curve. This is used to collect commitment shares from and exchange them with the user.