> ## 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. # Retrieve Balance > Retrieves the current account balance, based on the authentication that was used to make the request. ## OpenAPI ````yaml /global-account/v1.6/banking.yaml get /v1/balances/{currency} 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/balances/{currency}: get: tags: - Balances summary: Retrieve Balance description: >- Retrieves the current account balance, based on the authentication that was used to make the request. operationId: retrieve-balance parameters: - $ref: '#/components/parameters/XOnBehalfOf' - $ref: '#/components/parameters/PathCurrency' responses: '200': headers: x-response-id: $ref: '#/components/headers/XResponseId' description: Balances returned successfully. content: application/json: schema: $ref: '#/components/schemas/BalancesResponse' title: BalancesResponse 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 PathCurrency: name: currency description: >- Specifies the currency for which the balance is retrieved. Only a single currency can be provided. Currency codes follow the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#List_of_ISO_4217_currency_codes) standard. in: path required: true schema: type: string example: USD 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: BalancesResponse: type: object required: - balance_id - currency - available_balance - prepaid_balance - margin_balance - frozen_balance - create_time - last_trade_time - balance_status properties: balance_id: type: string description: The account balance id. example: 72970a7c-7921-431c-b95f-3438724ba16f currency: type: string description: Currency of the account balance. example: USD available_balance: type: string format: number description: Available balance. example: '5000.25' prepaid_balance: type: string format: number description: Prepaid account balance. example: '3600.12' margin_balance: type: string format: number description: Margin balance. example: '10000.00' frozen_balance: type: string format: number description: Frozen balance. example: '2353.25' create_time: $ref: '#/components/schemas/CreateTime' last_trade_time: type: string description: The last trade time at which the object was updated. example: '2024-03-21T17:17:32+08:00' balance_status: type: string description: > 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. example: ACTIVE enum: - ACTIVE - PENDING - PROCESSING - CLOSED CreateTime: type: string format: date/time example: '2024-03-01T00:00:00+08:00' description: >- The timestamp when the record was created in the system. Timestamp follows the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) standard. securitySchemes: XAuthToken: type: apiKey in: header name: x-auth-token description: The API token for login provided by UQPay. ````