Skip to navigation

Preview Quotations

View as Markdown

Stateless pricing preview across every corridor enabled on your account. Converts amount in currency to USD, then returns a quotation for each currency in your account supported_currencies.

Use this instead of decodeQr + getQuotation when you only need a rate. It creates no transaction, so it will not appear in listTransactions and nothing expires against your account. One call covers every corridor you have enabled.

Authentication

  • REQUIRED: Basic Auth Authorization: Basic base64(client_id:client_secret).

Request validation (order)

  • amount (number, required): must be > 0, else 400 INVALID_AMOUNT.

  • currency (string, required): ISO 4217, case-insensitive, else 400 MISSING_REQUIRED_FIELD.

  • 401 AUTHENTICATION_REQUIRED if authentication fails.

  • 429 RATE_LIMIT_EXCEEDED when the per-app rate limit is hit.

  • 400 INVALID_CURRENCY when no exchange rate is available for currency.

Behaviour

  • Target currencies come from your account supported_currencies (falls back to USD when none are configured).

  • A target currency is omitted from the response when it has no available FX rate, or when the converted local amount falls outside that corridor’s min/max limits.

  • Responses are cached briefly; expires_at is always refreshed to 30 minutes from the time of the response.

Response (200 JSON)

  • quotations: array of per-corridor items, each with amount and currency (local), exchange_rate, amount_usd, fee, percentage_fee, fixed_fee, expires_at.

  • Formatting matches the other pricing endpoints: exchange_rate at 10 decimal places, USD fields at 2.

Note: these figures are indicative. Binding pricing for a specific payout still comes from getQuotation on a real transaction.

Authentication

AuthorizationBasic

Basic Auth: base64(client_id:client_secret)

Query parameters

dpintegerOptional0-10Defaults to 2

Decimal places for monetary fields in the response (USD amounts, fees, exchange rates). Default 2, which rounds sub-cent fees to 0. Use dp=4 or higher to reconcile against exact deducted totals: at full precision amount_usd + percentage_fee + fixed_fee equals the amount deducted from your balance. Rounding is applied to the response only; all stored values and balance deductions always use full precision.

Request

This endpoint expects an object.
amountdoubleRequired

Amount in currency, must be greater than 0

currencystringRequired
ISO 4217 code of the input amount, e.g. USD

Response

OK
quotationslist of objectsOptional

Errors

400
Bad Request Error
401
Unauthorized Error
429
Too Many Requests Error