Skip to content
Quote/
Quote request

Quote request

Request

Request a quote with a locked price and a unique quoteId. The quote is valid for 3 minutes (expiresAt). Unique identifier for this quote. Use this when creating a ramp transaction via the Ramps Request payload to lock the quote in.

Prices are subject to change based on market volatility and network congestion. Once expired, a new quote must be requested.

Security
HMACAuth
Query
identityReferencestringrequired

A unique customer identifier provided by you. This field is required and must be unique for each customer. Please ensure you consistently reuse the same identityReference for repeat interactions with the same customer, allowing us to reliably recognize and associate their identity.

Example:identityReference=c-13344
fiatstringrequired

The desired fiat currency. Must be formatted as an ISO 4217 code.

Example:fiat=AUD
cryptostringrequired

The desired crypto token.

Example:crypto=ETH
methodstringrequired

The payment method.

Available payments
debit-credit-card
apple-pay
sepa-bank-transfer
gbp-bank-transfer
ach-bank-transfer
upi
pix
zar-bank-transfer
interac-bank-transfer
ideal-bank-transfer
google-pay
payid-bank-transfer
poli-bank-transfer
try-bank-transfer
wire-transfer
spei
pse
khipu
io-ar-bank-transfer
aud-bank-transfer
open-banking
euro-open-banking
usd-bank-transfer
paypal
klarna-paynow
Example:method=payid-bank-transfer
blockchainstringrequired

The blockchain for the crypto currency e.g. TRON or ETH.

Example:blockchain=ETH
transactionTypestringrequired

The type of transaction.

Enum:"ONRAMP""OFFRAMP"
Example:transactionType=ONRAMP
fiatAmountnumber, >= 10

Required without cryptoAmount The amount in fiat currency to convert. Amount in fiat minor precision (typically 2 decimals). This locks the fiat amount; the crypto amount will be computed and rounded to the configured crypto scale. Note: due to differing decimal scales and rounding rules, converting fiat→crypto and then crypto→fiat may not return the exact original number.

cryptoAmountnumber, >= 0.01

Required without fiatAmount Amount in crypto precision (token-dependent, e.g., 6–8 decimals). This locks the crypto amount; the fiat amount will be computed and rounded to the fiat scale. Note: small differences vs the reverse path are expected from precision/rounding.

curl -i -X GET \
  'https://docs.banxa.com/_mock/products/native-api/openapi/eapi/v0/quote?identityReference=c-13344&fiat=AUD&crypto=ETH&method=payid-bank-transfer&blockchain=ETH&transactionType=ONRAMP&fiatAmount=10&cryptoAmount=0.01' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Quote response with a unique quoteId and an expiresAt timestamp. The quote is valid for 3 minutes.

Bodyapplication/json
One of:
quoteIdstringrequired

Unique identifier for this quote. Use this when creating a ramp transaction via the Ramps Request payload to lock the quote in.

Example:"6e9174edd370ffe6331aeda7a6d75592"
identityReferencestring, [ 1 .. 255 ] characters(Identity Reference)^[A-Za-z0-9-]+$required

A unique customer identifier provided by the partner. This field is required and must be unique for each customer.

Important: You must consistently reuse the same identityReference for repeat interactions with the same customer, allowing Banxa to reliably recognize and associate their identity across multiple transactions.

Format Requirements:

  • Only ASCII letters (a-z, A-Z), digits (0-9), and hyphens (-) are allowed
  • Must be between 1 and 255 characters
  • Case-sensitive

Best Practices:

  • Use a consistent format across your system
  • Consider using a prefix to identify your organization (e.g., 'partner-customer-123')
  • Do not include personally identifiable information (PII) in the reference
  • Store the mapping between your internal customer ID and this reference securely
Example:"c-13344"
sourceobjectrequired
targetobjectrequired
processingFeestringrequired

The processing fee associated with the quote.

Example:"0.00"
networkFeestringrequired

The network fee (gas fee) associated with the quote.

Example:"0.00"
marketRateobject(Market Rates)required

Current market rates for crypto and forex conversions.

expiresAtstringrequired

The expiry timestamp of the quote. The quote is valid for 3 minutes from creation.

Example:"2026-04-10 04:50:36"
Response
Customer wants to spend exactly 24.50 AUD to buy ETH
{
  "quoteId": "6e9174edd370ffe6331aeda7a6d75592",
  "identityReference": "wesley",
  "source": {
    "fiat": { … },
    "amount": "24.50"
  },
  "target": {
    "crypto": { … },
    "amount": "0.007259"
  },
  "processingFee": "0.00",
  "networkFee": "0.00",
  "marketRate": {
    "crypto": { … },
    "forex": { … }
  },
  "expiresAt": "2026-04-10 04:50:36"
}
© Banxa 2026