Charge First Payment Automatically after NACH Registration

The flow to complete an authorisation transaction using paper NACH differs from the other payment method’s flow.

Create a customer.

Create an order by passing the `customer_id` and the method as `nac...

Create an order by passing the customer_id and the method as nach. Razorpay generates a NACH form with the customer information pre-filled and ready to sign.

The customer can get the form in one of the following ways to sign it:

You can download the form from the Dashboard and send it to the customer.
A customer can download the form from the Hosted page (in the case of registration links).

The signed form can be uploaded in one of the following ways:

Using the Standard Checkout page.
Hosted page (in the case of registration links).
The customer can send you the form and you can upload the form for the customer. The acceptable image formats and size are:
jpeg
jpg
png
Maximum accepted size is 6 MB.

Once the details are validated, the authorisation transaction is completed and a token is generated. You can charge your customer as per your business model after the token status changes to confirmed.

1. Create an Authorisation Transaction

You can create an authorisation transaction:

Using the Razorpay Standard Checkout.
Using a Registration Link.

1.1. Using Razorpay Standard Checkout

To create an authorisation transaction using the Razorpay Standard Checkout, you need to:

[Create a Customer](#111-create-a-customer).

Create a Customer.

[Create an Order](#112-create-an-order).

Create an Order.

[Create Authorisation Payment using Razorpay Standard Checkout](#11...

Create Authorisation Payment using Razorpay Standard Checkout.

1.1.1. Create a Customer

Razorpay links recurring tokens to customers using a unique identifier generated through 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. /customers

Sample Code

Curl

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": "+919876543210",
  "fail_existing": "0",
  "notes":{
    "note_key_1": "September",
    "note_key_2": "Make it so."
  }
}'

```java: Java
RazorpayClient razorpay = new RazorpayClient("[YOUR_KEY_ID]", "[YOUR_KEY_SECRET]");

JSONObject customerRequest = new JSONObject();
customerRequest.put("name","Gaurav Kumar");
customerRequest.put("contact","+919876543210");
customerRequest.put("email","gaurav.kumar@example.com");
customerRequest.put("fail_existing", "0");
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);

```python: Python
import razorpay
client = razorpay.Client(auth=("YOUR_ID", "YOUR_SECRET"))

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

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

data := map[string]interface{}{
    "name": "Gaurav Kumar",
    "contact": +919876543210,
    "email": "gaurav.kumar@example.com",
    "fail_existing": "0",
    "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)

```php: PHP
$api = new Api($key_id, $secret);

$api->customer->create(array('name' => 'Gaurav Kumar', 'email' => 'gaurav.kumar@example.com','contact'=>'+919876543210','fail_existing' => "0", 'notes'=> array('notes_key_1'=> 'Tea, Earl Grey, Hot','notes_key_2'=> 'Tea, Earl Grey… decaf'));
```csharp: .NET
RazorpayClient client = new RazorpayClient("[YOUR_KEY_ID]", "[YOUR_KEY_SECRET]");

Dictionary options = new Dictionary();

options.Add("name", "Gaurav Kumar"); 
options.Add("contact", "+919876543210"); 
options.Add("email", "gaurav.kumar@example.com"); 
options.Add("fail_existing", "0"); 

Customer customer = Customer.Create(options);

```ruby: Ruby
require "razorpay"
Razorpay.setup('YOUR_KEY_ID', 'YOUR_SECRET')

para_attr = {
  "name": "Gaurav Kumar",
  "contact": "+919876543210",
  "email": "gaurav.kumar@example.com",
  "fail_existing": "0",
  "notes": {
    "notes_key_1": "Tea, Earl Grey, Hot",
    "notes_key_2": "Tea, Earl Grey… decaf."
  }
}

Razorpay::Customer.create(para_attr)

```javascript: Node.js
var instance = new Razorpay({ key_id: 'YOUR_KEY_ID', key_secret: 'YOUR_SECRET' })

instance.customers.create({
  name: "Gaurav Kumar",
  contact: "+919876543210",
  email: "gaurav.kumar@example.com",
  fail_existing: "0",
  notes: {
    notes_key_1: "Tea, Earl Grey, Hot",
    notes_key_2: "Tea, Earl Grey… decaf."
  }
})

Response

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

Request Parameters

name : string The name of the customer. For example, Gaurav Kumar. email : string The email address of the customer. For example, gaurav.kumar@example.com. contact : string The phone number of the customer. 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”.

Response Parameters

id : string The unique identifier of the customer. For example cust_1Aa00000000001. entity : string The name of the entity. Here, it is customer. name : string The name of the customer. For example, Gaurav Kumar. email : string The email address of the customer. For example, gaurav.kumar@example.com. contact : string The phone number of the customer. For example, 9876543210. notes : 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”. created_at : integer A Unix timestamp, at which the customer was created. You can create an order once you create a customer for the payment authorisation.

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

Curl

curl -u : \
-X POST https://api.razorpay.com/v1/orders \
-H "Content-Type: application/json" \
-d '{
  "amount":0,
  "currency":"INR",
  "method":"nach",
  "customer_id": "cust_1Aa00000000001",
  "receipt": "Receipt No. 1",
  "notes": {
    "notes_key_1": "Beam me up Scotty",
    "notes_key_2": "Engage"
  },
  "token":{
    "first_payment_amount": 10000,
    "auth_type":"physical",
    "max_amount":10000000,
    "expire_at":1580480689,
    "notes": {
      "notes_key_1": "Tea, Earl Grey, Hot",
      "notes_key_2": "Tea, Earl Grey… decaf."
    },
    "bank_account":{
      "account_number":"11214311215411",
      "ifsc_code":"HDFC0000001",
      "beneficiary_name":"Gaurav Kumar",
      "account_type":"savings"
    },
    "nach":{
      "form_reference1":"Recurring Payment for Gaurav Kumar",
      "form_reference2":"Method Paper NACH",
      "description":"Paper NACH Gaurav Kumar"
    }
  }
}'

```java: Java
RazorpayClient razorpay = new RazorpayClient("[YOUR_KEY_ID]", "[YOUR_KEY_SECRET]");

JSONObject orderRequest = new JSONObject();
orderRequest.put("amount", 0);
orderRequest.put("currency", "INR");
orderRequest.put("customer_id", "cust_JDdNazagOgg9Ig");
orderRequest.put("method", "nach");
orderRequest.put("receipt", "receipt#1");
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);
JSONObject token = new JSONObject();
token.put("first_payment_amount",100);
token.put("auth_type","physical");
token.put("max_amount","10000000");
token.put("expire_at","2709971120");
JSONObject tokenNotes = new JSONObject();
tokenNotes.put("notes_key_1","Tea, Earl Grey, Hot");
tokenNotes.put("notes_key_2","Tea, Earl Grey… decaf.");
token.put("notes",tokenNotes);
orderRequest.put("token", token);
JSONObject bankAccount = new JSONObject();
bankAccount.put("beneficiary_name","Gaurav Kumar");
bankAccount.put("account_number","11214311215411");
bankAccount.put("account_type","savings");
bankAccount.put("ifsc_code","HDFC0001233");
token.put("bank_account",bankAccount);
JSONObject nach = new JSONObject();
nach.put("form_reference1","Recurring Payment for Gaurav Kumar");
nach.put("form_reference2","Method Paper NACH");
nach.put("description","Paper NACH Gaurav Kumar");
token.put("nach",nach);

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

```php: PHP
$api = new Api($key_id, $secret);

$api->order->create(array('amount' => 100, 'currency' => 'INR', 'method'=>'nach', 'customer_id'=>$customerId, 'receipt'=>'Receipt No. 5', 'notes'=> array('note_key 1'=> 'Beam me up Scotty','note_key 2'=> 'Tea. Earl Gray. Hot.'), 'token'=>array('first_payment_amount'=>10000, 'auth_type'=>'physical' ,'max_amount'=>'50000','expire_at'=>'1634215992', 'notes'=>array('note_key 1'=> 'Tea, Earl Grey… decaf.','note_key 2'=> 'Tea. Earl Gray. Hot.'), 'bank_account'=>array('beneficiary_name'=>'Gaurav Kumar', 'account_number'=>'11214311215411', 'account_type'=>'savings', 'ifsc_code'=>'HDFC0001233'), 'nach'=> array('form_reference1'=> 'Recurring Payment for Gaurav Kumar','form_reference2'=> 'Method Paper NACH', 'description'=>'Paper NACH Gaurav Kumar'))));

```javascript: Node.js
var instance = new Razorpay({ key_id: 'YOUR_KEY_ID', key_secret: 'YOUR_SECRET' })

