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: Onboard users and create wallets or sub-wallets with program-based configuration, and update them as needed.
  • Fund transfers: Handle credits, debits, and refunds securely with duplicate-transaction protection.
  • RBI-compliant KYC and rules: Enforce KYC verification, balance limits, and transaction rules in line with RBI guidelines.
  • Wallet balances: Retrieve total and sub-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 lifecycle

Create PPI User

Create a new user in the PPI system with personal information required for wallet operations.

Get PPI User Details

Retrieve details of an existing user based on the user ID.

Update PPI User

Update an existing PPI user’s information.

​
Verification flows

Min KYC Verification

Perform minimum KYC verification for wallet users as per RBI guidelines.

Send OTP

Send an OTP to the user’s registered mobile number for verification.

Verify OTP

Verify the OTP submitted by the user to complete the verification flow.

​
Getting started

Use the following resources to begin implementing PPI APIs:

API setup

Base URLs, API keys, and steps to run your first PPI API request

Secure your integration

Authenticate requests and keep credentials safe with Client ID and Client Secret