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. You can generate this identifier using the Customer API.

You can create

customers

with basic information such as email and contact and use them for various Razorpay offerings. The following endpoint creates a customer.

POST

/customers

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 Razorpay order_id, for example, order_1Aa00000000001, that would be tied to the authorization transaction. Refer to our detailed

Order documentation

for more details.

Use the below endpoint to create an order.

POST

/orders

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

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. For example, cust_1Aa00000000001.

token

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

max_amount

mandatory

integer The maximum amount that can be auto-debited in a single charge. The minimum value is 100 (₹1 ), and the maximum value is 1500000 (₹15,000). For an amount higher than this, the cardholder should provide an Additional Factor of Authentication (AFA) as per RBI guidelines.

expire_at

mandatory

integer The Unix timestamp that indicates when the authorization transaction must expire. The default value is 10 years.

frequency

mandatory

string The frequency at which you can charge your customer. Currently supported frequencies are as_presented and monthly. The support for other frequencies is expected to be live soon.

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.

notes

optional

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

<script type="text/javascript" src="https://checkout.razorpay.com/v1/razorpay.js"></script>
<script src= "https://ajax.googleapis.com/ajax/libs/jquery/3.3.1/jquery.min.js"> </script>
  <body><button id="btn" style="background-color: #3399cc; color: white; font-size: 16px; font-family: sans-serif">Pay</button>
<script>
  const btn = document.querySelector("#btn");
                var razorpay = new Razorpay({
                  key: "<YOUR_TEST_KEY>",
                  image: "https://i.imgur.com/n5tjHFD.jpg"
                });
          razorpay.once("ready", function(response) {
            console.log(response.methods);
          })
          var data = {
      "amount": 100, // in currency subunits. Here 1000 = 1000 paise, which equals to ₹10
      "currency": "INR",// Default is INR. We support more than 90 currencies.
      "email": "gaurav.kumar@example.com",
      "contact": "9123456780",
      "notes": {
        "address": "Ground Floor, SJR Cyber, Laskar Hosur Road, Bengaluru",
      },
      "order_id": "order_00000000000001",
      "customer_id": "cust_00000000000001",
      "recurring": "1",
      "save": 1,
      "consent_to_save_card": 1,
      "method": "card",
      "card[name]": "Gaurav Kumar",
      "card[number]": "5104015555555558",
      "card[cvv]": "123",
      "card[expiry_month]": "10",
      "card[expiry_year]": "25"
    };
      btn.addEventListener("click", function(){ // has to be placed within user initiated context, such as click, in order for popup to open.
      razorpay.createPayment(data);
      razorpay.on("payment.success", function(resp) {
        alert(resp.razorpay_payment_id),
        alert(resp.razorpay_order_id),
        alert(resp.razorpay_signature)}); // will pass payment ID, order ID, and Razorpay signature to success handler.
      razorpay.on("payment.error", function(resp){alert(resp.error.description)}); // will pass error object to error handler
    })
  </script>
</body>

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

save

mandatory

integer Indicates whether to save the card details. Possible values:

1: Save the card details.
0: Do not save the card details.

consent_to_save_card

mandatory

integer Indicates whether you have taken the customer's consent for tokenising the card. Possible values:

1: Taken the customer's consent.
0: Not taken the customer's consent.

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

1.2.1. Create a Registration Link

Use the below endpoint to create a registration link.

POST

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

mandatory

string Customer's email address.

contact

mandatory

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:

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

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

{
    "id": "inv_FHrfRupD2ouKIt",
    "entity": "invoice",
    "receipt": "Receipt No. 1",
    "invoice_number": "Receipt No. 1",
    "customer_id": "cust_BMB3EwbqnqZ2EI",
    "customer_details": {
        "id": "cust_BMB3EwbqnqZ2EI",
        "name": "Alex Lim",
        "email": "alex.lim@example.com",
        "contact": "+6591119111",
        "gstin": null,
        "billing_address": null,
        "shipping_address": null,
        "customer_name": "Alex Lim",
        "customer_email": "alex.lim@example.com",
        "customer_contact": "+6591119111"
    },
    "order_id": "order_FHrfRw4TZU5Q2L",
    "line_items": [],
    "payment_id": null,
    "status": "cancelled",
    "expire_by": 4102444799,
    "issued_at": 1595491479,
    "paid_at": null,
    "cancelled_at": 1595491488,
    "expired_at": null,
    "sms_status": "sent",
    "email_status": "sent",
    "date": 1595491479,
    "terms": null,
    "partial_payment": false,
    "gross_amount": 100,
    "tax_amount": 0,
    "taxable_amount": 0,
    "amount": 100,
    "amount_paid": 0,
    "amount_due": 100,
    "currency": "SGD",
    "currency_symbol": "S$",
    "description": "Registration Link",
    "notes": {
        "note_key 1": "Beam me up Scotty",
        "note_key 2": "Tea. Earl Gray. Hot."
    },
    "comment": null,
    "short_url": "https://rzp.io/i/QlfexTj",
    "view_less": true,
    "billing_start": null,
    "billing_end": null,
    "type": "link",
    "group_taxes_discounts": false,
    "created_at": 1595491480,
    "idempotency_key": null
}

Path Parameter

mandatory

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