Withdrawal

Cancel withdrawal

/v3/offchain/withdrawal/{id}

1 credit per API call.

This method is helpful if you need to cancel the withdrawal if the blockchain transaction fails or is not yet processed. This does not cancel already broadcast blockchain transaction, only Tatum internal withdrawal, and the ledger transaction, that was linked to this withdrawal.
By default, the transaction fee is included in the reverted transaction. There are situations, like sending ERC20 on ETH, TRC token on TRON, XLM or XRP based assets, when the fee should not be reverted, because e.g. the fee is in calculated in Ethereum and transaction was in ERC20 currency. In this situation, only the transaction amount should be reverted, not the fee.

Tip: For Virtual Accounts where withdrawal currency is a token, \n it is recommended to use “revert=false”. Otherwise, the blockchain \n transaction fee in native currency will be reverted as effective \n Virtual Account balance. Example: tx out fails and cancel \n “revert=true” from a 10 USDT + 0.10 TRX as “fee” would be \n reverted as 10+30 USDT (where the TRX of the fee is converted to USDT)

delete/v3/offchain/withdrawal/{id}

Request

  • Base URL
    https://api.tatum.io
  • URL
    https://api.tatum.io/v3/offchain/withdrawal/{id}
  • Auth
    API key in header x-api-key

Path parameters

idstring required

ID of created withdrawal

Query parameters

revertboolean
Example:true

Defines whether fee should be reverted to account balance as well as amount. Defaults to true. Revert true would be typically used when withdrawal was not broadcast to blockchain. False is used usually for Ethereum based currencies when gas was consumed but transaction was reverted.

Response

OK

Changes

No recorded changes to this operation across all 1 revision of this API.