Accounts

Get an account balance

The GET /accounts/{accountId}/balance endpoint retrieves the balance for a given bank account.

get/accounts/{accountId}/balance

Request

  • Base URL
    https://api.token.io
  • URL
    https://api.token.io/accounts/{accountId}/balance
  • Auth
    • HTTP bearer
    • or API key in header Authorization

Path parameters

accountIdstring

The unique bank account id, which specifies the account for which the information is requested.

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

status'INVALID_REQUEST' | 'SUCCESSFUL_REQUEST' | 'MORE_SIGNATURES_NEEDED'

Specifies the status of the request.

Example 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"
}

Changes

No recorded changes to this operation across all 5 revisions of this API.