Quote a settlement conversion

Prices a settlement: what a payer must send in their own currency for you to be credited a given amount in yours, and at what rate.

No ability is required, and the same notes as the wallets operation apply: any valid key of your account reaches it, 403 insufficient_scope cannot occur, and the only 403 you can meet is ORIGIN_NOT_ALLOWED. A key is still required — an anonymous request is refused with 401 missing_api_key.

This is not the same operation as POST /v1/conversions/rate. A quote is asymmetric and priced: source is the payer's local currency and can never be USD, and sell_rate already carries your account's FX fee. A rate is symmetric and free of both fee and spread. Quoting a payer from the rate operation understates what they must send.

destination_amount is the figure before your account's payin fee, and the quote is blind to customer_paid_fee. See ConversionQuote for what that means in practice and for why the three figures do not round-trip.

amount_type takes its default by omission. To use receive, leave the field out rather than sending it empty.

Refusals past the shared ones: 422 VALIDATION_FAILED, 422 INVALID_CURRENCY and 500 CONVERSION_QUOTE_ERROR. INVALID_CURRENCY means the source currency cannot be priced; its errors.error is a bare string, not an array. This operation cannot return SYSTEM_DATABASE_ERROR.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
number
required
≥ 1
string
enum
required

The payer's currency. These five are the ones verified to price end to end.

PEN is left out on purpose, not by oversight. The validator accepts it and this operation cannot serve it: every PEN quote passes validation and then fails with 422 INVALID_CURRENCY, naming the currency. Use POST /v1/conversions/rate if all you need is a PEN conversion.

Any other code the validator accepts is unverified on this operation. Its failure mode is not documented here and no status is promised for it — do not build on one.

USD is never a valid source here — this operation prices a settlement, and POST /v1/conversions/rate is what converts between two currencies without one.

Allowed:
string
required
length between 3 and 3

The currency you want to be credited in — in practice, your wallet's currency. Any three-character code is accepted by the request, so send one you actually hold a wallet in.

string
enum
Defaults to receive

With receive, amount is what you want to receive in destination; with charge, it is what the payer is charged in source. To take the default, omit the field rather than sending it empty.

Allowed:
Responses

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json