private/cancel_withdrawal

Cancels a pending withdrawal request. This method allows you to cancel a withdrawal that has not yet been processed. Once a withdrawal is processed, it cannot be cancelled.

📖 Related Article: Managing Withdrawals

Scope: wallet:read_write

Try in API console

cURL

cURL

curl --request GET \
  --url https://test.deribit.com/api/v2/private/cancel_withdrawal \
  --header 'Content-Type: application/json' \
  --data '
{
  "jsonrpc": "2.0",
  "id": 7420,
  "method": "private/cancel_withdrawal",
  "params": {
    "currency": "BTC",
    "id": 1
  }
}
'

200

{
  "jsonrpc": "2.0",
  "id": 7420,
  "result": {
    "address": "2NBqqD5GRJ8wHy1PYyCXTe9ke5226FhavBz",
    "amount": 0.5,
    "confirmed_timestamp": null,
    "created_timestamp": 1550571443070,
    "currency": "BTC",
    "fee": 0.0001,
    "id": 1,
    "priority": 0.15,
    "state": "cancelled",
    "transaction_id": null,
    "updated_timestamp": 1550571443070
  }
}

Query Parameters

currency · enum<string> · required

The currency symbol Currency, i.e "BTC", "ETH", "USDC"

Available options: BTC, ETH, USDC, USDT, EURR

id · number · required

The withdrawal id

Example:

1

Response

200 - application/json

Success response

jsonrpc · enum<string> · required

The JSON-RPC version (2.0)

Available options: 2.0

result · object · required

Hide child attributes

result. address · string · required

Address in proper format for currency

Example:

"1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa"

result. amount · number · required

Amount of funds in given currency

Example:

1

result. currency · enum<string> · required

Currency, i.e "BTC", "ETH", "USDC"

Available options: BTC, ETH, USDC, USDT, EURR

result. state · enum<string> · required

Withdrawal state, allowed values : unconfirmed, confirmed, cancelled, completed, interrupted, rejected

Available options: unconfirmed, confirmed, cancelled, completed, interrupted, rejected

result. transaction_id · string | null · required

Transaction id in proper format for currency, null if id is not available

Example:

"1b1fb5568515e2b79503501e3d3680b2d0838d5dfc2d15a04eb8cd9fbbe0b572"

result. updated_timestamp · integer · required

The timestamp (milliseconds since the Unix epoch)

Example:

1536569522277

result. confirmed_timestamp · integer | null

The timestamp (milliseconds since the Unix epoch) of withdrawal confirmation, null when not confirmed

Example:

1536569522277

result. created_timestamp · integer

The timestamp (milliseconds since the Unix epoch)

Example:

1536569522277

result. fee · number

Fee in currency

Example:

0.000023

result. id · integer

Withdrawal id in Deribit system

Example:

1

result. priority · number

Id of priority level

Example:

1

result. nonce · string

Optional idempotency nonce if provided in the request

id · integer

The id that was sent in the request