instance.orders.create({
  amount: 100,
  currency: "INR",
  method: "nach",
  receipt: "Receipt No. 5",
  notes: {
    "note_key 1": "Beam me up Scotty",
    "note_key 2": "Tea. Earl Gray. Hot."
  },
  token: {
    first_payment_amount: 10000,
    auth_type: "physical",
    max_amount: 50000,
    expire_at: 1634215992,
    notes: {
      "note_key 1": "Tea, Earl Grey… decaf.",
      "note_key 2": "Tea. Earl Gray. Hot."
    },
    bank_account: {
      beneficiary_name: "Gaurav Kumar",
      account_number: "11214311215411",
      account_type: "savings",
      ifsc_code: "HDFC0001233"
    },
    nach: {
      form_reference1: "Recurring Payment for Gaurav Kumar",
      form_reference2: "Method Paper NACH",
      description: "Paper NACH Gaurav Kumar"
    }
  }
})
```python: Python
client = razorpay.Client(auth=("YOUR_ID", "YOUR_SECRET"))

client.order.create({
   "amount":100,
   "currency":"INR",
   "method":"nach",
   "receipt":"Receipt No. 5",
   "notes":{
      "note_key 1":"Beam me up Scotty",
      "note_key 2":"Tea. Earl Gray. Hot."
   },
   "token":{
      "first_payment_amount":10000,
      "auth_type":"physical",
      "max_amount":50000,
      "expire_at":1634215992,
      "notes":{
         "note_key 1":"Tea, Earl Grey… decaf.",
         "note_key 2":"Tea. Earl Gray. Hot."
      },
      "bank_account":{
         "beneficiary_name":"Gaurav Kumar",
         "account_number":11214311215411,
         "account_type":"savings",
         "ifsc_code":"HDFC0001233"
      },
      "nach":{
         "form_reference1":"Recurring Payment for Gaurav Kumar",
         "form_reference2":"Method Paper NACH",
         "description":"Paper NACH Gaurav Kumar"
      }
   }
})

```ruby: Ruby
require "razorpay"
Razorpay.setup('YOUR_KEY_ID', 'YOUR_SECRET')

para_attr = {
  "amount": 100,
  "currency": "INR",
  "method": "nach",
  "receipt": "Receipt No. 5",
  "notes": {
    "note_key 1": "Beam me up Scotty",
    "note_key 2": "Tea. Earl Gray. Hot."
  },
  "token": {
    "first_payment_amount": 10000,
    "auth_type": "physical",
    "max_amount": 50000,
    "expire_at": 1634215992,
    "notes": {
      "note_key 1": "Tea, Earl Grey… decaf.",
      "note_key 2": "Tea. Earl Gray. Hot."
    },
    "bank_account": {
      "beneficiary_name": "Gaurav Kumar",
      "account_number": 11214311215411,
      "account_type": "savings",
      "ifsc_code": "HDFC0001233"
    },
    "nach": {
      "form_reference1": "Recurring Payment for Gaurav Kumar",
      "form_reference2": "Method Paper NACH",
      "description": "Paper NACH Gaurav Kumar"
    }
  }
}
Razorpay.Order.create(para_attr)

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

data := map[string]interface{}{
  "amount":0,
  "currency":"INR",
  "method":"nach",
  "customer_id": "cust_1Aa00000000001",
  "receipt":"Receipt No. 1",
  "notes": map[string]interface{}{
    "notes_key_1": "Beam me up Scotty",
    "notes_key_2": "Engage",
  },
  "token":map[string]interface{}{
    "first_payment_amount": 10000,
    "auth_type":"physical",
    "max_amount":10000000,
    "expire_at":2709971120,
    "notes": map[string]interface{}{
      "notes_key_1": "Tea, Earl Grey, Hot",
      "notes_key_2": "Tea, Earl Grey… decaf.",
    },
    "bank_account":map[string]interface{}{
      "account_number":"11214311215411",
      "ifsc_code":"HDFC0000001",
      "beneficiary_name":"Gaurav Kumar",
      "account_type":"savings",
    },
    "nach":map[string]interface{}{
      "form_reference1":"Recurring Payment for Gaurav Kumar",
      "form_reference2":"Method Paper NACH",
      "description":"Paper NACH Gaurav Kumar",
    },
  },
}
body, err := client.Order.Create(data, nil)

```csharp: .NET
RazorpayClient client = new RazorpayClient("[YOUR_KEY_ID]", "[YOUR_KEY_SECRET]");

Dictionary orderRequest = new Dictionary();
orderRequest.Add("amount", 0);
orderRequest.Add("currency", "INR");
orderRequest.Add("customer_id", "cust_JDdNazagOgg9Ig");
orderRequest.Add("method", "nach");
orderRequest.Add("receipt", "receipt#1");
Dictionary notes = new Dictionary();
notes.Add("notes_key_1","Tea, Earl Grey, Hot");
notes.Add("notes_key_2","Tea, Earl Grey… decaf.");
orderRequest.Add("notes", notes);
Dictionary token = new Dictionary();
token.Add("auth_type","physical");
token.Add("max_amount","10000000");
token.Add("expire_at","2709971120");
Dictionary tokenNotes = new Dictionary();
tokenNotes.Add("notes_key_1","Tea, Earl Grey, Hot");
tokenNotes.Add("notes_key_2","Tea, Earl Grey… decaf.");
token.Add("notes",tokenNotes);
orderRequest.Add("token", token);
Dictionary bankAccount = new Dictionary();
bankAccount.Add("beneficiary_name","Gaurav Kumar");
bankAccount.Add("account_number","11214311215411");
bankAccount.Add("account_type","savings");
bankAccount.Add("ifsc_code","HDFC0001233");
token.Add("bank_account",bankAccount);
Dictionary nach = new Dictionary();
nach.Add("form_reference1","Recurring Payment for Gaurav Kumar");
nach.Add("form_reference2","Method Paper NACH");
nach.Add("description","Paper NACH Gaurav Kumar");
token.Add("nach",nach);

Order order = client.Order.Create(orderRequest);

```json: Response
{
  "id":"order_1Aa00000000001",
  "entity":"order",
  "amount":0,
  "amount_paid":0,
  "amount_due":0,
  "currency":"INR",
  "receipt":"Receipt No. 1",
  "offer_id":null,
  "offers":{
    "entity":"collection",
    "count":0,
    "items":[]
  },
  "status":"created",
  "attempts":0,
  "notes": {
    "notes_key_1": "Beam me up Scotty",
    "notes_key_2": "Engage"
  },
  "created_at":1579775420,
  "token":{
    "method":"nach",
    "notes": {
      "notes_key_1": "Tea, Earl Grey, Hot",
      "notes_key_2": "Tea, Earl Grey… decaf."
    },
    "recurring_status":null,
    "failure_reason":null,
    "currency":"INR",
    "max_amount":10000000,
    "auth_type":"physical",
    "expire_at":1580480689,
    "nach":{
      "create_form":true,
      "form_reference1":"Recurring Payment for Gaurav Kumar",
      "form_reference2":"Method Paper NACH",
      "prefilled_form":"https://rzp.io/i/bitw",
      "upload_form_url":"https://rzp.io/i/gts",
      "description":"Paper NACH Gaurav Kumar"
    },
    "bank_account":{
      "ifsc":"HDFC0000001",
      "bank_name":"HDFC Bank",
      "name":"Gaurav Kumar",
      "account_number":"11214311215411",
      "account_type":"savings",
      "beneficiary_email":"gaurav.kumar@example.com",
      "beneficiary_mobile":"9876543210"
    },
    "first_payment_amount":10000
  }
}

Download and Upload the Pre-filled NACH Form

Once the order is created, the generated pre-filled form must be downloaded, signed by your customer and uploaded back to Razorpay to complete the transaction. You receive the following parameters as part of the response: prefilled_form : The link from where you can download the pre-filled NACH form. upload_form_url : The link where the NACH form should be uploaded once it is signed by the customer.

Request Parameters

amount mandatory : integer Amount in currency subunits. For Paper NACH, the amount has to be 0. currency mandatory : string The 3-letter ISO currency code for the payment. Currently, we only support INR. method mandatory : string The authorisation method. In this case the value will be nach. customer_id mandatory : string The unique identifier of the customer, who is to be charged. For example, cust_D0cs04OIpPPU1F. receipt optional : string A user-entered unique identifier for the order. For example, rcptid #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 authorisation transaction such as max amount and bank account information. Pass a value in the first_payment_amount parameter if you want to auto-charge the customer the first payment immediately after authorization. first_payment_amount optional : integer The amount, in paise, that should be auto-charged in addition to the authorization amount. For example, 100000. auth_type mandatory : string The payment method used to make the authorisation payment. Here, it is physical. bank_account : The customer’s bank account details that is printed on the NACH form. account_numbermandatory : string The customer’s bank account number. For example 11214311215411. ifsc_codemandatory : string The customer’s bank IFSC. For example UTIB0000001. beneficiary_namemandatory : string The customer’s name. For example, Gaurav Kumar. account_type optional : string The customer’s bank account type. Possible values:

savings (default)
current
cc (Cash Credit)
nre (SB-NRE)
nro (SB-NRO)

max_amount optional : integer Use to set the maximum amount per debit request. Know about maximum and default values. expire_at optional : integer The Unix timestamp that specifies when the registration link should expire. The value can range from the current date to 01-19-2038 (2147483647). nach : Additional information to be printed on the NACH form that your customer will sign. form_reference1 optional : string A user-entered reference that appears on the NACH form. form_reference2 optional : string A user-entered reference that appears on the NACH form. description optional : string A user-entered description that appears on the hosted page. For example, Form for Gaurav Kumar. 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”.

Response Parameters

id : string A unique identifier of the order created. For example order_1Aa00000000001. entity : string The entity that has been created. Here it is order. amount : integer Amount in currency subunits. For emandate, the amount should be 0. amount_paid : integer The amount that has been paid. amount_due : integer The amount that is yet to pay. currency : string The 3-letter ISO currency code for the payment. Currently, we only support INR. receipt : string A user-entered unique identifier of the order. For example, rcptid #1. You should map this parameter to the order_id sent by Razorpay. status : string The status of the order. notes : 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”. created_at : integer The Unix timestamp at which the order was created. token : Details related to the authorisation such as max amount and bank account information. auth_type : string Emandate type used to make the authorisation payment. Possible values:

