Balance Models

These models are returned by the get all balances and get an account balances endpoints.

BalanceData

{
  "account_id": "5358dae1-269e-c21e-952b-b8b8d597dcce",
  "amount": {
    "amount": "150.0000",
    "currency": "USD"
  },
  "credit_debit_indicator": "Credit",
  "datetime": "2019-10-24T22:37:22.547",
  "type": "InterimAvailable"
}

This model is a representation of a single balance for an account within Ebury. Fields

string

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

object

Always present. Object of Amount

string

Always present. One of CreditDebitIndicator

string

Always present. Date and time

string

Always present. Type of the balance. One of BalanceType

Amount

{
  "amount": "150.0000",
  "currency": "USD"
}

This model is a representation of a balance/transaction amount. Fields

string

Always present. The balance/transaction amount

string

Always present. The ISO 4217 code of the balance currency

BalanceType

This is an enumeration of the balance types of an account. Values

Value	Description
`InterimAvailable`	Available balance calculated in the course of the account servicer’s business day.
`RequiredFunds`	Funds required on account including future-dated items (kept for backwards compatibility).
`RequiredFundsImmediate`	Funds required on account for items due now (same as Ebury Online).
`Outgoing`	Outgoing funds (pending trades, payments and fees).
`Incoming`	Incoming funds (pending trade credits).
`InitialMargin`	Initial margin/deposit balance.
`MarginCall`	Margin call balance.
`Processing`	Payments currently being processed.

CreditDebitIndicator

Whether the balance/transaction amount is credit or debit. Values

Value	Description
`Debit`	The amount is debit
`Credit`	The amount is credit

​BalanceData

​Amount

​BalanceType

​CreditDebitIndicator

BalanceData

Amount

BalanceType

CreditDebitIndicator