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.
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ā
.
id
string
The unique identifier of the customer. For example cust_1Aa00000000001
.
entity
string
The name of the entity. Here, it is customer
.
name
string
The name of the customer. For example, Nur Aisyah
.
string
The email ID of the customer. For example, nur.aisyah@example.com
.
contact
string
The phone number of the customer. For example, 60345675444
.
notes
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ā
.
created_at
integer
A Unix timestamp, at which the customer was created.
You can create an order once you create a customer for the payment authorisation.
You can use the
to create a unique Curlecorder_id
that is associated with the authorisation transaction. The following endpoint creates an order.
amount
mandatory
integer
Amount in currency subunits. For Paper NACH, 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 authorisation method. In this case the value will be nach
.
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 authorisation such as max amount, bank account information and NACH information.
auth_type
mandatory
string
In this case, it will be physical
.
bank_account
Customer's bank account details that will be printed on the NACH form.
account_number
mandatory
string
Customer's bank account number. For example 11214311215411
.
ifsc_code
mandatory
string
Customer's bank IFSC. For example UTIB0000001
.
beneficiary_name
mandatory
string
Customer's name. For example, Gaurav Kumar
.
account_type
optional
string
Customer's bank account type. Possible values:
savings
(default)current
cc
(Cash Credit)nre
(SB-NRE)nro
(SB-NRO)
max_amount
optional
integer
Use to set the maximum amount per debit request. The value can range from 500
- 1000000000
(1cr, default value).
expire_at
optional
integer
Timestamp, in Unix, that specifies when the registration link should expire. The value can range from the current date to 01-19-2038 (2147483647
).
nach
Additional information to be printed on the NACH form that your customer will sign.
form_reference1
optional
string
A user-entered reference that appears on the NACH form.
form_reference2
optional
string
A user-entered reference that appears on the NACH form.
description
optional
string
A user-entered description that appears on the hosted page. For example, Form for Gaurav Kumar.
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ā
.
id
string
A unique identifier of the order created. For example order_1Aa00000000001
.
entity
string
The entity that is created. Here it is order
.
amount
integer
Amount in currency subunits. For NACH, the amount should be 0
.
amount_paid
integer
The amount that has been paid.
amount_due
integer
The amount that is yet to pay.
currency
string
The 3-letter ISO currency code for the payment. Currently, we only support INR
.
receipt
string
A user-entered unique identifier of the order. For example, rcptid #10
. You should map this parameter to the order_id
sent by Razorpay.
status
string
The status of the order. Here, it is created
.
notes
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ā
.
created_at
integer
The Unix timestamp at which the order was created.
token
Details related to the authorisation such as max amount and bank account information.
method
string
Payment method used to make the authorisation payment. Here, it is nach
.
notes
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ā
.
max_amount
integer
The maximum amount in paise a customer can be charged in a transaction. The value can range from 500
to 100000000
.
expire_at
integer
The Unix timestamp to indicate the date till which you can use the token (authorisation on the payment method) to charge the customer subsequent payments.
auth_type
string
NACH type used to make the authorisation payment. Here, it is physical
.
nach
Additional information to be printed on the NACH form that your customer will sign.
create_form
boolean
Indicates whether the form is created or not. Possible values:
true
: The NACH form is created.false
: The NACH form is not created.
form_reference1
string
A user-entered reference that appears on the NACH form.
form_reference2
string
A user-entered reference that appears on the NACH form.
prefilled_form
string
The link from where you can download the pre-filled NACH form.
upload_form_url
string
The link where the NACH form should be uploaded once it is signed by the customer.
description
string
A user-entered description that appears on the hosted page. For example, Paper NACH Gaurav Kumar
.
bank_account
Customer's bank account details that should be pre-filled on the checkout.
ifsc_code
string
Customer's bank IFSC. For example, HDFC0000001
.
bank_name
string
The bank name. For example, HDFC Bank
.
name
string
Name of the beneficiary. For example, Gaurav Kumar
.
account_number
string
Customer's bank account number.
account_type
string
Customer's bank account type. Possible values:
savings
(default value)current
cc
(Cash Credit)nre
(SB-NRE)nro
(SB-NRO)
beneficiary_email
string
Email address of the beneficiary. For example, gaurav.kumar@example.com
.
beneficiary_mobile
integer
Mobile number of the beneficiary.
Download and Upload the Pre-filled NACH Form
Once the order is created, the pre-filled form must be downloaded, signed by your customer and uploaded back to Razorpay to complete the transaction.
You receive the following parameters as part of the response:
prefilled_form
The link from where you can download the pre-filled NACH form.
upload_form_url
The link where the NACH form should be uploaded once it is signed by the customer.
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. Refer to the
for more information.Given below is a list of possible errors you may face while creating an Order.
Error | Cause | Solution |
---|---|---|
The id provided does not exist | This error occurs when you enter an incorrect customer_id . | Make sure to enter a valid customer_id . |
The api key provided is invalid | This error occurs when you enter the wrong API key or secret. | Make sure to enter a valid API key and secret. |
The amount should be 0. | This error occurs when you enter an amount greater than INR 0. | Make sure to enter the amount is INR 0. |
Invalid IFSC Code | This error occurs when you enter an incorrect IFSC code. | Make sure to enter a correct IFSC code. |
The currency should be INR when method is nach | This error occurs when you enter a currency other than INR | Make sure the currency is INR. |
The amount field is required. | This error occurs when you have not entered the amount or the max_amount value. | Make sure to enter the max_amount value. |
The minimum transaction amount allowed is Re. 5. | This error occurs when you enter the maximum amount less than the minimum amount. | Make sure the max_amount value is more than the min_amount value. |
invaild_account_number | This error occurs when you have not entered the account_number . | Make sure to enter a valid account_number . |
selected_frequency_invalid | This error occurs when you enter an incorrect frequency parameter value. | Make sure to enter a correct frequency parameter value. |
You should create an authorisation payment after you create an order.
To create an authorisation payment:
- Download the Paper NACH form and send it to the customer.
- Ask the customers to fill the form and either or send it to you to upload the form using the .
Create a payment checkout form for customers to upload the NACH form and make the Authorisation Transaction. You can use the Handler Function or Callback URL.
Handler Function | Callback URL |
---|---|
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. | 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. |
Watch Out!
The Callback URL is not supported for Recurring Payments created using the registration link.
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
boolean
Determines whether the recurring is enabled or not. Possible values:
1
: Recurring is enabled.0
: Recurring is not enabled.
Given below is a list of possible errors you may face while making the authorisation payment.
Error | Cause | Solution |
---|---|---|
transaction_limit_exceeded | The customers have exceeded their account's credit or debit limit. This error usually occurs during high-value transactions. | You have reached the maximum transaction limit for this account. You can try again with a lower amount or use a different bank account. |
payment_invalid_account | This error occurs when the customer's bank account is either closed or no longer valid. The customer or bank may have closed the account. | The payment could not be completed as the entered bank account details are incorrect. Try again with another account. |
account_closed | This error occurs when the customer's bank account is either closed or no longer valid. The customer or bank may have closed the account. | The payment could not be completed as your bank account is closed. You can try again with another account or contact your bank for details. |
invalid_withdrawer_data | This error occurs when the customer's bank account is either closed or no longer valid. The customer or bank may have closed the account. | The payment could not be completed as the customer's bank account is closed or blocked. You can try again with another account. |
validation_failure | The bank could not validate the customer registration for debiting the customer. | The payment is declined due to a mismatch in account details. Try again with the account registered with the business only. |
payment_account_withdrawal_frozen | The bank has temporarily blocked withdrawals on the customer's account. | The payment could not be completed as withdrawal for your bank account is locked. You can try again with another account or contact your bank for details. |
No_DR_allowed | The bank has temporarily blocked withdrawals on the customer's account. | The payment could not be completed as withdrawal for your bank account is locked. You can try again with another account or contact your bank for details. |
Payment_duplicate _request | A payment initiation request with the same parameters was passed to the gateway. The gateway is blocking duplicate requests. | You should retry after 30 minutes. |
Registration already in progress | A payment initiation request with the same parameters was passed to the gateway. The gateway is blocking duplicate requests. | Your mandate registration is already in progress. Check the status in some time. |
payment_risk_check_failed | Payment declined due to risk checks. Razorpay, Gateway and issuer bank perform these risk checks. The source parameter would give additional clarity on where the risk check failed. | The payment could not be completed due to a temporary technical issue. You can try again in sometime. |
Use the following API to upload the NACH file sent by the customer.
order_id
mandatory
string
The unique identifier of the order that was created. For example, order_FoLdZrq6QGKUWg
.
recurring
mandatory
boolean
Determines whether the recurring is enabled or not. Possible values:
1
: Recurring is enabled.0
: Recurring is not enabled.
file
mandatory
strinng
The path where you have saved the NACH file.
razorpay_payment_id
string
The unique identifier of the payment that is created. For example, pay_FjDn43bvssCqEM
.
razorpay_order_id
string
The unique identifier of the order that is created. For example, order_FjDdQ6a0GluJ2c
.
razorpay_signature
string
The signature generated by the Razorpay. For example, f13775ea8a91e9bf229b9fdba3ad783f7ff2bdbce1c35e87a69ae7418808da04
Given below is a list of possible errors you may face while while uploading a NACH file.
Error | Cause | Solution |
---|---|---|
unknown_file_type | This error occurs when the file type of the image is not supported. | Make sure the image is in either .jpeg , .jpg or .png formats. |
file_size_exceeds_limit | This error occurs when the file size exceeds the permissible limits. | Make sure to upload an image of a smaller size. |
image_not_clear | This error occurs when the uploaded image is not clear. This can either be due to poor resolution or because part of the image is cropped. | Make sure to upload an image with better quality. |
form_mismatch | This error occurs when the ID of the uploaded form does not match that in our records. | Make sure to upload the image against the correct order ID. |
form_signature_missing | This error occurs when the signature of the customer is either missing or could not be detected. | Check that the customer has signed in the appropriate box and that the image uploaded is clear. For current accounts, a company stamp may also be required. |
form_data_mismatch | This error occurs when one or more of the fields on the NACH form do not match with that in our records. | Check that the image is clear and the data has not been tampered with before uploading again. |
form_status_pending | This error occurs when a form against the order is pending action on the destination bank. You cannot submit a new form till you receive a status. | Wait for an update from the destination bank on the approval/rejection of the mandate. |