> ## Documentation Index
> Fetch the complete documentation index at: https://docs.payvessel.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Wallet Balance

> Retrieve the current balance for a managed wallet

**Retrieve the current balance** for a managed wallet. Always verify the available balance before initiating transfers to avoid transaction failures.

## Endpoint

<Badge variant="success">**GET**</Badge> `/pms/api/external/request/wallet/balance/`

## Response

<ResponseField name="status" type="string">
  Request status - `"success"` or `"error"`.
</ResponseField>

<ResponseField name="message" type="string">
  Description of the result.
</ResponseField>

<ResponseField name="data" type="object">
  <Expandable title="Data Object">
    <ResponseField name="data.available_balance" type="string">
      Funds available for immediate transfer.
    </ResponseField>

    <ResponseField name="data.ledger_balance" type="string">
      Book balance including pending debits/credits.
    </ResponseField>

    <ResponseField name="data.currency" type="string">
      The wallet currency (e.g., `NGN`).
    </ResponseField>
  </Expandable>
</ResponseField>

## Example Request

```bash theme={null}
curl -X GET https://api.payvessel.com/pms/api/external/request/wallet/balance/ \
  -H "api-key: YOUR_API_KEY" \
  -H "api-secret: YOUR_SECRET"
```

## Example Response

```json theme={null}
{
  "status": true,
  "message": "string",
  "data": {
    "available_balance": "1.78",
    "ledger_balance": "-9390113420548.59",
    "currency": "NGN"
  }
}
```


## OpenAPI

````yaml GET /pms/api/external/request/wallet/balance/
openapi: 3.1.0
info:
  title: PayVessel API
  description: >-
    PayVessel API for accepting payments, sending money, verifying identities,
    and managing wallets
  version: 1.0.0
servers:
  - url: https://api.payvessel.com
  - url: https://sandbox.payvessel.com
security:
  - {}
paths:
  /pms/api/external/request/wallet/balance/:
    get:
      tags:
        - Wallets
      summary: Wallet Balance
      description: Retrieve the current balance for a managed wallet
      parameters:
        - name: api-key
          in: header
          description: Your Payvessel public API key
          required: true
          schema:
            type: string
        - name: api-secret
          in: header
          description: Your Payvessel secret
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Wallet balance retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WalletBalanceResponse'
components:
  schemas:
    WalletBalanceResponse:
      type: object
      properties:
        status:
          type: boolean
          description: Request status
        message:
          type: string
          description: Response message
        data:
          type: object
          properties:
            available_balance:
              type: string
              description: Funds available for immediate transfer
            ledger_balance:
              type: string
              description: Book balance including pending debits/credits
            currency:
              type: string
              description: The currency of the wallet

````