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
to get this feature activated on your Curlec account.Following are a couple of use cases where you can use this feature:
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.
If you are an insurance provider, you need to charge the customer the first premium immediately when selling them the policy.
Currently, only HDFC and ICICI support this feature.
The integration flow here is same as that for emandate registration.
- .
- .
- .
You can create an authorisation transaction:
- Using the .
- Using a .
To create an authorisation transaction using the Razorpay Standard Checkout, you need to:
- .
- .
- .
Curlec links recurring tokens to customers via a unique identifier. You can generate this identifier using the Customer API.
You can create
with basic information such asemail
and contact
and use them for various Curlec offerings. The following endpoint creates a customer.
Request Parameters
name
mandatory
string
The name of the customer. For example, Nur Aisyah
.
mandatory
string
The email ID of the customer. For example, nur.aisyah@example.com
.
contact
mandatory
string
The phone number of the customer. For example, 60345675444
.
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”
.
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
Use the below endpoint to create an order.
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.
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”
.
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
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”
.
Create a payment checkout form for customers to make Authorisation Transaction and register their mandate. You can use the Handler Function or Callback URL.
Watch Out!
The Callback URL is not supported for Recurring Payments created using the registration link.
Additional Checkout Fields
You should send the following additional parameters along with the existing checkout options as a part of the authorisation transaction.
customer_id
mandatory
string
Unique identifier of the customer created in the
order_id
mandatory
string
Unique identifier of the order created in the
recurring
mandatory
: integer
. In this case, the value has to be 1
.Registration Link is an alternate way of creating an authorization transaction. You can create a registration link using the
orHandy Tips
You do not have to create a customer if you choose the registration link method for creating an authorization transaction.
- When you create a registration link, an is automatically issued to the customer. They can use this invoice to make the authorization payment.
Handy Tips
You can
against a registration link.Use the below endpoint to create a registration link.
Request Parameters
customer
Details of the customer to whom the registration link will be sent.
name
mandatory
string
. Customer's name.
mandatory
string
. Customer's email address.
contact
mandatory
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”
.
The following endpoint sends/resends notifications with the short URL to the customer:
Path Parameters
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
The following endpoint cancels a registration link.
Handy Tips
You can only cancel registration link 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
.
Once you capture a payment, Curlec 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
in the following ways:
- API
The following endpoint retrieves the token_id
using a payment_id
.
Handy Tips
You can also retrieve the token_id
via the
id
mandatory
string
The unique identifier of the payment to be retrieved. For example, pay_1Aa00000000002
.
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.
id
mandatory
string
The unique identifier of the customer for whom tokens are to be retrieved. For example, cust_1Aa00000000002
.
The following endpoint deletes a token.
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
.
Following are the two steps to create and charge your customer a subsequent payment:
You should perform the following steps to create and charge your customer subsequent payments:
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.
amount
mandatory
integer
Amount in currency subunits. For cards, the minimum value is 100
(MYR 1.00).
currency
mandatory
string
The 3-letter ISO currency code for the payment. Currently, we only support MYR
.
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 Curlec.
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 .
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.
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.
description
optional
string
A user-entered description for the payment. For example, Creating recurring payment for Nur Aisyah
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”
.
Was this page helpful?
ON THIS PAGE