API ReferenceIntegrationsKnowledge Base

Bulk Upload

Payment Links is a simple way of collecting payments from your customers. However, generating them in large volumes can become challenging. This is especially true if you are a business accepting majority of your payments through Payment Links.

You can generate and process Payment Links in bulk by uploading a batch file in the Dashboard. This saves time and eliminates the hassle of creating multiple individual links.

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.

How it Works🔗

  1. Download the batch file format from the Dashboard.
  2. Add the required details to the file.
  3. Upload batch file on Razorpay Dashboard.
  4. The payment links are created and sent to your customers.

Note:
As we have launched a new version of Payment Links, the Batch Upload format has changed. The new fields and their descriptions are given below. We will stop supporting the older Batch Upload format from June 30 2021.

Batch File Life Cycle🔗

Once uploaded, a batch file go through the following states:

  • Created: You have successfully uploaded the file. No action has been performed on the file by us.
  • Processing: We have picked up the file for processing.
  • Processed: The file has been processed by us.

Note:
The Processed state does not mean all rows in the file were successfully processed and used to create payment links. It just means the file was successfully processed, with or without errors.

Download the Bulk Upload report to check for errors. You can correct these errors and upload the data again in another file.

Create Payment Links Using Bulk Upload🔗

Note:

  • The size of a batch file can be up to 10 MB. You can add up to 50,000 rows in a particular file. The links will be processed in the same sequence as listed in the file.
  • Field names/headers in a batch should not be modified. Modifications can cause upload failure.
  1. Log into the Dashboard.

  2. Navigate to Payment Links.

  3. Click Batch Upload.

  4. Click Download Sample File to download the sample template.

  5. Enter the required details in the template.

  6. On the Dashboard, click Click here to upload.

  7. Upload the file.

    bulk
  8. Review the data being uploaded using the sample rows shown on screen.

  9. Give the bulk upload a name using the Batch File Name field.

  10. Select the appropriate notify options to send the payment links to your customer.

  11. Select the reminder option if you want to enable automatic reminders to your customer. Learn more about reminders.

  12. Click Create to upload the bulk file and create the payment links.

bulk

Once a batch is successfully created and is in the Processed state, you can see either an All links sent or a Send all links option under the Actions based on your notifying choice above.

To send the links:

  1. Log into the Dashboard.
  2. Navigate to Payment Links.
  3. Click Batch Upload.
  4. Click the batch upload for which you want to send notifications.
  5. Click Send all links.
  6. Select Send SMS and/or Send Email on the Send Reminder? pop-up window that appears.
  7. Click Yes, Send all. This enables Razorpay to process and issue Payment Links to their respective recipients as defined in the batch file.

Handle Errors🔗

During the upload step, if we detect any errors in the data rows, we show an error message on-screen. We also generate an error report file that you can download to check the rows with the errors and the reason for the errors. This makes it easy for you to fix the errors and upload the file.

Fix the errors, make the required changes and re-upload the batch file.

Sample Template Fields🔗

Reference Id optional
Enter a unique number for each link. This is mapped to the receipt value provided while creating an Order at your server-side. This field has a limit of 40 characters.
Customer Name optional
Name of the customer. This field has a limit of 40 characters.
Customer Email optional
Email address of the customer.
Customer Contact optional
Contact number of the customer. You can enter domestic as well as international numbers. The expected format of the phone number is + {country code}{phone number}. If the country code is not specified, 91 will be used as the default value.
Currency optional
Defaults to INR. We accept payments in international currencies.
Amount mandatory
Amount to be paid by the customer in currency subunits. That is, if currency selected is 'INR', then the amount must be in paise. For example, enter 29995 for an amount of ₹299.95.
Description mandatory
Brief description stating the purpose for which Payment Link is being created.
Expire by optional
Date and Time on/at which the Payment Link expires. Supported formats:
DD-MM-YYYY HH:mm:ss (For example, 14-12-2018 18:45:00)
DD-MM-YYYY HH:mm
DD-MM-YYYY
Partial Payment optional
Indicates whether partial payments are enabled for your account. Set to 1 to enable partial payments and 0 to disable.
Note:
Partial payments are not allowed via UPI Payment Links.
First Payment Min Amount (In Paise) optional
Minimum amount that must be paid by the customer as the first partial payment. For example, if an amount of ₹7,000 is to be received from the customer in two installments of #1 - ₹5,000, #2 - ₹2,000, then you can set this value as 500000.
Notes optional
The notes object is a set of key-value pairs that can be used to store additional information about the entity. It can hold a maximum of 15 key-value pairs, each 255 characters long (maximum).

Bulk Upload Report🔗

A Processed batch file DOES NOT necessarily mean that all Payment Links were created successfully. There is a chance that few Payment Links did not get created because of certain issues in the entered data. For example, the file might contain duplicate Invoice Numbers or say, data was missing in a few fields.

Download the Bulk Upload report to check for errors. You can correct these errors and upload the data again in another file.

To download the Batch Upload:

  1. Log into the Dashboard.
  2. Navigate to Payment Links.
  3. Click Batch Upload.
  4. Click the batch upload for which you want to download the report. Details of the batch upload are shown on screen.
    • Total rows processed
    • Payment Links created
    • Paid
    • Expired
  5. Click Download Report.
batch details

The report is downloaded. You can check the report for errors, fix them and upload them in another file.

Batch Upload Report Fields🔗

A processed batch file does not necessarily mean that all Payment Links were created successfully. There is a chance that few payment links were not created because of certain issues in the entered data. For example, the file might contain duplicate Invoice Numbers or say, data was missing in a few fields.

The Batch Report contains the following additional fields to help you check if a link was issued for a row or not.

Additional Fields

Datatype

Description

Status

string/null

This indicates the processing status of the row. It can either be "success" or "failed".

Payment Link ID

string/null

The unique identifier of the Payment Link. This is null/empty if there are errors during the creation.

Payment Link Short URL

string/null

The URL of the Payment Link. This is null/empty if there are errors during the creation.

Error Code

string/null

In case of an error, this column has a error code.

Error Description

string/null

In case of an error, this column has the error message.

To fix the errors, make the required changes and re-upload the batch file.

×