Skip to main content
A conversion is one entry through the tenant’s FX position accounts, balanced in each currency on its own.

Before you start

You need AST:FXP:<CCY> in both currencies. Without them a conversion gets FX_POSITION_MISSING. Open them with POST /v1/accounts.

Rates

A manual desk rate is entered in the console and is not usable until a second person signs it off.
mid is units of quote per one base, as a decimal string. A rate older than the tenant’s maximum age blocks conversions with RATE_STALE.

Quote

A quote prices an amount at the live rate less the spread, and holds it for 60 seconds. It needs entries:write or fx:write.
$100.00 at 1492.74875 comes to ₦149,274.87. Quotes are by baseAmount.

Convert

A conversion needs entries:write.
The answer is an entry with kind: FX and fxRateId set. A quote can be used once, and a second try gets QUOTE_USED. After 60 seconds it gets QUOTE_EXPIRED.