Recurring Payments APIs for UPI
List of Recurring Payments APIs available for UPI.
You can use the Recurring Payments APIs to perform various actions using UPI as a payment method.
- We recommend that you create a single customer id rather than multiple customer ids for the same customer. If their details change, you can use the Edit Customer Details API. Duplicate validation is done based on email ID and phone number.
- Use the
fail_existing : 1
parameter so that the API returns the same details of the customer created earlier. If the fail_existing : 0
is used, the API throws an error and does not fetch the customer ID previously created. This can help in the end-user journey experience if a customer is signing up despite having signed up earlier.
- Use the Payments Downtime API to check for any ongoing downtimes that may impact the UPI Recurring.
- Ensure you pass all the token parameters while creating an Order for the authorization transaction using the Standard Checkout method.
- Ensure you pass the value of the
recurring
parameter as 1
in the Create an Authorization Payment API. If not passed, it would be considered a one-time payment. Once the authorization payment is made, we request you verify the payment signature at your backend.
- To check the status of the token ID use the Fetch Token API.
- Enable webhooks to check the status of the token and payments and the registration link. Use this only if your business is using it in a non-critical way. In critical scenarios, we recommend that you fetch APIs.
- A pre-debit notification is sent before the payment is deducted by the issuing bank. It is recommended that you check the presentment time in the FAQ document before proceeding with the recurring payments.
- Ensure to pass the below parameters while creating a registration link using the API:
- Customer details such as
name
, email
, and contact
.
sms_notify
and email_notify
as 1
to send notifications to customers.
amount
as 0
and type
as link
.
description
of the link.
subscription_registration
details such as:
method
as upi
max_amount
as 500
frequency
as monthly
or as_presented
- Ensure the
token_id
passed is for the linked customer_id
while creating a recurring payment.
- Use webhook to get real-time updates of payment.
The table below lists the various Recurring Payments APIs available for UPI and gives a brief description of each API: