Payments

Recurring Payments

Emandate

Charge Customer During Registration

Charge Customers During Registration - Use Cases and Payment Methods

Register a customer's mandate and debit the first recurring payment as part of the same transaction using Emandate.

If you are using the existing emandate flow, you can only charge the customer after they complete the authorisation transaction and the token is confirmed. This means, you need to wait a few days before you can charge the customer. If the mandate registration fails, you have to start the process again, causing further delays. This may lead to a delay in onboarding the customer impacting your business.

You can use this feature where you can charge any amount to your customer as part of the authorisation transaction. The customer is charged an amount immediately while initiating the mandate registration in the background. This helps you to onboard the customer immediately without waiting for the mandate to be registered.

Feature Request
This is an on-demand feature. Please raise a request with our Support team to get this feature activated on your Razorpay account.

Use Cases๐Ÿ”—

Following are a couple of use cases where you can use this feature:

Mutual Funds๐Ÿ”—

When a customer starts a new Systematic Investment Plan (SIP), the investment needs to be made immediately. The customer needs to be charged as part of the mandate registered process. It is not possible to wait for a few days while the mandate is registered before charging the customer.

Insurance๐Ÿ”—

If you are an insurance provider, you need to charge the customer the first premium immediately when selling them the policy.

1. Create an Authorization Transaction๐Ÿ”—

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๐Ÿ”—

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 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 generated in the response.

Request Parameters๐Ÿ”—

amount mandatory

integer Amount in currency subunits. Pass 100 for โ‚น1.

currency mandatory

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

method mandatory

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

payment_capture mandatory

boolean Indicates if auto-capture is enabled for the order. In this case, the value should 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.

auth_type optional

string Here, it has to be netbanking.

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. Default is 9999900 (โ‚น99,999).

expire_at optional

integer The timestamp, in Unix format, till when you can use the token (authorisation on the payment method) to charge the customer subsequent payments. Default is 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๐Ÿ”—

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.

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.

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

method mandatory

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

auth_type optional

string Here, it has to be netbanking.

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. Default is 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. Default is 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 The account holder's name. 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 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.

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.

Handy Tips
You can also search for the token on your Razorpay Dashboard.

2.1. Fetch Token by Payment ID๐Ÿ”—

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

/payments/:id

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

Path Parameter๐Ÿ”—

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

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๐Ÿ”—

Following are the two steps to create and charge your customer a subsequent payment:

You have to complete two steps to create and charge your customer subsequent payments:

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

Use the below endpoint to create an order:

/orders

Request Parameters๐Ÿ”—

amount mandatory
integer Amount in currency subunits. For cards, the minimum value is 100 (โ‚น1).
currency mandatory
string The 3-letter ISO currency code for the payment. Currently, we only support INR.
receipt optional
string A user-entered unique identifier for the order. For example, Receipt No. 1. This parameter should be mapped to the order_id sent by Razorpay.
notes optional
string 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โ€.
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.

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 Bank and Axis Bank, 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.
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โ€.
ร—

ON THIS PAGE