Api

Payments

Recurring Payments

Emandate

Create Authorization Transaction

1. Create the Authorization Transaction

Learn how to create an authorization transaction with method emandate so customers can complete the authorization using their netbanking login.

You can create an authorization transaction:

1.1. Using Razorpay APIs🔗

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

  1. Create a Customer.
  2. Create an Order.
  3. Create Authorization Payment using Razorpay APIs.

Handy Tips
For the Authorization Payment to be successful in a day (Example: 5th June), you should create an Order and the Authorization Transaction on the same day (5th June) before 11:59 pm.

1.1.1. Create a Customer🔗

Razorpay links recurring tokens to customers via a unique identifier. This unique identifier for the customer is generated using the Customer API.

You can create customers with basic details such as email and contact and use them for various Razorpay offerings. Know more about Customers.

You can create a customer using the below endpoint.

/customers

Once a customer is created, you can create an order for the authorization of the payment.

Request Parameters🔗

name mandatory
string The customer's name. For example, Gaurav Kumar.
email optional
string The customer's email address. For example, gaurav.kumar@example.com.
contact optional
string The customer's phone number. For example, 9876543210.
fail_existing optional
string If a customer with the same details already exists, the request throws an exception by default. You can pass an additional parameter fail_existing to get the details of the existing customer in the response. Possible values:
  • 0 - fetch details of existing customer
  • 1 - throw the exception error (default)
notes optional
object Key-value pair that can be used to store additional information about the entity. Maximum 15 key-value pairs, 256 characters (maximum) each. For example, "note_key": "Beam me up Scotty”.

1.1.2. Create an Order🔗

The Orders API allows you to create a unique Razorpay order_id, for example, order_1Aa00000000001, that would be tied to the authorization transaction. To learn more about Razorpay Orders, refer to our detailed Order documentation.

Use the below endpoint to create an order.

/orders

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

Authorization transaction + auto-charge first payment:
You can register a customer's mandate AND charge them the first recurring payment as part of the same transaction. Refer to the Emandate section under Registration and Charge First Payment Together for more information.

Request Parameters🔗

amount mandatory

integer Amount in currency subunits. For emandate, the amount has to 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 authorization method. In this case the value will be emandate.

customer_id mandatory

string The unique identifier of the customer, who is to be charged. For example, cust_D0cs04OIpPPU1F.

receipt optional

string. A user-entered unique identifier for the order. For example, rcptid #1. This parameter should be mapped to the order_id sent by Razorpay.

notesoptional

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

token

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

auth_type optional

string Possible values:

  • netbanking
  • debitcard
  • aadhaar
max_amount optional

integer The maximum amount, in paise, that a customer can be charged in one transaction. The value can range from 500 - 100000000. Defaults to 9999900 (₹99,999).

expire_at optional

integer The timestamp, in Unix format, till when you can use the token (authorization on the payment method) to charge the customer subsequent payments. Defaults to 10 years for emandate. The value can range from the current date to 31-12-2099 (4102444799).

notesoptional

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

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 Customer's name. For example, Gaurav Kumar.
notesoptional

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

Authorization transaction + auto-charge first payment:
You can register a customer's mandate AND charge them the first recurring payment as part of the same transaction. Refer to the Emandate section under Registration and Charge First Payment Together for more information.

1.1.3. Create an Authorization Payment🔗

Handler Function vs Callback URL

  • Handler Function
    When you use the handler function, the response object of the successful payment (razorpay_payment_id, razorpay_order_id and razorpay_signature) is submitted to the Checkout Form. You need to collect these and send them to your server.
  • Callback URL
    When you use a Callback URL, the response object of the successful payment (razorpay_payment_id, razorpay_order_id and razorpay_signature) is submitted to the Callback URL.

Additional Checkout Fields🔗

The following additional parameters must be sent along with the existing checkout options as part of the authorization transaction.

customer_id mandatory
string Unique identifier of the customer created in the first step.
order_id mandatory
string Unique identifier of the order created in the second step.
recurring mandatory
integer. In this case, the value has to be 1.

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.

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

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.

Use the below endpoint to create a registration link for recurring payments.

/subscription_registration/auth_links

Request Parameters🔗

customer

Details of the customer to whom the registration link will be sent.

name mandatory
string. Customer's name.
email mandatory
string. Customer's email address.
contactmandatory
string. Customer's phone number.
type mandatory

string. In this case, the value is link.

currency mandatory

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

amount mandatory

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

description mandatory

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

subscription_registration

Details of the authorization payment.

method mandatory

string The authorization method. In this case, it will be emandate.

auth_type optional

string Possible values:

  • netbanking
  • debitcard
  • aadhaar
max_amount optional

integer The maximum amount, in paise, that a customer can be charged in one transaction. The value can range from 500 - 99999900. Defaults to 9999900 (₹99,999).

expire_at optional

integer The timestamp, in Unix format, till when you can use the token (authorization on the payment method) to charge the customer subsequent payments. Defaults to 10 years for emandate. The value can range from the current date to 31-12-2099 (4101580799).

bank_account

The customer's bank account details.

beneficiary_name optional
string Name on the bank account. For example Gaurav Kumar.
account_number optional
integer 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. Can have the following 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. Can have the following values:

  • 0 - Notifications are not sent by Razorpay.
  • 1 - Notifications are sent by Razorpay (default value).
expire_by optional

integer The timestamp, in Unix, till when the registration link should be available to the customer to make the authorization transaction.

receipt optional

string A unique identifier entered by you for the order. For example, Receipt No. 1. This parameter should be mapped to the order_id sent by Razorpay.

notes optional

object This is a key-value pair that 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🔗

Use the below endpoint to send/resend notifications with the short URL to the customer:

/invoices/:id/notify_by/:medium

Allowed values for medium path parameter is sms and email.

Path Parameters🔗

idmandatory
string The unique identifier of the invoice linked to the registration link for which you want to send the notification. For example, inv_1Aa00000000001.
medium mandatory
string Determines by which you would like to resend the notification. Possible values are
  • sms
  • email

Use the below endpoint to cancel a registration link.

/invoices/:id/cancel

Hand Tips
You can only cancel registration link that is in the issued state.

Path Parameter🔗

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

ON THIS PAGE