netbanking
debitcard
aadhaar

max_amount : integer The maximum amount in paise a customer can be charged in a transaction. Know about the maximum and default values. expire_at : integer The Unix timestamp to indicate till when you can use the token (authorisation on the payment method) to charge the customer subsequent payments. The default value is 10 years for emandate. This value can range from the current date to 31-12-2099 (4102444799). notes : 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”. bank_account : Customer’s bank account details that should be pre-filled on the checkout. account_number : string Customer’s bank account number. account_type : string Customer’s bank account type. Possible values:

savings (default)
current

ifsc_code : string Customer’s bank IFSC. For example UTIB0000001. beneficiary_name : string Name of the beneficiary. For example, Gaurav Kumar.

Download and Upload the Pre-filled NACH Form

Once the order is created, the pre-filled form must be downloaded, signed by your customer and uploaded back to Razorpay to complete the transaction. You receive the following parameters as part of the response: prefilled_form : The link from where you can download the pre-filled NACH form. upload_form_url : The link where the NACH form should be uploaded once it is signed by the customer. Authorisation transaction + auto-charge first payment: You can register a customer’s mandate and charge them the first recurring payment as part of the same transaction. Refer to the Paper NACH section under Registration and Charge First Payment Together for more information. You can create a payment against the order_id after it is created.

1.1.3. Create an Authorisation Payment

You should create an authorisation payment after you create an order. To create an authorisation payment:

Download the Paper NACH form and send it to the customers.
Ask the customers to fill the form and either Upload via Checkout or send it to you to upload the form using the create NACH File API.

1.1.3.1 Upload the NACH File via Checkout

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

Handler Function | Callback URL

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

Watch Out!The Callback URL is not supported for Recurring Payments created using the registration link.

Checkout with handler functions

 Pay 
   
  
    var options = {
      "key": "[YOUR_KEY_ID]",
      "order_id": "order_1Aa00000000001",
      "customer_id": "cust_1Aa00000000001",
      "recurring": true,
      "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();
    }
  
```html: Manual checkout with Callback URL
 Pay 
   
  
    var options = {
      "key": "[YOUR_KEY_ID]",
      "order_id": "order_1Aa00000000001",
      "customer_id": "cust_1Aa00000000001",
      "recurring": true,
      "callback_url": "https://eneqd3r9zrjok.x.pipedream.net/",
      "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();
    }
  

Additional Checkout Fields

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 : boolean Determines whether the recurring payment is enabled or not. Possible values:

1: Recurring payment is enabled.
0: Recurring payment is not enabled.

1.1.3.2 Upload the NACH File via API

You can upload the signed NACH forms that are collected from your customers using the create NACH File API, . Razorpay’s OCR-enabled NACH engine submits the form to NPCI on successful verification and you will receive a success or a failure response.

Feature Request

This is an on-demand feature. Please raise a request with our Support team to get this feature activated on your Razorpay account.to get this feature activated on your account.Use the following endpoint to upload the signed Paper NACH form via the API./payments/create/nach/fileUse the following API to upload the NACH file sent by the customer.

Request

curl -u : \
-X POST 'https://api.razorpay.com/v1/payments/create/nach/file' \
-H "Content-Type: multipart/form-data" \
-F 'order_id=order_FoLdZrq6QGKUWg' \
-F 'recurring=1' \
-F 'file=@/Users/your_name/sample_uploaded.jpeg' // file path

Successful Response

{
  "razorpay_payment_id": "pay_FjDn43bvssCqEM",
  "razorpay_order_id": "order_FjDdQ6a0GluJ2c",
  "razorpay_signature": "f13775ea8a91e9bf229b9fdba3ad783f7ff2bdbce1c35e87a69ae7418808da04"
}
```json: Failure Response
{
   "error":{
      "code":"BAD_REQUEST_ERROR",
      "description":"file size exceeds limit",
      "field":null,
      "source":"customer",
      "step":"form_upload",
      "reason":"file size exceeds limit",
      "metadata":{
         "payment_id":null,
         "order_id":"order_DBJKIP31Y4jl8"
      }
   }
}

Error Reasons

The below table lists the errors that may appear while uploading the NACH file, the reason, explanation and next steps:

Reason | Explanation | Next Steps

`unknown_file_type` | The file type of the image is not supported. | Upload an image that is in either of `.jpeg`, `.jpg` or `.png` formats.

`file_size_exceeds_limit` | The file size exceeds the permissible limits. | Upload an image of smaller size.

`image_not_clear` | The uploaded image is not clear. This can either be due to poor resolution or because part of the image is cropped. | Upload an image with better quality without any cropping of the form.

`form_mismatch` | The ID of the uploaded form does not match with that in our records. | Check that the form is uploaded against the correct order ID.

`form_signature_missing` | The signature of the customer is either missing or could not be detected. | Check that the customer has signed in the appropriate box and that the image uploaded is clear. For current account, a company stamp may also be required.

`form_data_mismatch` | One or more of the fields on the NACH form do not match with that in our records. | Check that the image is clear and that the data has not been tampered with before uploading again.

form_status_pending | A form against this order is pending action on the destination bank. A new form cannot be submitted till a status is received. | Wait for an update from the destination bank on the approval/rejection of the mandate.

1.2. Using a Registration Link

Registration Link is an alternate way of creating an authorisation transaction. You can create a registration link using the API or Dashboard.

Handy Tips

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

When you create a registration link, an invoice is automatically issued to the customer. They can use this invoice to make the authorisation payment.
A registration link should always have an order amount (in paise) the customer will be charged when making the authorisation payment. This amount should be 0 in the case of Paper NACH.

Handy Tips

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

1.2.1. Create a Registration Link

The following endpoint creates a registration link for recurring payments. /subscription_registration/auth_links

Curl

curl -u :
-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"
  },
  "amount":0,
  "currency":"INR",
  "type":"link",
  "description":"12 p.m. Meals",
  "subscription_registration":{
    "method":"nach",
    "auth_type":"physical",
    "bank_account":{
      "beneficiary_name":"Gaurav Kumar",
      "account_number":"11214311215411",
      "account_type":"savings",
      "ifsc_code":"HDFC0001233"
    },
    "nach":{
      "form_reference1":"Recurring Payment for Gaurav Kumar",
      "form_reference2":"Method Paper NACH"
    },
    "expire_at":1947483647,
    "max_amount":50000
  },
  "receipt":"Receipt No. 1",
  "sms_notify":true,
  "email_notify":true,
  "expire_by":1647483647,
  "notes":{
    "note_key 1":"Beam me up Scotty",
    "note_key 2":"Tea. Earl Gray. Hot."
  }
}'

```java: Java
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", 0);
registrationLinkRequest.put("currency", "INR");
registrationLinkRequest.put("description", "12 p.m. Meals");
JSONObject subscriptionRegistration = new JSONObject();
subscriptionRegistration.put("method","nach");
subscriptionRegistration.put("auth_type","physical");
subscriptionRegistration.put("max_amount",50000);
subscriptionRegistration.put("expire_at",1609423824);
JSONObject bankAccount = new JSONObject();
bankAccount.put("beneficiary_name","Gaurav Kumar");
bankAccount.put("account_number","11214311215411");
bankAccount.put("account_type","savings");
bankAccount.put("ifsc_code","HDFC0001233");
JSONObject nach = new JSONObject();
nach.put("form_reference1","Recurring Payment for Gaurav Kumar");
nach.put("form_reference2","Method Paper NACH");
subscriptionRegistration.put("bank_account",bankAccount);
subscriptionRegistration.put("nach",nach);
registrationLinkRequest.put("subscription_registration", subscriptionRegistration);
registrationLinkRequest.put("receipt", "Receipt No. #27");
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);

```php: PHP
$api = new Api($key_id, $secret);

$api->subscription->createSubscriptionRegistration(array('customer'=>array('name'=>'Gaurav Kumar','email'=>'gaurav.kumar@example.com','contact'=>'9123456780'),'amount'=>100, 'type'=>'link','currency'=>'INR','description'=>'Registration Link for Gaurav Kumar','subscription_registration'=>array('first_payment_amount'=>100, 'method'=>'nach', 'auth_type'=>'physical' ,'max_amount'=>'50000','expire_at'=>'1634215992','bank_account'=>array('beneficiary_name'=>'Gaurav Kumar', 'account_number'=>'11214311215411', 'account_type'=>'savings', 'ifsc_code'=>'HDFC0001233'), 'nach'=> array('form_reference1'=> 'Recurring Payment for Gaurav Kumar','form_reference2'=> 'Method Paper NACH')),'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.'));

```javascript: Node.js
var instance = new Razorpay({ key_id: 'YOUR_KEY_ID', key_secret: 'YOUR_SECRET' })

instance.payments.createRecurringPayment({
  customer: {
    name: "Gaurav Kumar",
    email: "gaurav.kumar@example.com",
    contact: 9123456780
  },
  amount: 100,
  type: "link",
  currency: "INR",
  description: "Registration Link for Gaurav Kumar",
  subscription_registration: {
    first_payment_amount: 100,
    method: "nach",
    auth_type: "physical",
    max_amount: 50000,
    expire_at: 1634215992,
    bank_account: {
      beneficiary_name: "Gaurav Kumar",
      account_number: "11214311215411",
      account_type: "savings",
      ifsc_code: "HDFC0001233"
    },
    nach: {
      form_reference1: "Recurring Payment for Gaurav Kumar",
      form_reference2: "Method Paper NACH"
    }
  },
  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."
  }
})
```python: Python
client = razorpay.Client(auth=("YOUR_ID", "YOUR_SECRET"))

