Ctrl+K

Internal get transfers

post/api/v2/internal/transfer

Returns all transfers matching the list of provided ids

Request Body

ids array[string] required

200 Response

transfers array[object] required
baseValue number
The value (in base units) sent by this transfer, excluding network fees. BitGo is deprecating this field in the future.
baseValueString string
The value (in base units) sent by this transfer, excluding network fees represented as a string. BitGo is deprecating this field in the future.
Example: 2000000
Match pattern: ^-?\d+$
coin string required
A cryptocurrency symbol or token ticker symbol
Example: btc
comment
string or null
A comment from the user
date string <date-time>required
The date this Transfer was last updated
enterprise string
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
organization string
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
bitgoOrg string
Allowed values: BitGo Trust BitGo New York BitGo Germany BitGo Switzerland BitGo Europe ApS Frankfurt DE Trust BitGo Singapore BitGo Korea BitGo Custody MENA FZE BitGo India BitGo Sister Trust 1 BitGo Inc
entries array[object] required
An array of objects describing the change in address balances made as a result of this Transfer
history array[object] required
An audit log of events that have happened to the Transfer during its lifecycle
id string required
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
pendingApproval string
state string required
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: initialized pendingApproval rejected signed unconfirmed confirmed removed failed replaced deleted
stakingParams object
txid string
The on-chain transaction id
Example: b8a828b98dbf32d9fd1875cbace9640ceb8c82626716b4a64203fdc79bb46d26
type string required
Defines whether or not this Transfer was sent or received by the user
Allowed values: send receive
usd number
The amount of USD of this Transfer (will be negative if it's a send)
usdRate number
The USD rate at the time this Transfer was created
medianUsdValue number
The median USD value of this Transfer
medianUsdRate number
The median USD rate at the time this Transfer was created
feeUsd number
The fee USD value for token transfers
feeUsdRate number
The fee coin USD rate for token transfers
value number
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+$
wallet string required
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
walletType string
Wallet type
Allowed values: backing cold custodial custodialPaired hot advanced trading
replaces array[string]
Transaction IDs that this transfer replaces.
replacedBy array[string]
Transaction IDs that replace this transfer.
baseValueWithoutFeesString string
The value (in base units) sent by this transfer, excluding network fees, represented as a string
baseValueWithoutFees number
The value (in base units) sent by this transfer excluding network fees.
coinSpecific
confirmations number
The number of blocks that have been confirmed since this Transfer's block was confirmed
consolidateId string
Consolidation ID if this transfer is part of a consolidation
feeString string
The Transfer's fee (in base units) represented as a String
feeCoin string
The coin used to pay the fee (for cross-chain transactions)
sequenceId string
Unique wallet identifier for preventing double-spends
subType string
Transfer subtype
Allowed values: ofc_deposit ofc_withdrawal ofc_book_transfer ofc_exchange ofc_bn_settlement_transfer ofc_bn_allocation ofc_trading_order ofc_trading_settlement ofc_margin_collateral ofc_margin_position ofc_direct_trade ofc_routed ofc_fee ofc_other ofc_unstake receive_from_gastank reserved_amount utxo_message_signing pending_deposit staking_eth_withdrawal staking_eth_partial_withdrawal staking_eth_full_withdrawal staking_eth_mev_reward staking_eth_block_reward staking_bera_withdrawal staking_bera_block_reward
txRequestId string
Associated transaction request ID
goStakingRequestId string
Associated GO staking request ID
height number
The height of the block this Transfer was confirmed in (999999999 if unconfirmed)
heightId string
The unique height id of the block
instant boolean
Whether this is an instant transaction
instantId string
The instant transaction ID if applicable
isFee boolean
Whether this transfer represents a fee
isReward boolean
Whether this transfer represents a staking reward
isUnlock boolean
Whether this transfer represents an unlock operation
nSegwitInputs number
DEPRECATED. Number of segwit inputs on the transfer.
outputs array[object]
payGoFee number
The Transfer's BitGo fee (in base units)
payGoFeeString string
The Transfer's BitGo fee (in base units) represented as a String
inputs array[object]
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.
label string
Address labels (if any) from entries concatenated.
metadata array[object]
Additional metadata associated with the transfer
sendAccounting array[object]
Accounting breakdown for send transactions
tags array[string]
The tags to be used on this Transfer (used in Policies)
txidType string
The type of the transaction id
usersNotified boolean
Whether BitGo already sent notifications to the users of the transfer wallet
vSize number
The size of the transaction
walletLabel string
Label of the wallet associated with this transfer
enterpriseName string
Name of the enterprise associated with this transfer
elliptic string
Elliptic risk score information (trust transfers)
senderInformationVerified boolean
Whether sender information has been verified (trust transfers)
buildParams dictionary<string, any>
Parameters used to build the transaction
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)

400 Response

name string
Error code
context object required
Properties that apply to a specific error name
error string required
Human-readable error message
requestId string required
Client request id