Account information

The Accounts API enables you to read and perform operations on your Banking Circle accounts. The Balances endpoint allows you to get the current balance on a specific account. The Bookings endpoint allows you to get details on bookings on a specific account - both money outflows and inflows.

To use the Account API, you send a GET accounts request with a valid token to check if you have permission to access all the accounts you need. Contact your Integration Manager if you are missing account access. After finding out what accounts are associated with which account IDs, you can request account details, balances, and booking per account.

Check available accounts

To get an overview of your available accounts, use the endpoint GET /api/v1/accounts. You can also get a sub-set of your accounts by filtering on parameters such as currency of the account to find a specific account. Leaving all fields blank will return all accounts without any filter.

Below is listed an example of a 200 Success response for one account:

{
  "result": [
    {
      "accountId": "cd6d9d20-18b0-4ee7-b071-742b67ae1234",
      "accountDescription": "Description of the account",
      "accountIdentifiers": [
        {
          "account": "DK1111000000011111",
          "financialInstitution": null,
          "country": null
        }
      ],
      "status": "Active",
      "currency": "EUR",
      "openingDate": "2020-12-06T00:00:00+00:00",
      "closingDate": null,
      "ownedByCompanyId": "2920e27e-b112-4b09-8ae6-c6f4aaacd3c7",
      "ownedByCompanyName": "NAME industries Ltd",
      "protectionType": "None",
      "balances": [
        {
          "type": "CurrentBalance",
          "currency": "EUR",
          "beginOfDayAmount": 19435.5,
          "financialDate": "2021-12-06T00:00:00+00:00",
          "intraDayAmount": 9900.4,
          "lastTransactionTimestamp": null
        }
      ]
    }
  ],
  "pageInfo": {
    "currentPage": 1,
    "pageSize": 50
  }
}

Check account balance

To read the balance of an account, use the endpoint GET api/v1/accounts/{account-id}/balances. You need to specify the ID for the account you wish to read the balance of.

See below an example of how a 200 success response will look like:

{
  "result": [
    {
      "type": "CurrentBalance",
      "currency": "EUR",
      "beginOfDayAmount": 999,
      "financialDate": "2021-12-06T00:00:00+00:00",
      "intraDayAmount": 250,
      "lastTransactionTimestamp": "2021-11-26T00:00:00+00:00"
    }
  ],
  "pageInfo": {
    "currentPage": 1,
    "pageSize": 50
  }
}

Check fees

You can use the fees endpoints to get an overview of your paid and outstanding fees. Use the GET api/v1/fees.

The statuses PendingProcessing and MissingFunding indicate that the fee has not been paid, while Processed means it has been successfully paid. MissingFunding is used when the account does not contain the required funding, while PendingProcessing indicates that the fees are waiting to be processed.

See below an example for a 200 Success response:

{
  "result": [
    {
      "feeId": "4412fac4-99cd-f068-0690-878ec341d760",
      "accountId": "6aad6365-7bef-89c4-9a94-31af8ca6c7e3",
      "account": {
        "account": "DK111100000001001",
        "financialInstitution": null,
        "country": null
      },
      "status": "Processed",
      "description": "Payment Fee",
      "amount": {
        "currency": "EUR",
        "amount": 2053.91
      },
      "instructedDate": "2021-02-27T00:00:00+00:00",
      "dueDate": "2021-03-02T00:00:00+00:00",
      "valueDate": "2021-03-02T00:00:00+00:00"
    }
  ],
  "pageInfo": {
    "currentPage": 1,
    "pageSize": 50
  }
}