client.payment.createRecurring({
   "customer":{
      "name":"Gaurav Kumar",
      "email":"gaurav.kumar@example.com",
      "contact":9123456780
   },
   "amount":100,
   "type":"link",
   "currency":"INR",
   "description":"Registration Link for Gaurav Kumar",
   "subscription_registration":{
      "first_payment_amount":100,
      "method":"nach",
      "auth_type":"physical",
      "max_amount":50000,
      "expire_at":1634215992,
      "bank_account":{
         "beneficiary_name":"Gaurav Kumar",
         "account_number":11214311215411,
         "account_type":"savings",
         "ifsc_code":"HDFC0001233"
      },
      "nach":{
         "form_reference1":"Recurring Payment for Gaurav Kumar",
         "form_reference2":"Method Paper NACH"
      }
   },
   "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."
   }
})

```ruby: Ruby
require "razorpay"
Razorpay.setup('YOUR_KEY_ID', 'YOUR_SECRET')

para_attr = {
  "customer": {
    "name": "Gaurav Kumar",
    "email": "gaurav.kumar@example.com",
    "contact": 9123456780
  },
  "amount": 100,
  "type": "link",
  "currency": "INR",
  "description": "Registration Link for Gaurav Kumar",
  "subscription_registration": {
    "first_payment_amount": 100,
    "method": "nach",
    "auth_type": "physical",
    "max_amount": 50000,
    "expire_at": 1634215992,
    "bank_account": {
      "beneficiary_name": "Gaurav Kumar",
      "account_number": 11214311215411,
      "account_type": "savings",
      "ifsc_code": "HDFC0001233"
    },
    "nach": {
      "form_reference1": "Recurring Payment for Gaurav Kumar",
      "form_reference2": "Method Paper NACH"
    }
  },
  "receipt": "Receipt No. 27",
  "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)

```go: Go
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",
  },
  "amount":0,
  "currency":"INR",
  "type":"link",
  "description":"12 p.m. Meals",
  "subscription_registration":map[string]interface{}{
    "method":"nach",
    "auth_type":"physical",
    "bank_account":map[string]interface{}{
      "beneficiary_name":"Gaurav Kumar",
      "account_number":"11214311215411",
      "account_type":"savings",
      "ifsc_code":"HDFC0001233",
    },
    "nach":map[string]interface{}{
      "form_reference1":"Recurring Payment for Gaurav Kumar",
      "form_reference2":"Method Paper NACH",
    },
    "expire_at":1947483647,
    "max_amount":50000,
  },
  "receipt":"Receipt No. 1",
  "sms_notify":true,
  "email_notify":true,
  "expire_by":1647483647,
  "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)

```csharp: .NET
RazorpayClient client = new RazorpayClient("[YOUR_KEY_ID]", "[YOUR_KEY_SECRET]");

Dictionary registrationLinkRequest = new Dictionary();
Dictionary customer = new Dictionary();
customer.Add("name","Gaurav Kumar");
customer.Add("email","gaurav.kumar@example.com");
customer.Add("contact","9123456780");
registrationLinkRequest.Add("customer", customer);
registrationLinkRequest.Add("type", "link");
registrationLinkRequest.Add("amount", 0);
registrationLinkRequest.Add("currency", "INR");
registrationLinkRequest.Add("description", "12 p.m. Meals");
Dictionary subscriptionRegistration = new Dictionary();
subscriptionRegistration.Add("method","nach");
subscriptionRegistration.Add("auth_type","physical");
subscriptionRegistration.Add("max_amount",50000);
subscriptionRegistration.Add("expire_at",1609423824);
Dictionary bankAccount = new Dictionary();
bankAccount.Add("beneficiary_name","Gaurav Kumar");
bankAccount.Add("account_number","11214311215411");
bankAccount.Add("account_type","savings");
bankAccount.Add("ifsc_code","HDFC0001233");
Dictionary nach = new Dictionary();
nach.Add("form_reference1","Recurring Payment for Gaurav Kumar");
nach.Add("form_reference2","Method Paper NACH");
subscriptionRegistration.Add("bank_account",bankAccount);
subscriptionRegistration.Add("nach",nach);
registrationLinkRequest.Add("subscription_registration", subscriptionRegistration);
registrationLinkRequest.Add("receipt", "Receipt No. #111");
registrationLinkRequest.Add("email_notify", true);
registrationLinkRequest.Add("sms_notify", true);
registrationLinkRequest.Add("expire_by", 1580479824);
Dictionary notes = new Dictionary();
notes.Add("notes_key_1","Tea, Earl Grey, Hot");
notes.Add("notes_key_2","Tea, Earl Grey… decaf.");
registrationLinkRequest.Add("notes", notes);

Invoice invoice = client.Invoice.CreateRegistrationLink(registrationLinkRequest);

```json: Response
{
    "id": "inv_FHrZiAubEzDdaq",
    "entity": "invoice",
    "receipt": "Receipt No. 27",
    "invoice_number": "Receipt No. 27",
    "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_FHrZiBOkWHZPOp",
    "line_items": [],
    "payment_id": null,
    "status": "issued",
    "expire_by": 1647483647,
    "issued_at": 1595491154,
    "paid_at": null,
    "cancelled_at": null,
    "expired_at": null,
    "sms_status": "sent",
    "email_status": "sent",
    "date": 1595491154,
    "terms": null,
    "partial_payment": false,
    "gross_amount": 0,
    "tax_amount": 0,
    "taxable_amount": 0,
    "amount": 0,
    "amount_paid": 0,
    "amount_due": 0,
    "currency": "INR",
    "currency_symbol": "₹",
    "description": "12 p.m. Meals",
    "notes": {
        "note_key 1": "Beam me up Scotty",
        "note_key 2": "Tea. Earl Gray. Hot."
    },
    "comment": null,
    "short_url": "https://rzp.io/i/bzDYbNg",
    "view_less": true,
    "billing_start": null,
    "billing_end": null,
    "type": "link",
    "group_taxes_discounts": false,
    "created_at": 1595491154,
    "idempotency_key": null,
    "token": {
        "method": "nach",
        "notes": {
            "note_key 1": "Beam me up Scotty",
            "note_key 2": "Tea. Earl Gray. Hot."
        },
        "recurring_status": null,
        "failure_reason": null,
        "currency": "INR",
        "max_amount": 50000,
        "auth_type": "physical",
        "expire_at": 1947483647,
        "nach": {
            "create_form": true,
            "form_reference1": "Recurring Payment for Gaurav Kumar",
            "form_reference2": "Method Paper NACH",
            "prefilled_form": "https://rzp.io/i/exdIzYN",
            "upload_form_url": "https://rzp.io/i/bzDYbNg",
            "description": "12 p.m. Meals"
        },
        "bank_account": {
            "ifsc": "HDFC0001233",
            "bank_name": "HDFC Bank",
            "name": "Gaurav Kumar",
            "account_number": "11214311215411",
            "account_type": "savings",
            "beneficiary_email": "gaurav.kumar@example.com",
            "beneficiary_mobile": "9123456780"
        },
        "first_payment_amount": 0
    },
    "nach_form_url": "https://rzp.io/i/exdIzYN"
}

Download and Upload the Pre-filled NACH Form

Once the registration link is created, the customer should complete these steps:

Download the pre-filled form using the Download NACH Form option on...

Download the pre-filled form using the Download NACH Form option on the Razorpay hosted page.

Sign the form.

Upload the signed form using the Upload NACH Form option on the Raz...

Upload the signed form using the Upload NACH Form option on the Razorpay hosted page.

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 authorisation payment. first_payment_amount optional : integer The amount, in paise, the customer should be auto-charged in addition to the authorization amount. For example, 100000. method mandatory : string The NACH type used to make the authorisation payment. Here, it is physical. auth_type mandatory : string The authorization method used to make the authorisation transaction. Here, it is nach. bank_account : The customer’s bank account details. beneficiary_name mandatory : string The name on the beneficiary. For example, Gaurav Kumar. account_number mandatory : integer The customer’s bank account number. For example, 11214311215411. account_type mandatory : string The customer’s bank account type. Possible values:

savings
current

ifsc_code mandatory : string The customer’s bank IFSC. For example, HDFC0000001. max_amount optional : integer Use to set the maximum amount, in paise, per debit request. Know about maximum and default values. expire_at optional : integer The Unix timestamp till when you can use the token (authorization on the payment method) to charge the customer subsequent payments. The default value is 10 years for emandate. This value can range from the current date to 31-12-2099 (4101580799). nach : Additional information to be printed on the NACH form that your customer will sign. form_reference1 optional : string A user-entered reference that appears on the NACH form. form_reference2 optional : string A user-entered reference that appears on the NACH form. description optional : string A user-entered description that appears on the hosted page. For example, Form for Gaurav Kumar. 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 authorisation 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”.

Response Parameters

