Sign in

v1

latestOpenAPI 3.1.02026-07-241653251.3 MB
Payments

Request payment quote

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.

post/payments/rfq

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.

Request body

participant_codestring required

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

quoted_currency'CAD' | 'EUR' | 'GBP' | 'JPY' | 'MXN' | 'USD' required

the quoted asset

underlying_currency'AAVE.ETH' | 'ADA' | 'ALGO' | 'AVAX' | 'BAT.ETH' | 'BCH' | 'BTC' | 'BUSD.ETH' | 'COMP.ETH' | 'DAI.ETH' | 'DOGE' | 'DOT' | 'EGLD' | 'EOS' | 'ETC' | 'ETH' | 'ETH.ARBITRUM' | 'GRT.ETH' | 'GYEN.ETH' | 'HBAR' | 'LINK.ETH' | 'LTC' | 'LUNA' | 'MATIC.ETH' | 'MATIC.POLYGON' | 'MKR.ETH' | 'MOB' | 'SAND.ETH' | 'SOL' | 'UNI.ETH' | 'USDC.ETH' | 'USDC.ALGO' | 'USDC.POLYGON' | 'USDC.SOL' | 'USDC.HBAR' | 'USDC.XLM' | 'USDC.AVAX' | 'USDT.ETH' | 'UST' | 'WBTC.ETH' | 'XEM' | 'XLM' | 'XRP' | 'XTZ' | 'ZUSD.ETH' required

the underlying asset

side'buy' | 'sell' required

The participant side of the quote - buy or sell.

totalstring

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

quantitystring

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

quote_expiry'5s' | '30s' | '1m' | '5m' | '10m' | '15m'

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

Example request

{
  "participant_code": "CUST01",
  "quoted_currency": "USD",
  "underlying_currency": "BTC",
  "side": "buy",
  "total": "125.08",
  "quantity": "6.761693",
  "quote_expiry": "5m"
}

Response

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

Example response

{
  "message": {
    "request_id": "6fc13022-717b-45ff-bb05-011a7d4f3116",
    "participant_code": "ABCDEF",
    "underlying_currency": "XRP",
    "quoted_currency": "USD",
    "side": "sell",
    "quantity": "6.761693",
    "price": "1.317844179922575",
    "quote_id": "a3790e55-d0cb-4c82-b525-4965966ce24d",
    "expire_ts": 1777896067992,
    "account_group": "00SCXM",
    "account_label": "general",
    "obo_participant": {
      "participant_code": "20XRLH",
      "account_group": "WRD1K0",
      "account_label": "general"
    },
    "quote_notional": "8.91",
    "disclosed_spread": "0.468992514024906101025",
    "disclosed_spread_rate": "500"
  }
}