intent
One of
The intent of the transaction request
intentType
string required
Allowed value: consolidate
receiveAddress
string required
senderAddressIndex
number
unsignedTxs
array[object]
Holds all unsigned transactions that will be used to fulfill the TxRequest for MPC wallets.
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.
Coin specific information.
signatureShares
array[object]
Only used for MPC coins. This is used to collect signature shares from and exchange them with the user.
The VSS proof of the signature share
The source of the signature share.
Allowed values: user
backup
bitgo
The recipient of the signature share.
Allowed values: user
backup
bitgo
commitmentShares
array[object]
Only used for MPC coins on EdDSA curve. This is used to collect commitment shares from and exchange them with the user.
The type of the commitment share
Allowed value: commitment
The source of the commitment share
Allowed values: user
backup
bitgo
Example: user
The recipient of the commitment share.
Allowed values: user
backup
bitgo
Example: bitgo
The hashes of all transactions from the TxRequest that have been signed and are pending broadcast.
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
The idempotency key of the transaction request
The id of the Wallet the TxRequest is for.
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
The type describes who owns the keys to the wallet associated to the TxRequest.
Allowed values: backing
cold
custodial
custodialPaired
hot
trading
The version of the transaction request
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}$
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
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.
intents
required
intentType
string required
Allowed value: consolidate
receiveAddress
string required
senderAddressIndex
number
The id of the Pending Approval that was created for the TxRequest if one was required.
Indicates if this is the latest transaction request
True, if the transaction request is canceled.