v1

latestOpenAPI 3.1.02026-07-241653251.3 MB

Payins

Request a payin quote

Retrieves a quote for a pay event for a given participant code and asset. The response includes a deposit address and rate at which a subsequent on-chain deposit will be honored.

The quote has an expiry timestamp (price_expire_ts) — for volatile assets, the platform must execute the deposit before this time, or a new quote can be requested for the same payment to refresh the price. For stablecoins, price_expire_ts will be null.

The request_id you send (via the X-Request-Id header) is the idempotency key for this endpoint: re-submitting the same request_id returns the existing active quote — same transaction_id, deposit address, and rate — instead of creating a new one.

Use the returned transaction_id as the path parameter when calling POST /pay/{id}/rfq to refresh a quote.

After the on-chain deposit settles or fails, a crypto_pay_status_changed webhook reports the outcome (success + status_reason_code).

post/pay/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 code for the shopper making the payment

pay_assetstring required

The cryptocurrency asset to be deposited (e.g., BTC, ETH, USDC)

quoted_totalstring required

The total fiat amount the shopper is paying

quoted_currency'USD' required

The fiat currency for the payment. Currently only USD is supported

account_labelstring

Optional account label for the transaction. Defaults to "pay"

client_reference_idstring

An optional client-provided reference ID for tracking purposes

merchant_participant_codestring

Optional participant code of the merchant tied to this transaction. When omitted, the platform itself is treated as the merchant.

Example request

{
  "participant_code": "ABCDEF",
  "pay_asset": "BTC",
  "quoted_total": "100.00",
  "quoted_currency": "USD",
  "account_label": "pay",
  "client_reference_id": "order-12345",
  "merchant_participant_code": "MERCH01"
}

Response

Pay quote created successfully

Example response

{
  "message": {
    "request_id": "14f8ebb8-7530-4aa4-bef9-9d73d56313f3",
    "participant_code": "ABCDEF",
    "pay_asset": "BTC",
    "quoted_currency": "USD",
    "quoted_total": "100.00",
    "underlying_quantity": "0.00152307",
    "rate": "65658.42",
    "price_expire_ts": 1712757000000,
    "deposit_address": "bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh",
    "transaction_id": "550e8400-e29b-41d4-a716-446655440000",
    "client_reference_id": "order-12345",
    "merchant_participant_code": "MERCH01"
  }
}