Get quote

post

https://api.cert.zerohash.com/convert_withdraw/rfq

Retrieves a quote for the purchase of an asset and the network fees associated with an imminent and automatic withdrawal of the asset. Exactly one of quantity or total must be supplied in the request body.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Convert-and-withdraw quote parameters. Select the variant that matches whether the request is expressed as a quantity of the underlying or a total in the quoted currency.

Request for quote with specific quantity of underlying asset. Use this when you know the exact amount of crypto to convert and withdraw.

participant_code

string

The identifier of the participant making the quote request

quoted_currency

string

enum

required

the quoted asset

Allowed:

underlying

string

enum

required

the underlying asset

side

string

enum

required

The participant side of the quote - buy or sell

Allowed:

account_label

string

The account_label that's used to fund the trade. This parameter is case sensitive.

withdrawal_address

string

required

The on-chain address for the withdrawal.

fee_inclusive

boolean

Only applicable for orders by total. If true, the total_notional equals the total value specified, fees included.

spread

string

The spread to apply to the quote in basis points

destination_tag

string

Destination tag / memo ID. Required for some assets (e.g., EOS, XLM, XRP) depending on no_destination_tag.

no_destination_tag

boolean

Whether the destination requires a tag/memo. For EOS, this must be false per zerohash requirements.

beneficiary_participant_code

string

Identifier of the participant benefiting from the quote request

beneficiary_first_name

string

First name of the individual beneficiary. Not with business_beneficiary_name. Redundant if beneficiary_participant_code is provided.

beneficiary_last_name

string

Last name of the individual beneficiary. Not with business_beneficiary_name. Redundant if beneficiary_participant_code is provided.

beneficiary_business_name

string

Business name of the beneficiary. Not with first/last beneficiary name. Redundant if beneficiary_participant_code is provided.

quantity

string

required

Amount of the underlying currency requested. Exactly one of quantity or total must be supplied.

fees

array of objects

Optional custom fees applied to the quote. Up to 5 entries are accepted.

fees

payment_processor

object

Optional payment processor metadata associating this quote with an external PSP.

contract_execution

object

Optional EVM smart-contract execution metadata. Only available on supported EVM networks.

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

201Successfully generated convert-and-withdraw quote. Returns the quote envelope ({ message: {...} }) with pricing, network fees, and an ephemeral quote_id.

400Bad Request

403Forbidden

404Not Found

500Internal Server Error

503Service Unavailable