Api

Payments

Recurring Payments

Cards

Create Authorization Transaction

1. Create the Authorization Transaction

Create an authorisation transaction for cards using Razorpay APIs.

You can create an authorization transaction:

Note:
Bank downtime can affect success rates when processing recurring payments via debit cards.

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.

Handy Tips
For the Authorization Payment to be successful in a day (Example: 5th June), you should create an Order and the Authorization Transaction on the same day (5th June) before 11:59 pm.

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. Know more about 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 optional
string The customer's email address. For example, gaurav.kumar@example.com.
contact optional
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. Know more about Razorpay Orders.

Use the below endpoint to create an order.

/orders

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

Request Parameters๐Ÿ”—

amount mandatory

integer Amount in currency subunits. For cards, the minimum value is 100 (โ‚น1).

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.

method optional

string Payment method used to make the registration transaction. Possible value is card. If no value is passed, by default, card will be assumed.

token

Provides token details.

max_amount optional
integer Indicates the threshold value for which additional factor of authentication flow is chosen. The value 500000 (โ‚น5000) will be set as max_amount by default.
expire_at optional
integer The timestamp of the token expiry date in UNIX format.
The card expiry date will be used as default if you do not pass the value.
Also, the response will be null if you do not pass the value during the order creation.
frequency optional
string Frequency for subsequent debits. If not provided, value defaults to as_presented.
receipt optional

string A user-entered unique identifier for the order. 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โ€.

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.

Handy Tips
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 cards, 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.
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 is 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 Determines by which you would like to resend the notification. Possible values are
  • sms
  • email

Use the below endpoint to cancel a registration link.

/invoices/:id/cancel

Hand Tips
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.
ร—

ON THIS PAGE