id : string The unique identifier of the invoice. entity : string The entity that has been created. Here, it is invoice. receipt : string A user-entered unique identifier of the invoice. invoice_number : string Unique number you added for internal reference. customer_id : string The unique identifier of the customer. For example, cust_BMB3EwbqnqZ2EI. customer_details : object Details of the customer. id : string The unique identifier associated with the customer to whom the invoice has been issued. name : string The customer’s name. email : string The customer’s email address. contact : integer The customer’s phone number. billing_address : string Details of the customer’s billing address. shipping_address : string Details of the customer’s shipping address. order_id : string The unique identifier of the order associated with the invoice. line_items : string Details of the line item that is billed in the invoice. Maximum of 50 line items are allowed. payment_id : string Unique identifier of a payment made against the invoice. status : string The status of the invoice. Possible values:

draft
issued
partially_paid
paid
cancelled
expired
deleted

expire_by : integer The Unix timestamp at which the invoice will expire. issued_at : integer The Unix timestamp at which the invoice was issued to the customer. paid_at : integer The Unix timestamp at which the payment was made. cancelled_at : integer The Unix timestamp at which the invoice was cancelled. expired_at : integer The Unix timestamp at which the invoice expired. sms_status : string The delivery status of the SMS notification for the invoice sent to the customer. Possible values:

pending
sent

email_status : string The delivery status of the email notification for the invoice sent to the customer. Possible values:

pending
sent

date : integer Timestamp, in Unix format, that indicates the issue date of the invoice. terms : string Any terms to be included in the invoice. Maximum of 2048 characters. partial_payment : boolean Indicates whether the customer can make a partial payment on the invoice. Possible values:

true: The customer can make partial payments.
false (default): The customer cannot make partial payments.

amount : integer Amount to be paid using the invoice. Must be in the smallest unit of the currency. For example, if the amount to be received from the customer is 299.95, pass the value as 29995. amount_paid : integer Amount paid by the customer against the invoice. amount_due : integer The remaining amount to be paid by the customer for the issued invoice. currency : string The currency associated with the invoice. description : string A brief description of the invoice. notes : object Any custom notes added to the invoice. Maximum of 2048 characters. short_url : string The short URL that is generated. This is the link that can be shared with the customer to receive payments. type : string Here, it is invoice. comment : string Any comments to be added in the invoice. Maximum of 2048 characters.

1.2.2. Send/Resend Notifications

The following endpoint sends/resends notifications with the short URL to the customer: /invoices/:id/notify_by/:medium

Sample Code

Curl

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

 ```java: Java
 RazorpayClient razorpay = new RazorpayClient("[YOUR_KEY_ID]", "[YOUR_KEY_SECRET]");

 String invoiceId = "inv_1Aa00000000001";

 String medium = "sms";

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

 ```php: PHP
 $api = new Api($key_id, $secret);

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

 ```javascript: Node.js
 var instance = new Razorpay({ key_id: 'YOUR_KEY_ID', key_secret: 'YOUR_SECRET' })

 instance.invoices.notifyBy(invoiceId, medium)

 ```python: Python
 client = razorpay.Client(auth=("YOUR_ID", "YOUR_SECRET"))

 client.invoice.notify_by(invoiceId, medium)

 ```ruby: Ruby
 require "razorpay"
 Razorpay.setup('YOUR_KEY_ID', 'YOUR_SECRET')

 invoiceId = "inv_JDdNb4xdf4gxQ7"

 medium = "email" 

 Razorpay::Invoice.notify_by(invoiceId, medium)

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

 body, err := client.Invoice.Notify("", "", nil, nil)

 ```csharp: .NET
 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

Response Parameters

success : boolean Indicates whether the notifications were sent successfully. Possible values:

true: The notifications were successfully sent via SMS, email or both.
false: The notifications were not sent.

1.2.3. Cancel a Registration Link

The following endpoint cancels a registration link. /invoices/:id/cancel

Curl

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

```java: Java
RazorpayClient razorpay = new RazorpayClient("[YOUR_KEY_ID]", "[YOUR_KEY_SECRET]");

String invoiceId = "inv_1Aa00000000001";

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

```php: PHP
$api = new Api($key_id, $secret);

$api->invoice->fetch($invoiceId)->cancel();
```javascript: Node.js
var instance = new Razorpay({ key_id: 'YOUR_KEY_ID', key_secret: 'YOUR_SECRET' })

instance.invoices.cancel(invoiceId);
```python: Python
client = razorpay.Client(auth=("YOUR_ID", "YOUR_SECRET"))

client.invoice.cancel(invoiceId)

```ruby: Ruby
require "razorpay"
Razorpay.setup('YOUR_KEY_ID', 'YOUR_SECRET')

invoiceId = "inv_JDdNb4xdf4gxQ7"

Razorpay::Invoice.cancel(invoiceId)

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

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

```csharp: .NET
RazorpayClient client = new RazorpayClient("[YOUR_KEY_ID]", "[YOUR_KEY_SECRET]");

string invoiceId = "inv_DAweOiQ7amIUVd";

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

```json: Response
{
  "amount": 0,
  "amount_due": 0,
  "amount_paid": 0,
  "auth_link_status": "cancelled",
  "billing_end": null,
  "billing_start": null,
  "cancelled_at": 1661428198,
  "comment": null,
  "created_at": 1661424249,
  "currency": "INR",
  "currency_symbol": "₹",
  "customer_details": {
    "billing_address": null,
    "contact": "9023456780",
    "customer_contact": "9023456780",
    "customer_email": "gaurav.kumar1@example.com",
    "customer_name": "Gaurav Kumar",
    "email": "gaurav.kumar1@example.com",
    "gstin": null,
    "id": "cust_K9pyoGi6vDUMgM",
    "name": "Gaurav Kumar",
    "shipping_address": null
  },
  "customer_id": "cust_K9pyoGi6vDUMgM",
  "date": 1661424248,
  "description": "salsa",
  "email_status": "sent",
  "entity": "invoice",
  "expire_by": 1947483647,
  "expired_at": null,
  "first_payment_min_amount": null,
  "gross_amount": 0,
  "group_taxes_discounts": false,
  "id": "inv_K9pyoiihbl98jD",
  "idempotency_key": null,
  "invoice_number": "trtrtr1",
  "issued_at": 1661424248,
  "line_items": [],
  "nach_form_url": "https://rzp.io/i/Ui2gOJOom",
  "notes": {
    "note_key 1": "Beam me up Scotty",
    "note_key 2": "Tea. Earl Gray. Hot."
  },
  "order_id": "order_K9pypNRrcL4bij",
  "paid_at": null,
  "partial_payment": false,
  "payment_id": null,
  "receipt": "trtrtr1",
  "reminder_status": null,
  "short_url": "https://rzp.io/i/WNa96WB",
  "sms_status": "sent",
  "status": "cancelled",
  "subscription_status": null,
  "supply_state_code": null,
  "tax_amount": 0,
  "taxable_amount": 0,
  "terms": null,
  "token": {
    "auth_type": "physical",
    "bank_account": {
      "account_number": "11214311215411",
      "account_type": "savings",
      "bank_name": "HDFC Bank",
      "beneficiary_email": "gaurav.kumar1@example.com",
      "beneficiary_mobile": "9023456780",
      "ifsc": "HDFC0001233",
      "name": "Gaurav Kumar"
    },
    "currency": "INR",
    "expire_at": 1947483647,
    "failure_reason": null,
    "first_payment_amount": 0,
    "max_amount": 50000,
    "method": "nach",
    "nach": {
      "create_form": true,
      "description": "salsa",
      "form_reference1": "Recurring Payment for Gaurav Kumar",
      "form_reference2": "Method Paper NACH",
      "prefilled_form": "https://rzp.io/i/WYAUISM64",
      "prefilled_form_transient": "https://rzp.io/i/Ui2gOJOom",
      "upload_form_url": "https://rzp.io/i/WNa96WB"
    },
    "notes": {
      "note_key 1": "Beam me up Scotty",
      "note_key 2": "Tea. Earl Gray. Hot."
    },
    "recurring_status": null
  },
  "type": "link",
  "user_id": null,
  "view_less": true
}

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.

Response Parameters

draft
issued
partially_paid
paid
cancelled
expired
deleted

pending
sent

email_status : string The delivery status of the email notification for the invoice sent to the customer. Possible values:

pending
sent

true: The customer can make partial payments.
false (default): The customer cannot make partial payments.

2. Fetch and Manage Tokens

Once you capture a payment, Razorpay Checkout returns a razorpay_payment_id. You can use this id to fetch the token_id, which is used to create and charge subsequent payments. You can retrieve the token_id using the Dashboard or the APIs given below. Know more about Tokens.

2.1. Fetch Token by Payment ID

Use the below endpoint to fetch the token_id using a payment_id. /payments/:id

Curl

curl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET] \
-X GET https://api.razorpay.com/v1/payments/pay_1Aa00000000003

```java: Java
RazorpayClient razorpay = new RazorpayClient("[YOUR_KEY_ID]", "[YOUR_SECRET}"

String paymentId = "pay_1Aa00000000003";

Payment payment = razorpay.payments.fetch(paymentId);

```php: PHP
$api = new Api($key_id, $secret);

$api->payment->fetch($paymentId);
```javascript: Node.js
var instance = new Razorpay({ key_id: 'YOUR_KEY_ID', key_secret: 'YOUR_SECRET' })

instance.payments.fetch(paymentId)
```python: Python
client = razorpay.Client(auth=("YOUR_ID", "YOUR_SECRET"))

client.payment.fetch(paymentId)

```ruby: Ruby
require "razorpay"
Razorpay.setup('YOUR_KEY_ID', 'YOUR_SECRET')

paymentId = "pay_1Aa00000000003"

Razorpay::Payment.fetch(paymentId)

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

body, err := client.Payment.Fetch("", nil, nil)

```csharp: .NET
RazorpayClient client = new RazorpayClient("[YOUR_KEY_ID]", "[YOUR_KEY_SECRET]");

string paymentId = "pay_Z6t7VFTb9xHeOs";

Payment payment = client.Payment.Fetch(paymentId);

```json: Response
{
  "id": "pay_EnLNTjINiPkMEZ",
  "entity": "payment",
  "amount": 0,
  "currency": "INR",
  "status": "captured",
  "order_id": "order_EnLLfglmKksr4K",
  "invoice_id": "inv_EnLLfgCzRfcMuh",
  "international": false,
  "method": "nach",
  "amount_refunded": 0,
  "refund_status": null,
  "captured": true,
  "description": "Invoice #inv_EnLLfgCzRfcMuh",
  "card_id": null,
  "bank": "UTIB",
  "wallet": null,
  "vpa": null,
  "email": "gaurav.kumar@example.com",
  "contact": "+919876543210",
  "customer_id": "cust_DtHaBuooGHTuyZ",
  "token_id": "token_EnLNTnn7uyRg5V",
  "notes": {
    "note_key 1": "Beam me up Scotty",
    "note_key 2": "Tea. Earl Gray. Hot."
  },
  "fee": 0,
  "tax": 0,
  "error_code": null,
  "error_description": null,
  "error_source": null,
  "error_step": null,
  "error_reason": null,
  "acquirer_data": {},
  "created_at": 1588827564
}

Handy Tips

You can also retrieve the token_id via the payment.authorized webhook.

Path Parameter

id mandatory : string The unique identifier of the payment to be retrieved. For example, pay_1Aa00000000002.

Response Parameters

id : string Unique identifier of the payment. entity : string Indicates the type of entity. Here, it is payment. amount : integer The payment amount represented in smallest unit of the currency passed. For example, amount = 100 translates to 100 subunits, that is 1. currency : string The currency in which the payment is made. Refer to the list of international currencies that we support. status : string The status of the payment. Possible values:

created
authorized
captured
refunded
failed

order_id : string The unique identifier of the order. invoice_id : string The unique identifier of the invoice. international : boolean Indicates whether the payment is done via an international card or a domestic one. Possible values:

true: Payment made using international card.
false: Payment not made using international card.

method : string The payment method used for making the payment. Possible values:

card
netbanking
wallet
emi
upi

amount_refunded : integer The amount refunded in smallest unit of the currency passed. refund_status : string The refund status of the payment. Possible values:

null
partial
full

captured : boolean Indicates if the payment is captured. Possible values:

true: Payment has been captured.
false: Payment has not been captured.

description : string Description of the payment, if any. email : string Customer email address used for the payment. contact : integer Customer contact number used for the payment. customer_id : string The unique identifier of the customer. token_id : string The unique identifier of the token. notes : json object Contains user-defined fields, stored for reference purposes. fee : integer Fee (including GST) charged by Razorpay. tax : integer GST charged for the payment. error_code : string Error that occurred during payment. For example, BAD_REQUEST_ERROR. error_description : string Description of the error that occurred during payment. For example, Payment processing failed because of incorrect OTP. error_source : string The point of failure. For example, customer. error_step : string The stage where the transaction failure occurred. The stages can vary depending on the payment method used to complete the transaction. For example, payment_authentication. error_reason : string The exact error reason. For example, incorrect_otp. created_at : integer Timestamp, in UNIX format, on which the payment was created.

2.2. Fetch Tokens by Customer ID

Use the below endpoint to fetch tokens linked to a customer. A customer can have multiple tokens tied to them. These tokens can be used to create subsequent payments for multiple products or services.

Watch Out!This endpoint will not fetch the details of expired and unused tokens./customers/:id/tokens

Curl

curl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET] \
-X GET https://api.razorpay.com/v1/customers/cust_1Aa00000000002/tokens

