Retrieve a list of the client's balances
Authorizations
An API Key.
Query Parameters
A comma-separated list of currency codes compliant to ISO 4217
The ID of the client
The balance types to be retrieved. Multiple types can be specified by repeating the parameter (e.g., balance_types=InterimAvailable&balance_types=Outgoing).
InterimAvailable, RequiredFunds, RequiredFundsImmediate, Outgoing, Incoming, InitialMargin, MarginCall, Processing Page number (1-indexed) for paginated results
x >= 1Number of items per page (default 50, max 100)
1 <= x <= 100Field to sort results by. Use 'currency' to sort alphabetically by currency code, or a balance type name to sort by that balance's amount.
currency, InterimAvailable, RequiredFunds, RequiredFundsImmediate, Outgoing, Incoming, InitialMargin, MarginCall, Processing Sort order for results
asc, desc Comma-separated list of currency codes to pin to the top of results
Response
A list with the client's balances.
The UUID of the account. Null for aggregate balance types (Incoming, Outgoing, RequiredFundsImmediate, Processing) which are calculated across all accounts for a currency.
Whether the balance is credit or debit
Credit, Debit The date and time when the balance was calculated.
Balance type enumeration. RequiredFundsImmediate: items due now (same as Ebury Online). RequiredFunds: includes future-dated items (kept for backwards compatibility).
InterimAvailable, RequiredFunds, RequiredFundsImmediate, Outgoing, Incoming, InitialMargin, MarginCall, Processing