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

# List Balances

`GET /v1/balances`

Retrieves the balance of funds that are available for banking accounts.

## Query parameters

- `page_size` integer, required
- `page_number` integer, required

## Headers

- `x-on-behalf-of` string

## Response `200`

OK - Balances returned successfully.

- object
  - `total_pages` integer — The total pages of available items.
  - `total_items` integer — The total counts of available items.
  - `data` BalancesResponse[]
    - `balance_id` string, required — The account balance id.
    - `currency` string, required — Currency of the account balance.
    - `available_balance` string, number, required — Available balance.
    - `prepaid_balance` string, number, required — Prepaid account balance.
    - `margin_balance` string, number, required — Margin balance.
    - `frozen_balance` string, number, required — Frozen balance.
    - `create_time` string, date/time, required — The timestamp when the record was created in the system. Timestamp follows the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) standard.
    - `last_trade_time` string, required — The last trade time at which the object was updated.
    - `balance_status` 'ACTIVE' | 'PENDING' | 'PROCESSING' | 'CLOSED', required — The balance status of the account. - `ACTIVE`: Account balance is operational and available for transactions. - `PENDING`: Account balance is awaiting activation or verification. - `PROCESSING`: Account balance is currently being updated or modified. - `CLOSED`: Account balance has been terminated and is no longer accessible.

---

[API](https://skmtc.dev/uqpay/apis/authentication-api.md) · [All operations](https://skmtc.dev/uqpay/apis/authentication-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/uqpay/authentication-api/revisions/cef532a10777/schema)