1. Create the Authorization Transaction

Create an authorisation transaction for NACH using Razorpay APIs.


The flow to complete an authorisation transaction using paper NACH differs from the other payment method's flow.

  1. Create a customer.
  2. Create an order by passing the customer_id and the method as nach. Razorpay generates a NACH form with the customer information pre-filled and ready to sign.
  3. The customer can get the form in one of the following ways to sign it:
    • You can download the form from the Dashboard and send it to the customer.
    • A customer can download the form from the Hosted page (in the case of registration links).
  4. The signed form can be uploaded in one of the following ways:
    • Using the Standard Checkout page.
    • Hosted page (in the case of registration links).
    • The customer can send you the form and you can upload the form for the customer. The acceptable image formats and size are:
      • jpeg
      • jpg
      • png
      • Maximum accepted size is 6 MB.

Once the details are validated, the authorisation transaction is completed, and a token is generated. You can charge your customer as per your business model after the token status changes to confirmed.

The acceptable image formats and size are:

  • jpeg
  • jpg
  • png
  • Maximum accepted size is 6 MB.

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

  1. .
  2. .
  3. .

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 as email and contact and use them for various Razorpay offerings. The following endpoint creates a customer.

POST
/customers

name

mandatory

string The name of the customer. For example, Gaurav Kumar.

email

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ā€¯.

You can use the

to create a unique Razorpay order_id that is associated with the authorisation transaction. The following endpoint creates an order.

POST
/orders

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.

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ā€¯.

After you create an order, you have to create an authorization payment. To create an authorization payment:

  1. Download the Paper NACH form and send it to the customers.
  2. Ask the customers to fill the form and send it to you.
  3. You upload the received form via the create NACH File API. The acceptable image formats and size are jpeg, jpg and png. Maximum accepted size is 6 MB.

Use the below endpoint to upload the signed Paper NACH form via APIs.

POST
/payments/create/nach/file

Razorpay's OCR-enabled NACH engine submits the form to NPCI on successful verification and you will receive a success/failure response.

Use the following API to upload the NACH file sent by the customer.

To learn about errors, refer to the FAQ

section.

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

is automatically issued to the customer. The customer can use the invoice to make the Authorization Payment.

Know how to

using the Razorpay Dashboard.

Handy Tips

You can use webhooks to get notifications about successful payments against a registration link. Know more about

.

In the case of Paper NACH, the order amount must be 0.

Use the below endpoint to create a registration link for recurring payments.

POST
/subscription_registration/auth_links

Download and Upload the Pre-filled NACH Form

Once the registration link is created, the customer should complete these steps:

  1. Download the pre-filled form using the Download NACH Form option on the Razorpay hosted page.
  2. Sign the form.
  3. Upload the signed form using the Upload NACH Form option on the Razorpay hosted page.

Use the below endpoint to create a registration link for recurring payments.

POST
/subscription_registration/auth_links

Download and Upload the Pre-filled NACH Form

Once the registration link is created, the customer should complete these steps:

  1. Download the pre-filled form using the Download NACH Form option on the Razorpay hosted page.
  2. Sign the form.
  3. Upload the signed form using the Upload NACH Form option on the Razorpay hosted page.

The following endpoint creates a registration link for recurring payments.

POST
/subscription_registration/auth_links

Download and Upload the Pre-filled NACH Form

Once the registration link is created, the customer should complete these steps:

  1. Download the pre-filled form using the Download NACH Form option on the Razorpay hosted page.
  2. Sign the form.
  3. 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 is sent.

name

mandatory

string Customer's name.

email

mandatory

string Customer's email address.

contact

mandatory

integer Customer's contact number.

type

mandatory

string In this case, the value is link.

amount

mandatory

integer The payment amount in the smallest currency sub-unit.

currency

mandatory

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

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.

subscription_registration

Details of the authorisation payment.

method

mandatory

string The Paper NACH method used to make the authorisation transaction. Here, it is physical.

auth_type

mandatory

string The payment method used to make the authorisation transaction. Here, it is nach.

bank_account

The customer's bank account details.

beneficiary_name

mandatory

string The beneficiary name. 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. The value can range from 500 - 1000000000. The dafault value is 1cr.

expire_at

optional

integer The Unix timestamp till when you can use the token (authorisation on the payment method) to charge the customer subsequent payments. The default value is 10 years. The value can range from the current date to 31-12-2099 (4101580799).

nach

Additional information to be printed on the NACH form 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. Possible 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. Possible values:

  • 0: Notifications are not sent by Razorpay.
  • 1: Notifications are sent by Razorpay (default value).

expire_by

optional

integer The Unix timestamp indicates the expiry of the registration link.

receipt

optional

string A unique identifier entered by you for the order. For example, Receipt No. 1. You should map this parameter to the order_id sent by Razorpay.

notes

optional

object This is a key-value pair that is 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:

POST
/invoices/:id/notify_by/:medium

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.

POST
/invoices/:id/cancel

Watch Out!

You can only cancel the registration link that is in the issued state.

id

mandatory

string The unique identifier for the invoice linked to the registration link that you want to cancel. For example, inv_1Aa00000000001.


Is this integration guide useful?