Skip to main content
GET
Fetch Agent Institution Wallet Balance

Authorizations

x-client-id
string
header
required

Your unique client identifier issued by Cashfree. You can find this in your Merchant Dashboard.

x-client-secret
string
header
required

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.

Headers

x-api-version
string
default:2025-01-01
required

API version to be used. Format is YYYY-MM-DD.

Path Parameters

agentId
string
required

The Agent Institution ID (bbpsAgentInstituteId) that owns the wallet. This is the parent institution identifier, not the channel-specific agent_id used in the Bill Fetch and Bill Payment APIs.

Response

Success response for fetching the current available wallet balance for a given Agent Institution.

balance
number<decimal>

Current wallet balance in INR. Positive on the prefunding model (remaining prefunded amount). On the shortfall (postfunding) model this can be negative, where the negative value is the current shortfall drawn against the credit line.

Example:

5000