POST/api/v2/crypto-virtual-accounts/ramp-quote

POST /api/v2/crypto-virtual-accounts/ramp-quote

Authentication

Send your API key in the x-api-key header on every request.

Request body

application/json

Request body fields
FieldTypeRequiredDescription
UserIdunknownNo
AccountIdstringNothe crypto on/off-ramp virtual parent account ID used as the source account for the dry-run quote.
AccountReferencestringNo
CryptoCurrencystringYesSource digital currency discovered from the the crypto on/off-ramp Trading API.
FiatCurrencystringYesTarget fiat currency. Pricing is returned by the crypto on/off-ramp Quick Trade with dry_run=true and is net of all the crypto on/off-ramp and network fees.
CryptoAmountstringYes
ChainIdunknownNo

Responses

200 — OK

Response 200 fields
FieldTypeRequiredDescription
buy_currencystringNo
buy_amountstringNo
sell_currencystringNo
sell_amountstringNo
payment_methodstringNo
quote_timestring (date-time)No
expirystring (date-time)No
ratestringNo
feesobjectNo
quote_amountstringNo
settlement_ccystringNo
settlement_chain_idunknownNo
settlement_token_addressstringNo
sessionstringNo

400 — Bad Request

Response 400 fields
FieldTypeRequiredDescription
MessagestringNo
CodestringNo
StatusunknownNo
ValidationErrorsobjectNo
DetailsstringNo

401 — Unauthorized

Response 401 fields
FieldTypeRequiredDescription
MessagestringNo
CodestringNo
StatusunknownNo
ValidationErrorsobjectNo
DetailsstringNo

Example request

curl -X POST "https://{base_url}/api/v2/crypto-virtual-accounts/ramp-quote" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"CryptoCurrency":"…","FiatCurrency":"…","CryptoAmount":"…"}'

This page is generated from the live OpenAPI specification and always matches the current API.