Sign in
latestOpenAPI 3.0.32026-08-224982,0272.8 MB

e445c15e5bee

Transfer

Update wire withdrawal

Approve or reject a pending wire withdrawal. If approving, the state updates to confirmed, enabling BitGo Trust to wire transfer the funds. If rejecting, the state updates to rejected, canceling the pending wire transfer. This endpoint is deprecated. Use Confirm fiat withdrawal instead.

put/api/v2/wallet/{walletId}/wirewithdrawals/{transferId}/confirm

Path parameters

walletIdstring required
Example:59cd72485007a239fb00282ed480da1f
transferIdstring required

Request body

action'approve' | 'reject' required
coin'tfiatusd' | 'tfiateuro' | 'tfiatgbp' | 'tfiatinr' | 'tfiataed' | 'tfiatsgd' | 'fiatusd' | 'fiateuro' | 'fiatgbp' | 'fiataed' | 'fiatsgd'
amountstring

String representation of the amount to send in base units of the currency.

addressstring

The address to send to.

Example request

{
  "amount": "2000000",
  "address": "2MvrwRYBAuRtPTiZ5MyKg42Ke55W3fZJfZS"
}

Response

OK

baseValuenumber

The value (in base units) sent by this transfer, excluding network fees. BitGo is deprecating this field in the future.

baseValueStringstring

The value (in base units) sent by this transfer, excluding network fees represented as a string. BitGo is deprecating this field in the future.

coinstring required

A cryptocurrency symbol or token ticker symbol

commentstring nullable

A comment from the user

datestring date-time required

The date this Transfer was last updated

enterprisestring
organizationstring
bitgoOrg'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'
idstring required
pendingApprovalstring
state'initialized' | 'pendingApproval' | 'rejected' | 'signed' | 'unconfirmed' | 'confirmed' | 'removed' | 'failed' | 'replaced' | 'reversed' | 'deleted' 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.
  • reversed: The transfer was reversed (e.g., when a withdrawal offer is rejected in multi-step transfers).
  • 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.
txidstring

The on-chain transaction id

type'send' | 'receive' required
usdnumber

The amount of USD of this Transfer (will be negative if it's a send)

usdRatenumber

The USD rate at the time this Transfer was created

medianUsdValuenumber

The median USD value of this Transfer

medianUsdRatenumber

The median USD rate at the time this Transfer was created

feeUsdnumber

The fee USD value for token transfers

feeUsdRatenumber

The fee coin USD rate for token transfers

valuenumber

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)

valueStringstring required

The total value (in base units) sent by this Transfer represented as a String

walletstring required
walletType'backing' | 'cold' | 'custodial' | 'custodialPaired' | 'hot' | 'advanced' | 'trading'

Wallet type

replacesstring[]
replacedBystring[]
replacedByTransferIdstring[]
riskIndicatorsstring[]
baseValueWithoutFeesStringstring

The value (in base units) sent by this transfer, excluding network fees, represented as a string

baseValueWithoutFeesnumber

The value (in base units) sent by this transfer excluding network fees.

{"stackTrail":"components:schemas:Transfer1:properties:coinSpecific","oasType":"schema","type":"unknown","description":"Transfer fields specific to each coin type"}
confirmationsnumber

The number of blocks that have been confirmed since this Transfer's block was confirmed

consolidateIdstring

Consolidation ID if this transfer is part of a consolidation

feeStringstring nullable

The Transfer's fee (in base units) represented as a String

feeCoinstring

The coin used to pay the fee (for cross-chain transactions)

sequenceIdstring

Unique wallet identifier for preventing double-spends

