Ctrl+K

Create a transfer internally

put/api/v2/internal/transfer

Used by the lightning service to internally create a transfer

Request Body

walletId string required
txRequestId string required

200 Response

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 Frankfurt DE Trust BitGo Singapore 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
address string required
An address affected by this Transfer
Example: 2NAUwNgXaoFj2VVnSEvNLGuez8CfdU2UCMZ
valueString string
The change (in base units) in the address' balance represented as a string
Example: 20000
Match pattern: "^-?\d+$"
isChange boolean
True if this address is a change address (only exists for UTXO coins) and if this is a "send" transfer
wallet string
Only visible when the user has access to the wallet
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
value number
The change (in base units) in the address' balance
nftSymbol string
type string
Allowed values: flushForwarderTokens walletFunding walletInitialization addressInitialization importedOutput
isPayGo boolean
True if this address is the BitGo PayGo wallet
token string
If this is a token entry, the token's symbol
Example: omg
failed boolean
True if this entry is failed
associatedNativeCoinAddress string
The native coin receive address associated with the solana ATA address. This is currently present only for BitGo addresses. This change was done so that there is a mapping between the two addresses in the transfer entries.
history array[object] required
An audit log of events that have happened to the Transfer during its lifecycle
action string required
Allowed values: created approved rejected signed unconfirmed confirmed removed commented failed regenerated replaced replacing abandoned
comment
string or null
If this history object is of action "commented", this is the comment from the user
date string <date-time>required
The date of this history object
transferId string
The ID of the transfer that this history object is associated with
txid string
The transaction ID of the transaction that this history object is associated with
user string
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
id string required
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
pendingApproval string
state string required
Allowed values: initialized pendingApproval rejected signed unconfirmed confirmed removed failed replaced deleted
stakingParams object
actionType string required
requestId string required
source string
Allowed values: external internal
validator string
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
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}$
replaces array[string]
Transaction IDs that this transfer replaces.
replacedBy array[string]
Transaction IDs that replace this transfer.

400 Response

One of
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