ExchangeBalances

Get balances

Returns all balances held by the authenticated client, one per provisioned currency. Always returns an entry for every provisioned currency including zero balances.

Authentication

AuthorizationBearer
Token obtained via the login flow.

Query parameters

currencylist of stringsOptional

Filter to one or more currencies (ISO 4217). Repeatable — e.g. ?currency=USD&currency=NGN.

limitintegerOptional1-200Defaults to 20
Maximum number of results to return. Default 20, max 200.
cursorstringOptional

Opaque cursor from nextCursor of a previous response.

Response

Client balances.
balanceslist of objects
nextCursorstring or null

Opaque cursor for the next page. null when the list is exhausted.

hasMoreboolean

Convenience flag. false when nextCursor is null.

Errors

401
Unauthorized Error