1. Initiate Mandate Registration

Available in🇮🇳 India

UPI Collect Flow DeprecatedAccording to NPCI guidelines, the UPI Collect flow is being deprecated for new UPI Autopay registrations effective 28 February 2026.

Customers can no longer register UPI mandates by manually entering VPA/UPI id/mobile numbers.
Subsequent debits for existing mandates created via UPI Collect will continue to be executed without change.

ExemptionsUPI Collect will continue to be supported for:

MCC 6012 & 6211 (IPO and secondary market transactions).
iOS mobile app and mobile web transactions.
UPI Mandates (execute/modify/revoke operations only).
eRupi vouchers.
PACB businesses (cross-border/international payments).

Action Required

If you are a new Razorpay user, use UPI Intent.
If you are an existing Razorpay user not covered by exemptions, you must remove the UPI Collect flow parameters from your Create Authorization Payment API request and migrate to UPI Intent or UPI QR code to continue accepting UPI Autopay registrations. For detailed migration steps, refer to the migration documentation.

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 initiate mandate registration using the Razorpay APIs or a Registration Link. The following state diagram depicts the mandate registration flow and token lifecycle: UPI Autopay mandate registration and token state flow

UPI Autopay mandate registration and token state flow

A token changes state as the customer and your business act on it:

If the authorisation payment fails, the token moves to the rejected state.
Once a token is confirmed, it never moves to rejected. It moves only to paused or cancelled.
When the customer resumes a paused token, it moves back to confirmed.
When you cancel a token, it stays in the cancellation_initiated state until the downstream partner confirms the cancellation. It then moves to cancelled.

Refer to Token States for all states and the webhooks generated for each.

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.

1.1.1 Create a Customer

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

curl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET] \
-X POST https://api.razorpay.com/v1/customers \
-H "Content-Type: application/json" \
-d '{
  "name": "Gaurav Kumar",
  "email": "gaurav.kumar@example.com",
  "contact": "9123456780",
  "notes":{
    "note_key_1": "September",
    "note_key_2": "Make it so."
  }
}'

RazorpayClient razorpay = new RazorpayClient("[YOUR_KEY_ID]", "[YOUR_KEY_SECRET]");

JSONObject customerRequest = new JSONObject();
customerRequest.put("name","Gaurav Kumar");
customerRequest.put("contact","9123456780");
customerRequest.put("email","gaurav.kumar@example.com");
customerRequest.put("gstin","29XAbbA4369J1PA");
JSONObject notes = new JSONObject();
notes.put("notes_key_1","Tea, Earl Grey, Hot");
notes.put("notes_key_2","Tea, Earl Grey… decaf.");
customerRequest.put("notes",notes);

Customer customer = razorpay.customers.create(customerRequest);

import razorpay
client = razorpay.Client(auth=("YOUR_ID", "YOUR_SECRET"))

client.customer.create({
    'name': 'Gaurav Kumar',
    'email': 'gaurav.kumar@example.com',
    'contact': '9123456780',
    'notes': {'note_key_1': 'September', 'note_key_2': 'Make it so.'}
    })

import ( razorpay "github.com/razorpay/razorpay-go" )
client := razorpay.NewClient("YOUR_KEY_ID", "YOUR_SECRET")

data := map[string]interface{}{
    "name": "Gaurav Kumar",
    "contact": 9123456780,
    "email": "gaurav.kumar@example.com",
    "notes": map[string]interface{}{
        "notes_key_1": "Tea, Earl Grey, Hot",
        "notes_key_2": "Tea, Earl Grey… decaf.",
    },
}
body, err := client.Customer.Create(data, nil)

$api = new Api($key_id, $secret);

