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
confirmations integer required
The number of blocks that have been confirmed since this Transfer's block was confirmed
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 state of the transfer. Includes the following:
- `confirmed`: The transfer is confirmed on chain.
- `failed`: BitGo failed to confirm the transfer on chain. You must retry the transaction.
- `initialized`: The initial state when creating a transfer.
- `pendingApproval`: The transfer requires admin approval to proceed.
- `rejected`: The transfer was rejected by an admin.
- `removed`: A network re-org occurred, causing the confirmed transfer to be removed from the blockchain.
- `replaced`: The transfer was stuck due to having a low fee and was replaced by a new transfer with a higher fee.
- `signed`: The transfer was approved by an admin (if required) and then signed by BitGo.
- `unconfirmed`: The signed transaction was sent to the network, and is pending on-chain validation.
Allowed values: confirmed failed initialized pendingApproval rejected removed replaced signed unconfirmed
Example: confirmed
tags array[string] required
The tags to be used on this Transfer (used in Policies)
Example: 59cd72485007a239fb00282ed480da1f
history array[object] required
An audit log of events that have happened to the Transfer during its lifecycle
The size of the transaction
DEPRECATED. Number of segwit inputs on the transfer.
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.
Consolidation ID if this transfer is part of a consolidation
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
Associated transaction request ID
goStakingRequestId string
Associated GO staking request ID
Transfer subtype
Allowed values: ofc_withdrawal ofc_deposit ofc_unstake ofc_stake
The coin used to pay the fee (for cross-chain transactions)
Whether this is an instant transaction
The instant transaction ID if applicable
Whether this transfer represents a fee
Whether this transfer represents a staking reward
Whether this transfer represents an unlock operation
Additional metadata associated with the transfer
sendAccounting array[object]
Accounting breakdown for send transactions
createdTime string <date-time>
The time this transfer was created
approvedTime string <date-time>
The time this transfer was approved
rejectedTime string <date-time>
The time this transfer was rejected
signedTime string <date-time>
The time this transfer was signed
unconfirmedTime string <date-time>
The time this transfer became unconfirmed
confirmedTime string <date-time>
The time this transfer was confirmed
removedTime string <date-time>
The time this transfer was removed
commentedTime string <date-time>
The time this transfer was commented on
failedTime string <date-time>
The time this transfer failed
regeneratedTime string <date-time>
The time this transfer was regenerated
replacedTime string <date-time>
The time this transfer was replaced
replacingTime string <date-time>
The time this transfer started replacing another
abandonedTime string <date-time>
The time this transfer was abandoned
signedDate string <date-time>
The date this transfer was signed (legacy field)
customerApprovedTime string <date-time>
The time this transfer was approved by the customer (trust transfers)
idVerificationTime string <date-time>
The time identity verification was completed (trust transfers)
trustSignedTime string <date-time>
The time this transfer was signed by trust (trust transfers)
trustFinalApprovalTime string <date-time>
The time this transfer received final trust approval (trust transfers)
Label of the wallet associated with this transfer
Name of the enterprise associated with this transfer
Elliptic risk score information (trust transfers)
senderInformationVerified boolean
Whether sender information has been verified (trust transfers)
Parameters used to build the transaction
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.
Transaction IDs that this transfer replaces.
Transaction IDs that replace this transfer.