Skip to main content
POST
/
wallet
/
balance
Get Wallet and Sub-Wallet Balances
curl --request POST \
  --url https://api.cashfree.com/wallet/balance \
  --header 'Content-Type: application/json' \
  --header 'x-client-id: <api-key>' \
  --header 'x-client-secret: <api-key>' \
  --data '{
  "wallet_id": "9876543210987654321",
  "sub_wallet_id": "5432109876543210987"
}'
{
  "wallet_id": "9876543210987654321",
  "total_wallet_balance": 2150.25,
  "user_id": "1234567890123456789",
  "sub_wallets": [
    {
      "id": "5432109876543210987",
      "name": "sub wallet example",
      "type": "GIFT_PPI",
      "balance": 500,
      "status": "ACTIVE"
    }
  ]
}

Authorizations

​
x-client-id
string
header
required

Your unique client identifier issued by Cashfree.

​
x-client-secret
string
header
required

The secret key associated with your client ID.

Body

application/json
​
wallet_id
string
required

Unique identifier of the wallet.

Example:

"9876543210987654321"

​
sub_wallet_id
string

Optional sub-wallet ID. If provided, balance will be fetched only for this sub-wallet.

Example:

"5432109876543210987"

Response

Wallet balance fetched successfully.

​
wallet_id
string
Example:

"9876543210987654321"

​
total_wallet_balance
number
Example:

2150.25

​
user_id
string
Example:

"1234567890123456789"

​
sub_wallets
object[]

List of sub-wallets with their balances.

⌘I