Available in🇮🇳 India
You should perform the following steps to create and charge your customer subsequent payments:
3.1. Create an Order to Charge the Customer
You have to create a new order every time you want to charge your customers. This order is different from the one created during the authorisation transaction. The following endpoint creates an order.POST /orders
Handy TipsYou can use the
notification object in the request to control pre-debit notifications and recurring debits. This is known as the decoupled flow. If you do not pass this object, we will automatically try to debit 36 hours after the pre-debit notification is delivered.Request Parameters
Request Parameters
A user-entered unique identifier for the order. For example,
Receipt No. 1. You should map this parameter to the order_id sent by Razorpay.Key-value pair you can use to store additional information about the entity. Maximum of 15 key-value pairs, 256 characters each. For example,
"note_key": "Beam me up Scotty”.Determines whether the payment status should be changed to
captured automatically or not. Possible values:true: Payments are captured automatically.false: Payments are not captured automatically. You can manually capture payments using the Manually Capture Payments API.
Details of the pre-debit notification. Use this object to control pre-debit notifications and recurring debits. If you do not pass this object, we will automatically try to debit 36 hours after the pre-debit notification is delivered.
The
token_id generated when the customer successfully completes the authorisation payment. Different payment instruments for the same customer have different token_id.Response Parameters
Response Parameters
The
token_id generated when the customer successfully completes the authorisation payment. Different payment instruments for the same customer have different token_id.Key-value pair you can use to store additional information about the entity. Maximum of 15 key-value pairs, 256 characters each. For example,
"note_key": "Beam me up Scotty”.3.2. Create a Recurring Payment
Once you have generated anorder_id, use it with the token_id to create a payment and charge the customer. The following endpoint creates a payment to charge the customer.
POST /payments/create/recurring
Request Parameters
Request Parameters
The amount you want to charge your customer. This should be the same as the order amount.
The unique identifier of the customer you want to charge. For example,
cust_1Aa00000000002.The
token_id generated when the customer successfully completes the authorisation payment. Different payment instruments for the same customer have different token_id.Determines whether recurring payment is enabled or not.
true: Recurring payment is enabled.false: Recurring payment is not enabled.
A user-entered description for the payment. For example,
Creating recurring payment for Gaurav KumarTest the Integration
Once you’ve completed the integration, test it using our test cases for Card Recurring.3.3. Error Scenarios
If a subsequent payment fails, the payment carries an error object withcode, description, source, step and reason. Use the reason to decide the next action. For the Cards Recurring error reasons, see Error Codes.
3.4. Best Practices
- When you create a subsequent payment, the mandate hub sends the customer a pre-debit notification, and the card is debited 36 hours later. The payment stays in the
createdstate until then. Wait for the final payment status before you act on it. - A debit cannot exceed the recurring token’s
max_amount. Debits above the AFA limit need the customer’s approval through a link that is valid for 72 hours. - On a fixed-frequency token, such as one backing a subscription, only one debit is allowed per frequency cycle. Because the debit happens 36 hours after you create the payment, do not create it at the very end of a cycle.
- Check the token status before you create a subsequent payment. Charge a token only while it is
confirmed.