---
title: "Get Balances"
method: GET
path: "/data/v2/accounts/{account_id}/balances"
tags: ["Balance Raw Data"]
---

# Get Balances

`GET /data/v2/accounts/{account_id}/balances`

The `Get Balances` endpoint retrieves a list of balances associated with a specific bank account that has been linked by a user via LinkSDK, identified by both the `entity_id` and the `account_id`.The `account_id` can be found by making a call to the /accounts endpoint.Each balance object contains fields such as `balance type` (e.g., CLOSING_AVAILABLE, INTERIM_BOOKED, etc.), `amount`, `currency`, `credit/debit indicator`, and *optional* `credit_line` details that indicate available or agreed credit facilities tied to the account.Balance types can vary based on the bank and the nature of the account, and multiple types of balances may be available for the same account at the same time.**Requires an active entity with the `balances` permission to use.** **A step by step guide** [here](https://docs.leantech.me/docs/lean-open-finance-data-integration-guide).

## Path parameters

- `account_id` string, uuid, required

## Query parameters

- `async` boolean
- `page` integer
- `size` integer
- `entity_id` string, uuid
- `meta` string

## Response `200`

OK

- FetchBalancesV2Result
  - `status` 'OK' | 'PENDING' | 'FAILED' | 'CONSENT_EXPIRED' | 'RECONNECT_REQUIRED' | 'PROCESSING_STARTED', required — The status of the request
  - `results_id` string, uuid, required — The unique identifier for the request
  - `message` string, required — A message describing the status of the request
  - `meta` object, nullable — Meta information about the request
  - `timestamp` string, date-time, required — The datetime of when the request was made
  - `status_detail` StatusDetail, nullable
    - `granular_status_code` string, nullable — Granular status code
    - `status_additional_info` string, nullable — Additional information about the status
  - `refreshed_at` string, date-time, nullable — The datetime of when the data was refreshed
  - `type` string, nullable — The endpoint the original request was made to.
  - `data` BalancesData
    - `type` string, required — The endpoint the original request was made to.
    - `balances` Balance[], required — An array of balances associated with the account.
      - `entity_id` string, uuid — The unique identifier for the entity. Provided as a UUID.
      - `account_id` string, uuid — The account_id this balance is related to.
      - `credit_debit_indicator` 'CREDIT' | 'DEBIT' | 'UNSUPPORTED' — Indicates whether the balance is a credit or debit balance
      - `type` 'CLOSING_AVAILABLE' | 'CLOSING_BOOKED' | 'CLOSING_CLEARED' | 'EXPECTED' | 'FORWARD_AVAILABLE' | 'INFORMATION' | 'INTERIM_AVAILABLE' | 'INTERIM_BOOKED' | 'INTERIM_CLEARED' | 'OPENING_AVAILABLE' | 'OPENING_BOOKED' | 'OPENING_CLEARED' | 'PREVIOUSLY_CLOSED_BOOKED' | 'UNSUPPORTED' — The type of balance for the account. Note: Banks support different types for presenting account balance.
      - `amount` CurrencyAmount, required
        - `currency` string, required — The ISO 3 letter currency code
        - `amount` number, required — The amount of money in the currency specified.
      - `date_time` string, date-time, nullable — The date and time that this balance object was checked.
      - `credit_line` CreditLine[] — Represents the credit limits associated with the account. Each object defines a specific credit facility and its assigned limit
        - `included` boolean — Indicates whether or not a credit line is included in the balance of the account. Usage: If false, credit line is not included in the balance amount of the account
        - `amount` CurrencyAmount
          - `currency` string, required — The ISO 3 letter currency code
          - `amount` number, required — The amount of money in the currency specified.
        - `type` 'AVAILABLE' | 'CREDIT' | 'EMERGENCY' | 'PRE_AGREED' | 'TEMPORARY' | 'UNSUPPORTED' — The type of credit line
    - `page` PageMetadata, required — Metadata about the current page of results
      - `number` integer, required — The current page being returned by the API
      - `size` integer, required — The page size requested
      - `total_elements` integer, required — The total number of elements in all pages
      - `total_pages` integer, required — The total number of pages retrievable
      - `sort` string[] — Sort parameters applied to the results

## Other responses

- `202` — Accepted (Asynchronous request)
- `400` — Bad Request
- `404` — Account or entity not found
- `500` — Internal Server Error

---

[API](https://skmtc.net/leantech/apis/auth.md) · [All operations](https://skmtc.net/leantech/apis/auth/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/leantech/auth/revisions/c2e46d54d886/schema)