Banking accounts

📘

Changes to bank accounts and bank transactions

The Codat data types for bank accounts and bank transactions are going to change. Currently both data types are used for both accounting and banking integrations. In future, these will be separated as follows: accounting packages will use bankAccounts and accountTransactions and banking sources will use banking-accounts and banking-transactions.

Explore the Banking Accounts endpoint in Swagger.

Overview

The Banking Accounts data type provides a list of all the SMB's bank accounts, with rich data like balances, account numbers and institutions holding the accounts.

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

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

Data model

Field

Type

Description

id

string

The unique identifier of the bank account.

accountName

string

The official or formal name of the bank account.

informalName

string

An unofficial or informal name of the bank account.

accountHolder

string

The name of the account holder as returned by the institution.

accountType

string

This is the abstracted type of the account, i.e. "Credit", "Debit", "Unknown".

balance

See Balance

An object containing bank balance data.

accountNumbers

See Bank account numbers

An object containing bank account identification information.

currency

string

The base currency of the bank account.

institution

See Institution

An object containing institution identification information.

date

string
See Date

YYYY-MM-DDT00:00:00Z

modifiedDate

string
See Date

YYYY-MM-DDT00:00:00Z

The update timestamp if available. Date from Codat cache.

Balance

Field

Type

Description

available

number

The funds available to withdraw from the bank account.

current

number

The funds in or owed by the bank account.

limit

number

The credit limit or overdraft limit of the bank account.

Bank account numbers

Field

Type

Description

number

number

The bank account number.

bankCode

string

The BACS code for the bank account, e.g. Sort Code, ABA routing number for UK and US bank accounts respectively.

iban

string

The international bank account number, i.e. IBAN.

bic

string

The bank identifier code, i.e. BIC or SWIFT codes.

Institution

Field

Type

Description

id

string

The unique identifier of the institution.

name

string

The name of the institution.

Example data

{
    "accounts": [
        {
            "id": "cce404db-27f7-4286-95db-622b53596cf4",
            "accountName": "Business Current Account",
            "informalName": "Codat",
            "accountHolder": "Codat Ltd",
            "accountType": "Debit",
            "balance": {
                "available": -305495.34,
                "current": -305495.34,
                "limit": 5000.0
            },
            "accountNumbers": {
                "number": "46762629",
                "bankCode": "009911",
                "iban": "GB29 LOYD 4773 2346 7626 29",
                "bic": "LOYDGB21006"
            },
            "currency": "GBP",
            "institution": {
                "id": "lloyds-bank",
                "name": "Lloyds Bank"
            },
            "sourceModifiedDate": "2020-11-30T08:15:32"
        },
        {
            "id": "da4834b5-796e-4f0e-949d-3f29c93e3947",
            "accountName": "Business Savings Account",
            "informalName": "Codat",
            "accountHolder": "Codat Ltd",
            "accountType": "Debit",
            "balance": {
                "available": 463359.98,
                "current": 463381.83,
                "limit": 0.0
            },
            "accountNumbers": {
                "number": "26883257",
                "bankCode": "009911",
                "iban": "GB29 LOYD 4773 2326 8832 57",
                "bic": "LOYDGB21006"
            },
            "currency": "GBP",
            "institution": {
                "id": "lloyds-bank",
                "name": "Lloyds Bank"
            },
            "sourceModifiedDate": "2021-11-08T21:30:32"
        },
        {
            "id": "2f593774-1075-4805-a552-84eecc7eb264",
            "accountName": "Banking - Business Credit Card",
            "informalName": "Codat",
            "accountHolder": "Codat Ltd",
            "accountType": "Credit",
            "balance": {
                "available": 0,
                "current": 0,
                "limit": 0
            },
            "accountNumbers": {
                "number": "64577589",
                "bankCode": "009911",
                "iban": "GB29 LOYD 4773 2364 5775 89",
                "bic": "LOYDGB21006"
            },
            "currency": "GBP",
            "institution": {
                "id": "lloyds-bank",
                "name": "Lloyds Bank"
            },
            "sourceModifiedDate": "2020-11-16T21:03:32"
        }
    ]
}

Did this page help you?