Quote a currency conversion
Prices a conversion for a payment to an international-fx account denominated in a currency other than USD, and returns a short-lived quoteToken that locks the rate.
Pass the token as fxQuoteToken on POST /payments to be charged exactly what was quoted. The token is optional — omit it and the payment is priced again at creation time, at whatever rate then applies.
Fees are priced separately by POST /tools/fee-calculator; the two are independent and can be called in either order.
Authorizations
Headers
Entity the request operates on — an entity id (ent_<uuid>) or me (the partner's sole entity).
Body
Only accounts that actually convert currency can be quoted: an international-fx account denominated in something other than USD. Anything else — a domestic account, a USD-denominated international account, or international-gusd, which is dollar-denominated — is rejected with 400.
External receiving account id (acct_), the credit account
Minor units of currency — the amount the counterparty would receive.
Must match the receiving account's currency. Optional, but sending it turns a wrong assumption into a 400 instead of a quote in an unexpected currency.
^[A-Za-z]{3}$Why the money is being sent. Passed to the currency provider when the quote is minted, so send the same value you will send as compliance.purpose on the payment.
Response
The priced conversion and the token that locks it.
A priced currency conversion. foreignAmount is what the counterparty receives and amount is what the entity is debited, both in minor units of their own currency and both excluding fees.
ISO 4217 code of the currency delivered
Minor units of currency delivered to the counterparty
Minor units of USD debited from the entity, before fees
The applied rate: units of currency per USD
Opaque, short-lived token locking this rate. Pass it as fxQuoteToken on POST /payments, for a payment of this amount in this currency — the token is checked against both, so it cannot be spent on a payment it was not quoted for. Treat it as opaque; its format is not part of this contract.
The mid-market reference rate, for comparison
When the token stops being accepted. After this, quote again.