Ctrl+K

Clear Held Funds

post/das-rest/api/v1/hold/clear

Request Body

virtualWallet string
Example: 59cd72485007a239fb00282ed480da1f
backingWallet string
Example: 59cd72485007a239fb00282ed480da1f
currency string
A cryptocurrency or token ticker symbol.
Example: btc
release string
Example: 10990
amount string
Example: 10000
fees array[object]
define a fee charged as part of a transaction (same currency only)
amount string
Example: 10100
Match pattern: ^\d+$
notation string
Short notation for fee source/info
Example: on chain fee
fee_type string
Each fee type may be treated differently by accounting, revenue fee types: BITGO_WITHDRAWAL_FEE, BITGO_SETTLEMENT_FEE
Allowed values: WIRE_FEE ELECTRONIC_FEE BANK_FEE CHAIN_FEE BITGO_WITHDRAWAL_FEE BITGO_SETTLEMENT_FEE
Example: BITGO_SETTLEMENT_FEE
txId string
Example: 59cd72485007a239fb00282ed480da1f
holdTxId string
optional alternate hold tx id
Example: 59cd72485007a239fb00282ed480da1f
timestamp string
Example: 2018-10-26T20:20:55.000Z

200 Response

virtualWallet string
Example: 59cd72485007a239fb00282ed480da1f
currency string
A cryptocurrency or token ticker symbol.
Example: btc
released string
Example: 10000
withdrawn string
Example: 10000
fees string
sum of fees withheld
Example: 900
txId string
Example: 59cd72485007a239fb00282ed480da1f