Skip to content
COMMITLYCOMMITLYCOMMITLY Developers

List banks with their accounts

GET
/banks/
curl --request GET \
  --url 'https://app.commitly.com/api/banks/?page_size=100' \
  --header 'Authorization: Bearer <token>'

Returns the banks connected to the company, each with its bank accounts. Includes online and offline accounts.

Group level (Enterprise Edition): called with group-level credentials, the response contains the banks of all companies in the group. The tenant field identifies the owner.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
page
integer
>= 1

Page number, starting at 1. When paging through results, read this value from the next link and send it to the documented base URL.

page_size
integer
default: 100 >= 1 <= 1000

Number of records per page. Default 100, maximum 1000; larger values are reduced to 1000.

Responses

Section titled “Responses”

200

Section titled “200”

Paginated list of banks.

Media typeapplication/json
object
count
required

Total number of matching records.

integer
next
required

URL of the next page, or null on the last page. The host name may differ from the documented base URL; read page from it and call the documented base URL.

string | null format: uri
previous
required

URL of the previous page, or null on the first page.

string | null format: uri
results
Array<object>
object
id
integer
accounts
Array<object>
object
id
integer
bank

Bank data embedded in an account.

object
open_banking_connection_id
integer | null
name
string
bic
string
transaction_count
integer
last_transaction

Present in GET /accounts/ only.

object
id
integer
account

Short form of a bank account, embedded in transactions.

object
id
integer
name
string
alias
string
bank

Bank name. Present in the create-transactions response only.

string
currency

Present in the create-transactions response only.

string
value_date
string format: date-time
amount
number
purpose
string
counterpart_name
string
currency

ISO 4217 currency code.

string
date_created
string format: date-time
date_updated
string format: date-time
name
string
alias
string
iban
string
type_name

Account type as supplied by the bank provider (free text, e.g. Checking). Empty for offline accounts.

string
balance
number
overdraft_limit
number | null
status

Account status. Only offline accounts accept transactions via POST /accounts/{account_id}/transactions/; accounts with status API or DISCONNECTED, and accounts linked to a bank connection, do not.

string
Allowed values: UPDATED UPDATED_FIXED DOWNLOAD_IN_PROGRESS DOWNLOAD_FAILED DEPRECATED DISCONNECTED API OFFLINE
last_successful_update
string | null format: date-time
last_update_attempt
string | null format: date-time
banking_api_account
integer | null
date_created
string format: date-time
date_updated
string format: date-time
open_banking_connection_id
integer | null
name
string
bic
string
tenant
integer
Example
{
  "count": 2,
  "next": null,
  "previous": null,
  "results": [
    {
      "id": 3001,
      "accounts": [
        {
          "id": 4001,
          "bank": {
            "open_banking_connection_id": null,
            "name": "Offline Bank",
            "bic": ""
          },
          "transaction_count": 1988,
          "currency": "EUR",
          "date_created": "2021-01-21T08:54:20.387933Z",
          "date_updated": "2021-03-03T16:32:25.553579Z",
          "name": "Cash account",
          "alias": "",
          "iban": "",
          "type_name": "",
          "balance": 12745,
          "overdraft_limit": null,
          "status": "OFFLINE",
          "last_successful_update": null,
          "last_update_attempt": null,
          "banking_api_account": null
        }
      ],
      "date_created": "2021-01-21T08:54:20.380347Z",
      "date_updated": "2021-03-03T16:32:25.558301Z",
      "open_banking_connection_id": null,
      "name": "Offline Bank",
      "bic": "",
      "tenant": 19
    },
    {
      "id": 3002,
      "accounts": [
        {
          "id": 4002,
          "bank": {
            "open_banking_connection_id": 5001,
            "name": "Example Bank",
            "bic": "EXAMPLEXXXX"
          },
          "transaction_count": 1082,
          "currency": "EUR",
          "date_created": "2022-05-05T13:10:13.354781Z",
          "date_updated": "2024-01-11T10:51:33.342193Z",
          "name": "Checking account",
          "alias": "Main",
          "iban": "DE89370400440532013000",
          "type_name": "Checking",
          "balance": 60360.68,
          "overdraft_limit": 0,
          "status": "UPDATED",
          "last_successful_update": "2024-01-11T10:50:47Z",
          "last_update_attempt": "2024-01-11T10:50:46Z",
          "banking_api_account": 6001
        }
      ],
      "date_created": "2022-05-05T13:10:13.300000Z",
      "date_updated": "2022-05-05T13:10:13.300000Z",
      "open_banking_connection_id": 5001,
      "name": "Example Bank",
      "bic": "EXAMPLEXXXX",
      "tenant": 19
    }
  ]
}

401

Section titled “401”

The access token is invalid or has expired. Request a new token. The message is localized (see Accept-Language).

Media typeapplication/json
object
detail
required

Error message.

string
code

Present only if the company’s edition does not include the function; value billing_plan_permission_denied.

string
Example
{
  "detail": "Invalid token."
}

Headers

Section titled “Headers”
WWW-Authenticate
string

Authentication scheme, Bearer.

Example
Bearer

403

Section titled “403”

No access token was sent, or the credentials are not allowed to call this endpoint. If the company’s COMMITLY edition does not include the requested function, the body additionally contains "code": "billing_plan_permission_denied".

Media typeapplication/json
object
detail
required

Error message.

string
code

Present only if the company’s edition does not include the function; value billing_plan_permission_denied.

string
Example
{
  "detail": "User must be authenticated to access this resource."
}