API ReferenceIntegrationsKnowledge Base

Register Emandate and Charge First Payment Together

1. Create an Authorization Transaction#

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. To do this all you have to do is pass the first_payment_amount parameter while creating the order.

You can create an authorization transaction:

1.1. Using Razorpay Standard Checkout#

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

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

1.1.1. Create a Customer#

Creating a unique identifier for a customer allows Razorpay to tie the associated recurring tokens to it via the authorization transaction.

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

You can create a customer using the below endpoint.

/customers

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

Request Parameters#

name mandatory
string The customer's name. For example, Gaurav Kumar.
email mandatory
string The customer's email address. For example, gaurav.kumar@example.com.
contact mandatory
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 a payment. This order_id has a 1:1 mapping with the order created for the authorization payment at your end. To learn more about Razorpay Orders, refer 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 created.

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.

method mandatory

string The authorization method. In this case the value will be emandate.

payment_capture mandatory

boolean Indicates if auto-capture is enabled for the order. In this case the value has to be 1.

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. Pass a value in the first_payment_amount parameter if you want to auto-charge the customer the first payment immediately after authorization.

first_payment_amount optional

integer The amount, in paise, the customer should be auto-charged in addition to the authorization amount. For example, 100000.

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 (4101580799).

bank_account

Customer bank account details.

account_number optional
string Customer's bank account number.
ifsc_code optional
string Customer's bank IFSC. For example UTIB0000001.
beneficiary_name optional
string Customer's name. For example, Gaurav Kumar.
account_type optional
string Customer's bank account type. Possible values:
  • savings (default)
  • current
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”.

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#

For the authorization transaction, the following additional parameters must be sent along with the existing checkout (manual) options.

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

Note:
You can use Webhooks to get notifications about successful payments against a registration link. Refer to the Notifications using Webhooks section for more information.

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#

Use the below endpoint to create a registration link.

/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
first_payment_amount optional

integer The amount, in paise, the customer should be auto-charged in addition to the authorization amount. For example, 100000.

max_amount optional

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

expire_at optional

integer The timestamp, in Unix, 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 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.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 How you want to resend the notification. Possible values are
  • sms
  • email

1.2.4. Cancel a Registration Link#

Use the below endpoint to cancel a registration link.

/invoices/:id/cancel

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

2. Fetch and Manage Tokens#

Once you capture a payment, Razorpay Checkout returns a razorpay_payment_id that can be used to fetch the token_id. This is a manual process and can be done using either APIs or Webhooks. This token_id is used to create and charge subsequent payments. Learn about about Tokens.

Note:
You can also search for the Token on your Dashboard. Learn how to search for a Token on the Dashboard.

2.1. Fetch Token by Payment ID#

Use the below endpoint to fetch the token_id using a payment_id.

/payments/:id

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

Path Parameter#

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

2.2. Fetch Tokens by Customer ID#

Use the below endpoint to fetch all tokens linked to a customer.

A customer can have multiple tokens tied to them. These tokens can be used to create subsequent payments for multiple products or services.

/customers/:id/tokens

Path Parameter#

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

2.3. Delete Tokens#

Use the below endpoint to delete a token. You get a 200 OK response if the token is deleted successfully.

/customers/:customer_id/tokens/:token_id

Path Parameter#

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

3. Create Subsequent Payments#

You have to complete two steps to create and charge your customer a subsequent payment. These are:

  1. Create an order to charge the customer
  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 when you created the authorization transaction.

Use the below endpoint to create an order.

/orders

Auto-capture Payments:
To auto-capture payments, set payment_capture to 1 as shown in the example.

The payment_capture parameter defaults to 0 if not set.

3.2. Create a Recurring Payment#

Once you have generated an order_id, use it along with the token_id to create a payment and charge the customer.

Use the below endpoint to create a payment and charge the customer.

/payments/create/recurring

Once our system validates and successfully processes the payment request, a razorpay_payment_id is returned. In the case of some banks such as HDFC and Axis, the payment entity returned will be in the created state since the charge system of these banks are file-based and can take a few hours.

Request Parameters#

email mandatory
string The customer's email address. For example, gaurav.kumar@example.com.
contact mandatory
string The customer's phone number. For example, 9876543210.
amount mandatory
integer The amount you want to charge your customer. This should be the same as the amount in the order.
currency mandatory
string 3-letter ISO currency code for the payment. Currently, only INR is allowed.
order_idmandatory
string The unique identifier of the order created. For example, order_1Aa00000000002.
customer_id mandatory
string The customer_id for the customer you want to charge. For example, cust_1Aa00000000002.
token mandatory
string The token_id generated when the customer successfully completes the authorization payment. Different payment instruments for the same customer have different token_id.
recurring mandatory
boolean Determines if recurring payment is enabled or not. Possible values:
  • 1 - Recurring is enabled.
  • 0 - Recurring is not enabled.
descriptionoptional
string A user-entered description for the payment. For example, Creating recurring payment for Gaurav Kumar.
notesoptional
object Key-value pair that can be used to store additional information about the entity. Maximum 15 key-value pairs, 256 characters (maximum) each. For example, "note_key": "Beam me up Scotty”.
×