```java: Java
RazorpayClient razorpay = new RazorpayClient("[YOUR_KEY_ID]", "[YOUR_KEY_SECRET]");

String customerId = "cust_1Aa00000000004";

Customer customer = razorpay.customers.fetchTokens(customerId);

```php: PHP
$api = new Api($key_id, $secret);

$api->customer->fetch($customerId)->tokens()->all();

```javascript: Node.js
var instance = new Razorpay({ key_id: 'YOUR_KEY_ID', key_secret: 'YOUR_SECRET' })

instance.customers.fetchTokens(customerId)

```python: Python
client = razorpay.Client(auth=("YOUR_ID", "YOUR_SECRET"))

client.token.all(customerId)

```ruby: Ruby
require "razorpay"
Razorpay.setup('YOUR_KEY_ID', 'YOUR_SECRET')

customerId = "cust_1Aa00000000004"

Razorpay::Customer.fetchTokens(customerId)

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

body, err := client.Token.All("", nil, nil)

```csharp: .NET
RazorpayClient client = new RazorpayClient("[YOUR_KEY_ID]", "[YOUR_KEY_SECRET]");

string customerId = "cust_1Aa00000000001";

List token = client.Customer.Fetch(customerId).Tokens();

```json: Response
{
  "entity": "collection",
  "count": 1,
  "items": [
    {
      "id": "token_EhYgIE3pOyMQpD",
      "entity": "token",
      "token": "3mQ5Czc6APNppI",
      "bank": "HDFC",
      "wallet": null,
      "method": "nach",
      "vpa": null,
      "recurring": true,
      "recurring_details": {
        "status": "confirmed",
        "failure_reason": null
      },
      "auth_type": "physical",
      "mrn": null,
      "used_at": 1587564373,
      "created_at": 1587564373,
      "dcc_enabled": false
    }
  ]
}

Path Parameter

id mandatory : string The unique identifier of the customer for whom tokens are to be retrieved. For example, cust_1Aa00000000002.

Response Parameters

entity : string The entity being created. Here, it is a collection. count : integer The number of tokens to be fetched. items : object Details related to token such as token id and bank information. id : string The unique identifier linked to an item. In this example, it is token_id. entity : string The entity being created. Here, it is a token. token : string The token is being fetched. bank : string Card issuing bank details. wallet : string Provides wallet information. method : string The payment method used to make the transaction. card : object Details related to card used to make the transaction. entity : string The entity being created. Here, it is card. name : string Name of the cardholder. last4 : integer Last 4 digits of the card. network : string Name of the payment processor. Here it is Visa. type : string Card type (debit or credit). In this example, it is credit. issuer : string Name of the card-issuing bank. international : boolean Card usage restriction. Possible values:

true: Supports international transactions.
false: International transactions are not supported.

emi : string Card EMI status. Possible values.

true: The card is on EMI.
false: The card is not on EMI.

sub_type : string Type of the customer. expiry_month : integer Month on which the card expires. expiry_year : integer Year on which the card expires. flows : object The transaction flow details. otp : string Whether the OTP function is enabled or not. Possible values:

true: The OTP function is enabled.
false: The OTP function is not enabled.

recurring : string Whether the recurring for this payment method is enabled or not. Possible Values:

true: Recurring is enabled.
false: Recurring is not enabled.

vpa : object The VPA details. username : string The username of the VPA holder. For example, gaurav.kumar. handle : string The VPA handle. Here it is upi. name : string The name of the VPA holder. recurring : string This represents whether recurring is enabled for this token. Possible values:

true: Recurring is enabled.
false: Recurring is not enabled.

recurring_details : object Details of the recurring transaction. status : string This represents the status of the recurring transaction. Possible values:

initiated
confirmed
rejected
cancelled
paused

failure_reason : string This provides the reason why the recurring transaction failed. auth_type : string The authorisation type details. mrn : string The unique identifier issued by the payment gateway during customer registration. This can be Gateway Reference Number or Gateway Token. used_at : integer The VPA usage timestamp. created_at : integer The token creation timestamp. expired_at : integer The token expiry date timestamp. dcc_enabled : string Indicates whether the option to change currency is enabled or not. Possible values.

true: The option to change currency is enabled
false: The option to change currency is not enabled.

2.3. Delete Tokens

The following endpoint deletes a token. /customers/:customer_id/tokens/:token_id

Curl

curl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET] \
-X DELETE https://api.razorpay.com/v1/customers/cust_1Aa00000000002/tokens/token_1Aa00000000001

```java: Java
RazorpayClient razorpay = new RazorpayClient("[YOUR_KEY_ID]", "[YOUR_KEY_SECRET]");

String customerId = "cust_1Aa00000000002";

String tokenId = "token_1Aa00000000001";

Customer customer = razorpay.customers.deleteToken(customerId, tokenId);

```php: PHP
$api = new Api($key_id, $secret);

$api->customer->fetch($customerId)->tokens()->delete($tokenId);
```javascript: Node.js
var instance = new Razorpay({ key_id: 'YOUR_KEY_ID', key_secret: 'YOUR_SECRET' })

instance.customers.deleteToken(customerId, tokenId)

```python: Python
client = razorpay.Client(auth=("YOUR_ID", "YOUR_SECRET"))

client.token.delete(customerId, tokenId)

```ruby: Ruby
require "razorpay"
Razorpay.setup('YOUR_KEY_ID', 'YOUR_SECRET')

