Balances

Get a balance for a single account

Retrieve all balances for a single account by account ID

get/accounts/{account_id}/balances

Request

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

Path parameters

account_idstring required

The UUID of the account

Query parameters

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).

Headers

Authorizationstring required

The access token

X-Contact-IDstring

The ID of the contact

Response

Returns the requested balance

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.