subType'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' | 'ofc_financing_liquidation' | 'receive_from_gastank' | 'reserved_amount' | 'utxo_message_signing' | 'pending_deposit' | 'pending_deposit_activity' | 'internal_transfer' | 'pending_withdrawal_offer' | 'pending_deposit_offer' | 'offer_accepted' | 'offer_rejected' | 'confirmed_deposit' | 'confirmed_withdrawal' | 'deposit_offer_expired' | 'withdrawal_offer_expired' | 'withdrawal_offer_rejected' | 'utxo_expired' | 'offer_cancelled' | 'cancel_withdrawal_offer' | 'mint_request' | 'mint_offer' | 'mint_accept' | 'mint_deposit' | 'mint_reject' | 'burn_request' | 'burn_offer' | 'burn_accept' | 'burn_withdraw' | 'burn_reject' | 'pending_participant_onboarding_request' | 'participant_onboarding_accepted' | 'pending_dtcc_end_investor_invite' | 'end_investor_invite_offer' | 'end_investor_invite_accepted' | 'end_investor_invite_rejected' | 'pending_allocation' | 'allocation_accepted' | 'cosign_delegation_offer' | 'cosign_delegation_accepted' | 'cash_dvp_settled' | 'repo_dvp_open_leg_settled' | 'repo_dvp_close_leg_settled' | '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' | 'defi_deposit'

Transfer subtype

txRequestIdstring

Associated transaction request ID

goStakingRequestIdstring

Associated GO staking request ID

heightnumber

The height of the block this Transfer was confirmed in (999999999 if unconfirmed)

heightIdstring

The unique height id of the block

instantboolean

Whether this is an instant transaction

instantIdstring

The instant transaction ID if applicable

isFeeboolean

Whether this transfer represents a fee

isRewardboolean

Whether this transfer represents a staking reward

isUnlockboolean

Whether this transfer represents an unlock operation

nSegwitInputsnumber

DEPRECATED. Number of segwit inputs on the transfer.

payGoFeenumber

The Transfer's BitGo fee (in base units)

payGoFeeStringstring

The Transfer's BitGo fee (in base units) represented as a String

intendedValueStringstring

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.

labelstring

Address labels (if any) from entries concatenated.

tagsstring[]
txidTypestring

The type of the transaction id

usersNotifiedboolean

Whether BitGo already sent notifications to the users of the transfer wallet

vSizenumber

The size of the transaction

walletLabelstring

Label of the wallet associated with this transfer

enterpriseNamestring

Name of the enterprise associated with this transfer

ellipticstring

Elliptic risk score information (trust transfers)

senderInformationVerifiedboolean

Whether sender information has been verified (trust transfers)

buildParamsobject

Parameters used to build the transaction

createdTimestring date-time

The time this transfer was created

approvedTimestring date-time

The time this transfer was approved

rejectedTimestring date-time

The time this transfer was rejected

signedTimestring date-time

The time this transfer was signed

unconfirmedTimestring date-time

The time this transfer became unconfirmed

confirmedTimestring date-time

The time this transfer was confirmed

removedTimestring date-time

The time this transfer was removed

commentedTimestring date-time

The time this transfer was commented on

failedTimestring date-time

The time this transfer failed

regeneratedTimestring date-time

The time this transfer was regenerated

replacedTimestring date-time

The time this transfer was replaced

replacingTimestring date-time

The time this transfer started replacing another

abandonedTimestring date-time

The time this transfer was abandoned

signedDatestring date-time

The date this transfer was signed (legacy field)

customerApprovedTimestring date-time

The time this transfer was approved by the customer (trust transfers)

idVerificationTimestring date-time

The time identity verification was completed (trust transfers)

trustSignedTimestring date-time

The time this transfer was signed by trust (trust transfers)

trustFinalApprovalTimestring date-time

The time this transfer received final trust approval (trust transfers)

Example response

{
  "baseValueString": "2000000",
  "coin": "btc",
  "enterprise": "59cd72485007a239fb00282ed480da1f",
  "organization": "59cd72485007a239fb00282ed480da1f",
  "entries": [
    {
      "address": "2NAUwNgXaoFj2VVnSEvNLGuez8CfdU2UCMZ",
      "valueString": "20000",
      "wallet": "59cd72485007a239fb00282ed480da1f",
      "walletLabel": "My Cold Wallet",
      "token": "omg"
    }
  ],
  "history": [
    {
      "user": "59cd72485007a239fb00282ed480da1f"
    }
  ],
  "id": "59cd72485007a239fb00282ed480da1f",
  "txid": "b8a828b98dbf32d9fd1875cbace9640ceb8c82626716b4a64203fdc79bb46d26",
  "valueString": "2000000",
  "wallet": "59cd72485007a239fb00282ed480da1f"
}