$api->customer->create(array('name' => 'Gaurav Kumar', 'email' => 'gaurav.kumar@example.com','contact'=>'9123456780','notes'=> array('notes_key_1'=> 'Tea, Earl Grey, Hot','notes_key_2'=> 'Tea, Earl Grey… decaf'));

RazorpayClient client = new RazorpayClient("[YOUR_KEY_ID]", "[YOUR_KEY_SECRET]");

Dictionary<string, object> options = new Dictionary<string,object>();

options.Add("name", "Gaurav Kumar"); 
options.Add("contact", "9123456780"); 
options.Add("email", "gaurav.kumar@example.com"); 

Customer customer = Customer.Create(options);

require "razorpay"
Razorpay.setup('YOUR_KEY_ID', 'YOUR_SECRET')

para_attr = {
  "name": "Gaurav Kumar",
  "contact": 9123456780,
  "email": "gaurav.kumar@example.com",
  "gstin": "29XAbbA4369J1PA",
  "notes": {
    "notes_key_1": "Tea, Earl Grey, Hot",
    "notes_key_2": "Tea, Earl Grey… decaf."
  }
}

Razorpay::Customer.create(para_attr)

var instance = new Razorpay({ key_id: 'YOUR_KEY_ID', key_secret: 'YOUR_SECRET' })

instance.customers.create({
  name: "Gaurav Kumar",
  contact: 9123456780,
  email: "gaurav.kumar@example.com",
  gstin: "29XAbbA4369J1PA",
  notes: {
    notes_key_1: "Tea, Earl Grey, Hot",
    notes_key_2: "Tea, Earl Grey… decaf."
  }
})

{
   "id":"cust_1Aa00000000001",
   "entity":"customer",
   "name":"Gaurav Kumar",
   "email":"gaurav.kumar@example.com",
   "contact":"9123456780",
   "gstin":null,
   "notes":{
      "note_key_1":"September",
      "note_key_2":"Make it so."
   },
   "created_at ":1234567890
}

Once you create a customer, you can create an order for the mandate registration.

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.notes optional : object 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.1.2 Create an Order

Use the Orders API to create a unique Razorpay order_id that is associated with the mandate registration. The following endpoint creates an order. POST /orders

Sample Code

curl -u <YOUR_KEY_ID>:<YOUR_KEY_SECRET> \
-X POST https://api.razorpay.com/v1/orders \
-H "Content-Type: application/json" \
-d '{
  "amount": 100,
  "currency": "INR",
  "customer_id": "cust_4xbQrmEoA5WJ01",
  "method": "upi",
  "token": {
    "max_amount": 200000,
    "expire_at": 2709971120,
    "frequency": "monthly"
  },
  "receipt": "Receipt No. 1",
  "description": "Monthly Pro subscription",
  "notes": {
    "notes_key_1": "Tea, Earl Grey, Hot",
    "notes_key_2": "Tea, Earl Grey… decaf."
  }
}'

RazorpayClient razorpay = new RazorpayClient("[YOUR_KEY_ID]", "[YOUR_KEY_SECRET]");

JSONObject orderRequest = new JSONObject();
orderRequest.put("amount", 100);
orderRequest.put("currency", "INR");
orderRequest.put("customer_id", "cust_4xbQrmEoA5WJ01");
orderRequest.put("method", "upi");
orderRequest.put("receipt", "receipt#1");
JSONObject token = new JSONObject();
token.put("max_amount","200000"); 
token.put("expire_at","2709971120");
token.put("frequency","monthly");
orderRequest.put("token", token);
JSONObject notes = new JSONObject();
notes.put("notes_key_1","Tea, Earl Grey, Hot");
notes.put("notes_key_2","Tea, Earl Grey… decaf.");
orderRequest.put("notes", notes);

Order order = razorpay.orders.create(orderRequest);

$api = new Api($key_id, $secret);

$api->order->create(array('amount' => 0,'currency' => 'INR','method' => 'upi','customer_id' => 'cust_4xbQrmEoA5WJ01', 'token' => array('max_amount' => 200000, 'expire_at' => 2709971120, 'frequency' => 'monthly'),'receipt' => 'Receipt No. 1' ,'notes' => array('notes_key_1' => 'Beam me up Scotty','notes_key_2' => 'Engage')));

var instance = new Razorpay({ key_id: 'YOUR_KEY_ID', key_secret: 'YOUR_SECRET' })

instance.orders.create({
  amount: 100,
  currency: "INR",
  method: "upi",
  customer_id: "cust_1Aa00000000001",
  receipt: "Receipt No. 1",
  notes: {
    notes_key_1: "Beam me up Scotty",
    notes_key_2: "Engage"
  },
  token: {
    max_amount: 200000,
    expire_at: 2709971120,
    frequency: "monthly"
  }
})

client = razorpay.Client(auth=("YOUR_ID", "YOUR_SECRET"))

