Skip to main content
POST
Convert between two wallets of the calling business

Authorizations

authorization
string
header
required

Body

application/json
from_currency
enum<string>
required

Currency to convert from

Available options:
usd,
ngn,
ghs,
eur,
gbp,
kes,
zar,
ugx,
tzs,
xof,
rwf,
zmw,
xaf,
gmd,
lrd,
mwk,
etb,
egp,
sle,
usdt,
usdc,
btc,
eth,
sol,
trx,
local_currency
Example:

"usd"

to_currency
enum<string>
required

Currency to convert to

Available options:
usd,
ngn,
ghs,
eur,
gbp,
kes,
zar,
ugx,
tzs,
xof,
rwf,
zmw,
xaf,
gmd,
lrd,
mwk,
etb,
egp,
sle,
usdt,
usdc,
btc,
eth,
sol,
trx,
local_currency
Example:

"ngn"

from_amount
number
required

Amount of from_currency to convert (the principal)

Required range: x >= 1e-8
Example:

100

reference
string
required

Your idempotency key. Repeating a request with the same reference never converts twice and returns the original result.

Example:

"conv-123"

expected_to_amount
number

What the other side of this conversion received. Only a sanity check: nothing is converted if our own base amount differs from it by more than the allowed band.

Response

201