curl --request POST \
--url https://api.cashfree.com/ppi/wallet \
--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",
"cf_program_id": "9876543210987654321",
"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": "54252453468535350356",
"name": "Closed Wallet",
"type": "CLOSED_LOOP_PPI",
"status": "ACTIVE",
"balance": 0,
"available_balance": 0,
"funds_on_hold": 0
}
]
}Create Wallet
Creates a primary wallet and the associated sub-wallets for a user based on the specified program ID. The sub-wallet types, such as meal, fuel, and gift wallets, are determined by the program configuration. If the program is linked to a card program, a card is automatically created and associated with the wallet.
curl --request POST \
--url https://api.cashfree.com/ppi/wallet \
--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",
"cf_program_id": "9876543210987654321",
"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": "54252453468535350356",
"name": "Closed Wallet",
"type": "CLOSED_LOOP_PPI",
"status": "ACTIVE",
"balance": 0,
"available_balance": 0,
"funds_on_hold": 0
}
]
}Request parameters
Request parameters
| Parameter | Required | Description |
|---|---|---|
user_id | Always | The unique identifier of the user. |
wallet_id | Always | The unique identifier of the wallet. |
cf_program_id | Always | The unique identifier of the program. |
card_id | Conditionally | Required if cf_program_id is associated with a card program. |
cf_program_id is linked to a card program, you must provide card_id in the request. The card is associated with the wallet at the time of wallet creation.Authorizations
Your unique client identifier issued by Cashfree. You can find this in your Merchant Dashboard.
The secret key associated with your client ID. Use this to authenticate your API requests. You can find this in your Merchant Dashboard.
Headers
API version to be used. Format is in YYYY-MM-DD.
"2025-11-01"
Body
Request parameters to create a primary wallet and associated sub-wallets for a user.
Unique identifier for the user, as provided by you during PPI user creation. Only alphanumeric characters, periods (.), hyphens (-), and underscores (_) are allowed.
1 - 50"USER827364"
Unique identifier of the PPI program, provided by Cashfree. Use this to specify the program configuration when creating a wallet. If the provided cf_program_id is associated with a card program, then card_id is also required in the request. In such cases, the card is linked to the wallet during creation.
1 - 19"9876543210987654321"
Unique identifier that you create to identify the wallet in your system. Only alphanumeric characters, periods (.), hyphens (-), and underscores (_) are allowed.
1 - 50"WALLET936721"
Unique identifier for the card in your system. Only alphanumeric characters, periods (.), hyphens (-), and underscores (_) are allowed. Required if the cf_program_id is linked to a card program. The card is associated with the wallet when the wallet is created.
1 - 50"CARDR827364"
Response
Success response for creating a wallet.
Unique identifier for the user, as provided by you during PPI user creation.
"USER827364"
Unique identifier of the PPI program associated with the wallet, as provided by Cashfree.
"9876543210987654321"
Unique identifier for the wallet, as provided by you during wallet creation.
"WALLET936721"
Unique identifier for the wallet, automatically generated by Cashfree after successful wallet creation.
"1234567890123456783"
Name of the wallet.
"Gift Wallet"
List of sub-wallets created for this wallet.
Show child attributes
Show child attributes
Card details associated with the wallet, if a card exists.
Show child attributes
Show child attributes
Was this page helpful?