client.order.create({
   "amount":100,
   "currency":"INR",
   "method":"upi",
   "customer_id":"cust_1Aa00000000001",
   "receipt":"Receipt No. 1",
   "notes":{
      "notes_key_1":"Beam me up Scotty",
      "notes_key_2":"Engage"
   },
   "token":{
      "max_amount":200000,
      "expire_at":2709971120,
      "frequency":"monthly"
   }
})

require "razorpay"
Razorpay.setup('YOUR_KEY_ID', 'YOUR_SECRET')

para_attr = {
  "amount": 100,
  "currency": "INR",
  "method": "upi",
  "customer_id": "cust_1Aa00000000001",
  "receipt": "Receipt No. 1",
  "notes": {
    "notes_key_1": "Beam me up Scotty",
    "notes_key_2": "Engage"
  },
  "token": {
    "max_amount": 200000,
    "expire_at": 2709971120,
    "frequency": "monthly"
  }
}
Razorpay.Order.create(para_attr)

import ( razorpay "github.com/razorpay/razorpay-go" )
client := razorpay.NewClient("YOUR_KEY_ID", "YOUR_SECRET")

data := map[string]interface{}{
   "amount":100,
   "currency":"INR",
   "customer_id":"<customerId>",
   "method":"upi",
   "token":map[string]interface{}{
      "max_amount":5000,
      "expire_at":2709971120,
      "frequency":"monthly",
   },
   "receipt":"Receipt No. 1",
   "notes":map[string]interface{}{
      "notes_key_1":"Tea, Earl Grey, Hot",
      "notes_key_2":"Tea, Earl Grey… decaf.",
   },
}
body, err := client.Order.Create(data, nil)

{
  "id": "order_1Aa00000000002",
  "entity": "order",
  "amount": 100,
  "amount_paid": 0,
  "amount_due": 100,
  "currency": "INR",
  "receipt": "Receipt No. 1",
  "offer_id": null,
  "status": "created",
  "attempts": 0,
  "notes": {
    "notes_key_1": "Tea, Earl Grey, Hot",
    "notes_key_2": "Tea, Earl Grey… decaf."
    }
  "created_at": 1565172642
}

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

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 mandate registration. 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.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 (maximum) 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 mandate 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 Next Steps by Platform.

expire_at optional : integer The Unix timestamp that indicates when the mandate must expire. Defaults to 10 years.frequency mandatory : string The frequency at which you can charge your customer. Possible values:

weekly
monthly
quarterly
yearly
as_presented

1.1.3 Create an Authorisation Payment

Once an order is created, your next step is to create a payment to initiate the mandate registration on the customer’s UPI app. The UPI payment flow you use determines how the customer approves the mandate:

UPI Intent (recommended): The customer is redirected to their preferred UPI app (or scans a QR code on desktop) to approve the mandate. This is the default flow.
UPI Collect (deprecated): A collect request is sent to the customer’s VPA (UPI ID). This flow is being deprecated for new UPI Autopay registrations effective 28 February 2026. For iOS users, you may continue to use the Collect flow as a fallback.

Use the below endpoint to create a payment with payment method upi. POST /payments/create/upi

Sample Code

UPI Intent

curl -u <YOUR_KEY_ID>:<YOUR_KEY_SECRET> \
-X POST https://api.razorpay.com/v1/payments/create/upi \
-H "Content-Type: application/json" \
-d '{
   "amount":10000,
   "currency":"INR",
   "order_id":"order_1Aa00000000002",
   "customer_id":"cust_1Aa00000000001",
   "recurring":"1",
   "method":"upi",
   "upi":{
      "flow":"intent"
   },
   "notes":{
      "address":"note value"
   }
}'

{
   "razorpay_payment_id": "pay_R1D5dVYdY67f7M",
   "link": "upi://mandate?mc=5045&amrule=MAX&am=1.00&fam=1.00&tr=EZM2025080415061922323116&validitystart=04082025&pn=Demo&rev=Y&pa=demotestrzp.rzp@icici&tn=Demo&cu=INR&txnType=CREATE&block=N&orgid=400011&mode=04&recur=ASPRESENTED&purpose=14&validityend=03072035"
}

UPI Collect (Deprecated)

