Banking account balances

Explore the Banking Account Balances endpoint in Swagger.

View the coverage for banking account balances in the Data Coverage Explorer.

Overview

The Banking Account Balances data type provides a list of balances for a bank account including end-of-day batch balance or running balances per transaction.

🚧

How often should I pull Account Balances?

Because the balances on the banking-accountBalances data type are closing balances, we recommend you pull Account Balances no more frequently than daily. If you require a live intraday balance, this can be found for each account on the banking-bankAccounts data type.

Whilst you can choose to sync hourly, this may incur usage charges from Plaid or TrueLayer.

From the Banking Account Balances endpoint, you can retrieve a list of all bank account balances:
GET /companies/{companyId}/connections/{connectionId}/data/banking-accountBalances

Responses are paged, so you should provide page and pageSize query parameters in your request. See Pagination for details.

Data model

Field

Type

Description

accountId

string

The unique identifier of the account.

balance

See Balance

An object containing bank balance data.

date

string
See Date

Date of the balance.

modifiedDate

string
See Date

Date the balance was last changed in the Codat's cache.

sourceModified

string
See Date

Date the balance was last updated in the underlying open banking provider's data.

Balance

Field

Type

Description

available

decimal

The funds available to withdraw from the bank account.

current

decimal

The funds in or owed by the bank account.

limit

decimal

The credit limit or overdraft limit of the bank account.

Depending on the data provided by the underlying bank, not all balances are always available.
Depending on the data provided by the underlying bank, not all balances are always available.

Example data

{
    "accountBalances": [
        {
            "accountId": "cce404db-27f7-4286-95db-622b53596cf4",
            "balance": {
                "available": 714374.48,
                "current": 714374.57,
                "limit": 5000.0
            },
            "date": "2021-03-18T00:00:00"
        },
        {
            "accountId": "cce404db-27f7-4286-95db-622b53596cf4",
            "balance": {
                "available": 714374.48,
                "current": 714374.57,
                "limit": 5000.0
            },
            "date": "2021-03-19T00:00:00"
        },
        {
            "accountId": "cce404db-27f7-4286-95db-622b53596cf4",
            "balance": {
                "available": 714195.66,
                "current": 714204.39,
                "limit": 5000.0
            },
            "date": "2021-03-22T00:00:00"
        },
        {
            "accountId": "2f593774-1075-4805-a552-84eecc7eb264",
            "balance": {
                "available": -644945.42,
                "current": -644925.84,
                "limit": 0
            },
            "date": "2022-03-09T00:00:00"
        }
    ]
}

Did this page help you?