---
api: 'Open Banking API'
---

# Retrieve an account balance

Get the balance of an account.

See also [Tutorials: Get account and transaction information](/docs/guides/build-banking-apps/tutorials/get-account-and-transaction-information).

## Endpoint

GET `/accounts/{AccountId}/balances`

## Parameters

### header parameters

- `x-fapi-financial-id` (string, required)
  The unique ID of the [ASPSP](/docs/guides/build-banking-apps/glossary) that the request is issued to.
  The ID of Revolut is `001580000103UAvAAM`.

- `x-fapi-customer-last-logged-time` (string, optional)
  The date and time when the [PSU](/docs/guides/build-banking-apps/glossary) last logged in with the [TPP](/docs/guides/build-banking-apps/glossary).
  
  All dates in the HTTP headers are represented as [RFC 7231](https://datatracker.ietf.org/doc/html/rfc7231#section-7.1.1.1) Full Dates.
  For example: <nobr>`Sun, 10 Sep 2017 19:43:31 UTC`</nobr>.

- `x-fapi-customer-ip-address` (string, optional)
  The IP address of the [PSU](/docs/guides/build-banking-apps/glossary) if the PSU is logged in with the [TPP](/docs/guides/build-banking-apps/glossary).

- `x-fapi-interaction-id` (string, optional)
  An [RFC4122](https://datatracker.ietf.org/doc/html/rfc4122) UUID used as a correlation ID.

- `Authorization` (string, required)
  The access token that you've generated.
  For more information, see [Generate an access token](/docs/guides/build-banking-apps/get-started/get-access-token).

- `x-customer-user-agent` (string, optional)
  The user agent that the [PSU](/docs/guides/build-banking-apps/glossary) is using.

### path parameters

- `AccountId` (string, required)
  The ID of the account.

## Returns

### 200

Balances Read

#### Response attributes

- `Data` (object)
    The balance details.
  - `Data.Balance` (array of object)
      A list of elements to define the balance details.
    - `Data.Balance[].AccountId` (string)
        The unique and immutable ID to identify the account resource.
        This ID has no meaning to the account owner.
    - `Data.Balance[].CreditDebitIndicator` (enum)
        Indicates whether the balance is a credit or a debit balance.
        
        :::note
        A zero balance is considered a credit balance.
        :::
        Possible enum values:

        - `Credit`
        - `Debit`
    - `Data.Balance[].Type` (enum)
        The balance type.
        Possible enum values:

        - `InterimAvailable`
        - `InterimBooked`
        - `ClosingAvailable`
        - `ClosingBooked`
        - `ClosingCleared`
        - `Expected`
        - `ForwardAvailable`
        - `Information`
        - `InterimAvailable`
        - `InterimBooked`
        - `InterimCleared`
        - `OpeningAvailable`
        - `OpeningBooked`
        - `OpeningCleared`
        - `PreviouslyClosedBooked`
    - `Data.Balance[].DateTime` (string)
        The date and time for the balance.
        
        All dates in the JSON payloads are represented in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time format.
        All date-time fields in responses must include the timezone.
        
        For example: `2017-04-05T10:43:07+00:00`.
    - `Data.Balance[].Amount` (object)
        The amount of the cash balance after a transaction entry is applied to the account.
      - `Data.Balance[].Amount.Amount` (string)
          The amount of money where the unit of currency is explicit and compliant with [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).
      - `Data.Balance[].Amount.Currency` (string)
          [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code in upper case.
    - `Data.Balance[].CreditLine` (array of object, optional)
        A list of elements to provide details on the credit line.
      - `Data.Balance[].CreditLine[].Included` (boolean)
          Indicates whether the credit line is included in the balance of the account.
          
          :::note
          If set to `false`, credit line is not included in the account balance.
          :::
      - `Data.Balance[].CreditLine[].Type` (enum, optional)
          The limit type.
          Possible enum values:

          - `Available`
      - `Data.Balance[].CreditLine[].Amount` (object, optional)
          The amount of the cash balance after a transaction entry is applied to the account.
        - `Data.Balance[].CreditLine[].Amount.Amount` (string)
            The amount of money where the unit of currency is explicit and compliant with [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).
        - `Data.Balance[].CreditLine[].Amount.Currency` (string)
            [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code in upper case.
- `Links` (object)
    Links relevant to the payload.
  - `Links.Self` (string)
      The absolute URI to the resource.
  - `Links.Next` (string, optional)
      The absolute URI to the next pagination resource.
  - `Links.Prev` (string, optional)
      The absolute URI to the previous pagination resource.
- `Meta` (object)
    Meta data relevant to the payload.
  - `Meta.TotalPages` (integer, optional)
      Used for pagination. Indicates how many pages of results are available.

## Error responses

| HTTP status code | Description |
| --- | --- |
| 400 | Bad request |
| 401 | Unauthorized  Returned, for instance, when the access token has expired or is invalid, for example, when the consent has been revoked, or when the consent lacks necessary permissions. |
| 403 | Forbidden |
| 405 | Method Not Allowed |
| 406 | Not Acceptable |
| 429 | Too Many Requests |
| 500 | Internal Server Error |
