API ReferenceIntegrationsKnowledge Base

1. Create the Authorization Transaction

You can create an authorization transaction:

1.1 Using Razorpay APIs๐Ÿ”—

To create an authorization transaction using Razorpay APIs, you need to:

  1. Create a Customer.
  2. Create an Order.
  3. Create Authorization Payment using Razorpay APIs.

1.1.1 Create a Customer๐Ÿ”—

Razorpay links recurring tokens to customers via a unique identifier. This unique identifier for the customer is generated using the Customer API.

You can create customers with basic details such as email and contact and use them for various Razorpay offerings. Learn more about Razorpay Customers.

You can create a customer using the below endpoint.

/customers

Once a customer is created, you can create an order for the authorization of the payment.

Request Parameters๐Ÿ”—

name mandatory
string The customer's name. For example, Gaurav Kumar.
email mandatory
string The customer's email address. For example, gaurav.kumar@example.com.
contact mandatory
string The customer's phone number. For example, 9876543210.
fail_existing optional
string If a customer with the same details already exists, the request throws an exception by default. You can pass an additional parameter fail_existing to get the details of the existing customer in the response. Possible values:
  • 0 - fetch details of existing customer
  • 1 - throw the exception error (default)
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 Razorpay order_id, for example, order_1Aa00000000001, that would be tied to a payment. This order_id has a 1:1 mapping with the order created for the authorization payment at your end. To learn more about Razorpay Orders, refer our detailed Order documentation.

Use the below endpoint to create an order.

/orders

You can create a payment against the order_id once it is created.

Note:
The subsequent payment frequency is displayed on your customer's PSP. They can select the required frequency while registering for the mandate.

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.

method mandatory

string Payment method for the authorization transaction. Here, the value should be upi.

receipt optional

string Unique identifier for the order entered by you. For example, Receipt No. 1. This parameter should be mapped to the order_id sent by Razorpay.

notesoptional

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โ€.

token

Details related to the authorization such as max amount, frequency and expiry information.

max_amount optional
integer The maximum amount that can be debited in a single charge. Minimum value is 100 (โ‚น1 ). Maximum value is 200000 (โ‚น2,000).
expire_at optional
integer The Unix timestamp that indicates when the authorization transaction must expire. Defaults to 10 years.
frequency mandatory
string The frequency at which you can charge your customer.

1.1.3. Create an Authorization 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_id and razorpay_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_id and razorpay_signature) is submitted to the Callback URL.

Additional Checkout Fields๐Ÿ”—

The following additional parameters must be sent along with the existing checkout options as part of the authorization transaction.

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. Possible values:
  • 1: Recurring payment is enabled.
  • preferred: Use this when you want to support recurring payments and one-time payment in the same flow.

1.2. Using a Registration Link๐Ÿ”—

Registration Links are an alternate way of creating an authorization transaction. If you create a registration link, you need not create a customer or an order.

When you create a registration link, an invoice is automatically issued to the customer. The customer can use the invoice to make the Authorization Payment.

Learn how to create Registration Links using the Razorpay Dashboard.

Note:
You can use Webhooks to get notifications about successful payments against a registration link.

A registration link must always have the amount (in Paise) that the customer will be charged when making the authorization payment. For UPI, the amount must be a minimum of โ‚น1.

Use the below endpoint to create a registration link.

/subscription_registration/auth_links

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 authorization transaction.

method mandatory
string The authorization method. Here it is card.
max_amount optional
integer Use to set the maximum amount (in paise) per debit request. The value can range from 500 - 9999900. Defaults to โ‚น99,000.
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.
sms_notify optional

boolean Indicates if SMS notifications are to be sent by Razorpay. Can have the following values:

  • 0 - Notifications are not sent by Razorpay.
  • 1 - Notifications are sent by Razorpay(default value).
email_notify optional

boolean Indicates if email notifications are to be sent by Razorpay. Can have the following values:

  • 0 - Notifications are not sent by Razorpay.
  • 1 - Notifications are sent by Razorpay (default value).
expire_by optional

integer The timestamp, in Unix, till when the registration link should be available to the customer to make the authorization 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๐Ÿ”—

Use the below endpoint to send/resend notifications with the short URL to the customer.

/invoices/:id/notify_by/:medium

Allowed values for medium path parameter is sms and email

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 How you want to resend the notification. Possible values are
  • sms
  • email

Use the below endpoint to cancel a registration link.

/invoices/:id/cancel

Note
You can only cancel registration link that is in the issued state.

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.
×