API ReferenceIntegrationsKnowledge Base

RazorpayX Bulk Payout Links

You can use the bulk upload feature to create a large number of payout links from the RazorpayX Dashboard in 3 easy steps:

  1. Download the sample template.
  2. Add the required data to the template.
  3. Upload the template via the Dashboard.

Upload Bulk File🔗

Follow the below steps to upload a bulk file via the Dashboard.

  1. Log into your RazorpayX Dashboard.
  2. Navigate to Payout LinksBulk Payout Links.
  3. Download the sample template.
  4. Add the required data to the file. Ensure the data is formatted correctly.
  5. Upload the file via the Dashboard.
  6. Select the account from which the payout should be made. This can be:
  • Virtual Account
  • Current Account
  1. Enter the OTP sent to your registered mobile number/email address.
  2. Click CREATE PAYOUT LINK.

The table below lists the various fields in the sample template and briefly describes each field.

Name of Contact Mandatory
string Name of the contact to whom the payout link is to be sent. For example, Gaurav Kumar.
Payout Link Amount Mandatory
number The amount, in rupees, to be transferred to the contact. For example, 1000. The minimum value is 1.
Contact Phone Number Mandatory
string. The contact's phone number. For example, 9123456789.
Contact Email ID Mandatory
string The contact's email address. For example, gaurav.kumar@example.com.
Send Link to Phone Number Mandatory
string. Determines who sends the payout link to the contact via SMS. Possible values:
  • Yes - Razorpay sends the payout link to the contact via SMS.
  • No - You send the payout link to the contact via SMS.
Send Link to Mail ID Mandatory
string. Determines who sends the payout link to the contact via email. Possible values:
  • Yes - Razorpay sends the payout link to the contact via email.
  • No - You send the payout link to the contact via email.
Contact Type Mandatory
string The classification of contact that is being created. For example, employee. The following classifications are available by default:
  • vendor
  • customer
  • employee
  • self

    Note:
    Additional classifications can be created via the Dashboard, if required.
Payout Purpose Mandatory
string The purpose of the payout that is being created. The following classifications are available in the system by default:
  • refund
  • cashback
  • payout
  • salary
  • utility bill
  • vendor bill

    Note:
    - Additional purposes for payouts can be created via the Dashboard, if required.
    - This field is case sensitive.
Payout Description Mandatory
string A description for the payout link entered by you. This appears on the payout link hosted page.
Reference ID Optional
string A user-generated reference given to the payout. For example, Acme Transaction ID 12345. You can use this field to store your own transaction ID, if any.
Internal notes: Title Optional
string You can enter custom notes for your reference. Enter the note title in this column. This is not shown to the contact. For example, Refund 08 Feb 2021.
Internal notes: Description Optional
string You can enter custom notes for your reference. Enter the note description in this column. This is not shown to the contact. For example, Evening Batch.

Once a bulk upload is processed, you can download the processed bulk report from the Dashboard. The report has the following additional fields that you can check to see if the individual payouts were created and processed.

Payout Id
string Unique identifier for the payout. Populated if the payout is successfully created. For example, pout_FMfjLUuRS9Hlzc.
Error Code
string The error code for the failure. For example, BAD_REQUEST_ERROR.
Error Description
string The reason for the error. For example, No db records found.

Bulk Upload States🔗

Once uploaded, a bulk upload file moves through the following states:

  • created
  • processed

Created🔗

This is the initial state of the bulk upload. This indicates that the bulk upload is created in the RazorpayX database and is ready to be processed.

No processing has been done at this point.

Processed🔗

This is the final state of a bulk upload where the uploaded details are processed.

Note:
The processed state means the bulk file was fully processed. To check the status of the individual payout links, download the bulk payout links report.

Payout States🔗

Once your contact clicks on a payout link and enters their details, a payout is created. A payout can have the following statuses during its life cycle:

  • pending
  • queued
  • processing
  • processed
  • reversed
  • cancelled
  • rejected
  • failed
payout life cycle for payout links

Read more: Payout states

Note:
The Pending and Rejected states are available only if you have Approval Workflow enabled on your account.

×