Request payment quote

post

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

Retrieves a quote for a payout. Exactly one of quantity or total must be supplied. The returned quote_id can be passed to POST /payments/execute before expire_ts.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Quote parameters.

participant_code

string

required

The participant that the quote is being generated for. Typically the end customer.

quoted_currency

string

enum

required

the quoted asset

Allowed:

underlying_currency

string

enum

required

the underlying asset

side

string

enum

required

The participant side of the quote - buy or sell.

Allowed:

total

string

The desired amount expressed in the quoted_currency. Exactly one of quantity or total must be provided.

quantity

string

The desired amount expressed in the underlying_currency. Exactly one of quantity or total must be provided.

quote_expiry

string

enum

Requested time-to-live for the quote. Defaults to 5s when omitted.

Allowed:

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

200Quote generated. Execute the quote via POST /payments/execute before expire_ts elapses.

400Bad Request

403Forbidden

404Not Found

500Internal Server Error

503Service Unavailable