Sign in

v1

latestOpenAPI 3.1.02026-07-241653251.3 MB
Withdrawals

Get withdrawal quote

Returns a locked network fee quote for a planned crypto withdrawal. The returned withdrawal_quote_id is valid for 30 seconds and must be passed to POST /withdrawals/execute to complete the withdrawal. Exactly one of withdrawal_account_id or withdrawal_address must be supplied; if max_amount is false (the default), amount is required.

get/withdrawals/locked_network_fee

Query parameters

participant_codestring required

The participant the withdrawal will be debited from. 6-character alphanumeric code.

account_groupstring

The account_group for the source account. Defaults to the caller's participant_code when omitted.

account_labelstring

The account_label for the source account. Defaults to general when omitted.

assetstring required

The asset code of the asset being withdrawn, e.g. BTC.

amountstring

The requested withdrawal amount. Required (and must be positive) unless max_amount is true.

max_amount'true' | 'false'

When true, zerohash will generate a withdrawal for the full available balance of asset in the source account; in that case amount can be omitted. Defaults to false. Accepted as the string "true" or "false".

withdrawal_account_idstring

The withdrawal_account_id of the whitelisted destination account. Required when withdrawal_address is not provided.

withdrawal_addressstring

The on-chain address that will receive the crypto asset. Required when withdrawal_account_id is not provided.

destination_tagstring

The destination tag or memo ID associated with the transaction. Required when the asset is EOS, XLM, or XRP and no_destination_tag is false.

no_destination_tag'true' | 'false'

Whether the destination address requires a destination tag. Required for tag-based assets (EOS, XLM, XRP). zerohash requires no_destination_tag to be false for EOS. Accepted as the string "true" or "false".

Headers

X-SCX-SIGNEDstring required

HMAC-SHA256 signature of the request, base64-encoded. See the Authentication guide for the exact signing formula.

X-SCX-TIMESTAMPstring required
Example:1678901234

Current Unix timestamp in seconds. Must be within 60 seconds of server time or the request is rejected.

Response

Successfully retrieved locked network fee quote. including withdrawal_quote_id, net_withdrawal_quantity, and the locked network/withdrawal fees.

Example response

{
  "message": {
    "participant_code": "ABCDEF",
    "account_group": "JMCH0H",
    "account_label": "general",
    "asset": "BTC",
    "amount": "0.04867615",
    "withdrawal_address": "bc1qy08yh0cm565gvtx2z80dz6dnyr635mwtknl36e",
    "withdrawal_quote_id": "bdc4c936-8505-4e61-b859-f3a5a6bdc880",
    "network_fee": "0.00000282",
    "network_fee_notional": "0.22",
    "net_withdrawal_quantity": "0.04867333",
    "net_withdrawal_notional": "3832.29",
    "amount_notional": "3832.51",
    "withdrawal_fee": "0"
  }
}