Available in🇮🇳 India
A token is the unique identifier Razorpay creates for a customer’s UPI Autopay mandate. It holds the mandate terms (the maximum debit amount, the frequency and the expiry), and you use its token_id to execute every subsequent debit. In these docs, “mandate” refers to the authorisation the customer approves in their UPI app, and “token” is the object you work with in Razorpay APIs. One mandate maps to one token.
You can create an authorisation transaction using Razorpay APIs or Registration Link.
A token changes state as the customer and your business act on it:
- If the authorisation payment fails, the token moves to the
rejectedstate. - Once a token is
confirmed, it never moves torejected. It moves only topausedorcancelled. - When the customer resumes a
pausedtoken, it moves back toconfirmed. - When you cancel a token, it stays in the
cancellation_initiatedstate until the downstream partner confirms the cancellation. It then moves tocancelled.
1.1 Using Razorpay APIs
Mandate registration is the journey where the customer sets up the subscription for the first time. At Razorpay, it involves three steps: creating a customer, creating an order (to give context to the token) and creating an authorisation payment, where the first debit authorisation is performed on the customer. If the first debit fails, the registration fails. Here are the steps:- Create a Customer - This allows Razorpay to uniquely identify the customer and store UPI Autopay tokens against the customer ID.
- Create an Order - Send the token details required to set up UPI Autopay on the customer ID.
- Create an Authorisation Payment - Initialise the authorisation journey where the actual mandate registration happens.
Handy TipsFor the Authorisation Payment to be successful in a day (for example, 5th June), you should create an Order and the Authorisation Transaction on the same day (5th June) before 11:59 pm.
1.1.1 Create a Customer
Sample Code
Sample Code
Razorpay links recurring tokens to customers using a unique identifier generated through the Customer API.Creating a customer is mandatory to set up a registration. You may have your own way to identify customers at your end, so passing
email and contact is optional, but we recommend passing at least one of them to Razorpay. You can also use the customer for various Razorpay offerings. Know more about Customers. The following endpoint creates a customer.POST /customersSample Code
Sample Code
Request Parameters
Request Parameters
name
: string The name of the customer. For example, Gaurav Kumar.email
: string The email address of the customer. For example, gaurav.kumar@example.com.contact
: string The phone number of the customer. For example, 9876543210.fail_existing optional
: string The request throws an exception by default if a customer with the exact details already exists. You can pass an additional parameter fail_existing to get the existing customer’s details in the response. Possible values:1(default): If a customer with the same details already exists, throws an error.0: If a customer with the same details already exists, fetches details of the existing customer.
notes optional
: object Key-value pair that can be used to store additional information about the entity. Maximum 15 key-value pairs, 256 characters (maximum) each. For example, "note_key": "Beam me up Scotty”.1.1.2. Create an Order
The Orders API allows you to create a unique Razorpayorder_id, for example, order_1Aa00000000001, that would be tied to the authorisation transaction. Refer to our detailed Order documentation for more details.
You can create a payment against the order_id once it is generated.
Use the below endpoint to create an order.
POST /orders
Sample Code
Sample Code
Handy TipsThe
token.max_amount value must respect the limits defined by NPCI for your merchant category. Refer to the limits by MCC table for the maximum mandate amount and the AFA-free limit for your MCC.Handy TipsUPI Autopay supports only
INR. Recurring payments on cards support other currencies.Request Parameters
Request Parameters
amount mandatory
: integer Amount, in paise.currency mandatory
: string The 3-letter ISO currency code for the payment. Currently, we only support INR.customer_id mandatory
: string The unique identifier of the customer. For example, cust_4xbQrmEoA5WJ01.method mandatory
: string The authorisation method. Here, it is upi.receipt optional
: string A user-entered unique identifier of the order. For example, Receipt No. 1. You should map this parameter to the order_id sent by Razorpay.description optional
: string A description of the mandate that will be displayed to the customer in their UPI app. This helps the customer understand what they are subscribing to. Keep it under 50 characters and avoid special characters. For example, Monthly Pro subscription.notesoptional
: object Key-value pair that can be used to store additional information about the entity. Maximum 15 key-value pairs, 256 characters each. For example, "note_key": "Beam me up Scotty”.For S2S and custom checkout integrations, the customer selects the UPI app on your checkout page. We highly recommend passing the name of the app selected by the customer in this parameter. For example, "note_key_1": "phonepe". This helps Razorpay debug any issue in the mandate registration journey. If you have other notes, use the next available key, such as note_key_2.token
: Details related to the authorisation such as max amount, frequency and expiry information.max_amount mandatory
: integer The maximum amount that can be debited in a single charge.The minimum value is 100 (₹1). For the maximum value for your MCC, refer to the limits by MCC table.Best PracticesSet the
max_amount as close to the actual debit amount as possible. For example, if the expected debit amount is ₹99-₹299, setting the max_amount to ₹5,000 may cause the customer to drop off due to trust issues. A realistic max_amount builds customer trust while allowing flexibility for variable debits.Frequency also plays a crucial role in building customer trust. For example, if you are selling a monthly subscription but request an as_presented mandate, the customer may find it risky to set up the mandate. If your business has a flexible billing model, as_presented frequency fits your use case better, because NPCI has strict checks to ensure one successful debit per billing cycle.If you are a TPV (third-party validation) merchant, also prompt the customer to choose only their registered bank account at app selection. See Create an Authorisation Payment.expire_at mandatory
: integer The Unix timestamp that indicates when the authorisation transaction must expire. The default value is 10 years and the maximum value allowed is 30 years.frequency mandatory
: string The frequency at which you can charge your customer. Possible values:dailyweeklyfortnightlybimonthlymonthlyquarterlyhalf_yearlyyearlyas_presented
1.1.3. Create an Authorisation Payment
Handler Function vs Callback URL
- Handler Function:
When you use the handler function, the response object of the successful payment (razorpay_payment_id,razorpay_order_idandrazorpay_signature) is submitted to the Checkout Form. You need to collect these and send them to your server. - Callback URL:
When you use a Callback URL, the response object of the successful payment (razorpay_payment_id,razorpay_order_idandrazorpay_signature) is submitted to the Callback URL.
UPI Intent
UPI Intent
UPI Intent is supported on mWeb (Android) and Mobile App (WebView). On Desktop Web, as UPI Intent is not supported, a QR code is displayed instead.
List of Supported UPI Apps
List of Supported UPI Apps
UPI Collect
UPI Collect
Checkout with handler functions
Custom checkout with Callback URL
payment.captured or payment.failed webhook. If the payment is successful, the token.confirmed webhook is generated and you can get the token_id from it. If the payment fails, the payment.failed webhook arrives along with the token.rejected webhook and the token_id.
You can also poll for the payment status using the Fetch Payment API, but we recommend waiting for the webhook notification first and using polling as a fallback. You can also get the token_id using the Fetch Token APIs.
Additional Checkout fields
customer_id mandatory
: string Unique identifier of the customer created in the first step.
order_id mandatory
: string Unique identifier of the order created in the second step.
recurring mandatory
: string Determines if the recurring payment is enabled or not. Possible values:
1: Recurring payment is enabled.preferred: Use this if you want to allow recurring payments and one-time payment in the same flow.
1.2. Using a Registration Link
Registration Link is an alternate way of creating an authorisation transaction. You can create a registration link using the API or Dashboard.Handy Tips
- You do not have to create a customer if you choose the registration link method for creating an authorisation transaction.
- You can use Webhooks to get notifications about successful payments against a registration link.
₹1.
1.2.1. Create a Registration Link
Use the below endpoint to create a registration link.POST /subscription_registration/auth_links
Sample Code
Sample Code
Request Parameters
Request Parameters
customer
: Details of the customer to whom the registration link will be sent.name mandatory
: string Customer’s name.email mandatory
: string Customer’s email address.contactmandatory
: string Customer’s phone number.type mandatory
: string In this case, the value is link.currency mandatory
: string The 3-letter ISO currency code for the payment. Currently, only INR is supported.amount mandatory
: integer The payment amount in the smallest currency sub-unit.description mandatory
: string A description that appears on the hosted page. For example, 12:30 p.m. Thali meals (Gaurav Kumar).subscription_registration
: Details of the authorisation transaction.method mandatory
: string The authorization method. Here it is card.max_amount mandatory
: integer Use to set the maximum amount (in paise) per debit request.The minimum value is 100 (₹1). For the maximum value for your MCC, refer to the limits by MCC table.expire_at optional
: integer The timestamp, in Unix format, till when you can use the token (authorization on the payment method) to charge the customer subsequent payments.frequency mandatory
: string The frequency at which you can charge your customer. Must be set to monthly.sms_notify optional
: boolean Indicates if SMS notifications are to be sent by Razorpay. Can have the following values:true(default): Notifications are sent by Razorpay.false: Notifications are not sent by Razorpay.
email_notify optional
: boolean Indicates if email notifications are to be sent by Razorpay. Can have the following values:true(default): Notifications are sent by Razorpay.false: Notifications are not sent by Razorpay.
expire_by optional
: integer The timestamp, in Unix, till when the registration link should be available to the customer to make the authorisation transaction.receipt optional
: string A unique identifier entered by you for the order. For example, Receipt No. 1. This parameter should be mapped to the order_id sent by Razorpay.notes optional
: object This is a key-value pair that can be used to store additional information about the entity. Maximum 15 key-value pairs, 256 characters (maximum) each. For example, "note_key": "Beam me up Scotty”.1.2.2. Send/Resend Notifications
The following endpoint sends/resends notifications with the short URL to the customer:POST /invoices/:id/notify_by/:medium
Sample Code
Sample Code
Response
Path Parameters
Path Parameters
idmandatory
: string The unique identifier of the invoice linked to the registration link for which you want to send the notification. For example, inv_1Aa00000000001.medium mandatory
: string Determines through which medium you want to resend the notification. Possible values:smsemail
1.2.3. Cancel a Registration Link
The following endpoint cancels a registration link.POST /invoices/:id/cancel
Handy TipsYou can only cancel registration link in the
issued state.Sample Code
Sample Code
Response
Path Parameter
id mandatory
: string The unique identifier for the invoice linked to the registration link that you want to cancel. For example, inv_1Aa00000000001.