Before creating the collect payment, validate the customer’s UPI ID using the /payments/validate/vpa endpoint.

 curl -u <YOUR_KEY_ID>:<YOUR_KEY_SECRET> \
 -X POST https://api.razorpay.com/v1/payments/validate/vpa \
 -H "Content-Type: application/json" \
 -d '{
   "vpa": "gauravkumar@exampleupi"
 }'

 {
   "vpa": "gauravkumar@exampleupi",
   "success": true,
   "customer_name": "Gaurav Kumar"
 }

Once the UPI ID is validated, create the authorisation payment with upi.flow set to collect.

curl -u <YOUR_KEY_ID>:<YOUR_KEY_SECRET> \
-X POST https://api.razorpay.com/v1/payments/create/upi \
-H "Content-Type: application/json" \
-d '{
  "amount": 200,
  "currency": "INR",
  "order_id": "order_Ee0biRtLOqzRjP",
  "email": "gaurav.kumar@example.com",
  "contact": "9000090000",
  "customer_id": "cust_EIW4T2etiweBmG",
  "recurring": "1",
  "method": "upi",
  "upi": {
    "flow": "collect",
    "vpa": "gauravkumar@exampleupi",
    "expiry_time": 5
  },
  "ip": "192.168.0.103",
  "referer": "http",
  "user_agent": "Mozilla/5.0",
  "description": "Test flow",
  "save": true,
  "notes": {
    "note_key": "value1"
  }
}'

{
"razorpay_payment_id": "pay_EAm09NKReXi2e0"
}

Request Parameters

amount mandatory : integer The amount associated with the payment in smallest unit of the supported currency. For example, 2000 means ₹20. Must match the amount in order created previously.currency mandatory : string The 3-letter ISO currency code for the payment. Currently, we support only INR.order_id mandatory : string The unique identifier of the order created in the previous step.customer_id mandatory : string Unique identifier of the customer, obtained from the response of Step 1.1.1: Create a Customer.recurring mandatory : string Determines if the payment is recurring or one-time. 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.

method mandatory : string The payment method selected by the customer. Here, the value must be upi.upi : object Details of the UPI payment flow.flow mandatory : string Specify the type of the UPI payment flow.
Possible values are:

intent (default, recommended)
collect: Deprecated effective 28 February 2026. For iOS users, you may continue to use the Collect flow as a fallback.

notes optional : json object Key-value pairs that can hold additional information about the payment.UPI Intent flowNo additional parameters are required for the UPI Intent flow.UPI Collect flow (deprecated)Pass these parameters in addition to the parameters above.vpa mandatory : string VPA of the customer where the collect request will be sent. Applicable only to the UPI Collect flow.expiry_time optional : integer Period of time (in minutes) after which the collect request will expire. The default value is 5. Applicable only to the UPI Collect flow.email mandatory : string The customer’s email address. For example, gaurav.kumar@example.com.contact mandatory : string The customer’s contact number. For example, 9123456780.ip mandatory : string Client’s browser IP address. For example, 117.217.74.98.referer mandatory : string Value of referer header passed by the client’s browser. For example, https://example.com/user_agent mandatory : string Value of user_agent header passed by the client’s browser.
For example, Mozilla/5.0 (Windows NT 6.1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/79.0.3945.130 Safari/537.36save optional : boolean Applicable only to the UPI Collect flow. Specifies if the VPA should be stored as a token. Possible values:

true: Saves the VPA details.
false(default): Does not save the VPA details.

Response Parameters

If the payment request is valid, the response contains the following fields. Refer to the UPI Intent Flow document or the UPI Collect Flow document for more details.razorpay_payment_id : string Unique reference for the payment created. For example, pay_EAm09NKReXi2e0.link : string Returned only for the UPI Intent flow. The UPI intent link to redirect the customer to their UPI app for mandate approval. Use this as a deeplink on mobile or convert it to a QR code for desktop.

Once the authorisation payment is completed, you receive the corresponding 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.

Next Steps by Platform

For the UPI Intent flow, use the link returned in the response to take the customer to their UPI app:

mWeb and Mobile App
Desktop Web

Use the link returned in the response as a deeplink to redirect the customer to their preferred UPI app to complete the mandate registration.

UPI Intent is not supported on Desktop Web. Convert the link returned in the response into a QR code and display it on your checkout UI for the customer to scan with their preferred UPI app.

For the UPI Collect flow, a collect request is sent to the customer’s VPA. The customer must open their UPI app and approve the mandate request before it expires. Some merchant categories are exempted from the Collect deprecation. For the limits by merchant category, refer to UPI Transaction Limits.

Watch Out!If you are a TPV (third-party validation) merchant, show a clear message to the customer just before UPI app selection asking them to choose only the bank account they have already registered with you. On S2S and custom checkout integrations, app and account selection happens on your interface, so this prompt is your responsibility. If the customer authorises the mandate from a non-registered account, the registration may succeed but all subsequent debits will fail TPV validation.

1.2 Using a Registration Link

Registration Links are an alternate way of initiating mandate registration. If you create a registration link, you need not create a customer or an order separately. When you create a registration link, an invoice is automatically issued to the customer. The customer can use the invoice to complete the mandate registration. Know how to create Registration Links using the Dashboard.

Handy TipsYou can use webhooks to get notifications about successful payments against a registration link. Know more about Webhooks.

A registration link must always have the amount (in paise) that the customer will be charged when making the authorisation 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

Sample Code

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"
  },
  "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."
  }
}'

