1. Create the Authorization Transaction

1.1 Using Razorpay APIs

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

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.

POST

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

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

You can use the

Orders API

to create a unique Razorpay order_id that is associated with the authorisation transaction. The following endpoint creates an order.

POST

/orders

Handy Tips

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.

customer_id

mandatory

string The unique identifier of the customer. For example, cust_4xbQrmEoA5WJ01.

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.

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

token

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

max_amount

mandatory

integer The maximum amount that can be debited in a single charge.

For other categories and MCCs, the minimum value is 100 (₹1) and maximum value is 9999900 (₹99,999).

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:

daily
weekly
fortnightly
bimonthly
monthly
quarterly
half_yearly
yearly
as_presented

recurring_value

optional

integer Determines the exact date or range of dates for recurring debits. Possible values are:

1-7 for weekly frequency
1-31 for fortnightly frequency
1-31 for bimonthly frequency
1-31 for monthly frequency
1-31 for quarterly frequency
1-31 for half_yearly frequency
1-31 for yearly frequency and is not applicable for the as_presented frequency.

Watch Out!

If the date entered for the recurring debit is not available for a month, then the last day of the month is considered by default. For example, if the date entered is 31 and the month has only 28 days, then the date 28 is considered.

recurring_type

optional

string Determines when the recurring debit can be done. Possible values are:

on: Recurring debit happens on the exact day of every month.

Handy Tips
For creating an order with recurring_type=on, set the recurring_value parameter to the current date.
before: Recurring debit can happen any time before the specified date.
after: Recurring debit can happen any time after the specified date.

For example, if the frequency is monthly, recurring_value is 17, and recurring_type is before, recurring debit can happen between the month's 1st and 17th. Similarly, if recurring_type is after, recurring debit can only happen on or after the 17th of the month.

bank_account

mandatory

Details of the bank account of the customer.

account_number

mandatory

integer The bank account number of the customer. For example, 123456789012345.

name

mandatory

string The name of the bank account holder.

ifsc

mandatory

The IFSC of the bank. For example, HDFC0000053.

Error Response Parameters

Given below is a list of possible errors you may face while creating an Order.

1.1.3. Create an Authorization Payment

Create a payment checkout form for customers to make Authorisation Transaction and register their mandate. You can use the Handler Function or Callback URL.

Watch Out!

The callback URL is not supported for recurring payments created using the registration link.
The first payment fails with the error BAD_REQUEST_DUMMY_PAYMENT. However, a token is created.

<button id = "rzp-button1"> Pay </button>
  <script src = "https://checkout.razorpay.com/v1/checkout.js"> </script>
  <script>
    var options = {
      "key": "[YOUR_KEY_ID]",
      "order_id": "order_1Aa00000000001",
      "customer_id": "cust_1Aa00000000001",
      "recurring": "1",
      "handler": function (response) {
        alert(response.razorpay_payment_id);
        alert(response.razorpay_order_id);
        alert(response.razorpay_signature);
      },
      "notes": {
        "note_key 1": "Beam me up Scotty",
        "note_key 2": "Tea. Earl Gray. Hot."
      },
      "theme": {
        "color": "#F37254"
      }
    };
    var rzp1 = new Razorpay(options);
    document.getElementById('rzp-button1').onclick = function (e) {
      rzp1.open();
      e.preventDefault();
    }
  </script>

Additional Checkout Fields

You should send the following additional parameters along with the existing checkout options as a part of the authorisation 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 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.

Error Response Parameters

Given below is a list of possible errors you may face while making the authorisation payment.

1.2. Using a Registration Link

Registration Link is an alternate way of creating an authorization transaction. You can create a registration link using the

API

Dashboard

Handy Tips

You do not have to create a customer if you choose the registration link method for creating an authorization transaction.

When you create a registration link, an
invoice
is automatically issued to the customer. They can use this invoice to make the authorization payment.

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 UPI, the amount must be a minimum of ₹1.

1.2.1. Create a Registration Link

The following endpoint creates a registration link.

