External Buy Quote
Generate a price-locked quote for an External Buy onramp transaction (crypto withdrawn to an external wallet). Pass the returned quote id as quote_id when creating the transaction to lock the price.
Onramp Price Lock
An External Buy transaction is price-locked only when it is created from a quote. Call this endpoint first, then pass the returned quote id as quote_id when creating the External Buy transaction.
Authentication uses the same HMAC client auth as the other client endpoints.
Request rules
- Provide exactly one of
from_amountorto_amount— not both, not neither. networkis required because the crypto withdrawal leg sends funds to an external wallet.
Response fields
| Field | Meaning |
|---|---|
id | Quote id. Pass this as quote_id when creating the transaction. |
network | Network the locked quote applies to. |
expiry | Price-lock expiry. The quote must be used to create a transaction before this time. |
settlement_expiry | Deadline by which the transaction must be completed (deposit settled). |
final_price | Locked price used for the transaction. |
min_crypto_amount | Minimum crypto amount that can be withdrawn on this network. |
fee_breakup keys | platform_fee, network_fee, client_fee, discount, tax_on_fee, tds |
A quote is single-use and tied to the client that created it.
Headers
Your API key (configured in credentials)
HMAC-SHA256 signature (auto-generated) To test manually: HMAC-SHA256 of apiKey + timestamp (or apiKey + timestamp + userId when X-User-Id is required), keyed with your API secret. The HMAC Generator flow computes this for you.
Unix timestamp in seconds (auto-generated) Unix seconds, e.g. Math.floor(Date.now() / 1000). Must match the timestamp used in the X-Signature computation.
Unique request identifier (auto-generated) Any unique string per request, e.g. a UUID.
User UUID (set above)
Body
Fiat currency for the onramp transaction.
Crypto currency for the onramp transaction.
Payment method used to complete the onramp deposit leg.
Network used to transfer the funds to the external wallet as part of the crypto withdrawal leg.
Fiat amount. Provide exactly one of from_amount or to_amount (not both, not neither).
Crypto amount. Provide exactly one of from_amount or to_amount (not both, not neither).
Related topics
Create External BuyBuy QuoteGet External Sell QuoteGet External Wallet QuotePool Buy Quote