Reference data

Generated page, from the OpenAPI specification the gateway serves (GET /v1/openapi.json). Do not edit it by hand: it is rewritten on every build.

Method	Path	Description
`GET`	`/v1/assets`	Assets and their decimals
`GET`	`/v1/balances`	Retrieve balances
`GET`	`/v1/corridors`	Corridors open to your account

`GET /v1/assets`

Assets and their decimals

Each asset carries its symbol and its number of decimals, which is what turns a minor unit into a readable amount.

⚠️ Do not hard-code the decimals — read them here. It is the only protection against being out by a factor of a hundred on a real amount.

Responses

200 — OK
401 — API key missing or rejected
403 — The key does not carry the required scope, or the account is not active
429 — The key's request budget is exhausted (300/min) — honour Retry-After

`GET /v1/balances`

Retrieve balances

Available, pending and reserved balance, PER ASSET and per (platform, country).

⚠️ Balances never add up across assets: there is no currency conversion on this platform, so a total across all assets would mean nothing. The reserved amount covers outflows already committed; it is not spendable.

Responses

200 — OK
401 — API key missing or rejected
403 — The key does not carry the required scope, or the account is not active
429 — The key's request budget is exhausted (300/min) — honour Retry-After

`GET /v1/corridors`

Corridors open to your account

The (asset, country, platform, direction) combinations YOUR account may use, in the order routing would pick them, with the identifiers to pass as asset_id and platform_id.

ⓘ Routing is inspectable, not guessable: if a payment is refused for a closed corridor, this list says which one was missing. It does NOT give a price — pricing depends on the client, the amount and the direction.

Responses

200 — OK
401 — API key missing or rejected
403 — The key does not carry the required scope, or the account is not active
429 — The key's request budget is exhausted (300/min) — honour Retry-After