Create a Lockable FX Quote
Request a lockable exchange rate between two currencies. Quotes have a
short expiry window; use the returned id on
POST /v1/fx/exchange to lock the rate before expiry.
You must supply at least one of sell_amount or buy_amount —
omitting both returns 400 missing_required_field. (The two are
individually optional but not both.)
Rate-limited to 30 per minute per IP.
Authorizations
Per-request DPoP proof JWT (RFC 9449). MUST accompany the Authorization: DPoP <access_token> header on every protected operation. The proof is signed by the merchant's private DPoP key and carries htm, htu, iat, jti, and ath claims.
Body
Supply either sell_amount OR buy_amount — the missing side is
computed from the locked rate.
ISO 4217 three-letter currency code.
^[A-Z]{3}$"USD"
ISO 4217 three-letter currency code.
^[A-Z]{3}$"USD"
Decimal amount as a string, never a float. Up to 12 whole digits.
^-?\d{1,12}(\.\d+)?$"1234.56"
Decimal amount as a string, never a float. Up to 12 whole digits.
^-?\d{1,12}(\.\d+)?$"1234.56"
Request a rate-locked quote whose customer_rate is held until
lock_expires_at. Redeem the lock by passing the returned id
(or equivalently lock_id) as quote_id on
POST /v1/fx/exchange before expiry. Defaults to true.
Set to false for an indicative (non-binding) quote that cannot
be redeemed on /v1/fx/exchange.
Response
Quote created.
An FX rate quote, optionally locked for execution.