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

# Fetch Agent Wallet Balance

> Use this API to fetch the current available wallet balance for a given Agent Institution. This balance reflects funds available for BBPS bill payment transactions.




## OpenAPI

````yaml /openapi/bbps/bbps-cou.yaml get /bbps/cou/agent/{agentId}/wallet/balance
openapi: 3.0.3
info:
  title: BBPS for Customers (Customer Operating Unit)
  version: 1.0.0
  description: >
    APIs for Agent Institutions to integrate with the Bharat Bill Payment System
    (BBPS) as a Customer Operating Unit (COU). These APIs enable bill discovery,
    bill fetch, bill payment, complaint management, and wallet operations.
servers:
  - url: https://sandbox.cashfree.com
    description: Sandbox (Testing) environment.
  - url: https://api.cashfree.com
    description: Production environment.
security:
  - XClientID: []
    XClientSecret: []
paths:
  /bbps/cou/agent/{agentId}/wallet/balance:
    get:
      tags:
        - Wallet
      summary: Fetch Agent Wallet Balance
      description: >
        Use this API to fetch the current available wallet balance for a given
        Agent Institution. This balance reflects funds available for BBPS bill
        payment transactions.
      operationId: fetchAgentWalletBalance
      parameters:
        - name: agentId
          in: path
          required: true
          description: The BBPS Agent ID (bbpsAgentId) of the Agent Institution.
          schema:
            type: string
          example: OU01XXXXINT001123456
      responses:
        '200':
          description: >-
            Success response for fetching the current available wallet balance
            for a given Agent Institution.
          content:
            application/json:
              schema:
                type: object
                properties:
                  balance:
                    type: number
                    format: decimal
                    description: Current available wallet balance in INR.
                    example: 5000
              example:
                balance: 5000
        '400':
          description: Bad request error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                wallet_not_found:
                  summary: No active wallet
                  value:
                    status: BAD_REQUEST
                    message: >-
                      No active wallet found for bbpsAgentId:
                      OU01XXXXINT001123456
                    data: null
                agent_not_found:
                  summary: Agent not found
                  value:
                    status: BAD_REQUEST
                    message: 'Agent not found for bbpsAgentId: OU01XXXXINT001123456'
                    data: null
        '401':
          description: Authentication Error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedResponse'
        '500':
          description: API related Error.
components:
  schemas:
    ErrorResponse:
      type: object
      properties:
        status:
          type: string
          example: BAD_REQUEST
        message:
          type: string
          example: Validation error description
        data:
          nullable: true
          example: null
    UnauthorizedResponse:
      type: object
      properties:
        message:
          type: string
          example: Unauthorized
  securitySchemes:
    XClientID:
      type: apiKey
      in: header
      name: x-client-id
      description: >-
        Your unique client identifier issued by Cashfree. You can find this in
        your [Merchant
        Dashboard](https://merchant.cashfree.com/verificationsuite/developers/api-keys).
    XClientSecret:
      type: apiKey
      in: header
      name: x-client-secret
      description: >-
        Your unique client secret issued by Cashfree. Keep this confidential and
        never expose it in client-side code. You can find this in your [Merchant
        Dashboard](https://merchant.cashfree.com/verificationsuite/developers/api-keys).

````