RazorpayClient razorpay = new RazorpayClient("[YOUR_KEY_ID]", "[YOUR_KEY_SECRET]");

JSONObject registrationLinkRequest = new JSONObject();
JSONObject customer = new JSONObject();
customer.put("name","Gaurav Kumar");
customer.put("email","gaurav.kumar@example.com");
customer.put("contact","9123456780");
registrationLinkRequest.put("customer", customer);
registrationLinkRequest.put("type", "link");
registrationLinkRequest.put("amount", 100);
registrationLinkRequest.put("currency", "INR");
registrationLinkRequest.put("description", "Registration Link for Gaurav Kumar");
JSONObject subscriptionRegistration = new JSONObject();
subscriptionRegistration.put("method","upi");
subscriptionRegistration.put("max_amount",50000);
subscriptionRegistration.put("expire_at",1609423824);
subscriptionRegistration.put("frequency","monthly");
registrationLinkRequest.put("subscription_registration", subscriptionRegistration);
registrationLinkRequest.put("receipt", "Receipt No. #112");
registrationLinkRequest.put("email_notify", true);
registrationLinkRequest.put("sms_notify", true);
registrationLinkRequest.put("expire_by", 1580479824);
JSONObject notes = new JSONObject();
notes.put("notes_key_1","Tea, Earl Grey, Hot");
notes.put("notes_key_2","Tea, Earl Grey… decaf.");
registrationLinkRequest.put("notes", notes);

Invoice invoice = razorpay.invoices.createRegistrationLink(registrationLinkRequest);

$api = new Api($key_id, $secret);

$api->subscription->createSubscriptionRegistration(array('customer'=>array('name'=>'Gaurav Kumar','email'=>'gaurav.kumar@example.com','contact'=>'9123456780'),'type'=>'link','amount'=>100,'currency'=>'INR','description'=>'Registration Link for Gaurav Kumar','subscription_registration'=>array('method'=>'upi','max_amount'=>'500','expire_at'=>'1634215992','frequency'=>'monthly'),'receipt'=>'Receipt No. 5','email_notify'=>true,'sms_notify'=>true,'expire_by'=>1634215992,'notes' => array('note_key 1' => 'Beam me up Scotty','note_key 2' => 'Tea. Earl Gray. Hot.')));

var instance = new Razorpay({ key_id: 'YOUR_KEY_ID', key_secret: 'YOUR_SECRET' })

instance.subscriptions.createRegistrationLink({
  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: 1634215992,
    frequency: "monthly"
  },
  receipt: "Receipt No. 5",
  email_notify: true,
  sms_notify: true,
  expire_by: 1634215992,
  notes: {
    "note_key 1": "Beam me up Scotty",
    "note_key 2": "Tea. Earl Gray. Hot."
  }
})

require "razorpay"
Razorpay.setup('YOUR_KEY_ID', 'YOUR_SECRET')

para_attr = {
  "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": 1634215992,
    "frequency": "monthly"
  },
  "receipt": "Receipt No. 5",
  "email_notify": 1,
  "sms_notify": 1,
  "expire_by": 1634215992,
  "notes": {
    "note_key 1": "Beam me up Scotty",
    "note_key 2": "Tea. Earl Gray. Hot."
  }
}
Razorpay::SubscriptionRegistration.create(para_attr)

client = razorpay.Client(auth=("YOUR_ID", "YOUR_SECRET"))

