---
title: "List Virtual Accounts"
method: GET
path: "/v1/virtual/accounts"
tags: ["Virtual Accounts"]
---

# List Virtual Accounts

`GET /v1/virtual/accounts`

Get list of virtual accounts.

## Query parameters

- `page_size` integer, required
- `page_number` integer, required
- `currency` string

## Headers

- `x-on-behalf-of` string

## Response `200`

OK - List virtual accounts returned successfully.

- object
  - `total_pages` integer — The total pages of available items.
  - `total_items` integer — The total counts of available items.
  - `data` CurrencyBankDetailResponse[]
    - `account_holder` string, required — Holder of the global account.
    - `account_number` string, number, required — The account_number or Iban number of the global account.
    - `capability` object, required — The deposit receiving capabilities of this bank account.
      - `payment_method` 'SWIFT' | 'LOCAL', required — Payment method in which a deposit can be received. * `SWIFT` * `LOCAL`
    - `country_code` string, required — Two-letter country code [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
    - `currency` string, required — Three-letter ISO currency code, in lowercase. Must be a supported currency.
    - `account_bank_id` string, required — The account bank id.
    - `bank_name` string, required — Name of the account bank.
    - `bank_address` string, required — Address of the account bank.
    - `clearing_system` object, required — The clearing system routing information for this bank account.
      - `type` string, required — The type of clearing system identifier
      - `value` string, required — The clearing system identifier value
    - `status` 'ACTIVE' | 'INACTIVE' | 'CLOSED' | 'PROCESSING' — Status of global account. One of: * `ACTIVE` * `INACTIVE` * `CLOSED` * `PROCESSING`: The account creation request has been accepted, but the account is not yet active and its final banking details may still be processing.
    - `close_reason` string — Global account closure reason.

---

[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)
