v1

latestOpenAPI 3.0.12026-08-0674476716.0 KB

Accounts

Get account balances

The GET /account-balance endpoint retrieves the balances for multiple bank accounts.

get/account-balance

Query parameters

accountIdstring[]

A list of account ids for which you wish to retrieve account balances. Each accountId should be specified separately as accountId=a:xxx:xxx&accountId=a:yyy:yyy.

Headers

on-behalf-ofstring required

The tokenId represents the consent granted by the user (PSU).

token-customer-ip-addressstring ipv4

The user's IP address if the user is currently logged in with the TPP. If the customer IP address is supplied (recommended), it is inferred that the user is present during the session (<i>i.e.</i>, the request is user-initiated; adding a customer-initiated = true header makes this explicit). For AIS calls, if the customer's IP address is not provided in the request, the bank assumes it is a TPP-initiated request and may limit the TPP to 4 TPP-initiated access attempts within a given 24-hour period.

Response

Successful response

Example response

{
  "response": [
    {
      "balance": {
        "accountId": "a:8DbPteGnytmMbKXdnWTReeRB6cYWKXZ84JgLTBC7fKL4:5zKcENpV4",
        "available": {
          "currency": "EUR",
          "value": "10.23"
        },
        "current": {
          "currency": "EUR",
          "value": "10.23"
        },
        "otherBalances": [
          {
            "amount": {
              "currency": "EUR",
              "value": "10.23"
            },
            "type": "Trial",
            "updatedAtMs": "581458935"
          }
        ]
      },
      "status": "SUCCESSFUL_REQUEST"
    }
  ]
}