client.registration_link.create({
  "customer":{
      "name":"Gaurav Kumar",
      "email":"gaurav.kumar@example.com",
      "contact":9123456780
  },
  "type":"link",
  "amount":100,
  "currency":"INR",
  "description":"12 p.m. Meals",
  "subscription_registration":{
      "method":"upi",
      "expire_at":1580480689,
      "max_amount":500,
      "frequency":"monthly"
  },
  "receipt":"Receipt no. 1",
  "expire_by":1880480689,
  "sms_notify": True,
  "email_notify": True,
  "notes":{
      "note_key 1":"Beam me up Scotty",
      "note_key 2":"Tea. Earl Gray. Hot."
  }
})

import ( razorpay "github.com/razorpay/razorpay-go" )
client := razorpay.NewClient("YOUR_KEY_ID", "YOUR_SECRET")

data:= map[string]interface{}{
  "customer":map[string]interface{}{
    "name":"Gaurav Kumar",
    "email":"gaurav.kumar@example.com",
    "contact":"9123456780",
  },
  "type":"link",
  "amount":"100",
  "currency":"INR",
  "description":"Registration Link for Gaurav Kumar",
  "subscription_registration":map[string]interface{}{
    "method":"upi",
    "max_amount":"500",
    "expire_at":1609423824,
    "frequency": "monthly",
  },
  "receipt":"Receipt No. 1",
  "email_notify":true,
  "sms_notify":true,
  "expire_by":1681987284,
  "notes":map[string]interface{}{
    "note_key 1":"Beam me up Scotty",
    "note_key 2":"Tea. Earl Gray. Hot.",
  },
}
body, err := client.Invoice.CreateRegistrationLink(data, nil)

{
  "id": "inv_FHr1ekX0r2VCVK",
  "entity": "invoice",
  "receipt": "Receipt No. 23",
  "invoice_number": "Receipt No. 23",
  "customer_id": "cust_BMB3EwbqnqZ2EI",
  "customer_details": {
    "id": "cust_BMB3EwbqnqZ2EI",
    "name": "Gaurav Kumar",
    "email": "gaurav.kumar@example.com",
    "contact": "9123456780",
    "gstin": null,
    "billing_address": null,
    "shipping_address": null,
    "customer_name": "Gaurav Kumar",
    "customer_email": "gaurav.kumar@example.com",
    "customer_contact": "9123456780"
  },
  "order_id": "order_FHr1ehR3nmNeXo",
  "line_items": [],
  "payment_id": null,
  "status": "issued",
  "expire_by": 4102444799,
  "issued_at": 1595489219,
  "paid_at": null,
  "cancelled_at": null,
  "expired_at": null,
  "sms_status": "pending",
  "email_status": "pending",
  "date": 1595489219,
  "terms": null,
  "partial_payment": false,
  "gross_amount": 100,
  "tax_amount": 0,
  "taxable_amount": 0,
  "amount": 100,
  "amount_paid": 0,
  "amount_due": 100,
  "currency": "INR",
  "currency_symbol": "₹",
  "description": "Registration Link for Gaurav Kumar",
  "notes": {
    "note_key 1": "Beam me up Scotty",
    "note_key 2": "Tea. Earl Gray. Hot."
  },
  "comment": null,
  "short_url": "https://rzp.io/i/ak1WxDB",
  "view_less": true,
  "billing_start": null,
  "billing_end": null,
  "type": "link",
  "group_taxes_discounts": false,
  "created_at": 1595489219,
  "idempotency_key": null
}

Request Parameters

customer : object Details of the customer to whom the registration link is sent.name mandatory : string Customer’s name.email mandatory : string Customer’s email address.contactmandatory : 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 mandate registration.method mandatory : string The payment method used for mandate registration. Here, it is upi.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 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

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

