Skip to main content
Use the Prepaid Payment Instrument (PPI) APIs to create and manage digital wallets, sub-wallets, gift cards, and prepaid cards for your users. They enable secure fund transactions, ensure compliance with RBI guidelines, and support integration across multiple business use cases.

​
Key features

The key features offered by Cashfree’s PPI APIs are:
  • Create and manage users, wallets, and sub-wallets.
  • Handle fund transfers securely with duplicate-transaction protection.
  • Enforce RBI-compliant KYC, balance, and transaction rules.
  • Retrieve wallet balances in real time.

​
Program structure

Cashfree sets up a Program based on your business needs and the wallet restrictions you define.
  • Definition: A Program specifies the type of wallet or instrument you can offer.
  • Functions: It lets you configure limits, validity, and usage rules.
  • Sub-Programs: A Program can include multiple categories, such as meal, reward, or gift wallets, to support different use cases.
For example, the main program may have an overall load limit of ₹50,000 per month. Within it, the Meal sub-wallet could allow only ₹2,000 per month and be restricted to food merchants.

​
User Management

Create PPI User

Use this API to create a new user in the PPI system with personal information required for wallet operations.

Get PPI User Details

Use this API to retrieve details of an existing user based on the user ID.

​
Wallet Management

Create Wallet

Use this API to create a wallet and associated sub-wallets based on a program configuration.

Credit Wallet

Use this API to credit funds to a user’s sub-wallet and issue gift codes for gift wallets.

Debit Wallet

Use this API to debit an amount from a user’s sub-wallet. Behaviour varies depending on the sub-wallet type.

Get Wallet Balance

Use this API to fetch total wallet and sub-wallet balances with optional filtering by specific sub-wallet.

⌘I