1. Create the Authorization Transaction

Create an authorisation transaction for emandate to complete your customer's authorization using their netbanking login.

You can create an authorization transaction:

Using the
Razorpay APIs
.
Using a
Registration Link
.

1.1. Using Razorpay APIs

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

1.1.1. Create a Customer

Razorpay links recurring tokens to customers via a unique identifier. You can generate this identifier using the Customer API.

You can create

customers

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

POST

/customers

Request Parameters

name

mandatory

string The name of the customer. For example, Gaurav Kumar.

mandatory

string The email ID of the customer. For example, gaurav.kumar@example.com.

contact

mandatory

string The phone number of the customer. For example, 9876543210.

fail_existing

optional

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

0: Retrieve details of the existing customer.
1 (default): Throws an exception error.

notes

optional

object Key-value pair that can be used to store additional information about the entity. Maximum 15 key-value pairs, 256 characters (maximum) each. For example, "note_key": "Beam me up Scotty”.

1.1.2. Create an Order

You can use the

Orders API

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

POST

/orders

You can use the

Orders

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

POST

/orders

curl -u <YOUR_KEY_ID>:<YOUR_KEY_SECRET> \
-X POST https://api.razorpay.com/v1/orders \
-H "Content-Type: application/json" \
-d '{
  "amount": 0,
  "currency": "INR",
  "payment_capture": true,
  "method": "emandate",
  "customer_id": "cust_1Aa00000000001",
  "receipt": "Receipt No. 1",
  "notes": {
    "notes_key_1": "Beam me up Scotty",
    "notes_key_2": "Engage"
  },
  "token": {
    "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"
    }
  }
}'

curl -u <YOUR_KEY_ID>:<YOUR_KEY_SECRET> \
-X POST https://api.razorpay.com/v1/orders \
-H "Content-Type: application/json" \
-d '{
  "amount": 0,
  "currency": "INR",
  "payment_capture": true,
  "method": "emandate",
  "customer_id": "cust_1Aa00000000001",
  "receipt": "Receipt No. 1",
  "notes": {
    "notes_key_1": "Beam me up Scotty",
    "notes_key_2": "Engage"
  },
  "token": {
    "auth_type": "debitcard",
    "max_amount": 9999900,
    "expire_at": 4102444799,
    "bank_account": {
      "beneficiary_name": "Gaurav Kumar",
      "account_number": "1121431121541121",
      "account_type": "savings",
      "ifsc_code": "HDFC0000001"
    },
    "notes": {
      "notes_key_1": "Tea, Earl Grey, Hot",
      "notes_key_2": "Tea, Earl Grey… decaf."
    }
  }
}'

curl -u <YOUR_KEY_ID>:<YOUR_KEY_SECRET> \
-X POST https://api.razorpay.com/v1/orders \
-H "Content-Type: application/json" \
-d '{
  "amount": 0,
  "currency": "INR",
  "payment_capture": true,
  "method": "emandate",
  "customer_id": "cust_1Aa00000000001",
  "receipt": "Receipt No. 1",
  "notes": {
    "notes_key_1": "Beam me up Scotty",
    "notes_key_2": "Engage"
  },
  "token": {
    "auth_type": "aadhaar",
    "max_amount": 9999900,
    "expire_at": 4102444799,
    "bank_account": {
      "beneficiary_name": "Gaurav Kumar",
      "account_number": "1121431121541121",
      "account_type": "savings",
      "ifsc_code": "HDFC0000001"
    },
    "notes": {
      "notes_key_1": "Tea, Earl Grey, Hot",
      "notes_key_2": "Tea, Earl Grey… decaf."
    }
  }
}'

Authorisation transaction + auto-charge first payment

You can register a customer's mandate and charge them the first recurring payment as part of the same transaction. Know more about

charge first payment automatically after Emandate registration

Request Parameters

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

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

Details related to the authorisation such as max amount and bank account information.

auth_type

