Skip to main content

private/create-withdrawal

POST 
/private/create-withdrawal
Creates a withdrawal request. Withdrawal setting must be enabled for your API Key. If you do not see the option when viewing your API Key, this feature is not yet available for you.

Request​

Body

required
    id int64required

    Request id (echoed in response)

    method stringrequired

    Must be "private/create-withdrawal"

    api_key stringrequired

    Your API key (only required for private REST)

    sig stringrequired

    HMAC-SHA256 signature in hex (only required for private REST)

    nonce int64required

    Current timestamp in milliseconds, e.g. "1771761038000".

    params objectrequired
    client_wid string

    Optional Client withdrawal ID.

    currency stringrequired

    E.g. BTC, CRO.

    amount decimalrequired

    Withdrawal amount.

    address stringrequired

    Destination address (must be whitelisted).

    address_tag string

    Secondary address identifier for coins like XRP, XLM (memo or tag).

    network_id string

    Desired network; address must be whitelisted. See default_network and network in get-currency-networks.

Success.
Schema
    id int64

    Echoed request id

    method string

    Method invoked

    code int32

    0 = success; non-zero indicates error (reason code).

    result object
    Present when code === 0. currency and other fields per docs.
    id int64

    Newly created withdrawal ID.

    client_wid string

    (Optional) Client withdrawal ID if provided in the request.

    currency string

    E.g. BTC, CRO.

    amount decimal

    Withdrawal amount.

    fee decimal

    Withdrawal fee.

    address string

    Address with Address Tag (if any).

    create_time int64

    Creation time (ms).

    message string

    Present when code !== 0.

    original string

    Present when code !== 0.