Banking accounts

An account where payments are made or received, and bank transactions are recorded

Explore the Banking Accounts endpoints in Swagger.

View the coverage for banking accounts in the Data Coverage Explorer.

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 ID of the account from the provider.

name

string

The name of the account according to the provider.

informalName

string

The friendly name of the account, chosen by the holder. This may not have been set by the account holder and therefore is not always available.

holder

string

The name of the person or company who holds the account.

type

string

The type of transactions and balances on the account.
For Credit accounts, positive balances are liabilities and positive transactions reduce liabilities.
For Debit accounts, positive balances are assets and positive transactions increase assets.

balance

See Balance

An object containing bank balance data.

identifiers

See Identifiers

An object containing bank account identification information.

currency

string
See Currency

The currency code for the account.

institution

See Institution

The bank or other financial institution providing the account.

modifiedDate

string
See Date

YYYY-MM-DDT00:00:00Z

The date the record was last updated in Codat's cache.

sourceModifiedDate

string
See Date

YYYY-MM-DDT00:00:00

The date the record was last changed in the originating system.

Balance

FieldTypeDescription
availablenumberThe balance available in the account, including any pending transactions. This doesn't include additional funds available from any overdrafts.
currentnumberThe balance of the account only including cleared transactions.
limitnumberThe minimum allowed balance for the account. For example, a $100 overdraft would show as a limit of -100.

Identifiers

Field

Type

Description

type

string

Type of account, either:
_ Account

_ Card

_ Credit

_ Depository

_ Investment

_ Loan

* Other

subtype

string

Detailed account category

number

number

The account number for the account. When combined with the bankCode, this is usually enough to uniquely identify an account within a jurisdiction.

bankCode

string

The local (usually national) routing number for the account.

This is known by different names in different countries:
_ BSB code (Australia)
_ routing number (Canada, USA)
* sort code (UK)

iban

string

The international bank account number (IBAN) for the account, if known.

bic

string

The ISO 9362 code (commonly called SWIFT code, SWIFT-BIC or BIC) for the account.

maskedAccountNumber

string

A portion of the actual account number to help account identification where number is tokenised (Plaid only)

Institution

FieldTypeDescription
idstringThe institution's ID, according to the provider.
namestringThe institution's name, according to the underlying provider.

Example data

{
  "results": [
    {
      "id": "1703194f-7805-4da8-bac0-2ba5da4a4216",
      "name": "Business Current Account",
      "informalName": "Codat",
      "holder": "Codat Ltd",
      "type": "Debit",
      "balance": {
        "available": -459987.97,
        "current": -459964.9,
        "limit": 5000
      },
      "identifiers": {
        "type": "Depository",
        "subtype": "checking",
        "number": "46762629",
        "bankCode": "009911",
        "iban": "GB29 LOYD 4773 2346 7626 29",
        "bic": "LOYDGB21006",
        "maskedAccountNumber": "LOYDGB21006"
      },
      "currency": "GBP",
      "institution": {
        "id": "lloyds-bank",
        "name": "Lloyds Bank"
      },
      "modifiedDate": "2022-05-23T16:32:50Z",
      "sourceModifiedDate": "2021-08-14T05:04:12"
    }
  ]

Read next