Sample Code

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

 RazorpayClient razorpay = new RazorpayClient("[YOUR_KEY_ID]", "[YOUR_KEY_SECRET]");

 String invoiceId = "inv_1Aa00000000001";

 String medium = "sms";

 Invoice invoice = razorpay.invoices.notifyBy(invoiceId, medium);

 $api = new Api($key_id, $secret);

 $api->invoice->fetch($invoiceId)->notify($medium);

 var instance = new Razorpay({ key_id: 'YOUR_KEY_ID', key_secret: 'YOUR_SECRET' })

 instance.invoices.notifyBy(invoiceId, medium)

 client = razorpay.Client(auth=("YOUR_ID", "YOUR_SECRET"))

 client.invoice.notify_by(invoiceId, medium)

 require "razorpay"
 Razorpay.setup('YOUR_KEY_ID', 'YOUR_SECRET')

 invoiceId = "inv_JDdNb4xdf4gxQ7"

 medium = "email" 

 Razorpay::Invoice.notify_by(invoiceId, medium)

 import ( razorpay "github.com/razorpay/razorpay-go" )
 client := razorpay.NewClient("YOUR_KEY_ID", "YOUR_SECRET")

 body, err := client.Invoice.Notify("<invoiceId>", "<medium>", nil, nil)

 RazorpayClient client = new RazorpayClient("[YOUR_KEY_ID]", "[YOUR_KEY_SECRET]");

 string invoiceId = "inv_Z6t7VFTb9xHeOs";

 string medium = "sms";

 Invoice invoice = client.Invoice.Fetch(invoiceId).NotifyBy(medium);

Response

{
  "success": true
}

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:

sms
email

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

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

 RazorpayClient razorpay = new RazorpayClient("[YOUR_KEY_ID]", "[YOUR_KEY_SECRET]");

 String invoiceId = "inv_1Aa00000000001";

 Invoice invoice = razorpay.invoices.cancel(invoiceId);

 $api = new Api($key_id, $secret);

 $api->invoice->fetch($invoiceId)->cancel();

 var instance = new Razorpay({ key_id: 'YOUR_KEY_ID', key_secret: 'YOUR_SECRET' })

 instance.invoices.cancel(invoiceId)

 client = razorpay.Client(auth=("YOUR_ID", "YOUR_SECRET"))

 client.invoice.cancel(invoiceId)

 require "razorpay"
 Razorpay.setup('YOUR_KEY_ID', 'YOUR_SECRET')

 invoiceId = "inv_1Aa00000000001"

 Razorpay::Invoice.cancel(invoiceId)

 import ( razorpay "github.com/razorpay/razorpay-go" )
 client := razorpay.NewClient("YOUR_KEY_ID", "YOUR_SECRET")

 body, err := client.Invoice.Cancel("<invoiceId>", nil, nil)

 RazorpayClient client = new RazorpayClient("[YOUR_KEY_ID]", "[YOUR_KEY_SECRET]");

 string invoiceId = "inv_Z6t7VFTb9xHeOs";

 Invoice invoice = client.Invoice.Fetch(invoiceId).Cancel();

Response

{
  "id": "inv_FHrfRupD2ouKIt",
  "entity": "invoice",
  "receipt": "Receipt No. 1",
  "invoice_number": "Receipt No. 1",
  "customer_id": "cust_BMB3EwbqnqZ2EI",
  "customer_details": {
      "id": "cust_BMB3EwbqnqZ2EI",
      "name": "<n>",
      "email": "<email>",
      "contact": "<phone>",
      "gstin": null,
      "billing_address": null,
      "shipping_address": null,
      "customer_name": "<n>",
      "customer_email": "<email>",
      "customer_contact": "<phone>"
  },
  "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": "INR",
  "currency_symbol": "₹",
  "description": "Registration Link for Gaurav Kumar",
  "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

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

1.3 Error Scenarios

If the authorisation payment fails, the payment entity carries error fields such as error_code, error_source, error_step and error_reason. Use the error_reason to decide the next action for the customer. For the UPI error reasons, descriptions and recommended next steps, refer to UPI Error Codes.

​1.1 Using Razorpay APIs

​1.1.1 Create a Customer

​1.1.2 Create an Order

​1.1.3 Create an Authorisation Payment

​Next Steps by Platform

​1.2 Using a Registration Link

​1.2.1 Create a Registration Link

​1.2.2 Send/Resend Notifications

​1.2.3 Cancel a Registration Link

​Path Parameter

​1.3 Error Scenarios

1.1 Using Razorpay APIs

1.1.1 Create a Customer

1.1.2 Create an Order

1.1.3 Create an Authorisation Payment

Next Steps by Platform

1.2 Using a Registration Link

1.2.1 Create a Registration Link

1.2.2 Send/Resend Notifications

1.2.3 Cancel a Registration Link

Path Parameter

1.3 Error Scenarios