Wallet Details API | Cashfree Payments

curl --request POST \
  --url https://api.cashfree.com/ppi/wallet/details \
  --header 'Content-Type: application/json' \
  --header 'x-api-version: <x-api-version>' \
  --header 'x-client-id: <api-key>' \
  --header 'x-client-secret: <api-key>' \
  --data '
{
  "user_id": "USER827364",
  "wallet_id": "WALLET936721"
}
'

{
  "user_id": "USER827364",
  "cf_program_id": "9876543210987654321",
  "wallet_id": "WALLET936721",
  "cf_wallet_id": "1234567890123456783",
  "wallet_name": "Gift Wallet",
  "sub_wallets": [
    {
      "cf_sub_wallet_id": "35246543210987654321",
      "name": "Gift Wallet",
      "type": "GIFT_PPI",
      "status": "ACTIVE",
      "balance": 0,
      "available_balance": 0,
      "funds_on_hold": 0
    },
    {
      "cf_sub_wallet_id": "54252453468535350359",
      "name": "Cashfree Wallet",
      "type": "CLOSED_LOOP_PPI",
      "status": "ACTIVE",
      "balance": 0,
      "available_balance": 0,
      "funds_on_hold": 0
    }
  ]
}

POST

ppi

wallet

details

curl --request POST \
  --url https://api.cashfree.com/ppi/wallet/details \
  --header 'Content-Type: application/json' \
  --header 'x-api-version: <x-api-version>' \
  --header 'x-client-id: <api-key>' \
  --header 'x-client-secret: <api-key>' \
  --data '
{
  "user_id": "USER827364",
  "wallet_id": "WALLET936721"
}
'

{
  "user_id": "USER827364",
  "cf_program_id": "9876543210987654321",
  "wallet_id": "WALLET936721",
  "cf_wallet_id": "1234567890123456783",
  "wallet_name": "Gift Wallet",
  "sub_wallets": [
    {
      "cf_sub_wallet_id": "35246543210987654321",
      "name": "Gift Wallet",
      "type": "GIFT_PPI",
      "status": "ACTIVE",
      "balance": 0,
      "available_balance": 0,
      "funds_on_hold": 0
    },
    {
      "cf_sub_wallet_id": "54252453468535350359",
      "name": "Cashfree Wallet",
      "type": "CLOSED_LOOP_PPI",
      "status": "ACTIVE",
      "balance": 0,
      "available_balance": 0,
      "funds_on_hold": 0
    }
  ]
}

Request parameters

user_id is always required. You must also provide one of the following identifier combinations.

Combination	Required parameters
By wallet	`user_id`, `wallet_id`
By card	`user_id`, `card_id`
By wallet and sub-wallet	`user_id`, `wallet_id`, `cf_sub_wallet_id`
By card and sub-wallet	`user_id`, `card_id`, `cf_sub_wallet_id`

Response behaviour

The response always includes wallet details and sub-wallet details. The following rules determine what additional data is returned based on the identifiers you provide.

If you provide wallet_id and the wallet has no associated card, the response returns wallet and sub-wallet details only.
If you provide wallet_id and the wallet has an associated card, the response also includes card details.
If you provide card_id, the response includes card details alongside wallet and sub-wallet details.
If you provide both wallet_id and cf_sub_wallet_id, the response returns details for the specified sub-wallet only.
If you provide both card_id and cf_sub_wallet_id, the response returns details for the specified sub-wallet along with wallet and card details.

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

The secret key associated with your client ID. Use this to authenticate your API requests. You can find this in your Merchant Dashboard.

Headers

x-api-version

string

default:2025-11-01

required

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

Example:

"2025-11-01"

Body

application/json

Request parameters to fetch wallet and sub-wallet details, including current balances, for a user.

user_id

string

required

Unique identifier for the user, as provided by you during PPI user creation. Only alphanumeric characters, periods (.), hyphens (-), and underscores (_) are allowed.

Required string length: 1 - 50

Example:

"USER827364"

wallet_id

string

Unique identifier for the wallet, as provided by you during wallet creation. Only alphanumeric characters, periods (.), hyphens (-), and underscores (_) are allowed.

Required string length: 1 - 50

Example:

"WALLET936721"

card_id

string

Unique identifier for the card, as provided by you during card creation. Only alphanumeric characters, periods (.), hyphens (-), and underscores (_) are allowed.

Required string length: 1 - 50

Example:

"CARDR827364"

cf_sub_wallet_id

string

Optional sub-wallet ID. If provided, the response includes only this sub-wallet's balance. Only numeric characters are allowed.

Required string length: 1 - 19

Example:

"35246543210987654321"

Response

Success response for fetching wallet details.

user_id

string

Unique identifier for the user, as provided by you during PPI user creation.

Example:

"USER827364"

cf_program_id

string

Unique identifier of the PPI program associated with the wallet, as provided by Cashfree.

Example:

"9876543210987654321"

wallet_id

string

Unique identifier for the wallet, as provided by you during wallet creation.

Example:

"WALLET936721"

cf_wallet_id

string

Unique identifier for the wallet, automatically generated by Cashfree after successful wallet creation.

Example:

"1234567890123456783"

wallet_name

string

Name of the wallet.

Example:

"Cashback Wallet"

sub_wallets

object[]

List of sub-wallets created for this wallet.

Show child attributes

card

object

Card details associated with the wallet, if a card exists.

Show child attributes

Check Transaction Eligibility Get Wallet Statement

⌘I

Prepaid Payment Instrument APIs

Get Wallet Details

Authorizations

Headers

Body

Response