optional

string Emandate type used to make the authorisation payment. Possible values:

netbanking
debitcard
aadhaar

max_amount

optional

integer The maximum amount in paise a customer can be charged in a transaction. Defaults to 9999900 (₹99,999). The maximum value you can set is 1000000000 (₹1,00,00,000)

expire_at

optional

integer The Unix timestamp to indicate till when you can use the token (authorisation on the payment method) to charge the customer 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.

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

Customer's bank account details that should be pre-filled on the checkout.

account_number

optional

string Customer's bank account number.

account_type

optional

string Customer's bank account type. Possible values:

savings (default value)
current

ifsc_code

optional

string Customer's bank IFSC. For example UTIB0000001.

beneficiary_name

optional

string Name of the beneficiary. For example, Gaurav Kumar.

Watch Out!

The beneficiary_name should be between 4 to 120 characters.

1.1.3. Create an Authorization Payment

Once an order is created, your next step is to create a payment. Use the below endpoint to create a payment with payment method netbanking.

POST

/payments/create/json

Request Parameters

amount

mandatory

integer Amount in currency subunits. For netbanking, the amount has to be 0 (₹0).

currency

mandatory

string The 3-letter ISO currency code for the payment. Currently, we only support INR.

order_id

mandatory

string The unique identifier of the order created using in

Step 1.1.2

customer_id

mandatory

string The unique identifier of the customer to be charged. For example, cust_K39wXdBlhqNk0B.

recurring

mandatory

string Possible values:

1: Recurring payment is enabled.
preferred: Use this when you want to support recurring payments and one-time payment in the same flow.

auth_type

optional

string Emandate type used to make the authorization payment. Possible values:

netbanking
debitcard
aadhaar

mandatory

string The customer's email address. For example, gaurav.kumar@example.com.

contact

mandatory

string The customer's contact number. For example, 8888888888.

method

mandatory

string The payment method selected by the customer. Here, the value must be emandate.

bank

mandatory

string The customer's bank name. The bank code used here should match the bank details used in

Step 1.1.2

. Use the

Method API

to check the bank code.

account_number

string Customer's bank account number.

account_type

string Customer's bank account type. Possible values:

savings (default value)
current

ifsc_code

string Customer's bank IFSC. For example HDFC0000001.

Response Parameters

If the payment request is valid, the response contains the following fields. Refer to the

S2S Json V2 integration document

for more details.

razorpay_payment_id

string Unique identifier of the payment. Present for all responses.

array A list of action objects available to you to continue the payment process. Present when the payment requires further processing.

action

string An indication of the next step available to you to continue the payment process. The value here is redirect - Use this URL to redirect customer to the bank page.

url

string URL to be used for the action indicated.

1.2. Using a Registration Link

Registration Links are an alternate way of creating an authorization transaction. If you create a registration link, you need not create a customer or an order.

When you create a registration link, an

invoice

is automatically issued to the customer. The customer can use the invoice to make the Authorization Payment.

Know how to

create Registration Links

using the Razorpay Dashboard.

Handy Tips

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

Webhooks

A registration link must always have an amount (in Paise) that the customer will be charged when making the authorization payment. In the case of emandate, the order amount must be 0.

1.2.1. Create a Registration Link

The following endpoint creates a registration link.

POST

/subscription_registration/auth_links

curl -u <YOUR_KEY_ID>:<YOUR_KEY_SECRET>
-X POST https://api.razorpay.com/v1/subscription_registration/auth_links
-H "Content-Type: application/json" \
-d '{
  "customer": {
    "name": "Gaurav Kumar",
    "email": "gaurav.kumar@example.com",
    "contact": "9123456780"
  },
  "type": "link",
  "amount": 0,
  "currency": "INR",
  "description": "12 p.m. Meals",
  "subscription_registration": {
    "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": 1,
  "email_notify": 1,
  "notes": {
    "note_key 1": "Beam me up Scotty",
    "note_key 2": "Tea. Earl Gray. Hot."
  }
}'

