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.

POST /ppi/wallet

cURL

createWallet

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"
}
'

200

SUCCESS_WALLET

{
  "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

The following parameters are required to create a wallet.

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.

If 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

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 create a primary wallet and associated sub-wallets 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"

cf_program_id · string · required

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.

Required string length: 1 - 19

Example:

"9876543210987654321"

wallet_id · string · required

Unique identifier that you create to identify the wallet in your system. Only alphanumeric characters, periods (.), hyphens (-), and underscores (_) are allowed.

Required string length: 1 - 50

Example:

"WALLET936721"

card_id · string

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.

Required string length: 1 - 50

Example:

"CARDR827364"

Response

200

application/json

Success response for creating a wallet.

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:

"Gift 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