Sign in

v3

latestOpenAPI 3.0.02026-07-311784111.3 MB
Wallet
Private

Creates a new withdrawal request. This method allows you to withdraw funds from your account to an external address. The withdrawal can be configured with priority settings and must use an address from your address book.

Withdrawal Checks & Balance Updates

Withdrawal funds are checked twice: when a user requests a withdrawal and again when they confirm it via the email link. If available funds decrease between these steps, the withdrawal may be rejected.

A withdrawal may also be rejected if the on-chain fee increases between the request and confirmation.

The withdrawal amount is deducted only after all checks pass and the transaction is scheduled. The web-interface Withdrawal tab displays all withdrawals regardless of their status (pending, cancelled, rejected, or completed).

📖 Related Article: Managing Withdrawals

Scope: wallet:read_write and mainaccount

Try in API console

get/private/withdraw

Query parameters

currency'BTC' | 'ETH' | 'USDC' | 'USDT' | 'EURR' required

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

The currency symbol

addressstring required

Address in currency format, it must be in address book

amountnumber required

Amount of funds to be withdrawn

priority'insane' | 'extreme_high' | 'very_high' | 'high' | 'mid' | 'low' | 'very_low'

Withdrawal priority, optional for BTC, default: high

noncestring

Nonce

Example:bF1_gfgcsd

Optional idempotency nonce. If provided, subsequent requests with the same nonce will return the previously created transaction instead of creating a new one. Must be 8-128 characters. The nonce is persisted on the resulting transaction and returned in the response.

Response

Success response

jsonrpc'2.0' required

The JSON-RPC version (2.0)

idinteger

The id that was sent in the request

Example response

{
  "result": {
    "address": "1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa",
    "amount": 1,
    "confirmed_timestamp": 1536569522277,
    "created_timestamp": 1536569522277,
    "fee": 0.000023,
    "id": 1,
    "priority": 1,
    "transaction_id": "1b1fb5568515e2b79503501e3d3680b2d0838d5dfc2d15a04eb8cd9fbbe0b572",
    "updated_timestamp": 1536569522277
  }
}