curl -u <YOUR_KEY_ID>:<YOUR_KEY_SECRET>
-X POST https://api.razorpay.com/v1/subscription_registration/auth_links
-H "Content-Type: application/json" \
-d '{
  "customer": {
    "name": "Gaurav Kumar",
    "email": "gaurav.kumar@example.com",
    "contact": "9123456780"
  },
  "type": "link",
  "amount": 0,
  "currency": "INR",
  "description": "12 p.m. Meals",
  "subscription_registration": {
    "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": 1,
  "email_notify": 1,
  "notes": {
    "note_key 1": "Beam me up Scotty",
    "note_key 2": "Tea. Earl Gray. Hot."
  }
}'

curl -u <YOUR_KEY_ID>:<YOUR_KEY_SECRET>
-X POST https://api.razorpay.com/v1/subscription_registration/auth_links
-H "Content-Type: application/json" \
-d '{
  "customer": {
    "name": "Gaurav Kumar",
    "email": "gaurav.kumar@example.com",
    "contact": "9123456780"
  },
  "type": "link",
  "amount": 0,
  "currency": "INR",
  "description": "12 p.m. Meals",
  "subscription_registration": {
    "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": 1,
  "email_notify": 1,
  "notes": {
    "note_key 1": "Beam me up Scotty",
    "note_key 2": "Tea. Earl Gray. Hot."
  }
}'

Request Parameters

customer

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

name

mandatory

string Customer's name.

mandatory

string Customer's email address.

contact

mandatory

integer Customer's contact number.

type

mandatory

string In this case, the value is link.

amount

mandatory

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

currency

mandatory

string The 3-letter ISO currency code for the payment. Currently, only INR is supported.

description

mandatory

string A description that appears on the hosted page. For example, 12:30 p.m. Thali meals (Gaurav Kumar).

subscription_registration

Details of the authorization payment.

method

mandatory

string The authorization method. Here, it is emandate.

auth_type

optional

string Possible values:

netbanking
debitcard
aadhaar

max_amount

optional

integer The maximum amount, in paise, a customer can be charged in a transaction. Defaults to 9999900 (₹99,999). The maximum value you can set is 1000000000 (₹1,00,00,000)

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

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:

0: Notifications are not sent by Razorpay.
1: Notifications are sent by Razorpay (default value).

email_notify

optional

boolean Indicates if email notifications are to be sent by Razorpay. Possible values:

0: Notifications are not sent by Razorpay.
1: Notifications are sent by Razorpay (default value).

expire_by

optional

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

receipt

optional

string A unique identifier entered by you for the order. For example, Receipt No. 1. You should map this parameter to the order_id sent by Razorpay.

notes

optional

object This is a key-value pair that is used to store additional information about the entity. Maximum 15 key-value pairs, 256 characters (maximum) each. For example, "note_key": "Beam me up Scotty”.

1.2.2. Send/Resend Notifications

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

POST

/invoices/:id/notify_by/:medium

Path Parameters

mandatory

string The unique identifier of the invoice linked to the registration link for which you want to send the notification. For example, inv_1Aa00000000001.

medium

mandatory

string Determines through which medium you want to resend the notification. Possible values:

sms
email

1.2.3. Cancel a Registration Link

The following endpoint cancels a registration link.

POST

/invoices/:id/cancel

Handy Tips

You can only cancel registration link in the issued state.

Path Parameter

mandatory

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

Is this integration guide useful?

ON THIS PAGE

1.1. Using Razorpay APIs

1.1.1. Create a Customer

Request Parameters

1.1.2. Create an Order

Request Parameters

1.1.3. Create an Authorization Payment

1.2. Using a Registration Link

1.2.1. Create a Registration Link

Request Parameters

1.2.2. Send/Resend Notifications

Path Parameters

1.2.3. Cancel a Registration Link

Path Parameter