> ## Documentation Index > Fetch the complete documentation index at: https://docs.vitawallet.io/llms.txt > Use this file to discover all available pages before exploring further. # Balance > This endpoint returns the **current balance of a wallet in real time**. By passing the wallet's `uuid` in the URL, the response includes the `balances` object reflecting the up-to-date balance at the exact moment of the request — across all currencies active in that wallet. Use this endpoint whenever you need an authoritative, real-time view of available funds — for example, before initiating a payout, validating a transaction, or displaying balances in your dashboard. --- #### Common Use Cases - **Pre-payout balance check:** Verify that the master wallet has sufficient funds before sending money to a customer or an external bank account. - **Real-time dashboards:** Display up-to-date balance information across all your wallets in admin or merchant-facing interfaces. - **Multi-wallet reconciliation:** Periodically refresh the balance of each wallet to ensure your internal records stay aligned with Vita Business. - **Operational alerts:** Trigger internal alerts when a wallet's balance falls below a defined threshold (e.g., to top up before processing batches of payouts). --- #### Path Parameters | Parameter | Type | Description | | --- | --- | --- | | `uuid` | string (UUID) (required) | Universal unique identifier of the wallet you want to query. | #### Request Example ```bash curl --location 'https://api.vitawallet.io/api/businesses/wallets/ffe3d2ad-e062-4967-a58a-c586799d8d10' ``` --- #### Response Structure The response returns a `wallet` object describing the queried wallet, including its identifier, its merchant token, the current balances by currency, and a flag indicating whether it's a master wallet. | Field | Description | | --- | --- | | `uuid` | Universal unique identifier assigned by Vita Wallet to the wallet across all its services. | | `token` | Merchant identification token associated with the wallet (e.g., `master`). | | `balances` | Object containing the current balance for each active currency in the wallet (e.g., `clp`, `usd`, `usdt`). Values are updated at the moment of the request. | | `is_master` | Boolean indicating whether this wallet is the **master wallet** (`true`) or a sub-wallet (`false`). | #### Response Example json ``` { "wallet": { "uuid": "ffe3d2ad-e062-4967-a58a-c586799d8d10", "token": "master", "balances": { "clp": 99979224179.28, "usd": 9220.99, "usdt": 1875.78182164, "usdc": 1215.48, "btc": 0 }, "is_master": true } } ``` --- #### Important Considerations EndFragment ## OpenAPI ````yaml /openapi.yaml get /api/businesses/wallets/{uuid} openapi: 3.0.0 info: title: Vita Business API description: >- Vita Wallet Business API — integra payins, payouts, exchange, transactions, users y webhooks para operar pagos en LatAm y el mundo. version: 1.0.0 contact: name: Vita Wallet Support url: https://vitawallet.io email: empresas@vitawallet.io servers: - url: https://api.vitawallet.io description: Production - url: https://api.stage.vitawallet.io description: Sandbox security: - xLogin: [] xTransKey: [] xDate: [] hmacSignature: [] tags: - name: Create Payin - name: Direct Payment - name: Exchange - name: Vita Sent - name: Bank Payouts - name: External Crypto Payouts - name: Transactions - name: Users Creation - name: User Information - name: Webhooks externalDocs: url: https://vitawallet.io description: Vita Wallet paths: /api/businesses/wallets/{uuid}: get: tags: - User Information summary: Balance description: >- This endpoint returns the **current balance of a wallet in real time**. By passing the wallet's `uuid` in the URL, the response includes the `balances` object reflecting the up-to-date balance at the exact moment of the request — across all currencies active in that wallet. Use this endpoint whenever you need an authoritative, real-time view of available funds — for example, before initiating a payout, validating a transaction, or displaying balances in your dashboard. --- #### Common Use Cases - **Pre-payout balance check:** Verify that the master wallet has sufficient funds before sending money to a customer or an external bank account. - **Real-time dashboards:** Display up-to-date balance information across all your wallets in admin or merchant-facing interfaces. - **Multi-wallet reconciliation:** Periodically refresh the balance of each wallet to ensure your internal records stay aligned with Vita Business. - **Operational alerts:** Trigger internal alerts when a wallet's balance falls below a defined threshold (e.g., to top up before processing batches of payouts). --- #### Path Parameters | Parameter | Type | Description | | --- | --- | --- | | `uuid` | string (UUID) (required) | Universal unique identifier of the wallet you want to query. | #### Request Example ```bash curl --location 'https://api.vitawallet.io/api/businesses/wallets/ffe3d2ad-e062-4967-a58a-c586799d8d10' ``` --- #### Response Structure The response returns a `wallet` object describing the queried wallet, including its identifier, its merchant token, the current balances by currency, and a flag indicating whether it's a master wallet. | Field | Description | | --- | --- | | `uuid` | Universal unique identifier assigned by Vita Wallet to the wallet across all its services. | | `token` | Merchant identification token associated with the wallet (e.g., `master`). | | `balances` | Object containing the current balance for each active currency in the wallet (e.g., `clp`, `usd`, `usdt`). Values are updated at the moment of the request. | | `is_master` | Boolean indicating whether this wallet is the **master wallet** (`true`) or a sub-wallet (`false`). | #### Response Example json ``` { "wallet": { "uuid": "ffe3d2ad-e062-4967-a58a-c586799d8d10", "token": "master", "balances": { "clp": 99979224179.28, "usd": 9220.99, "usdt": 1875.78182164, "usdc": 1215.48, "btc": 0 }, "is_master": true } } ``` --- #### Important Considerations EndFragment operationId: balance parameters: - name: uuid in: path schema: type: string required: true description: Wallet UUID example: f0953f43-2e68-4a1a-acdf-f5227fe0095c responses: '200': description: Successful response. content: application/json: example: wallet: uuid: f0953f43-2e68-4a1a-acdf-f5227fe0095c type: business_wallet attributes: token: master created_at: '2020-08-19T20:36:12.652Z' balances: usdc: 0 ars: 0 mxn: 0 cop: 0 brl: 0 usd: 7.02 usdt: 9.99 eur: 0 btc: 0 clp: 0 is_master: true components: securitySchemes: xLogin: type: apiKey in: header name: x-login description: Business xLogin xTransKey: type: apiKey in: header name: x-trans-key description: Business xTransKey xDate: type: apiKey in: header name: x-date description: ISO8601 datetime hmacSignature: type: apiKey in: header name: Authorization description: 'V2-HMAC-SHA256 signature. Example: `V2-HMAC-SHA256, Signature: `' ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.