---
title: "Get Account Balances"
method: GET
path: "/accounts/{accountId}/balances"
tags: ["Financial Data"]
---

# Get Account Balances

`GET /accounts/{accountId}/balances`

## Request

- Base URL: `https://api.yapily.com`
- URL: `https://api.yapily.com/accounts/{accountId}/balances`
- Auth: HTTP basic

Returns the balance for the end user associated with the presented consent token.

Feature: `ACCOUNT_BALANCES`

## Path parameters

- `accountId` string, required

## Headers

- `consent` string, required
- `psu-id` string
- `psu-corporate-id` string
- `psu-ip-address` string
- `sub-application` string, uuid

## Response `200`

Ok

- ApiResponseOfBalances
  - `meta` ResponseMeta
    - `tracingId` string
  - `data` Balances
    - `mainBalanceAmount` Amount: __Mandatory__. Monetary Amount.
      - `amount` number, required: __Mandatory__. The monetary value
      - `currency` string, required: __Mandatory__. The [ISO 4217](https://www.xe.com/iso4217.php) currency code
    - `balances` AccountBalance[]
      - `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' | 'AUTHORISED' | 'OTHER' | 'UNKNOWN': Specifies the type of the stated account balance.
      - `dateTime` string, date-time: Date and time of the reported balance.
      - `balanceAmount` Amount: __Mandatory__. Monetary Amount.
        - `amount` number, required: __Mandatory__. The monetary value
        - `currency` string, required: __Mandatory__. The [ISO 4217](https://www.xe.com/iso4217.php) currency code
      - `creditLineIncluded` boolean: __Optional__. Indicates whether any credit lines are included in the balance.
      - `creditLines` CreditLine[]: __Optional__. Specifies the type of balance.
        - `type` 'AVAILABLE' | 'CREDIT' | 'EMERGENCY' | 'PRE_AGREED' | 'TEMPORARY' | 'OTHER' | 'UNKNOWN': __Mandatory__. The type of credit that has been provided.
        - `creditLineAmount` Amount: __Mandatory__. Monetary Amount.
          - `amount` number, required: __Mandatory__. The monetary value
          - `currency` string, required: __Mandatory__. The [ISO 4217](https://www.xe.com/iso4217.php) currency code
  - `links` object
  - `forwardedData` ResponseForwardedData[]
    - `headers` object
    - `url` string
  - `raw` RawResponse[]
    - `request` RawRequest
      - `method` string
      - `url` string
      - `requestInstant` string, date-time
      - `headers` object
      - `body` object
      - `bodyParameters` object
      - `startTime` string, date-time
      - `startedAt` string, date-time
    - `duration` string, iso8601
    - `headers` object
    - `resultCode` integer
    - `result` object
  - `tracingId` string

## Other responses

- `default`: Error Response

---

[API](https://skmtc.dev/yapily/apis/yapily-api.md) - [All operations](https://skmtc.dev/yapily/apis/yapily-api/llms.txt) - [OpenAPI document](https://skmtc.dev/yapily/apis/yapily-api/revisions/a8ca54f9eb9f?raw)