private/cancel_transfer_by_id

Cancel a pending transfer by its ID. This method allows you to cancel a transfer that has not yet been processed. Once a transfer is processed, it cannot be cancelled.

📖 Related Article: Managing Transfers

Scope: wallet:read_write

Try in API console

cURL

cURL

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

200

{
  "jsonrpc": "2.0",
  "id": 9187,
  "result": {
    "amount": 0.2,
    "created_timestamp": 1550579457727,
    "currency": "BTC",
    "direction": "payment",
    "id": 2,
    "other_side": "2MzyQc5Tkik61kJbEpJV5D5H9VfWHZK9Sgy",
    "state": "cancelled",
    "type": "user",
    "updated_timestamp": 1550579457727
  }
}

Query Parameters

currency · enum<string> · required

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

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

id · integer · required

Id of transfer

Example:

12

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. id · integer · required

Id of transfer

Example:

12

result. created_timestamp · integer · required

The timestamp (milliseconds since the Unix epoch)

Example:

1536569522277

result. type · enum<string> · required

Type of transfer: user - sent to user, subaccount - sent to subaccount

Available options: user, subaccount

result. currency · enum<string> · required

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

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

result. amount · number · required

Amount of funds in given currency

Example:

1

result. other_side · string · required

For transfer from/to subaccount returns this subaccount name, for transfer to other account returns address, for transfer from other account returns that accounts username.

Example:

"Smith"

result. state · string · required

Transfer state, allowed values : prepared, confirmed, cancelled, waiting_for_admin, insufficient_funds, withdrawal_limit otherwise rejection reason

result. updated_timestamp · integer · required

The timestamp (milliseconds since the Unix epoch)

Example:

1536569522277

result. direction · enum<string>

Transfer direction

Available options: payment, income

id · integer

The id that was sent in the request