API ReferenceIntegrationsKnowledge Base

About Bulk Payouts

You can use the Bulk Upload feature to create Bulk payouts from the RazorpayX Dashboard. You can use the bulk upload feature to either make a payout to an existing Fund account or create a new Contact (with a Fund account) while creating payouts.

Handy Tips
This article is about using the Bulk Upload and creating Bulk payouts for customers who want to upload bulk files with amount in rupees. For customers who are using the paise units for Bulk Payouts, see Bulk Payouts (in paise).

Bulk Upload File🔗

You must use the Sample Template to create payouts using the Bulk Upload feature. This template is only for .csv files. For customers using spreadsheets in .xls format, click here to create payouts.

Watch Out!
• Before uploading the file for bulk upload, ensure that the cell data type is converted to plain text (if not already in plain text). Sometimes, sheets created using Google Sheets or other such applications are converted to scientific format, and such text is not accepted by the system.

• CSV uploads are recommended for files that contain more than 10,000 rows. Excel files that contain more than 10,000 rows are not processed.

The table below lists the various required fields in the template and gives a brief description of each field.

RazorpayX Account Number Mandatory

string The account from which you want to make the payout. For example, 7878780080316316.

Account details can be found on the RazorpayX Dashboard. Handy Tips
Ensure the account number format is not changed when uploading the file.

  • Pass your virtual account number if you want money to be deducted from your virtual account.
  • Pass your current account number if you want money to be deducted from your current account.
Payout Amount Mandatory

number The amount, in INR, to be transferred from the business account to the contact's fund account.

Enter 369.05 to create a payout for ₹369.05.

Minimum ₹1 to be paid out. Only 2 decimals allowed.

Payout Currency Mandatory

string The currency in which the payout is being made. Here, it has to be INR.

Payout Mode Mandatory

string The mode that should be used to make the payout. Payout Modes are Case-Sensitive
The payout modes are case sensitive. When creating payouts using APIs, ensure payout modes are entered in upper case.

  • account_type = vpa use UPI.
  • account_type = bank_account:
    • NEFT
    • RTGS
    • IMPS
Payout Purpose Mandatory

string The purpose of the payout that is being created.

Handy Tips

  • This field is case-sensitive.
  • Additional purposes for payouts can be created via the RazorpayX Dashboard, if required.

The following classifications are available in the system by default:

  • refund
  • cashback
  • payout
  • salary
  • utility bill
  • vendor bill
Payout Narration Optional

string This is a custom note that also appears on the bank statement.

Maximum length 30 characters. Allowed characters are: a-z, A-Z. 0-9 and space.

Handy Tips

  • If no value is passed for this parameter, it defaults to the Merchant Billing Label.
  • Ensure the most important text in the first 9 characters as banks may truncate the rest as per their standards.
Payout Reference Id Optional

string A user-generated reference given to the payout. For example, Acme Transaction ID 12345.

Maximum length 40 characters.

You can use this field to store your own transaction id, if any.

Fund Account Id Conditionally Mandatory

string The unique id linked to a fund account. For example, fa_00000000000001.

Handy Tips
This field is mandatory if you want to make a payout to an existing fund account. This way you do not need to provide other fund account and contact details.

Fund Account Type Mandatory if Fund Account id not given

string The type of account to be linked to the customer id. Possible values:

  • bank_account
  • vpa
Fund Account Name Mandatory if Fund Account id not given and Fund Account Type = bank_account

string Name of the account holder as per bank records.

For example, Gaurav Kumar.

Fund Account Ifsc Mandatory if Fund Account id not given and Fund Account Type = bank_account

string Bank IFSC of the account number.

For example, HDFC0000053.

Fund Account Number Mandatory if Fund Account id not given and Fund Account Type = bank_account

string Beneficiary account number.

For example, 765432123456789.

Fund Account Vpa Mandatory if Fund Account id not given and Fund Account Type = vpa

string The virtual payment address. For example, gauravkumar@upi.

Contact Type Mandatory if Fund Account id not given

string The classification of contact that is being created. For example, employee.

Handy Tips
Additional classifications can be created via the Dashboard, if required.

The following classifications are available in the system by default:

  • vendor
  • customer
  • employee
  • self
Contact Name Mandatory if Fund Account id not given

string Name of the contact. For example, Gaurav Kumar.

Contact Email Optional

string Email address for the contact.

For example, gaurav.kumar@example.com

Contact Mobile Optional

string. Phone number for the contact. For example, 9123456789.

Contact Reference Id Optional

string A user-generated reference given to the contact. For example, Acme Contact ID 12345.

Maximum length 40 characters.

notes[example text] Optional

string Notes for the details being imported. You can replace the example text in the header with text of your choice. You can add up to 15 notes. Text in the header is the title and text in the cell is the value for the note.

Create Payouts in Bulk🔗

To create payouts in bulk:

  1. Log into your RazorpayX Dashboard.
  2. Navigate to MenuPayoutsBulk Payouts.
  3. Download the Sample Template in .csv format or Sample Template in .xlsx format.
  4. Add the required data to the file. Ensure the data is formatted correctly.
  5. Upload the file via the Dashboard.
create payouts using the bulk upload feature

Cannot be Queued
Your payouts created using the bulk upload feature cannot be queued. In case of insufficient balance, the payouts will fail.

Schedule Bulk Payouts🔗

You can create scheduled payouts using the Bulk Upload feature.

To schedule bulk payouts:

  1. Select Schedule the payout.
  2. Select the date when you want the payout to be processed. You can schedule payouts up to 3 months in advance.
  3. Select a time slot when you want the payout to be processed. Following are the 4 slots available:
  • 9 a.m. to 10 a.m.
  • 1 p.m. to 2 p.m.
  • 5 p.m. to 6 p.m.
  • 9 p.m. to 10 p.m.
schedule bulk payouts

After the bulk file is uploaded, it is picked up for processing immediately. Payouts created via the bulk upload feature go to the pending or scheduled state. It then follows the payout life cycle.

Handy Tips
After a bulk file is uploaded, the file is processed immediately. The individual payouts created are scheduled as per the selected options.

Cancelling Payouts
You can cancel your payouts until 1 minute before the scheduled time.

×