Cancel withdrawal
DELETE {{baseUrl}}/v3/offchain/withdrawal/:id?revert=true
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.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
revert | boolean | 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. |