XSxs2a
XS2A.api.accounts

Retrieve the balance for a specific bank account

Changed on
get/api/accounts/{bank-account-id}/balance

Request

Path parameters

bank-account-idstring required

The bank-account-id for the account for which the balance is to be checked.

Response

Request successfully processed

idstring

Bank Account ID

availablenumber float nullable

The available amount. This can be null, if the available amount is not known.

limitnumber float nullable

The limit of the account. This can be null, if the limit is not known.

balancenumber float nullable

The current account balance.

currency_id'EUR' | 'CHF'

The id of the currency to be used.

datestring

The date the balance was seen on.

created_atstring

Date of creation

objectstring

The value bank_account

Example response

{
  "id": "bac_c8KYwjexO2iO5AE9",
  "available": 3123.99,
  "limit": 1000.99,
  "balance": 2123.99,
  "currency_id": "EUR",
  "date": "2017-12-06T00:00:00Z",
  "created_at": "2018-03-16 11:14:58",
  "object": "bank_account"
}

Changes