POST

/subscription_registration/auth_links

curl -u <YOUR_KEY_ID>:<YOUR_KEY_SECRET>
-X POST https://api.razorpay.com/v1/subscription_registration/auth_links
-H "Content-Type: application/json" \
-d '{
   "customer":{
      "name":"Gaurav Kumar",
      "email":"gaurav.kumar@example.com",
      "contact":"9123456780"
   },
   "type":"link",
   "amount":"100",
   "currency":"INR",
   "description":"Registration Link for Gaurav Kumar",
   "subscription_registration":{
      "method":"upi",
      "max_amount":"500",
      "expire_at":4102444799,
      "frequency":"monthly",
      "recurring_value": 25,
      "recurring_type": "on",
      "bank_account":{
         "account_number":"123456789012345",
         "name":"Gaurav Kumar",
         "ifsc_code":"HDFC0000053"
      }
   },
   "receipt":"Receipt No. 23",
   "email_notify":true,
   "sms_notify":true,
   "expire_by":4102444799,
   "notes":{
      "note_key 1":"Beam me up Scotty",
      "note_key 2":"Tea. Earl Gray. Hot."
   }
}'

Request Parameters

customer

object Details of the customer to whom the registration link is sent.

name

mandatory

string Customer's name.

mandatory

string Customer's email address.

contact

mandatory

integer Customer's contact number.

type

mandatory

string In this case, the value is link.

amount

mandatory

integer The payment amount in the smallest currency sub-unit.

currency

mandatory

string The 3-letter ISO currency code for the payment.

description

mandatory

string A description that appears on the hosted page.

subscription_registration

Details of the authorization transaction.

method

mandatory

string The payment method used to make authorization transaction. Here, it is card.

max_amount

mandatory

integer Use to set the maximum amount (in paise) per debit request.

For other categories and MCCs, the minimum value is 100 (₹1) and maximum value is 9999900 (₹99,999).

expire_at

optional

integer The Unix timestamp till when you can use the token to charge the customer subsequent payments. 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:

daily
weekly
fortnightly
bimonthly
monthly
quarterly
half_yearly
yearly
as_presented

recurring_value

optional

integer Determines the exact date or range of dates for recurring debits. Possible values are:

1-7 for weekly frequency
1-31 for fortnightly frequency
1-31 for bimonthly frequency
1-31 for monthly frequency
1-31 for quarterly frequency
1-31 for half_yearly frequency
1-31 for yearly frequency and is not applicable for the as_presented frequency.

Watch Out!

recurring_type

optional

string Determines when the recurring debit can be done. Possible values are:

on: recurring debit happens on the exact day of every month.
before: recurring debit can happens any time before the specified date.
after: recurring debit can happens any time after the specified date.

bank_account

mandatory

Details of the bank account of the customer.

account_number

mandatory

integer The bank account number of the customer. For example, 123456789012345.

name

mandatory

string The name of the bank account holder.

ifsc

mandatory

string The IFSC of the bank. For example, HDFC0000053.

sms_notify

optional

boolean Indicates if SMS notifications are to be sent by Razorpay. Possible 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. Possible values:

true (default): Notifications are sent by Razorpay .
false: Notifications are not sent by Razorpay.

expire_by

optional

integer The Unix timestamp indicates the expiry of the registration link.

receipt

optional

string A unique identifier entered by you for the order. For example, Receipt No. 1. You should map this parameter 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

The following endpoint sends/resends notifications with the short URL to the customer:

POST

/invoices/:id/notify_by/:medium

Path Parameters

mandatory

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:

sms
email

1.2.3. Cancel a Registration Link

The following endpoint cancels a registration link.

POST

/invoices/:id/cancel

Handy Tips

You can only cancel registration link in the issued state.

curl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET]
-X POST https://api.razorpay.com/v1/invoices/inv_1Aa00000000001/cancel

Path Parameter

mandatory

string The unique identifier for the invoice linked to the registration link that you want to cancel. For example, inv_1Aa00000000001.