A cryptocurrency or token ticker symbol.
Example: btc
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
The on-chain transaction id
Example: b8a828b98dbf32d9fd1875cbace9640ceb8c82626716b4a64203fdc79bb46d26
The type of the transaction id
Allowed values: transactionHash blockHash
The height of the block this Transfer was confirmed in (999999999 if unconfirmed)
The unique height id of the block
date string <date-time>required
The date this Transfer was last updated
Defines whether or not this Transfer was sent or received by the user
Allowed values: send receive
The total value (in base units) sent by this Transfer (may be approximate for ETH and other coins where amounts in base units can exceed 2^53 - 1)
valueString string required
The total value (in base units) sent by this Transfer represented as a String
Example: 2000000
Match pattern: ^-?\d+$
intendedValueString string
A string representation (in base units) of the initial value for the transfer. This is present because when a transaction fails on chain, its value is mutated to be zero. This string is immutable and will always be the intended value of the initial transfer regardless of the final state of the transaction.
Example: 2000000
Match pattern: ^-?\d+$
The value (in base units) sent by this transfer, excluding network fees. BitGo is deprecating this field in the future. Instead, use baseValueWithoutFees.
The value (in base units) sent by this transfer, excluding network fees represented as a string. BitGo is deprecating this field in the future. Instead, use baseValueWithoutFees.
Example: 2000000
Match pattern: ^-?\d+$
baseValueWithoutFees integer
The value (in base units) sent by this transfer excluding network fees.
baseValueWithoutFeesString string
The value (in base units) sent by this transfer, excluding network fees, represented as a string
Example: 2000000
Match pattern: ^-?\d+$
The Transfer's fee (in base units) represented as a String
The Transfer's BitGo fee (in base units)
The Transfer's BitGo fee (in base units) represented as a String
The amount of USD of this Transfer (will be negative if it's a send)
The USD price at the time this Transfer was created
The status of this Transfer
Allowed values: signed unconfirmed confirmed pendingApproval removed failed rejected
Example: confirmed
tags array[string] required
The tags to be used on this Transfer (used in Policies)
history array[object] required
An audit log of events that have happened to the Transfer during its lifecycle
The size of the transaction
coinSpecific object required
Transfer fields specific to each coin type
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.
An array of objects describing the change in address balances made as a result of this Transfer
Whether BitGo already sent notifications to the users of the transfer wallet
Address labels (if any) from entries concatenated.
confirmations integer required
The number of blocks that have been confirmed since this Transfer's block was confirmed
If this is a Transfer on a UTXO coin, the array of inputs
If this is a Transfer on a UTXO coin, the array of outputs