> ## Documentation Index > Fetch the complete documentation index at: https://developers.uqpay.com/llms.txt > Use this file to discover all available pages before exploring further. # List Virtual Accounts > Get list of virtual accounts. ## OpenAPI ````yaml /global-account/v1.6/banking.yaml get /v1/virtual/accounts openapi: 3.0.2 info: title: Banking API version: 0.0.1 description: > UQPAY Banking API provides comprehensive banking and payment solutions for global money movement. ## Key Features - International payments and transfers - Multi-currency account management - Real-time currency conversion - Virtual account services - Fund deposit and withdrawal ## Authentication Use API keys to authenticate your client requests when utilizing UQPAY APIs. API keys are unique data strings used to authenticate users and enable access to privileged operations. Your API key should be kept confidential and secure at all times. ## Service Components - **Payout**: Create and manage international fund transfers to beneficiaries - **Payer**: Manage entities making payments and authorizing fund transfers - **Beneficiary**: Handle recipient information and bank details - **Balance**: View and manage multi-currency account balances - **Deposit**: Process incoming fund transfers - **Virtual Accounts**: Utilize local bank accounts in foreign currencies - **Conversion**: Execute currency exchange at competitive rates ## Getting Started 1. Obtain API credentials 2. Set up test environment using sandbox URL 3. Implement authentication 4. Start with basic operations ## Support For technical support and integration assistance, contact UQPAY support team. contact: name: UQPAY Support url: https://www.uqpay.com/support email: banking.tech@uqpay.com license: name: Proprietary url: https://www.uqpay.com/legal/api-terms termsOfService: https://www.uqpay.com/legal/terms x-api-id: banking-api-v1.6.0 x-logo: url: https://uqpay.com/img/UQPAY_LogoAnimv2.gif backgroundColor: '#FFFFFF' altText: UQPAY Logo x-categories: - Banking - Payment Processing - Foreign Exchange servers: - url: https://api-sandbox.uqpaytech.com/api description: Sandbox base URL. - url: https://api.uqpay.com/api description: Production base URL. security: [] tags: - name: Balances description: >- View and manage available funds across different currencies in your account. - name: Transfers description: >- A wallet transfer resource is used for sending funds directly from your UQPAY account to a connected account. - name: Deposits description: >- Deposits are bank transfers made into your UQPAY Global Accounts for adding funds or collecting funds from third parties. - name: Virtual Accounts description: >- Virtual Accounts function as local bank accounts in foreign currencies. They enable worldwide fund collection with account details that allow you to receive funds from various platforms. Virtual Accounts can also be used to top up your UQPAY balance. - name: Payout description: >- A Payout resource is created when you send funds to a beneficiary. It details the beneficiary, bank details, the amount being paid, its status, and other relevant information. You can create the payout using either direct beneficiary details or a previously created beneficiary ID. - name: Payers description: >- The payer is the party making the payout and authorizing the transfer of funds from their account to the beneficiary's account. - name: Beneficiaries description: >- The beneficiary is the recipient of the funds and is typically the party who will ultimately benefit from the payout. - name: Conversion description: Manage currency conversions and exchange rates for your transactions. - name: Exchange Rates description: >- Retrieve real-time exchange rates for a specified currency pair or all available pairs. - name: Global Accounts description: >- ⚠️ WARNING This API version is deprecated. Eventually, a deprecated API version becomes unsupported. Global Accounts are foreign currency accounts that function as local bank accounts. - name: Simulator description: Simulate deposit transactions on the sandbox environment. paths: /v1/virtual/accounts: get: tags: - Virtual Accounts summary: List Virtual Accounts description: Get list of virtual accounts. operationId: list-virtual-accounts parameters: - $ref: '#/components/parameters/XOnBehalfOf' - $ref: '#/components/parameters/PageSize' - $ref: '#/components/parameters/PageNumber' - name: currency description: >- Specifies the currency or currencies for the Virtual Account (VA), determining which funds it can receive. Multiple currencies should be separated by commas. Currency codes follow the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#List_of_ISO_4217_currency_codes) standard. in: query schema: type: string example: USD,SGD responses: '200': description: OK - List virtual accounts returned successfully. headers: x-response-id: $ref: '#/components/headers/XResponseId' content: application/json: schema: title: listVirtualAccountsResponse properties: total_pages: $ref: '#/components/schemas/TotalPages' total_items: $ref: '#/components/schemas/TotalItems' data: type: array items: $ref: '#/components/schemas/CurrencyBankDetailResponse' type: object security: - XAuthToken: [] components: parameters: XOnBehalfOf: in: header name: x-on-behalf-of schema: type: string required: false description: > Specifies the sub-account on whose behalf the request is made. This should be set to the `account_id`, which can be retrieved via the [List Connected Accounts](/account-center/v1.6/api-reference/list-connected-accounts-1). If omitted or empty, the request is executed using the master account. More information at [Connected Accounts](/account-center/v1.6/guide/connected-accounts). example: 18523f72-f4de-4f9c-bb8e-ec7d1c4f32be PageSize: name: page_size description: >- The maximum number of items to return per page. Must be between **10 and 100**, inclusive. in: query required: true schema: type: integer minimum: 1 maximum: 100 example: 10 PageNumber: name: page_number description: >- The page number to retrieve a specific set of items. Must be **1 or greater**. in: query required: true schema: type: integer minimum: 1 example: 1 headers: XResponseId: description: >- Universally unique identifier (UUID v4) for the response. Helpful for identifying a request when communicating with UQPAY support. schema: type: string format: uuid example: 2adba88e-9d63-44bc-b975-9b6ae3440dde schemas: TotalPages: type: integer example: 10 description: The total number of pages of available items. TotalItems: type: integer example: 105 description: The total counts of available items. CurrencyBankDetailResponse: type: object required: - account_holder - account_number - capability - country_code - currency - account_bank_id - bank_name - bank_address - routing_codes properties: account_holder: type: string description: Holder of the global account. example: John Doe account_number: type: string format: number description: The account_number or Iban number of the global account. example: '12345678' capability: type: object description: The deposit receiving capabilities of this bank account. required: - payment_method properties: payment_method: type: string enum: - SWIFT - LOCAL example: SWIFT description: | Payment method in which a deposit can be received. * `SWIFT` * `LOCAL` country_code: $ref: '#/components/schemas/CountryCode' currency: type: string description: >- Three-letter ISO currency code, in lowercase. Must be a supported currency. example: SGD account_bank_id: type: string description: The account bank id. example: 72970a7c-7921-431c-b95f-3438724ba16f bank_name: type: string description: Name of the account bank. example: ABC Bank bank_address: type: string description: Address of the account bank. example: 810 Seventh Avenue, New York, NY 10019, US clearing_system: type: object description: The clearing system routing information for this bank account. required: - type - value properties: type: type: string description: The type of clearing system identifier example: bic_swift value: type: string description: The clearing system identifier value example: TCCLGB3L example: type: bic_swift value: TCCLGB3L status: type: string enum: - ACTIVE - INACTIVE - CLOSED example: ACTIVE description: | Status of global account. One of: * `ACTIVE` * `INACTIVE` * `CLOSED` close_reason: type: string example: '' description: Global account closure reason. CountryCode: type: string example: SG description: >- Two-letter country code [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). maxLength: 2 minLength: 2 securitySchemes: XAuthToken: type: apiKey in: header name: x-auth-token description: The API token for login provided by UQPay. ````