Wallet Operations

This section details the following wallet operations with an amount of ₹ 500 as an example:

• Load a Wallet: Customer wants to add ₹ 500 to the wallet.
• Accept Payments from a Wallet: Customer wants to pay ₹ 500 from the wallet.
• Refund to a Wallet: Merchant wants to refund ₹ 500 to a wallet.
• Send Cashback to a Wallet: Merchant wants to send ₹ 500 as a cashback to a wallet.
• Make a Payout

​

Prerequisites

• Set up your Razorpay account.
• Generate API Keys from Razorpay Dashoboard.
• Create a Customer.

​

Load a Wallet

When a customer adds funds or money into the wallet, it is called loading a wallet. A wallet is created only when a customer adds funds or money into the wallet for the first time. Follow the below steps for loading a wallet:

1. Customer proceeds to Checkout from the normal payment flow for an amount, say ₹ 500, using the selected payment mode (Net Banking/Debit card/Credit card/UPI).
2. You authenticate the customer in your backend and make a capture payment request for the payment made and the amount gets credited to your account.
3. You make a transfer payment request of ₹ 500 to the customer’s wallet.
4. Customer’s wallet gets credited with ₹ 500 and your account gets debited with the same amount.
5. Razorpay sends a ‘success information’ response which you may show to your customer.

The following image illustrates the flow of funds while loading a wallet: Reloading the wallet at the time of checkout will have the same flow. This usually happens when the customer finds out that there is insufficient balance in the wallet at the time of making a payment. Refer to the API Reference to see the APIs with the examples that are used in this operation.

​

Accept Payments from a Wallet

Follow the below steps for accepting payment from a wallet:

1. The customer initiates payment of ₹ 500 for an order from the wallet.
2. You authenticate the customer in your backend and make a create payment request with the customer_id.
3. You make a capture payment request for the payment of ₹ 500.
4. ₹ 500 gets debited from the customer’s wallet and your account gets credited with the same amount.

The following image illustrates the flow of funds when a payment is made from a wallet: Refer to the API reference to see the APIs with the examples that are used in this operation.

​

Refund to a Wallet

Follow the below steps to refund to a wallet when payment is made from a wallet:

1. You make a Refund to wallet request for a payment of ₹ 500 with the payment_id.
2. Customer’s wallet gets credited with ₹ 500 and your account gets debited with the same amount.

The following image illustrates the flow of refund made to a wallet: Refer to the API Reference to see the APIs with the examples that are used in this operation.

​

Send Cashback to a Wallet

Follow the below steps to send cashback to a wallet:

1. You make a direct transfer request of ₹ 500 with the customer_id.
2. Customer’s wallet gets credited with ₹ 500 and your account gets debited with the same amount.

The following image illustrates the flow of cashback to a wallet: Refer to the API Reference to see the APIs with the examples that are used in this operation.

​

Make a Payout

Payouts allow customers to transfer funds directly from their wallets to any of the linked bank accounts. If there are no bank accounts linked to a customer, send an API request to Razorpay with the bank account details to link the bank account to a customer. This allows Razorpay to tie the bank account with the particular Customer Id and thereby process a fund transfer initiated towards that account. Refer to the API Reference to make a payout.