customerId = "cust_1Aa00000000004"

tokenId = "token_Hxe0skTXLeg9pF"

Razorpay::Customer.fetch(customerId).deleteToken(tokenId)

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

body, err := client.Token.Delete("", "", nil, nil)

```ruby: Ruby
require "razorpay"
Razorpay.setup('YOUR_KEY_ID', 'YOUR_SECRET')

customerId = "cust_1Aa00000000004"

tokenId = "token_Hxe0skTXLeg9pF"

Razorpay::fetch(customerId).deleteToken(tokenId)

```java: Java
RazorpayClient razorpay = new RazorpayClient("[YOUR_KEY_ID]", "[YOUR_KEY_SECRET]");

String customerId = "cust_DtHaBuooGHTuyZ";

String tokenId = "token_HouA2OQR5Z2jTL";

Customer customer = instance.customers.deleteToken(customerId, tokenId);

```csharp: .NET
RazorpayClient client = new RazorpayClient("[YOUR_KEY_ID]", "[YOUR_KEY_SECRET]");

string customerId = "cust_Z6t7VFTb9xHeOs";

string tokenId = "token_1Aa00000000001";

Customer customer = client.Customer.Fetch(customerId).DeleteToken(tokenId);

Response

{
    "deleted": true
}

Path Parameter

customer_id mandatory : string The unique identifier of the customer with whom the token is linked. For example, cust_1Aa00000000002. token_id mandatory : string The unique identifier of the token that is to be deleted. For example, token_1Aa00000000001.

Response Parameters

deleted : boolean Indicates whether the token is deleted. Possible values:

true: The token is deleted successfully.
false: The token was not deleted.

3. Create Subsequent Payments

You should perform the following steps to create and charge your customer subsequent payments:

Create an order to charge the customer
Create a recurring payment

3.1. Create an Order to Charge the Customer

You have to create a new order every time you want to charge your customers. This order is different from the one created during the authorisation transaction. The following endpoint creates an order. /orders

Curl

curl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET] \
-X POST https://api.razorpay.com/v1/orders \
-H "Content-Type: application/json" \
-d '{
  "amount":1000,
  "currency":"INR",
  "payment_capture": true,
  "receipt":"Receipt No. 1",
  "notes": {
    "notes_key_1":"Tea, Earl Grey, Hot",
    "notes_key_2":"Tea, Earl Grey… decaf."
  }
}'

```java: Java
RazorpayClient razorpay = new RazorpayClient("[YOUR_KEY_ID]", "[YOUR_KEY_SECRET]");

JSONObject orderRequest = new JSONObject();
orderRequest.put("amount", 1000);
orderRequest.put("currency", "INR");
orderRequest.put("payment_capture", true);
orderRequest.put("receipt", "Receipt No. 1");
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);

```php: PHP
$api = new Api($key_id, $secret);

$api->order->create(array('receipt' => '123', 'amount' => 100, 'payment_capture' => true, 'currency' => 'INR', 'notes'=> array('key1'=> 'value3','key2'=> 'value2')));

```javascript: Node.js
var instance = new Razorpay({ key_id: 'YOUR_KEY_ID', key_secret: 'YOUR_SECRET' })

instance.orders.create({
  "amount":1000,
  "currency":"INR",
  "payment_capture": true,
  "receipt":"Receipt No. 1",
  "notes": {
    "notes_key_1":"Tea, Earl Grey, Hot",
    "notes_key_2":"Tea, Earl Grey… decaf."
  }
})

```python: Python
client = razorpay.Client(auth=("YOUR_ID", "YOUR_SECRET"))

client.order.create({
    'amount': 1000,
    'currency': 'INR',
    'payment_capture': True,
    'receipt': 'Receipt No. 1',
    'notes': {'notes_key_1': 'Tea, Earl Grey, Hot',
              'notes_key_2': 'Tea, Earl Grey... decaf.'}
    })

```ruby: Ruby
require "razorpay"
Razorpay.setup('YOUR_KEY_ID', 'YOUR_SECRET')

para_attr = {
  "amount": 1000,
  "currency": "INR",
  "payment_capture": true,
  "receipt": "Receipt No. 1",
  "notes": {
    "notes_key_1": "Tea, Earl Grey, Hot",
    "notes_key_2": "Tea, Earl Grey… decaf."
  }
}

Razorpay::Order.create(para_attr)

```go: Go
import ( razorpay "github.com/razorpay/razorpay-go" )
client := razorpay.NewClient("YOUR_KEY_ID", "YOUR_S ECRET")

data:= map[string]interface{}{
  "amount":1000,
  "currency":"INR",
  "payment_capture": true,
  "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)

```csharp: .NET
RazorpayClient client = new RazorpayClient("[YOUR_KEY_ID]", "[YOUR_KEY_SECRET]");

Dictionary orderRequest = new Dictionary();
orderRequest.Add("amount", 100);
orderRequest.Add("currency", "INR");
orderRequest.Add("receipt", "receipt#12b");
orderRequest.Add("payment_capture", true);
Dictionary notes = new Dictionary();
notes.Add("notes_key_1", "Tea, Earl Grey, Hot");
notes.Add("notes_key_2", "Tea, Earl Grey… decaf.");
orderRequest.Add("notes", notes);

Order order = client.Order.Create(orderRequest);

Success Response

{
   "id":"order_1Aa00000000002",
   "entity":"order",
   "amount":1000,
   "amount_paid":0,
   "amount_due":1000,
   "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":1579782776
}

```json: Failure Response
{
   "error":{
      "code":"BAD_REQUEST_ERROR",
      "description":"The id provided does not exist",
      "source":"business",
      "step":"payment_initiation",
      "reason":"input_validation_failed",
      "metadata":{
         
      }
   }
}

Request Parameters

amount mandatory : integer Amount in currency subunits. currency mandatory : string The 3-letter ISO currency code for the payment. receipt optional : string A user-entered unique identifier for the order. For example, Receipt No. 1. You should map this parameter to the order_id sent by Razorpay. notes optional : object Key-value pair you can use to store additional information about the entity. Maximum of 15 key-value pairs, 256 characters each. For example, "note_key": "Beam me up Scotty”. payment_capture mandatory : boolean Determines whether the payment status should be changed to captured automatically or not. Possible values:

true: Payments are captured automatically.
false: Payments are not captured automatically. You can manually capture payments using the Manually Capture Payments API.

Response Parameters

id : string A unique identifier of the order created. For example order_1Aa00000000001. entity : string The entity that has been created. Here it is order. amount : integer Amount in currency subunits. amount_paid : integer The amount that has been paid. amount_due : integer The amount that is yet to pay. currency : string The 3-letter ISO currency code for the payment. Currently, we only support INR. receipt : string A user-entered unique identifier of the order. For example, rcptid #1. status : string The status of the order. notes : object Key-value pair you can use to store additional information about the entity. Maximum of 15 key-value pairs, 256 characters each. For example, "note_key": "Beam me up Scotty”. created_at : integer The Unix timestamp at which the order was created.

3.2. Create a Recurring Payment

Once you have generated an order_id, use it with the token_id to create a payment and charge the customer. The following endpoint creates a payment to charge the customer. /payments/create/recurring

Curl

curl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET] \
-X POST https://api.razorpay.com/v1/payments/create/recurring \
-H "Content-Type: application/json" \
-d '{
  "email": "gaurav.kumar@example.com",
  "contact": "+919876543210",
  "amount": 1000,
  "currency": "INR",
  "order_id": "order_1Aa00000000002",
  "customer_id": "cust_1Aa00000000001",
  "token": "token_1Aa00000000001",
  "recurring": true,
  "description": "Creating recurring payment for Gaurav Kumar",
  "notes": {
    "note_key 1": "Beam me up Scotty",
    "note_key 2": "Tea. Earl Gray. Hot."
  }
}'

```java: Java
RazorpayClient razorpay = new RazorpayClient("[YOUR_KEY_ID]", "[YOUR_KEY_SECRET]");

JSONObject paymentRequest = new JSONObject();
paymentRequest.put("email", "gaurav.kumar@example.com");
paymentRequest.put("contact", "+919876543210");
paymentRequest.put("amount", 1000);
paymentRequest.put("currency", "INR");
paymentRequest.put("order_id", "order_1Aa00000000002");
paymentRequest.put("customer_id", "cust_1Aa00000000001");
paymentRequest.put("token", "token_1Aa00000000001");
paymentRequest.put("recurring", true);
paymentRequest.put("description", "Creating recurring payment for Gaurav Kumar");
JSONObject notes = new JSONObject();
paymentRequest.put("notes_key_1","Tea, Earl Grey, Hot");
paymentRequest.put("notes_key_2","Tea, Earl Grey… decaf.");

Payment payment = razorpay.payments.createRecurringPayment(paymentRequest);

```php: PHP
$api = new Api($key_id, $secret);

$api->payment->createRecurring(array('email'=>'gaurav.kumar@example.com','contact'=>'+919876543210','amount'=>100,'currency'=>'INR','order_id'=>'order_1Aa00000000002','customer_id'=>'cust_1Aa00000000001','token'=>'token_1Aa00000000001','recurring'=>true,'description'=>'Creating recurring payment for Gaurav Kumar'));

```javascript: Node.js
var instance = new Razorpay({ key_id: 'YOUR_KEY_ID', key_secret: 'YOUR_SECRET' })

