You can create an authorisation transaction:
- Using the .
- Using a .
To create an authorisation transaction using the Razorpay Standard Checkout, you need to:
- .
- .
- .
Razorpay 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 Razorpay offerings. The following endpoint creates a customer.
name
mandatory
string
The name of the customer. For example, Gaurav Kumar
.
mandatory
string
The email ID of the customer. For example, gaurav.kumar@example.com
.
contact
mandatory
string
The phone number of the customer. For example, 9876543210
.
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, Gaurav Kumar
.
string
The email ID of the customer. For example, gaurav.kumar@example.com
.
contact
string
The phone number of the customer. For example, 9876543210
.
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
API to create a unique Razorpayorder_id
that is associated with the authorization transaction. The following endpoint creates an order.
Download and Upload the Pre-filled NACH Form
Once the order is created, the generated 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.
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 authorization transaction 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, that should be auto-charged in addition to the authorization amount. For example, 100000
.
auth_type
mandatory
string
The payment method used to make the authorization payment. Here, it is physical
.
bank_account
The customer's bank account details that is printed on the NACH form.
account_number
mandatory
string
The customer's bank account number. For example 11214311215411
.
ifsc_code
mandatory
string
The customer's bank IFSC. For example UTIB0000001
.
beneficiary_name
mandatory
string
The customer's name. For example, Gaurav Kumar
.
account_type
optional
string
The 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
The Unix timestamp 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 has been created. Here it is order
.
amount
integer
Amount in currency subunits. For emandate, 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 #1
. You should map this parameter to the order_id
sent by Razorpay.
status
string
The status of the order.
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.
auth_type
string
Emandate type used to make the authorisation payment. Possible values:
netbanking
debitcard
aadhaar
max_amount
integer
The maximum amount in paise a customer can be charged in a transaction. The value can range from 500
to 100000000
. The default value is 9999900
(₹99,999).
expire_at
integer
The Unix timestamp to indicate till when you can use the token (authorisation on the payment method) to charge the customer subsequent payments. The default value is 10 years for emandate
. This value can range from the current date to 31-12-2099 (4102444799
).
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”
.
bank_account
Customer's bank account details that should be pre-filled on the checkout.
account_number
string
Customer's bank account number.
account_type
string
Customer's bank account type. Possible values:
savings
(default value)current
ifsc_code
string
Customer's bank IFSC. For example UTIB0000001
.
beneficiary_name
string
Name of the beneficiary. For example, Gaurav Kumar
.
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.You can create a payment against the order_id
after it is created.
You should create an authorization payment after you create an order.
To create an authorization payment:
- Download the Paper NACH form and send it to the customers.
- 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.
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
boolean
Determines whether the recurring payment is enabled or not. Possible values:
1
: Recurring payment is enabled.0
: Recurring payment is not enabled.
You can upload the signed NACH forms that are collected from your customers using the create NACH File API, . Razorpay's OCR-enabled NACH engine submits the form to NPCI on successful verification and you will receive a success or a failure response.
Feature Request
- This is an on-demand feature. Please raise a request with our to get this feature activated on your Razorpay account.
- Watch this video to know how to raise a feature enablement request on the Razorpay Dashboard.
Use the following endpoint to upload the signed Paper NACH form via the API.
Use the following API to upload the NACH file sent by the customer.
The below table lists the errors that may appear while uploading the NACH file, the reason, explanation and next steps:
Reason | Explanation | Next Steps |
---|---|---|
unknown_file_type | The file type of the image is not supported. | Upload an image that is in either of .jpeg , .jpg or .png formats. |
file_size_exceeds_limit | The file size exceeds the permissible limits. | Upload an image of smaller size. |
image_not_clear | The uploaded image is not clear. This can either be due to poor resolution or because part of the image is cropped. | Upload an image with better quality without any cropping of the form. |
form_mismatch | The ID of the uploaded form does not match with that in our records. | Check that the form is uploaded against the correct order ID. |
form_signature_missing | 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 account, a company stamp may also be required. |
form_data_mismatch | 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 that the data has not been tampered with before uploading again. |
form_status_pending | A form against this order is pending action on the destination bank. A new form cannot be submitted till a status is received. | Wait for an update from the destination bank on the approval/rejection of the mandate. |
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.
- A registration link should always have an order amount (in paise) the customer will be charged when making the authorization payment. This amount should be
0
in the case of Paper NACH.
Handy Tips
You can
against a registration link.The following endpoint creates a registration link for recurring payments.
Download and Upload the Pre-filled NACH Form
Once the registration link is created, the customer should complete these steps:
- Download the pre-filled form using the Download NACH Form option on the Razorpay hosted page.
- Sign the form.
- Upload the signed form using the Upload NACH Form option on the Razorpay hosted page.
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 authorization payment.
first_payment_amount
optional
integer
The amount, in paise, the customer should be auto-charged in addition to the authorization amount. For example, 100000
.
method
mandatory
string
The NACH type used to make the authorization payment. Here, it is physical
.
auth_type
mandatory
string
The authorization method used to make the authorization transaction. Here, it is nach
.
bank_account
The customer's bank account details.
beneficiary_name
mandatory
string
The name on the beneficiary. For example, Gaurav Kumar
.
account_number
mandatory
integer
The customer's bank account number. For example, 11214311215411
.
account_type
mandatory
string
The customer's bank account type. Possible values:
savings
current
ifsc_code
mandatory
string
The customer's bank IFSC. For example, HDFC0000001
.
max_amount
optional
integer
Use to set the maximum amount, in paise, per debit request. This value can range from 500
- 1000000000
. The default value is 1cr.
expire_at
optional
integer
The Unix timestamp till when you can use the token (authorization on the payment method) to charge the customer subsequent payments. The default value is 10 years for emandate
. This value can range from the current date to 31-12-2099 (4101580799
).
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.
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”
.
id
string
The unique identifier of the invoice.
entity
string
The entity that has been created. Here, it is invoice
.
receipt
string
A user-entered unique identifier of the invoice.
invoice_number
string
Unique number you added for internal reference.
customer_id
string
The unique identifier of the customer. For example, cust_BMB3EwbqnqZ2EI
.
customer_details
Details of the customer.
id
string
The unique identifier associated with the customer to whom the invoice has been issued.
name
string
The customer's name.
string
The customer's email address.
contact
integer
The customer's phone number.
billing_address
string
Details of the customer's billing address.
shipping_address
string
Details of the customer's shipping address.
order_id
string
The unique identifier of the order associated with the invoice.
line_items
string
Details of the line item that is billed in the invoice. Maximum of 50 line items are allowed.
payment_id
string
Unique identifier of a payment made against the invoice.
status
string
The status of the invoice. Possible values:
draft
issued
partially_paid
paid
cancelled
expired
deleted
expire_by
integer
The Unix timestamp at which the invoice will expire.
issued_at
integer
The Unix timestamp at which the invoice was issued to the customer.
paid_at
integer
The Unix timestamp at which the payment was made.
cancelled_at
integer
The Unix timestamp at which the invoice was cancelled.
expired_at
integer
The Unix timestamp at which the invoice expired.
sms_status
string
The delivery status of the SMS notification for the invoice sent to the customer. Possible values:
pending
sent
email_status
string
The delivery status of the email notification for the invoice sent to the customer. Possible values:
pending
sent
date
integer
Timestamp, in Unix format, that indicates the issue date of the invoice.
terms
string
Any terms to be included in the invoice. Maximum of 2048 characters.
partial_payment
boolean
Indicates whether the customer can make a partial payment on the invoice. Possible values:
true
: The customer can make partial payments.false
(default): The customer cannot make partial payments.
amount
integer
Amount to be paid using the invoice. Must be in the smallest unit of the currency. For example, if the amount to be received from the customer is ₹299.95, pass the value as 29995
.
amount_paid
integer
Amount paid by the customer against the invoice.
amount_due
integer
The remaining amount to be paid by the customer for the issued invoice.
currency
string
The currency associated with the invoice. You should mandatorily pass this parameter if you are accepting international payments.
description
string
A brief description of the invoice.
notes
object
Any custom notes added to the invoice. Maximum of 2048 characters.
short_url
string
The short URL that is generated. This is the link that can be shared with the customer to receive payments.
type
string
Here, it is invoice
.
comment
string
Any comments to be added in the invoice. Maximum of 2048 characters.
The following endpoint sends/resends notifications with the short URL to the customer:
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
success
boolean
Indicates whether the notifications were sent successfully. Possible values:
true
: The notifications were successfully sent via SMS, email or both.false
: The notifications were not sent.
The following endpoint cancels a registration link.
id
mandatory
string
The unique identifier for the invoice linked to the registration link that you want to cancel. For example, inv_1Aa00000000001
.
id
string
The unique identifier of the invoice.
entity
string
The entity that has been created. Here, it is invoice
.
receipt
string
A user-entered unique identifier of the invoice.
invoice_number
string
Unique number you added for internal reference.
customer_id
string
The unique identifier of the customer. For example, cust_BMB3EwbqnqZ2EI
.
customer_details
Details of the customer.
id
string
The unique identifier associated with the customer to whom the invoice has been issued.
name
string
The customer's name.
string
The customer's email address.
contact
integer
The customer's phone number.
billing_address
string
Details of the customer's billing address.
shipping_address
string
Details of the customer's shipping address.
order_id
string
The unique identifier of the order associated with the invoice.
line_items
string
Details of the line item that is billed in the invoice. Maximum of 50 line items are allowed.
payment_id
string
Unique identifier of a payment made against the invoice.
status
string
The status of the invoice. Possible values:
draft
issued
partially_paid
paid
cancelled
expired
deleted
expire_by
integer
The Unix timestamp at which the invoice will expire.
issued_at
integer
The Unix timestamp at which the invoice was issued to the customer.
paid_at
integer
The Unix timestamp at which the payment was made.
cancelled_at
integer
The Unix timestamp at which the invoice was cancelled.
expired_at
integer
The Unix timestamp at which the invoice expired.
sms_status
string
The delivery status of the SMS notification for the invoice sent to the customer. Possible values:
pending
sent
email_status
string
The delivery status of the email notification for the invoice sent to the customer. Possible values:
pending
sent
date
integer
Timestamp, in Unix format, that indicates the issue date of the invoice.
terms
string
Any terms to be included in the invoice. Maximum of 2048 characters.
partial_payment
boolean
Indicates whether the customer can make a partial payment on the invoice. Possible values:
true
: The customer can make partial payments.false
(default): The customer cannot make partial payments.
amount
integer
Amount to be paid using the invoice. Must be in the smallest unit of the currency. For example, if the amount to be received from the customer is ₹299.95, pass the value as 29995
.
amount_paid
integer
Amount paid by the customer against the invoice.
amount_due
integer
The remaining amount to be paid by the customer for the issued invoice.
currency
string
The currency associated with the invoice. You should mandatorily pass this parameter if you are accepting international payments.
description
string
A brief description of the invoice.
notes
object
Any custom notes added to the invoice. Maximum of 2048 characters.
short_url
string
The short URL that is generated. This is the link that can be shared with the customer to receive payments.
type
string
Here, it is invoice
.
comment
string
Any comments to be added in the invoice. Maximum of 2048 characters.