Balances

Retrieve a list of the client's balances

Retrieve a list of the client's balances, optionally filtered by currency

get/balances

Request

  • Base URL: https://api.ebury.io
  • URL: https://api.ebury.io/balances
  • Auth: API key in header x-api-key

Query parameters

currenciesstring

A comma-separated list of currency codes compliant to ISO 4217

client_idstring required

The ID of the client

balance_typesstring[]

The balance types to be retrieved. Multiple types can be specified by repeating the parameter (e.g., balance_types=InterimAvailable&balance_types=Outgoing).

pageinteger

Page number (1-indexed) for paginated results

page_sizeinteger

Number of items per page (default 50, max 100)

sort_by'currency' | 'InterimAvailable' | 'RequiredFunds' | 'RequiredFundsImmediate' | 'Outgoing' | 'Incoming' | 'InitialMargin' | 'MarginCall' | 'Processing'

Field to sort results by. Use 'currency' to sort alphabetically by currency code, or a balance type name to sort by that balance's amount.

sort_order'asc' | 'desc'

Sort order for results

pinned_currenciesstring

Comma-separated list of currency codes to pin to the top of results

Headers

Authorizationstring required

The access token

X-Contact-IDstring

The ID of the contact

Response

A list with the client's balances.

account_idstring nullable required

The UUID of the account. Null for aggregate balance types (Incoming, Outgoing, RequiredFundsImmediate, Processing) which are calculated across all accounts for a currency.

credit_debit_indicator'Credit' | 'Debit' required

Whether the balance is credit or debit

datetimestring required

The date and time when the balance was calculated.

type'InterimAvailable' | 'RequiredFunds' | 'RequiredFundsImmediate' | 'Outgoing' | 'Incoming' | 'InitialMargin' | 'MarginCall' | 'Processing' required

Balance type enumeration. RequiredFundsImmediate: items due now (same as Ebury Online). RequiredFunds: includes future-dated items (kept for backwards compatibility).

Changes

No recorded changes to this operation across all 1 revision of this API.