instance.payments.createRecurringPayment({
  "email": "gaurav.kumar@example.com",
  "contact": "+919876543210",
  "amount": 1000,
  "currency": "INR",
  "order_id": "order_1Aa00000000002",
  "customer_id": "cust_1Aa00000000001",
  "token": "token_1Aa00000000001",
  "recurring": true,
  "description": "Creating recurring payment for Gaurav Kumar",
  "notes": {
    "note_key 1": "Beam me up Scotty",
    "note_key 2": "Tea. Earl Gray. Hot."
  }
})

```python: Python
client = razorpay.Client(auth=("YOUR_ID", "YOUR_SECRET"))

client.payment.createRecurring({
    'email': 'gaurav.kumar@example.com',
    'contact': +919876543210,
    'amount': 1000,
    'currency': 'INR',
    'order_id': "order_1Aa00000000002",
    'customer_id': "cust_1Aa00000000001",
    'token': 'token_1Aa00000000001',
    'recurring': True,
    'description': 'Creating recurring payment for Gaurav Kumar',
    'notes': {'note_key 1': 'Beam me up Scotty',
              'note_key 2': 'Tea. Earl Gray. Hot.'}
    })

```ruby: Ruby
require "razorpay"
Razorpay.setup('YOUR_KEY_ID', 'YOUR_SECRET')

para_attr = {
  "email": "gaurav.kumar@example.com",
  "contact": "+919876543210",
  "amount": 1000,
  "currency": "INR",
  "order_id": "order_1Aa00000000002",
  "customer_id": "cust_1Aa00000000001",
  "token": "token_1Aa00000000001",
  "recurring": true,
  "description": "Creating recurring payment for Gaurav Kumar",
  "notes": {
    "note_key 1": "Beam me up Scotty",
    "note_key 2": "Tea. Earl Gray. Hot."
  }
}
Razorpay::Payment.create_recurring_payment(para_attr)

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

data:= map[string]interface{}{
  "email": "gaurav.kumar@example.com",
  "contact": "+919876543210",
  "amount": 1000,
  "currency": "INR",
  "order_id": "order_1Aa00000000002",
  "customer_id": "cust_1Aa00000000001",
  "token": "token_1Aa00000000001",
  "recurring": true,
  "description": "Creating recurring payment for Gaurav Kumar",
  "notes": map[string]interface{}{
    "note_key 1": "Beam me up Scotty",
    "note_key 2": "Tea. Earl Gray. Hot.",
  },
}
body, err := Client.Payment.CreateRecurringPayment(data, nil)

```csharp: .NET
RazorpayClient client = new RazorpayClient("[YOUR_KEY_ID]", "[YOUR_KEY_SECRET]");

Dictionary paymentRequest = new Dictionary();
paymentRequest.Add("email", "gaurav.kumar@example.com");
paymentRequest.Add("contact", "+919876543210");
paymentRequest.Add("amount", 1000);
paymentRequest.Add("currency", "INR");
paymentRequest.Add("order_id", "order_MZ35KPxZaqxfXq");
paymentRequest.Add("customer_id", "cust_KUyah9o60OPhfj");
paymentRequest.Add("token", "token_MZ37MsnhLNH4tN");
paymentRequest.Add("recurring", true);
paymentRequest.Add("description", "Creating recurring payment for Gaurav Kumar");
Dictionary notes = new Dictionary();
notes.Add("notes_key_1", "Tea, Earl Grey, Hot");
notes.Add("notes_key_2", "Tea, Earl Grey… decaf.");
paymentRequest.Add("notes", notes);

Payment payment = client.Payment.CreateRecurringPayment(paymentRequest);

Success Response

{
  "razorpay_payment_id" : "pay_1Aa00000000001"
}

```json: Failure Response
{
   "error":{
      "code":"BAD_REQUEST_ERROR",
      "description":"Amount exceeds maximum amount allowed",
      "source":"business",
      "step":"payment_initiation",
      "reason":"input_validation_failed",
      "metadata":{
         
      }
   }
}

Request Parameters

email mandatory : string The customer’s email address. For example, gaurav.kumar@example.com. contact mandatory : integer The customer’s phone number. For example, 9876543210. currency mandatory : string 3-letter ISO currency code for the payment. Currently, only INR is allowed. amount mandatory : integer The amount you want to charge your customer. This should be the same as the order amount. order_idmandatory : string The unique identifier of the order created. For example, order_1Aa00000000002. customer_id mandatory : string The unique identifier of the customer you want to charge. For example, cust_1Aa00000000002. token mandatory : string The token_id generated when the customer successfully completes the authorisation payment. Different payment instruments for the same customer have different token_id. recurring mandatory : boolean Determines whether recurring payment is enabled or not.

true: Recurring payment is enabled.
false: Recurring payment is not enabled.

notesoptional : object Key-value pair you can use to store additional information about the entity. Maximum of 15 key-value pairs, 256 characters each. For example, "note_key": "Beam me up Scotty”.

Response Parameters

razorpay_payment_id : string The unique identifier of the payment that is created. For example, pay_1Aa00000000001. razorpay_order_id : string The unique identifier of the order that is created. For example, order_1Aa00000000001. razorpay_signature : string The signature generated by the Razorpay. For example, 9ef4dffbfd84f1318f6739a3ce19f9d85851857ae648f114332d8401e0949a3d.

​1. Create an Authorisation Transaction

​1.1. Using Razorpay Standard Checkout

​1.1.1. Create a Customer

​Sample Code

​Request Parameters

​Response Parameters

​1.1.2. Create an Order

​Request Parameters

​Response Parameters

​1.1.3. Create an Authorisation Payment

​1.1.3.1 Upload the NACH File via Checkout

​Handler Function | Callback URL

​Additional Checkout Fields

​1.1.3.2 Upload the NACH File via API

​Error Reasons

​Reason | Explanation | Next Steps

​unknown_file_type | The file type of the image is not supported. | Upload an image that is in either of .jpeg, .jpg or .png formats.

​file_size_exceeds_limit | The file size exceeds the permissible limits. | Upload an image of smaller size.

​image_not_clear | The uploaded image is not clear. This can either be due to poor resolution or because part of the image is cropped. | Upload an image with better quality without any cropping of the form.

​form_mismatch | The ID of the uploaded form does not match with that in our records. | Check that the form is uploaded against the correct order ID.

​form_signature_missing | The signature of the customer is either missing or could not be detected. | Check that the customer has signed in the appropriate box and that the image uploaded is clear. For current account, a company stamp may also be required.

​form_data_mismatch | One or more of the fields on the NACH form do not match with that in our records. | Check that the image is clear and that the data has not been tampered with before uploading again.

​1.2. Using a Registration Link

​1.2.1. Create a Registration Link

​Request Parameters

​Response Parameters

​1.2.2. Send/Resend Notifications

​Sample Code

​Path Parameters

​Response Parameters

​1.2.3. Cancel a Registration Link

​Path Parameter

​Response Parameters

​2. Fetch and Manage Tokens

​2.1. Fetch Token by Payment ID

​Path Parameter

​Response Parameters

​2.2. Fetch Tokens by Customer ID

​Path Parameter

​Response Parameters

​2.3. Delete Tokens

​Path Parameter

​Response Parameters

​3. Create Subsequent Payments

​3.1. Create an Order to Charge the Customer

​Request Parameters

​Response Parameters

​3.2. Create a Recurring Payment

​Request Parameters

​Response Parameters

1. Create an Authorisation Transaction

1.1. Using Razorpay Standard Checkout

1.1.1. Create a Customer

Sample Code

Request Parameters

Response Parameters

1.1.2. Create an Order

Request Parameters

Response Parameters

1.1.3. Create an Authorisation Payment

1.1.3.1 Upload the NACH File via Checkout

Handler Function | Callback URL

Additional Checkout Fields

1.1.3.2 Upload the NACH File via API

Error Reasons

Reason | Explanation | Next Steps

`unknown_file_type` | The file type of the image is not supported. | Upload an image that is in either of `.jpeg`, `.jpg` or `.png` formats.

`file_size_exceeds_limit` | The file size exceeds the permissible limits. | Upload an image of smaller size.

`image_not_clear` | The uploaded image is not clear. This can either be due to poor resolution or because part of the image is cropped. | Upload an image with better quality without any cropping of the form.

`form_mismatch` | The ID of the uploaded form does not match with that in our records. | Check that the form is uploaded against the correct order ID.

`form_signature_missing` | The signature of the customer is either missing or could not be detected. | Check that the customer has signed in the appropriate box and that the image uploaded is clear. For current account, a company stamp may also be required.

`form_data_mismatch` | One or more of the fields on the NACH form do not match with that in our records. | Check that the image is clear and that the data has not been tampered with before uploading again.

1.2. Using a Registration Link

1.2.1. Create a Registration Link

Request Parameters

Response Parameters

1.2.2. Send/Resend Notifications

Sample Code

Path Parameters

Response Parameters

1.2.3. Cancel a Registration Link

Path Parameter

Response Parameters

2. Fetch and Manage Tokens

2.1. Fetch Token by Payment ID

Path Parameter

Response Parameters

2.2. Fetch Tokens by Customer ID

Path Parameter

Response Parameters

2.3. Delete Tokens

Path Parameter

Response Parameters

3. Create Subsequent Payments

3.1. Create an Order to Charge the Customer

Request Parameters

Response Parameters

3.2. Create a Recurring Payment

Request Parameters

Response Parameters