> ## Documentation Index
> Fetch the complete documentation index at: https://razorpay-881012b3.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.
# Charge First Payment Automatically after Emandate Registration
> Register a customer's mandate and charge them the first recurring payment as part of the same transaction via Emandate.
Available in🇮🇳 India
You can register a customer's mandate and charge them the first recurring payment as part of the same transaction. For this, you have to pass the `first_payment_amount` parameter while creating the order.
## 1. Create an Authorisation Transaction
You can create an authorisation transaction using the [Razorpay Standard Checkout](#1-1-using-razorpay-standard-checkout) or using a [Registration Link](#1-2-using-a-registration-link).
### 1.1. Using Razorpay Standard Checkout
To create an authorisation transaction using the Razorpay Standard Checkout, you need to:
1. [Create a Customer](#1-1-1-create-a-customer).
2. [Create an Order](#1-1-2-create-an-order).
3. [Create Authorisation Payment using Razorpay Standard Checkout](#1-1-3-create-an-authorisation-payment).
### 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](/docs/api/customers) with basic information such as `email` and `contact` and use them for various Razorpay offerings. The following endpoint creates a customer.
`POST /customers`
```bash Curl theme={null}
curl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET] \
-X POST https://api.razorpay.com/v1/customers \
-H "Content-Type: application/json" \
-d '{
"name": "",
"email": "",
"contact": "",
"fail_existing": "0",
"notes":{
"note_key_1": "September",
"note_key_2": "Make it so."
}
}'
```
```java Java theme={null}
RazorpayClient razorpay = new RazorpayClient("[YOUR_KEY_ID]", "[YOUR_KEY_SECRET]");
JSONObject customerRequest = new JSONObject();
customerRequest.put("name","");
customerRequest.put("contact","");
customerRequest.put("email","");
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 theme={null}
import razorpay
client = razorpay.Client(auth=("YOUR_ID", "YOUR_SECRET"))
client.customer.create({
'name': '',
'email': '',
'contact': '',
'fail_existing': "0",
'notes': {'note_key_1': 'September', 'note_key_2': 'Make it so.'}
})
```
```go Go theme={null}
import ( razorpay "github.com/razorpay/razorpay-go" )
client := razorpay.NewClient("YOUR_KEY_ID", "YOUR_SECRET")
data := map[string]interface{}{
"name": "",
"contact": ,
"email": "",
"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 theme={null}
$api = new Api($key_id, $secret);
$api->customer->create(array('name' => '', 'email' => '','contact'=>'','fail_existing' => "0", 'notes'=> array('notes_key_1'=> 'Tea, Earl Grey, Hot','notes_key_2'=> 'Tea, Earl Grey… decaf'));
```
```csharp .NET theme={null}
RazorpayClient client = new RazorpayClient("[YOUR_KEY_ID]", "[YOUR_KEY_SECRET]");
Dictionary options = new Dictionary();
options.Add("name", "");
options.Add("contact", "");
options.Add("email", "");
options.Add("fail_existing", "0");
Customer customer = Customer.Create(options);
```
```ruby Ruby theme={null}
require "razorpay"
Razorpay.setup('YOUR_KEY_ID', 'YOUR_SECRET')
para_attr = {
"name": "",
"contact": "",
"email": "",
"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 theme={null}
var instance = new Razorpay({ key_id: 'YOUR_KEY_ID', key_secret: 'YOUR_SECRET' })
instance.customers.create({
name: "",
contact: "",
email: "",
fail_existing: "0",
notes: {
notes_key_1: "Tea, Earl Grey, Hot",
notes_key_2: "Tea, Earl Grey… decaf."
}
})
```
```json Response theme={null}
{
"id":"cust_1Aa00000000001",
"entity":"customer",
"name":"",
"email":"",
"contact":"",
"gstin":null,
"notes":{
"note_key_1":"September",
"note_key_2":"Make it so."
},
"created_at ":1234567890
}
```
`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”`.
`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
Use the [Orders API](/docs/api/orders) to create a unique Razorpay `order_id` that is associated with the authorisation transaction. The following endpoint creates an order.
`POST /orders`
```bash Curl theme={null}
curl -u : \
-X POST https://api.razorpay.com/v1/orders \
-H "Content-Type: application/json" \
-d '{
"amount": 0,
"currency": "INR",
"method": "emandate",
"customer_id": "cust_1Aa00000000001",
"receipt": "Receipt No. 1",
"notes": {
"notes_key_1": "Beam me up Scotty",
"notes_key_2": "Engage"
},
"token": {
"first_payment_amount": 100,
"auth_type": "aadhaar",
"max_amount": 9999900,
"expire_at": 4102444799,
"notes": {
"notes_key_1": "Tea, Earl Grey, Hot",
"notes_key_2": "Tea, Earl Grey… decaf."
},
"bank_account": {
"beneficiary_name": "Gaurav Kumar",
"account_number": "1121431121541121",
"account_type": "savings",
"ifsc_code": "HDFC0000001"
}
}
}'
```
```java Java theme={null}
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_1Aa00000000001");
orderRequest.put("method", "emandate");
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","aadhaar");
token.put("max_amount","9999900");
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);
Order order = razorpay.orders.create(orderRequest);
```
```php PHP theme={null}
$api = new Api($key_id, $secret);
$api->order->create(array('amount' => 0, 'currency' => 'INR', 'method'=>'emandate', 'customer_id'=>$customerId, 'receipt'=>'Receipt No. 5', 'notes'=> array('note_key 1'=> 'Beam me up Scotty','note_key 2'=> 'Engage'), 'token'=>array('first_payment_amount'=>100, 'auth_type'=>'aadhaar' ,'max_amount'=>'9999900','expire_at'=>'4102444799', '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'))));
```
```javascript Node.js theme={null}
var instance = new Razorpay({ key_id: 'YOUR_KEY_ID', key_secret: 'YOUR_SECRET' })
instance.orders.create({
amount: 0,
currency: "INR",
method: "emandate",
receipt: "Receipt No. 5",
notes: {
"note_key 1": "Beam me up Scotty",
"note_key 2": "Engage"
},
token: {
first_payment_amount: 100,
auth_type: "aadhaar",
max_amount: 9999900,
expire_at: 4102444799,
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"
}
}
})
```
```python Python theme={null}
client = razorpay.Client(auth=("YOUR_ID", "YOUR_SECRET"))
client.order.create({
'amount': 0,
'currency': 'INR',
'method': 'emandate',
'customer_id': 'cust_1Aa00000000001',
'receipt': 'Receipt No. 1',
'notes': {'notes_key_1': 'Beam me up Scotty',
'notes_key_2': 'Engage'},
'token': {
'first_payment_amount': 100,
'auth_type': 'aadhaar',
'max_amount': 9999900,
'expire_at': 4102444799,
'notes': {'notes_key_1': 'Tea, Earl Grey, Hot',
'notes_key_2': 'Tea, Earl Grey... decaf.'},
'bank_account': {
'beneficiary_name': 'Gaurav Kumar',
'account_number': 1121431121541121,
'account_type': 'savings',
'ifsc_code': 'HDFC0000001'
}
}
})
```
```ruby Ruby theme={null}
require "razorpay"
Razorpay.setup('YOUR_KEY_ID', 'YOUR_SECRET')
para_attr = {
"amount": 0,
"currency": "INR",
"method": "emandate",
"receipt": "Receipt No. 5",
"notes": {
"note_key 1": "Beam me up Scotty",
"note_key 2": "Engage"
},
"token": {
"first_payment_amount": 100,
"auth_type": "aadhaar",
"max_amount": 9999900,
"expire_at": 4102444799,
"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"
}
}
}
Razorpay::Order.create(para_attr)
```
```go Go theme={null}
import ( razorpay "github.com/razorpay/razorpay-go" )
client := razorpay.NewClient("YOUR_KEY_ID", "YOUR_SECRET")
data := map[string]interface{}{
"amount": 0,
"currency": "INR",
"payment_capture": true,
"method": "emandate",
"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": 100,
"auth_type": "aadhaar",
"max_amount": 9999900,
"expire_at": 4102444799,
"notes": {
"notes_key_1": "Tea, Earl Grey, Hot",
"notes_key_2": "Tea, Earl Grey… decaf.",
},
"bank_account": map[string]interface{}{
"beneficiary_name": "Gaurav Kumar",
"account_number": "1121431121541121",
"account_type": "savings",
"ifsc_code": "HDFC0000001",
},
},
}
body, err := client.Order.Create(data, nil)
```
```json Response theme={null}
{
"id": "order_1Aa00000000001",
"entity": "order",
"amount": 0,
"amount_paid": 0,
"amount_due": 0,
"currency": "INR",
"receipt": "Receipt No. 1",
"offer_id": null,
"status": "created",
"attempts": 0,
"notes": {
"notes_key_1": "Beam me up Scotty",
"notes_key_2": "Engage"
},
"created_at": 1579700597,
"token": {
"method": "emandate",
"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": 9999900,
"auth_type": "aadhaar",
"expire_at": 4102444799,
"bank_account": {
"ifsc": "HDFC0000001",
"bank_name": "HDFC Bank",
"name": "Gaurav Kumar",
"account_number": "1121431121541121",
"account_type": "savings",
"beneficiary_email": "gaurav.kumar@example.com",
"beneficiary_mobile": "9000090000"
},
"first_payment_amount": 100
}
}
```
```bash Curl theme={null}
curl -u : \
-X POST https://api.razorpay.com/v1/orders \
-H "Content-Type: application/json" \
-d '{
"amount": 0,
"currency": "INR",
"method": "emandate",
"customer_id": "cust_1Aa00000000001",
"receipt": "Receipt No. 1",
"notes": {
"notes_key_1": "Beam me up Scotty",
"notes_key_2": "Engage"
},
"token": {
"first_payment_amount": 100,
"auth_type": "netbanking",
"max_amount": 9999900,
"expire_at": 4102444799,
"notes": {
"notes_key_1": "Tea, Earl Grey, Hot",
"notes_key_2": "Tea, Earl Grey… decaf."
},
"bank_account": {
"beneficiary_name": "Gaurav Kumar",
"account_number": "1121431121541121",
"account_type": "savings",
"ifsc_code": "HDFC0000001"
}
}
}'
```
```java Java theme={null}
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_1Aa00000000001");
orderRequest.put("method", "emandate");
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","netbanking");
token.put("max_amount","9999900");
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);
Order order = razorpay.orders.create(orderRequest);
```
```php PHP theme={null}
$api = new Api($key_id, $secret);
$api->order->create(array('amount' => 0, 'currency' => 'INR', 'method'=>'emandate', 'customer_id'=>$customerId, 'receipt'=>'Receipt No. 5', 'notes'=> array('note_key 1'=> 'Beam me up Scotty','note_key 2'=> 'Engage'), 'token'=>array('first_payment_amount'=>100, 'auth_type'=>'netbanking' ,'max_amount'=>'9999900','expire_at'=>'4102444799', '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'))));
```
```javascript Node.js theme={null}
var instance = new Razorpay({ key_id: 'YOUR_KEY_ID', key_secret: 'YOUR_SECRET' })
instance.orders.create({
amount: 0,
currency: "INR",
method: "emandate",
receipt: "Receipt No. 5",
notes: {
"note_key 1": "Beam me up Scotty",
"note_key 2": "Engage"
},
token: {
first_payment_amount: 100,
auth_type: "netbanking",
max_amount: 9999900,
expire_at: 4102444799,
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"
}
}
})
```
```python Python theme={null}
client = razorpay.Client(auth=("YOUR_ID", "YOUR_SECRET"))
client.order.create({
'amount': 0,
'currency': 'INR',
'method': 'emandate',
'customer_id': 'cust_1Aa00000000001',
'receipt': 'Receipt No. 1',
'notes': {'notes_key_1': 'Beam me up Scotty',
'notes_key_2': 'Engage'},
'token': {
'first_payment_amount': 100,
'auth_type': 'netbanking',
'max_amount': 9999900,
'expire_at': 4102444799,
'notes': {'notes_key_1': 'Tea, Earl Grey, Hot',
'notes_key_2': 'Tea, Earl Grey... decaf.'},
'bank_account': {
'beneficiary_name': 'Gaurav Kumar',
'account_number': 1121431121541121,
'account_type': 'savings',
'ifsc_code': 'HDFC0000001'
}
}
})
```
```ruby Ruby theme={null}
require "razorpay"
Razorpay.setup('YOUR_KEY_ID', 'YOUR_SECRET')
para_attr = {
"amount": 0,
"currency": "INR",
"method": "emandate",
"receipt": "Receipt No. 5",
"notes": {
"note_key 1": "Beam me up Scotty",
"note_key 2": "Engage"
},
"token": {
"first_payment_amount": 100,
"auth_type": "netbanking",
"max_amount": 9999900,
"expire_at": 4102444799,
"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"
}
}
}
Razorpay::Order.create(para_attr)
```
```go Go theme={null}
import ( razorpay "github.com/razorpay/razorpay-go" )
client := razorpay.NewClient("YOUR_KEY_ID", "YOUR_SECRET")
data := map[string]interface{}{
"amount": 0,
"currency": "INR",
"payment_capture": true,
"method": "emandate",
"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": 100,
"auth_type": "netbanking",
"max_amount": 9999900,
"expire_at": 4102444799,
"notes": {
"notes_key_1": "Tea, Earl Grey, Hot",
"notes_key_2": "Tea, Earl Grey… decaf.",
},
"bank_account": map[string]interface{}{
"beneficiary_name": "Gaurav Kumar",
"account_number": "1121431121541121",
"account_type": "savings",
"ifsc_code": "HDFC0000001",
},
},
}
body, err := client.Order.Create(data, nil)
```
```csharp .NET theme={null}
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", "emandate");
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("first_payment_amount",100);
token.Add("auth_type","netbanking");
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);
Order order = client.Order.Create(orderRequest);
```
```json Response theme={null}
{
"id": "order_1Aa00000000001",
"entity": "order",
"amount": 0,
"amount_paid": 0,
"amount_due": 0,
"currency": "INR",
"receipt": "Receipt No. 1",
"offer_id": null,
"status": "created",
"attempts": 0,
"notes": {
"notes_key_1": "Beam me up Scotty",
"notes_key_2": "Engage"
},
"created_at": 1579700597,
"token": {
"method": "emandate",
"recurring_status": null,
"failure_reason": null,
"currency": "INR",
"max_amount": 9999900,
"auth_type": "netbanking",
"expire_at": 4102444799,
"notes": {
"notes_key_1": "Tea, Earl Grey, Hot",
"notes_key_2": "Tea, Earl Grey… decaf."
},
"bank_account": {
"ifsc": "HDFC0000001",
"bank_name": "HDFC Bank",
"name": "Gaurav Kumar",
"account_number": "1121431121541121",
"account_type": "savings",
"beneficiary_email": "gaurav.kumar@example.com",
"beneficiary_mobile": "9000090000"
},
"first_payment_amount": 100
}
}
```
```bash Curl theme={null}
curl -u : \
-X POST https://api.razorpay.com/v1/orders \
-H "Content-Type: application/json" \
-d '{
"amount": 0,
"currency": "INR",
"method": "emandate",
"customer_id": "cust_1Aa00000000001",
"receipt": "Receipt No. 1",
"notes": {
"notes_key_1": "Beam me up Scotty",
"notes_key_2": "Engage"
},
"token": {
"first_payment_amount": 100,
"auth_type": "debitcard",
"max_amount": 9999900,
"expire_at": 4102444799,
"notes": {
"notes_key_1": "Tea, Earl Grey, Hot",
"notes_key_2": "Tea, Earl Grey… decaf."
},
"bank_account": {
"beneficiary_name": "Gaurav Kumar",
"account_number": "1121431121541121",
"account_type": "savings",
"ifsc_code": "HDFC0000001"
}
}
}'
```
```java Java theme={null}
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_1Aa00000000001");
orderRequest.put("method", "emandate");
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","debitcard");
token.put("max_amount","9999900");
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);
Order order = razorpay.orders.create(orderRequest);
```
```php PHP theme={null}
$api = new Api($key_id, $secret);
$api->order->create(array('amount' => 0, 'currency' => 'INR', 'method'=>'emandate', 'customer_id'=>$customerId, 'receipt'=>'Receipt No. 5', 'notes'=> array('note_key 1'=> 'Beam me up Scotty','note_key 2'=> 'Engage'), 'token'=>array('first_payment_amount'=>100, 'auth_type'=>'debitcard' ,'max_amount'=>'9999900','expire_at'=>'4102444799', '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'))));
```
```javascript Node.js theme={null}
var instance = new Razorpay({ key_id: 'YOUR_KEY_ID', key_secret: 'YOUR_SECRET' })
instance.orders.create({
amount: 0,
currency: "INR",
method: "emandate",
receipt: "Receipt No. 5",
notes: {
"note_key 1": "Beam me up Scotty",
"note_key 2": "Engage"
},
token: {
first_payment_amount: 100,
auth_type: "debitcard",
max_amount: 9999900,
expire_at: 4102444799,
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"
}
}
})
```
```python Python theme={null}
client = razorpay.Client(auth=("YOUR_ID", "YOUR_SECRET"))
client.order.create({
'amount': 0,
'currency': 'INR',
'method': 'emandate',
'customer_id': 'cust_1Aa00000000001',
'receipt': 'Receipt No. 1',
'notes': {'notes_key_1': 'Beam me up Scotty',
'notes_key_2': 'Engage'},
'token': {
'first_payment_amount': 100,
'auth_type': 'debitcard',
'max_amount': 9999900,
'expire_at': 4102444799,
'notes': {'notes_key_1': 'Tea, Earl Grey, Hot',
'notes_key_2': 'Tea, Earl Grey... decaf.'},
'bank_account': {
'beneficiary_name': 'Gaurav Kumar',
'account_number': 1121431121541121,
'account_type': 'savings',
'ifsc_code': 'HDFC0000001'
}
}
})
```
```ruby Ruby theme={null}
require "razorpay"
Razorpay.setup('YOUR_KEY_ID', 'YOUR_SECRET')
para_attr = {
"amount": 0,
"currency": "INR",
"method": "emandate",
"receipt": "Receipt No. 5",
"notes": {
"note_key 1": "Beam me up Scotty",
"note_key 2": "Engage"
},
"token": {
"first_payment_amount": 100,
"auth_type": "debitcard",
"max_amount": 9999900,
"expire_at": 4102444799,
"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"
}
}
}
Razorpay::Order.create(para_attr)
```
```go Go theme={null}
import ( razorpay "github.com/razorpay/razorpay-go" )
client := razorpay.NewClient("YOUR_KEY_ID", "YOUR_SECRET")
data := map[string]interface{}{
"amount": 0,
"currency": "INR",
"payment_capture": true,
"method": "emandate",
"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": 100,
"auth_type": "debitcard",
"max_amount": 9999900,
"expire_at": 4102444799,
"notes": {
"notes_key_1": "Tea, Earl Grey, Hot",
"notes_key_2": "Tea, Earl Grey… decaf.",
},
"bank_account": map[string]interface{}{
"beneficiary_name": "Gaurav Kumar",
"account_number": "1121431121541121",
"account_type": "savings",
"ifsc_code": "HDFC0000001",
},
},
}
body, err := client.Order.Create(data, nil)
```
```json Response theme={null}
{
"id": "order_1Aa00000000001",
"entity": "order",
"amount": 0,
"amount_paid": 0,
"amount_due": 0,
"currency": "INR",
"receipt": "Receipt No. 1",
"offer_id": null,
"status": "created",
"attempts": 0,
"notes": {
"notes_key_1": "Beam me up Scotty",
"notes_key_2": "Engage"
},
"created_at": 1579700597,
"token": {
"method": "emandate",
"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": 9999900,
"auth_type": "debitcard",
"expire_at": 4102444799,
"bank_account": {
"ifsc": "HDFC0000001",
"bank_name": "HDFC Bank",
"name": "Gaurav Kumar",
"account_number": "1121431121541121",
"account_type": "savings",
"beneficiary_email": "gaurav.kumar@example.com",
"beneficiary_mobile": "9000090000"
},
"first_payment_amount": 100
}
}
```
`amount` *mandatory*
: `integer` Amount in currency subunits. For emandate, the amount should be `0`.
`currency` *mandatory*
: `string` The 3-letter ISO currency code for the payment. Currently, we only support `INR`.
`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](/docs/api/payments/capture).
`method` *mandatory*
: `string` The authorisation method. Here, it is `emandate`.
`customer_id` *mandatory*
: `string` The unique identifier of the customer to be charged. For example, `cust_D0cs04OIpPPU1F`.
`receipt` *optional*
: `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.
`notes`*optional*
: `json object` Key-value pair that can be used to store additional information about the entity. Maximum 15 key-value pairs, 256 characters (maximum) each. For example, `"note_key": "Beam me up Scotty”`.
`token`
: `object` Details related to the authorization 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 mandate authorisation. The first payment amount will be debited, with a new `order_id` and corresponding `payment_id` created automatically and executed within 2 days of emandate token confirmation.
`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` *optional*
: `string` The payment method used to make the authorisation transaction. Possible values:
* `netbanking`
* `debitcard`
* `aadhaar`
`max_amount` *optional*
: `integer` The maximum amount, in paise, that a customer can be charged in one transaction. Know about [maximum and default values](/docs/payments/recurring-payments/emandate/faqs#2-what-is-the-maximum-amount-which-can).
`expire_at` *optional*
: `integer` The Unix timestamp, 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`*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”`.
`bank_account`
: `object` The customer's bank account details that should be pre-filled on the checkout.
`account_number` *optional*
: `string` The customer's bank account number.
`account_type` *optional*
: `string` The customer's bank account type. Possible values:
* `savings` (default)
* `current`
`ifsc_code` *optional*
: `string` The customer's bank IFSC. For example `UTIB0000001`.
`beneficiary_name` *optional*
: `string` The customer's name. For example, `Gaurav Kumar`.
**Watch Out!**
The `beneficiary_name` should be between 4 to 120 characters.
`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`
: `object` 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](/docs/payments/recurring-payments/emandate/faqs#2-what-is-the-maximum-amount-which-can).
`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`
: `object` 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`.
### 1.1.3. Create an Authorisation Payment
Create a payment checkout form for customers to make Authorisation Transaction and register their mandate. You can use the Handler Function or Callback URL.
| 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.
* While handling the first time authorisation payment response, consume the `error_reason` field with value `upi_dummy_payment` and `error_description` field with value `Payment was a dummy payment for one time mandate registration.` to identify successful mandate registration. The parent `error_code` will be `BAD_REQUEST_ERROR`.
```html Checkout with handler functions theme={null}
```
```html Manual checkout with Callback URL theme={null}
```
### Additional Checkout Fields
`customer_id` *mandatory*
: `string` Unique identifier of the customer created in the [first step](#1-1-1-create-a-customer).
`order_id` *mandatory*
: `string` Unique identifier of the order created in the [second step](#1-1-2-create-an-order).
### 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](#1-2-1-create-a-registration-link) or [Dashboard](/docs/payments/recurring-payments/create#1-create-a-registration-link).
**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](/docs/payments/invoices) 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 Emandate.
**Handy Tips**
You can [use Webhooks to get notifications about successful payments](/docs/api/payments/recurring-payments/webhooks#check-authorization-link-status-using-webhooks) against a registration link.
### 1.2.1. Create a Registration Link
The following endpoint creates a registration link.
`POST /subscription_registration/auth_links`
```bash Curl theme={null}
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"
},
"type": "link",
"amount": 0,
"currency": "INR",
"description": "12 p.m. Meals",
"subscription_registration": {
"first_payment_amount": 100,
"method": "emandate",
"auth_type": "aadhaar",
"expire_at": 1580480689,
"max_amount": 50000,
"bank_account": {
"beneficiary_name": "Gaurav Kumar",
"account_number": "11214311215411",
"account_type": "savings",
"ifsc_code": "HDFC0001233"
}
},
"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."
}
}'
```
```java Java theme={null}
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("first_payment_amount",100);
subscriptionRegistration.put("method","emandate");
subscriptionRegistration.put("auth_type","aadhaar");
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");
subscriptionRegistration.put("bank_account",bankAccount);
registrationLinkRequest.put("subscription_registration", subscriptionRegistration);
registrationLinkRequest.put("receipt", "Receipt No. 1");
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 theme={null}
$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'=>0,'currency'=>'INR','description'=>'Registration Link for Gaurav Kumar','subscription_registration'=>array('first_payment_amount'=>100, 'method'=>'emandate', 'auth_type'=>'aadhaar' ,'max_amount'=>'50000','expire_at'=>'1634215992','bank_account'=>array('beneficiary_name'=>'Gaurav Kumar', 'account_number'=>'11214311215411', 'account_type'=>'savings', 'ifsc_code'=>'HDFC0001233')),'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 theme={null}
var instance = new Razorpay({ key_id: 'YOUR_KEY_ID', key_secret: 'YOUR_SECRET' })
instance.payments.createRegistrationLink({
customer: {
name: "Gaurav Kumar",
email: "gaurav.kumar@example.com",
contact: 9123456780
},
type: "link",
amount: 0,
currency: "INR",
description: "Registration Link for Gaurav Kumar",
subscription_registration: {
first_payment_amount: 100,
method: "emandate",
auth_type: "aadhaar",
max_amount: 50000,
expire_at: 1634215992,
bank_account: {
beneficiary_name: "Gaurav Kumar",
account_number: "11214311215411",
account_type: "savings",
ifsc_code: "HDFC0001233"
}
},
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 theme={null}
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': 0,
'currency': 'INR',
'description': '12 p.m. Meals',
'subscription_registration': {
'first_payment_amount': 100,
'method': 'emandate',
'auth_type': 'aadhaar',
'expire_at': 1580480689,
'max_amount': 50000,
'bank_account': {
'beneficiary_name': 'Gaurav Kumar',
'account_number': 11214311215411,
'account_type': 'savings',
'ifsc_code': 'HDFC0001233',
},
},
'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.'}
})
```
```ruby Ruby theme={null}
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": 0,
"currency": "INR",
"description": "Registration Link for Gaurav Kumar",
"subscription_registration": {
"first_payment_amount": 100,
"method": "emandate",
"auth_type": "aadhaar",
"max_amount": 50000,
"expire_at": 1634215992,
"bank_account": {
"beneficiary_name": "Gaurav Kumar",
"account_number": 11214311215411,
"account_type": "savings",
"ifsc_code": "HDFC0001233"
}
},
"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)
```
```go Go theme={null}
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": 0,
"currency": "INR",
"description": "12 p.m. Meals",
"subscription_registration": map[string]interface{}{
"first_payment_amount": 100,
"method": "emandate",
"auth_type": "aadhaar",
"expire_at": 1580480689,
"max_amount": 50000,
"bank_account": map[string]interface{}{
"beneficiary_name": "Gaurav Kumar",
"account_number": "11214311215411",
"account_type": "savings",
"ifsc_code": "HDFC0001233",
},
},
"receipt": "Receipt no. 1",
"expire_by": 1880480689,
"sms_notify": true,
"email_notify": true,
"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)
```
```json Response theme={null}
{
"id": "inv_FHrZAOeCuB9HtK",
"entity": "invoice",
"receipt": "Receipt no. 26",
"invoice_number": "Receipt no. 26",
"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_FHrZAPOStKd4xS",
"line_items": [],
"payment_id": null,
"status": "issued",
"expire_by": 1880480689,
"issued_at": 1595491123,
"paid_at": null,
"cancelled_at": null,
"expired_at": null,
"sms_status": "pending",
"email_status": "pending",
"date": 1595491123,
"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": "test registration link",
"notes": {
"note_key 1": "Beam me up Scotty",
"note_key 2": "Tea. Earl Gray. Hot."
},
"comment": null,
"short_url": "https://rzp.io/i/RllVOmA",
"view_less": true,
"billing_start": null,
"billing_end": null,
"type": "link",
"group_taxes_discounts": false,
"created_at": 1595491123,
"idempotency_key": null
}
```
```bash Curl theme={null}
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"
},
"type": "link",
"amount": 0,
"currency": "INR",
"description": "12 p.m. Meals",
"subscription_registration": {
"first_payment_amount": 100,
"method": "emandate",
"auth_type": "netbanking",
"expire_at": 1580480689,
"max_amount": 50000,
"bank_account": {
"beneficiary_name": "Gaurav Kumar",
"account_number": "11214311215411",
"account_type": "savings",
"ifsc_code": "HDFC0001233"
}
},
"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."
}
}'
```
```java Java theme={null}
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("first_payment_amount",100);
subscriptionRegistration.put("method","emandate");
subscriptionRegistration.put("auth_type","netbanking");
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");
subscriptionRegistration.put("bank_account",bankAccount);
registrationLinkRequest.put("subscription_registration", subscriptionRegistration);
registrationLinkRequest.put("receipt", "Receipt No. 1");
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 theme={null}
$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'=>0,'currency'=>'INR','description'=>'Registration Link for Gaurav Kumar','subscription_registration'=>array('first_payment_amount'=>100, 'method'=>'emandate', 'auth_type'=>'netbanking' ,'max_amount'=>'50000','expire_at'=>'1634215992','bank_account'=>array('beneficiary_name'=>'Gaurav Kumar', 'account_number'=>'11214311215411', 'account_type'=>'savings', 'ifsc_code'=>'HDFC0001233')),'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 theme={null}
var instance = new Razorpay({ key_id: 'YOUR_KEY_ID', key_secret: 'YOUR_SECRET' })
instance.payments.createRegistrationLink({
customer: {
name: "Gaurav Kumar",
email: "gaurav.kumar@example.com",
contact: 9123456780
},
type: "link",
amount: 0,
currency: "INR",
description: "Registration Link for Gaurav Kumar",
subscription_registration: {
first_payment_amount: 100,
method: "emandate",
auth_type: "netbanking",
max_amount: 50000,
expire_at: 1634215992,
bank_account: {
beneficiary_name: "Gaurav Kumar",
account_number: "11214311215411",
account_type: "savings",
ifsc_code: "HDFC0001233"
}
},
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 theme={null}
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': 0,
'currency': 'INR',
'description': '12 p.m. Meals',
'subscription_registration': {
'first_payment_amount': 100,
'method': 'emandate',
'auth_type': 'netbanking',
'expire_at': 1580480689,
'max_amount': 50000,
'bank_account': {
'beneficiary_name': 'Gaurav Kumar',
'account_number': 11214311215411,
'account_type': 'savings',
'ifsc_code': 'HDFC0001233',
},
},
'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.'}
})
```
```ruby Ruby theme={null}
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": 0,
"currency": "INR",
"description": "Registration Link for Gaurav Kumar",
"subscription_registration": {
"first_payment_amount": 100,
"method": "emandate",
"auth_type": "netbanking",
"max_amount": 50000,
"expire_at": 1634215992,
"bank_account": {
"beneficiary_name": "Gaurav Kumar",
"account_number": 11214311215411,
"account_type": "savings",
"ifsc_code": "HDFC0001233"
}
},
"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)
```
```go Go theme={null}
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": 0,
"currency": "INR",
"description": "12 p.m. Meals",
"subscription_registration": map[string]interface{}{
"first_payment_amount": 100,
"method": "emandate",
"auth_type": "netbanking",
"expire_at": 1580480689,
"max_amount": 50000,
"bank_account": map[string]interface{}{
"beneficiary_name": "Gaurav Kumar",
"account_number": "11214311215411",
"account_type": "savings",
"ifsc_code": "HDFC0001233",
},
},
"receipt": "Receipt no. 1",
"expire_by": 1880480689,
"sms_notify": true,
"email_notify": true,
"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 theme={null}
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("first_payment_amount",100);
subscriptionRegistration.Add("method","emandate");
subscriptionRegistration.Add("auth_type","netbanking");
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");
subscriptionRegistration.Add("bank_account",bankAccount);
registrationLinkRequest.Add("subscription_registration", subscriptionRegistration);
registrationLinkRequest.Add("receipt", "Receipt No. 1");
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 theme={null}
{
"id": "inv_FHrY6tDtVP2dHg",
"entity": "invoice",
"receipt": "Receipt no. 25",
"invoice_number": "Receipt no. 25",
"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_FHrY6tiC2y7NNN",
"line_items": [],
"payment_id": null,
"status": "issued",
"expire_by": 1880480689,
"issued_at": 1595491063,
"paid_at": null,
"cancelled_at": null,
"expired_at": null,
"sms_status": "pending",
"email_status": "pending",
"date": 1595491063,
"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": "test registration link",
"notes": {
"note_key 1": "Beam me up Scotty",
"note_key 2": "Tea. Earl Gray. Hot."
},
"comment": null,
"short_url": "https://rzp.io/i/DxEcNtR",
"view_less": true,
"billing_start": null,
"billing_end": null,
"type": "link",
"group_taxes_discounts": false,
"created_at": 1595491063,
"idempotency_key": null
}
```
```bash Curl theme={null}
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"
},
"type": "link",
"amount": 0,
"currency": "INR",
"description": "12 p.m. Meals",
"subscription_registration": {
"first_payment_amount": 100,
"method": "emandate",
"auth_type": "debitcard",
"expire_at": 1580480689,
"max_amount": 50000,
"bank_account": {
"beneficiary_name": "Gaurav Kumar",
"account_number": "11214311215411",
"account_type": "savings",
"ifsc_code": "HDFC0001233"
}
},
"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."
}
}'
```
```java Java theme={null}
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("first_payment_amount",100);
subscriptionRegistration.put("method","emandate");
subscriptionRegistration.put("auth_type","debitcard");
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");
subscriptionRegistration.put("bank_account",bankAccount);
registrationLinkRequest.put("subscription_registration", subscriptionRegistration);
registrationLinkRequest.put("receipt", "Receipt No. 1");
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 theme={null}
$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'=>0,'currency'=>'INR','description'=>'Registration Link for Gaurav Kumar','subscription_registration'=>array('first_payment_amount'=>100, 'method'=>'emandate', 'auth_type'=>'debitcard' ,'max_amount'=>'50000','expire_at'=>'1634215992','bank_account'=>array('beneficiary_name'=>'Gaurav Kumar', 'account_number'=>'11214311215411', 'account_type'=>'savings', 'ifsc_code'=>'HDFC0001233')),'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 theme={null}
var instance = new Razorpay({ key_id: 'YOUR_KEY_ID', key_secret: 'YOUR_SECRET' })
instance.payments.createRegistrationLink({
customer: {
name: "Gaurav Kumar",
email: "gaurav.kumar@example.com",
contact: 9123456780
},
type: "link",
amount: 0,
currency: "INR",
description: "Registration Link for Gaurav Kumar",
subscription_registration: {
first_payment_amount: 100,
method: "emandate",
auth_type: "debitcard",
max_amount: 50000,
expire_at: 1634215992,
bank_account: {
beneficiary_name: "Gaurav Kumar",
account_number: "11214311215411",
account_type: "savings",
ifsc_code: "HDFC0001233"
}
},
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 theme={null}
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': 0,
'currency': 'INR',
'description': '12 p.m. Meals',
'subscription_registration': {
'first_payment_amount': 100,
'method': 'emandate',
'auth_type': 'debitcard',
'expire_at': 1580480689,
'max_amount': 50000,
'bank_account': {
'beneficiary_name': 'Gaurav Kumar',
'account_number': 11214311215411,
'account_type': 'savings',
'ifsc_code': 'HDFC0001233',
},
},
'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.'}
})
```
```ruby Ruby theme={null}
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": 0,
"currency": "INR",
"description": "Registration Link for Gaurav Kumar",
"subscription_registration": {
"first_payment_amount": 100,
"method": "emandate",
"auth_type": "debitcard",
"max_amount": 50000,
"expire_at": 1634215992,
"bank_account": {
"beneficiary_name": "Gaurav Kumar",
"account_number": 11214311215411,
"account_type": "savings",
"ifsc_code": "HDFC0001233"
}
},
"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)
```
```go Go theme={null}
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": 0,
"currency": "INR",
"description": "12 p.m. Meals",
"subscription_registration": map[string]interface{}{
"first_payment_amount": 100,
"method": "emandate",
"auth_type": "debitcard",
"expire_at": 1580480689,
"max_amount": 50000,
"bank_account": map[string]interface{}{
"beneficiary_name": "Gaurav Kumar",
"account_number": "11214311215411",
"account_type": "savings",
"ifsc_code": "HDFC0001233",
},
},
"receipt": "Receipt no. 1",
"expire_by": 1880480689,
"sms_notify": true,
"email_notify": true,
"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)
```
```json Response theme={null}
{
"id": "inv_FHrZAOeCuB9HtK",
"entity": "invoice",
"receipt": "Receipt no. 26",
"invoice_number": "Receipt no. 26",
"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_FHrZAPOStKd4xS",
"line_items": [],
"payment_id": null,
"status": "issued",
"expire_by": 1880480689,
"issued_at": 1595491123,
"paid_at": null,
"cancelled_at": null,
"expired_at": null,
"sms_status": "pending",
"email_status": "pending",
"date": 1595491123,
"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": "test registration link",
"notes": {
"note_key 1": "Beam me up Scotty",
"note_key 2": "Tea. Earl Gray. Hot."
},
"comment": null,
"short_url": "https://rzp.io/i/RllVOmA",
"view_less": true,
"billing_start": null,
"billing_end": null,
"type": "link",
"group_taxes_discounts": false,
"created_at": 1595491123,
"idempotency_key": null
}
```
`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.
`contact`*mandatory*
: `integer` Customer's contact number.
`type` *mandatory*
: `string` In this case, the value is `link`.
`amount` *mandatory*
: `integer` The payment amount in the smallest currency sub-unit.
`currency` *mandatory*
: `string` The 3-letter ISO currency code for the payment.
`description` *mandatory*
: `string` A description that appears on the hosted page.
`subscription_registration`
: `object` Details of the authorisation payment.
`method` *mandatory*
: `string` The authorization method. Here, it is `emandate`.
`auth_type` *optional*
: `string` Possible values:
* `netbanking`
* `debitcard`
* `aadhaar`
`first_payment_amount` *optional*
: `integer` The amount, in paise, the customer should be auto-charged in addition to the authorisation amount. For example, `100000`. Pass a value in the `first_payment_amount` parameter if you want to auto-charge the customer the first payment immediately after mandate authorisation. The first payment amount will be debited, with a new `order_id` and corresponding `payment_id` created automatically and executed within 2 days of emandate token confirmation.
`max_amount` *optional*
: `integer` The maximum amount, in paise, a customer can be charged in a transaction. Know about [maximum and default values](/docs/payments/recurring-payments/emandate/faqs#2-what-is-the-maximum-amount-which-can).
`expire_at` *optional*
: `integer` The Unix timestamp indicates till when you can use the token (authorization on the payment method) to charge the customer their subsequent payments. Defaults to `40 years`. The maximum value you can set is 40 years from the current date. Any value beyond this will throw an error.
`bank_account`
: `object` The customer's bank account details.
`beneficiary_name` *optional*
: `string` Name on the beneficiary. For example `Gaurav Kumar`.
**Watch Out!**
The `beneficiary_name` should be between 4 to 120 characters.
`account_number` *optional*
: `string` Customer's bank account number. For example `11214311215411`.
`account_type` *optional*
: `string` Customer's bank account type. Possible values:
* `savings` (default)
* `current`
`ifsc_code` *optional*
: `string` Customer's bank IFSC. For example `HDFC0000001`.
`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”`.
`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:
`POST /invoices/:id/notify_by/:medium`
```bash Curl theme={null}
curl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET]
-X POST https://api.razorpay.com/v1/invoices/inv_1Aa00000000001/notify_by/sms
```
```java Java theme={null}
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 theme={null}
$api = new Api($key_id, $secret);
$api->invoice->fetch($invoiceId)->notify($medium);
```
```javascript Node.js theme={null}
var instance = new Razorpay({ key_id: 'YOUR_KEY_ID', key_secret: 'YOUR_SECRET' })
instance.invoices.notifyBy(invoiceId, medium)
```
```python Python theme={null}
client = razorpay.Client(auth=("YOUR_ID", "YOUR_SECRET"))
client.invoice.notify_by(invoiceId, medium)
```
```ruby Ruby theme={null}
require "razorpay"
Razorpay.setup('YOUR_KEY_ID', 'YOUR_SECRET')
invoiceId = "inv_JDdNb4xdf4gxQ7"
medium = "email"
Razorpay::Invoice.notify_by(invoiceId, medium)
```
```go Go theme={null}
import ( razorpay "github.com/razorpay/razorpay-go" )
client := razorpay.NewClient("YOUR_KEY_ID", "YOUR_SECRET")
body, err := client.Invoice.Notify("", "", nil, nil)
```
```csharp .NET theme={null}
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);
```
```json Response theme={null}
{
"success": true
}
```
`id`*mandatory*
: `string` The unique identifier of the invoice linked to the registration link for which you want to send the notification. For example, `inv_1Aa00000000001`.
`medium` *mandatory*
: `string` Determines through which medium you want to resend the notification. Possible values:
* `sms`
* `email`
`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.
`POST /invoices/:id/cancel`
**Handy Tips**
You can only cancel registration link in the `issued` state.
```bash Curl theme={null}
curl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET]
-X POST https://api.razorpay.com/v1/invoices/inv_1Aa00000000001/cancel
```
```java Java theme={null}
RazorpayClient razorpay = new RazorpayClient("[YOUR_KEY_ID]", "[YOUR_KEY_SECRET]");
String invoiceId = "inv_1Aa00000000001";
Invoice invoice = razorpay.invoices.cancel(invoiceId);
```
```php PHP theme={null}
$api = new Api($key_id, $secret);
$api->invoice->fetch($invoiceId)->cancel();
```
```javascript Node.js theme={null}
var instance = new Razorpay({ key_id: 'YOUR_KEY_ID', key_secret: 'YOUR_SECRET' })
instance.invoices.cancel(invoiceId)
```
```python Python theme={null}
client = razorpay.Client(auth=("YOUR_ID", "YOUR_SECRET"))
client.invoice.cancel(invoiceId)
```
```ruby Ruby theme={null}
require "razorpay"
Razorpay.setup('YOUR_KEY_ID', 'YOUR_SECRET')
invoiceId = "inv_1Aa00000000001"
Razorpay::Invoice.cancel(invoiceId)
```
```go Go theme={null}
import ( razorpay "github.com/razorpay/razorpay-go" )
client := razorpay.NewClient("YOUR_KEY_ID", "YOUR_SECRET")
body, err := client.Invoice.Cancel("", nil, nil)
```
```csharp .NET theme={null}
RazorpayClient client = new RazorpayClient("[YOUR_KEY_ID]", "[YOUR_KEY_SECRET]");
string invoiceId = "inv_Z6t7VFTb9xHeOs";
Invoice invoice = client.Invoice.Fetch(invoiceId).Cancel();
```
```json Response theme={null}
{
"id": "inv_FHrfRupD2ouKIt",
"entity": "invoice",
"receipt": "Receipt No. 1",
"invoice_number": "Receipt No. 1",
"customer_id": "cust_BMB3EwbqnqZ2EI",
"customer_details": {
"id": "cust_BMB3EwbqnqZ2EI",
"name": "",
"email": "",
"contact": "",
"gstin": null,
"billing_address": null,
"shipping_address": null,
"customer_name": "",
"customer_email": "",
"customer_contact": ""
},
"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
}
```
`id` *mandatory*
: `string` The unique identifier for the invoice linked to the registration link that you want to cancel. For example, `inv_1Aa00000000001`.
`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.
## 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](/docs/payments/recurring-payments/create#3-search-for-the-token) or the APIs given below.
Know more about [Tokens](/docs/payments/recurring-payments/emandate/integrate#fetch-emandate-registration-details).
### 2.1. Fetch Token by Payment id
The following endpoint retrieves the `token_id` using a `payment_id`.
`GET /payments/:id`
```bash Curl theme={null}
curl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET] \
-X GET https://api.razorpay.com/v1/payments/pay_1Aa00000000002
```
```java Java theme={null}
RazorpayClient razorpay = new RazorpayClient("[YOUR_KEY_ID]", "[YOUR_KEY_SECRET]");
String paymentId = "pay_1Aa00000000002";
Payment payment = razorpay.payments.fetch(paymentId);
```
```php PHP theme={null}
$api = new Api($key_id, $secret);
$api->payment->fetch($paymentId);
```
```javascript Node.js theme={null}
var instance = new Razorpay({ key_id: 'YOUR_KEY_ID', key_secret: 'YOUR_SECRET' })
instance.payments.fetch(paymentId)
```
```python Python theme={null}
client = razorpay.Client(auth=("YOUR_ID", "YOUR_SECRET"))
client.payment.fetch(paymentId)
```
```ruby Ruby theme={null}
require "razorpay"
Razorpay.setup('YOUR_KEY_ID', 'YOUR_SECRET')
paymentId = "pay_1Aa00000000002"
Razorpay::Payment.fetch(paymentId)
```
```go Go theme={null}
import ( razorpay "github.com/razorpay/razorpay-go" )
client := razorpay.NewClient("YOUR_KEY_ID", "YOUR_SECRET")
body, err := client.Payment.Fetch("", nil, nil)
```
```csharp .NET theme={null}
RazorpayClient client = new RazorpayClient("[YOUR_KEY_ID]", "[YOUR_KEY_SECRET]");
string paymentId = "pay_Z6t7VFTb9xHeOs";
Payment payment = client.Payment.Fetch(paymentId);
```
```json Response theme={null}
{
"id": "pay_FHf9a7AO0iXM9I",
"entity": "payment",
"amount": 0,
"currency": "INR",
"status": "captured",
"order_id": "order_FHf9OwSeyetnKC",
"invoice_id": "inv_FHf9P2hhXEti7i",
"international": false,
"method": "emandate",
"amount_refunded": 0,
"refund_status": null,
"captured": true,
"description": null,
"card_id": null,
"bank": "HDFC",
"wallet": null,
"vpa": null,
"email": "gaurav.kumar@example.com",
"contact": "+919876543210",
"customer_id": "cust_DtHaBuooGHTuyZ",
"token_id": "token_FHf9aAZR9hWJkq",
"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": 1595447410
}
```
**Handy Tips**
You can also retrieve the `token_id` via the [payment.authorized](/docs/api/payments/recurring-payments/webhooks#payment-authorized) webhook.
`id` *mandatory*
: `string` The unique identifier of the payment to be retrieved. For example, `pay_1Aa00000000002`.
`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](/docs/payments/international-payments#supported-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
A customer can have multiple tokens and these tokens can be used to create subsequent payments for multiple products or services. The following endpoint retrieves tokens linked to a customer.
**Watch Out!**
This endpoint will not fetch the details of expired and unused tokens.
`GET /customers/:id/tokens`
```bash Curl theme={null}
curl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET] \
-X GET https://api.razorpay.com/v1/customers/cust_1Aa00000000002/tokens
```
```java Java theme={null}
RazorpayClient razorpay = new RazorpayClient("[YOUR_KEY_ID]", "[YOUR_KEY_SECRET]");
String customerId = "cust_1Aa00000000002";
Customer customer = razorpay.customers.fetchTokens(customerId);
```
```php PHP theme={null}
$api = new Api($key_id, $secret);
$api->customer->fetch($customerId)->tokens()->all();
```
```javascript Node.js theme={null}
var instance = new Razorpay({ key_id: 'YOUR_KEY_ID', key_secret: 'YOUR_SECRET' })
instance.customers.fetchTokens(customerId)
```
```python Python theme={null}
client = razorpay.Client(auth=("YOUR_ID", "YOUR_SECRET"))
client.token.all(customerId)
```
```ruby Ruby theme={null}
require "razorpay"
Razorpay.setup('YOUR_KEY_ID', 'YOUR_SECRET')
customerId = "cust_1Aa00000000002 "
Razorpay::Customer.fetchTokens(customerId)
```
```go Go theme={null}
import ( razorpay "github.com/razorpay/razorpay-go" )
client := razorpay.NewClient("YOUR_KEY_ID", "YOUR_SECRET")
body, err := client.Token.All("", nil, nil)
```
```csharp .NET theme={null}
RazorpayClient client = new RazorpayClient("[YOUR_KEY_ID]", "[YOUR_KEY_SECRET]");
string customerId = "cust_1Aa00000000001";
List token = client.Customer.Fetch(customerId).Tokens();
```
```json Response theme={null}
{
"entity": "collection",
"count": 2,
"items": [
{
"id": "token_FHf94Uym9tdYFJ",
"entity": "token",
"token": "2wDPM7VAlXtjAR",
"bank": "HDFC",
"wallet": null,
"method": "emandate",
"vpa": null,
"recurring": true,
"recurring_details": {
"status": "confirmed",
"failure_reason": null
},
"auth_type": "netbanking",
"mrn": null,
"used_at": 1595447381,
"created_at": 1595447381,
"bank_details": {
"beneficiary_name": "Gaurav Kumar",
"account_number": "1121431121541121",
"ifsc": "HDFC0000001",
"account_type": "savings"
},
"max_amount": 9999900,
"expired_at": 1689971140,
"dcc_enabled": false
},
{
"id": "token_FHf9aAZR9hWJkq",
"entity": "token",
"token": "AwAwIFBmDSJ4p6",
"bank": "HDFC",
"wallet": null,
"method": "emandate",
"vpa": null,
"recurring": true,
"recurring_details": {
"status": "confirmed",
"failure_reason": null
},
"auth_type": "debitcard",
"mrn": null,
"used_at": 1595447410,
"created_at": 1595447410,
"bank_details": {
"beneficiary_name": "Gaurav Kumar",
"account_number": "1121431121541121",
"ifsc": "HDFC0000001",
"account_type": "savings"
},
"max_amount": 9999900,
"expired_at": 4102444799,
"dcc_enabled": false
}
]
}
```
`id` *mandatory*
: `string` The unique identifier of the customer for whom tokens are to be retrieved. For example, `cust_1Aa00000000002`.
`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.
`DELETE /customers/:customer_id/tokens/:token_id`
```bash Curl theme={null}
curl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET] \
-X DELETE https://api.razorpay.com/v1/customers/cust_1Aa00000000002/tokens/token_1Aa00000000001
```
```java Java theme={null}
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 theme={null}
$api = new Api($key_id, $secret);
$api->customer->fetch($customerId)->tokens()->delete($tokenId);
```
```javascript Node.js theme={null}
var instance = new Razorpay({ key_id: 'YOUR_KEY_ID', key_secret: 'YOUR_SECRET' })
instance.customers.deleteToken(customerId, tokenId)
```
```python Python theme={null}
client = razorpay.Client(auth=("YOUR_ID", "YOUR_SECRET"))
client.token.delete(customerId, tokenId)
```
```ruby Ruby theme={null}
require "razorpay"
Razorpay.setup('YOUR_KEY_ID', 'YOUR_SECRET')
customerId = "cust_1Aa00000000004"
tokenId = "token_Hxe0skTXLeg9pF"
Razorpay::Customer.fetch(customerId).deleteToken(tokenId)
```
```go Go theme={null}
import ( razorpay "github.com/razorpay/razorpay-go" )
client := razorpay.NewClient("YOUR_KEY_ID", "YOUR_SECRET")
body, err := client.Token.Delete("", "", nil, nil)
```
```java Java theme={null}
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 theme={null}
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);
```
```json Response theme={null}
{
"deleted": true
}
```
`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`.
`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:
1. [Create an order to charge the customer](#3-1-create-an-order-to-charge-the-customer)
2. [Create a recurring payment](#3-2-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.
`POST /orders`
```bash Curl theme={null}
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 theme={null}
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 theme={null}
$api = new Api($key_id, $secret);
$api->order->create(array('receipt' => '123', 'amount' => 1000, 'payment_capture' => true, 'currency' => 'INR', 'notes'=> array('key1'=> 'value3','key2'=> 'value2')));
```
```javascript Node.js theme={null}
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 theme={null}
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 theme={null}
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 theme={null}
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 theme={null}
RazorpayClient client = new RazorpayClient("[YOUR_KEY_ID]", "[YOUR_KEY_SECRET]");
Dictionary orderRequest = new Dictionary();
orderRequest.Add("amount", 1000);
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);
```
```json Success Response theme={null}
{
"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 theme={null}
{
"error":{
"code":"BAD_REQUEST_ERROR",
"description":"The id provided does not exist",
"source":"business",
"step":"payment_initiation",
"reason":"input_validation_failed",
"metadata":{
}
}
}
```
`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](/docs/api/payments/capture).
`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.
`POST /payments/create/recurring`
```bash Curl theme={null}
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": "",
"contact": "",
"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 theme={null}
RazorpayClient razorpay = new RazorpayClient("[YOUR_KEY_ID]", "[YOUR_KEY_SECRET]");
JSONObject paymentRequest = new JSONObject();
paymentRequest.put("email", "");
paymentRequest.put("contact", "");
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 theme={null}
$api = new Api($key_id, $secret);
$api->payment->createRecurring(array('email'=>'','contact'=>'','amount'=>1000,'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 theme={null}
var instance = new Razorpay({ key_id: 'YOUR_KEY_ID', key_secret: 'YOUR_SECRET' })
instance.payments.createRecurringPayment({
"email": "",
"contact": "",
"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 theme={null}
client = razorpay.Client(auth=("YOUR_ID", "YOUR_SECRET"))
client.payment.createRecurring({
'email': '',
'contact': ,
'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 theme={null}
require "razorpay"
Razorpay.setup('YOUR_KEY_ID', 'YOUR_SECRET')
para_attr = {
"email": "",
"contact": "",
"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 theme={null}
import ( razorpay "github.com/razorpay/razorpay-go" )
client := razorpay.NewClient("YOUR_KEY_ID", "YOUR_SECRET")
data:= map[string]interface{}{
"email": "",
"contact": "",
"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 theme={null}
RazorpayClient client = new RazorpayClient("[YOUR_KEY_ID]", "[YOUR_KEY_SECRET]");
Dictionary paymentRequest = new Dictionary();
paymentRequest.Add("email", "");
paymentRequest.Add("contact", "");
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);
```
```json Success Response theme={null}
{
"razorpay_payment_id" : "pay_1Aa00000000001"
}
```
```json Failure Response theme={null}
{
"error":{
"code":"BAD_REQUEST_ERROR",
"description":"Amount exceeds maximum amount allowed",
"source":"business",
"step":"payment_initiation",
"reason":"input_validation_failed",
"metadata":{
}
}
}
```
`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_id`*mandatory*
: `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.
`description`*optional*
: `string` A user-entered description for the payment. For example, `Creating recurring payment for Gaurav Kumar`
`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”`.
`razorpay_payment_id`
: `string` The unique identifier of the payment that is created. For example, `pay_1Aa00000000001`.