Create withdrawal request

post

https://api.cert.zerohash.com/withdrawals/requests

Creates new withdrawal requests to be settled. Withdrawal requests created through the API go directly into an APPROVED state.
To retrieve withdrawal account IDs use the GET /withdrawals/digital_asset_addresses and GET /withdrawals/fiat_accounts endpoints.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Withdrawal request details including account ID, asset, amount, and destination information.

client_withdrawal_request_id

string

A unique identifier for the withdrawal, generally produced by the Platform on which the trade was executed
Note: this must be unique, per platform, per 24 hour period

withdrawal_account_id

string

The whitelisted withdrawal account or address to withdraw funds to
Note: only one of withdrawal_account_id, address or account{} can be submitted per withdrawal, but zerohash will always respond with withdrawal_account_id

address

string

account

object

participant_code

string

The participant code against whom the withdrawal will be made

beneficiary_participant_code

string

The identifier of the participant benefiting from the withdrawal request.

sender_participant_code

string

The identifier of the participant initiating the withdrawal on behalf of participant_code. Only applicable when operating on behalf of a third party.

beneficiary_first_name

string

The first name of the participant benefiting from the quote request
Only applies to individual beneficiaries. Cannot be used along with business_beneficiary_name.
Note: Redundant if beneficiary_participant_code is provided in request

beneficiary_last_name

string

The last name of the participant benefiting from the quote request
Only applies to individual beneficiaries. Cannot be used along with business_beneficiary_name.
Note: Redundant if beneficiary_participant_code is provided in request

beneficiary_business_name

string

The name of the the business participant benefiting from the quote request
Only applies to business beneficiaries. Cannot be used along with first/last_beneficiary_name.
Note: Redundant if beneficiary_participant_code is provided in request

account_group

string

The account group to withdraw against, e.g. 00SCXM for the Seed Digital Commodities Market account group

account_label

string

The account label associated with the account

amount

string

The amount to withdraw

asset

string

enum

The asset code for the withdrawal request, e.g. XRP.

Allowed:

destination_tag

string

The destination tag or memo ID associated with the transaction
If the asset is EOS, XLM or XRP and no_destination_tag is false, then this is required

no_destination_tag

boolean

Whether or not the specific withdrawal and destination address requires a destination tag.If the asset model is tag, this field is required
Note: zerohash requires that no_destination_tag be false for EOS.

gas_price

string

Applicable only for ERC-20 tokens, the transaction fee payable on the Ethereum network - refer to our FAQ on how this works

input_data

string

Applicable only for smart contract executions on the Ethereum blockchain. This is the ABI encoding of the function and its arguments in RLP format.

trade_id

string

If provided will apply the earlier agreed-upon network fee amount from the provided trade.

Headers

X-SCX-SIGNED

string

required

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

X-SCX-TIMESTAMP

string

required

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

Responses

200Successfully created withdrawal request. Returns the created resource with generated IDs and timestamps.

400Bad Request

403Forbidden

404Not Found

500Internal Server Error

503Service Unavailable