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 BBPS Agent ID (bbpsAgentId) of the Agent Institution.

Response

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

balance
number<decimal>

Current available wallet balance in INR.

Example:

5000