---
title: "Get Balances"
method: GET
path: "/balances"
tags: ["Balances"]
---

# Get Balances

`GET /balances`

Enables an AISP to retrieve balance information for account(s) that the PSU has consented to.

## Headers

- `x-fapi-auth-date` string
- `x-fapi-customer-ip-address` string
- `x-fapi-interaction-id` string
- `Authorization` string, required
- `x-customer-user-agent` string
- `x-client-id` string

## Response `200`

Balances Read

- OBReadBalance1
  - `Data` object, required
    - `Balance` object[], required
      - `AccountId` string, required — A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.
      - `CreditDebitIndicator` 'Credit' | 'Debit', required — Indicates whether the balance is a credit or a debit balance. Usage: A zero balance is considered to be a credit balance. <br /> For a full list of enumeration values refer to `OBInternalCreditDebitCode` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
      - `Type` 'CLAV' | 'CLBD' | 'FWAV' | 'INFO' | 'ITAV' | 'ITBD' | 'OPAV' | 'OPBD' | 'PRCD' | 'XPCD', required — Balance type, in a coded form. <br /> For a full list of enumeration values refer to `ExternalBalanceType1Code` in *ISO_External_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets).
      - `DateTime` string, date-time, required — Indicates the date (and time) of the balance. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
      - `Amount` object, required — Amount of money of the cash balance.
        - `Amount` string, required — A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
        - `Currency` string, required — A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
        - `SubType` 'BCUR' | 'LCUR' — Balance sub type, in a coded form. Default if not specified is BCUR of the account
      - `CreditLine` object[]
        - `Included` boolean, required — Indicates whether or not the credit line is included in the balance of the account. Usage: If not present, credit line is not included in the balance amount of the account.
        - `Type` 'Available' | 'Credit' | 'Emergency' | 'Pre-Agreed' | 'Temporary' — Limit type, in a coded form. <br /> For a full list of enumeration values refer to `OBInternalLimitType1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
        - `Amount` object — Amount of money of the credit line.
          - `Amount` string, required — A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
          - `Currency` string, required — A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
      - `LocalAmount` object — Optional component providing the equivalent of Amount in local currency. Default is Local Currency (LCUR) if not specified
        - `Amount` string, required — A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
        - `Currency` string, required — A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
        - `SubType` 'BCUR' | 'LCUR' — Balance sub type, in a coded form. Default if not specified is LCUR of the account
    - `TotalValue` object — Combined sum of all Amounts in the accounts base currency
      - `Amount` string, required — A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
      - `Currency` string, required — A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
  - `Links` Links — Links relevant to the payload
    - `Self` string, uri, required
    - `First` string, uri
    - `Prev` string, uri
    - `Next` string, uri
    - `Last` string, uri
  - `Meta` Meta — Meta Data relevant to the payload
    - `TotalPages` integer
    - `FirstAvailableDateTime` string, date-time — All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
    - `LastAvailableDateTime` string, date-time — All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

## Other responses

- `400` — Bad request
- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not found
- `405` — Method Not Allowed
- `406` — Not Acceptable
- `429` — Too Many Requests
- `500` — Internal Server Error

---

[API](https://skmtc.net/openbankinguk/apis/account-and-transaction-api-specification.md) · [All operations](https://skmtc.net/openbankinguk/apis/account-and-transaction-api-specification/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/openbankinguk/account-and-transaction-api-specification/revisions/b1c449c8ecb0/schema)