API ReferenceIntegrationsKnowledge Base

Batch Upload for Linked Accounts and Transfers

Generate and process Linked Accounts and Transfers in bulk by uploading a batch file in the Dashboard. This simplifies the process of creating these individually. To create in bulk, you need to download the sample file from the Dashboard, update the file with the required information and upload the file back to the Dashboard.

Watch Out!
The sample file should be in .csv or .xlsx format.

You can perform the following actions using batch upload:

Batch Upload StatusesπŸ”—

The following table lists the upload statuses and their description.

Status

Description

Created

This is the initial state of the upload and indicates that the batch is created and processed in Razorpay’s database.

Processing

This state indicates that the uploaded batch file is under process.

Processed

This is the final state of the batch file and indicates that the batch file is successfully processed and individual rows could be processed successfully or with errors. You can check the details via the Batch Report.

Scheduled

This state indicates that the file is scheduled to be processed at a later time.

Cancelled

This state indicates that you cancelled the processing of the batch file. This applies only to Batches in processing or scheduled state.

Create Linked Accounts via Batch UploadπŸ”—

You can create multiple linked accounts in bulk by uploading a batch file on the Dashboard.

Watch this video to see how to create linked accounts in bulk using a batch file.

To create linked accounts using batch upload:

  1. Log into the Razorpay Dashboard and click the Route menu.
  2. Click Batch Upload.
  3. Hover on Upload New Batch and click Linked Accounts. The Batch Upload pop-up page appears.
  4. Click download sample file to download the sample file.
  5. Update and save the file with the following details. Refer to the Linked Accounts Batch Fields section for more information.
    • account_name
    • account_email
    • dashboard_access
    • customer_refunds
    • business_name
    • business_type
    • ifsc_code
    • account_number
    • beneficiary_name
  6. Upload the updated file to the Dashboard in the Batch Upload pop-up page.
  7. Verify the details and enter the file name in the BATCH FILE NAME text box.
  8. You can choose to process the file immediately or schedule it for later.
  9. Click Create.

You can view the status and other details of the upload under the Batch Upload section on the Dashboard.

Linked Account Batch FieldsπŸ”—

The following table lists the fields required to create linked accounts and their description.

Field

Description and Possible Values

account_name

Name for the linked account.

account_email

Email for the linked account. This is an optional filed.

dashboard_access

Option to choose whether to provide Dashboard access or not. Possible values are:

  • 0 = No
  • 1 = Yes

customer_refunds

Option to choose whether to allow refund or not. Possible values are:

  • 0 = No
  • 1 = Yes

business_name

Business name of the linked account.

business_type

Business type of the linked account. Possible values are:

  • llp
  • ngo
  • individual
  • partnership
  • proprietorship
  • public_limited
  • private_limited
  • trust
  • society
  • not_yet_registered
  • educational_institutes

ifsc_code

IFSC code of the linked account bank.

account_number

Account number of the linked account.

beneficiary_name

Beneficiary name of the linked account.

Download the sample input file of the Linked Account creation for reference.

Batch File after ProcessingπŸ”—

Once a batch file is processed, you can download the processed file from the Dashboard. Click the Batch Id and click Download Report to download the file. Information such as the uploaded rows, successfully processed and failed rows are displayed in the file.

The downloaded file has the following additional fields that provide information about the created linked accounts or the reason for failure.

Field

Description and Possible Values

account_id

Unique ID of the linked account in the acc_FinZs6b5lL1Nmv format.

account_name

Name for the linked account.

account_email

Email for the linked account.

dashboard_access

Option to choose whether to provide Dashboard access or not. Possible values are:

  • 0 = No
  • 1 = Yes

customer_refunds

Option to choose whether to allow refund or not. Possible values are:

  • 0 = No
  • 1 = Yes

business_name

Business name of the linked account.

business_type

Business type of the linked account.

ifsc_code

IFSC code of the linked account bank.

account_number

Account number of the linked account.

beneficiary_name

Beneficiary name of the linked account.

account_status

The status of the linked account. Possible values:

  • success
  • failed

Error Code

The error code for the failure. For example, BAD_REQUEST_ERROR.

Error Description

The reason for the error. For example, The IFSC code field is required.

Create Transfers via Batch UploadπŸ”—

You can create transfers to linked accounts in bulk by uploading a batch file with the required details.

Watch this video to see how to create transfers to linked accounts in bulk using a batch file.

To create Transfers in bulk:

  1. Log into the Razorpay Dashboard and click the Route menu.

  2. Click Batch Upload.

  3. Hover on Upload New Batch and click Transfers. The Batch Upload pop-up page appears.

  4. Click download sample file to download the sample file.

  5. Update and save the file with the following details. Refer to the Transfers Batch Fields section for more information.

    • payment_id
    • account_id
    • amount
    • currency
    • transfer_notes
    • linked_account_notes
    • on_hold
    • on_hold_until

    Watch Out!
    You should enter the amount in paise. For example, if you want to transfer β‚Ή500, then you should enter 50000.

  6. Verify the details and enter the file name in the BATCH FILE NAME text box.

  7. You can choose to process the file immediately or schedule it for later.

  8. Click Create.

Transfers Batch FieldsπŸ”—

The following table lists the fields required to create transfers and their description.

Field

Description and Possible Values

payment_id

string Unique identifier of the payment on which the transfer must be created. This field is required only in the case of Transfers via Payment.

amount

integer The amount that has to be transferred to the linked account. For example, for an amount of β‚Ή200.35, the value of this field should be 20035.

currency

string The currency in which the transfer should be made. We support only INR for Route transactions.

account_id

string Unique identifier of the linked account to which the transfer is to be made.

transfer_notes

json object Set of key-value pairs that can be associated with an entity. These keys are useful for storing additional information about the entity. A maximum of 15 key-value pairs, each of 256 characters (maximum), are supported.

linked_account_notes

array List of the keys from the notes object, which needs to be shown to linked accounts on their Dashboard.

on_hold

boolean Indicates whether the account settlement for transfer is on hold. Possible values:

  • 1 - Puts the settlement on hold.
  • 0 - Releases the settlement.

on_hold_until

integer Timestamp, in Unix, indicates until when the settlement of the transfer must be put on hold. If no value is passed, the settlement is put on hold indefinitely.

Download the sample input file of Transfers creation for reference.

Batch File after ProcessingπŸ”—

Once a batch file is processed, you can download the processed file from the Dashboard. Click the Batch Id and click Download Report to download the file. Information such as the uploaded rows, successfully processed and failed rows are displayed in the file.

The downloaded file has the following additional fields that provide information about the created transfers or the reason for failure.

Field

Description and Possible Values

transfer_id

string Unique identifier of the transfer.

payment_id

string Unique identifier of the payment on which the transfer must be created. This field is required only in the case of Transfers via Payment.

account_id

string Unique identifier of the linked account to which the transfer is to be made.

amount

integer The amount that has to be transferred to the linked account. For example, for an amount of β‚Ή200.35, the value of this field should be 20035.

currency

string The currency in which the transfer should be made. We support only INR for Route transactions.

transfer_notes

json object Set of key-value pairs that can be associated with an entity. These keys are useful for storing additional information about the entity. A maximum of 15 key-value pairs, each of 256 characters (maximum), are supported.

linked_account_notes

array List of the keys from the notes object, which needs to be shown to linked accounts on their Dashboard.

on_hold

boolean Indicates whether the account settlement for transfer is on hold. Possible values:

  • 1 - Puts the settlement on hold.
  • 0 - Releases the settlement.

on_hold_until

integer Timestamp, in Unix, indicates until when the settlement of the transfer must be put on hold. If no value is passed, the settlement is put on hold indefinitely.

created_at

Timestamp of when the transfer is created.

Error Code

The error code for the failure. For example, BAD_REQUEST_ERROR.

Error Description

The reason for the error. For example, The IFSC code field is required.

View all BatchesπŸ”—

The Batch Upload section in the Dashboard displays the following fields:

Field

Description

Batch ID

ID of the newly uploaded batch.

Batch Name

Merchant defined label for the batch.

Count

Total number of rows uploaded.

Type

Type of the uploaded file. The value can be either of the following:

  • Linked Account
  • Transfers

Status

Status of the uploaded file. The value can be either of the following:

  • Created
  • Processed
  • Processing
  • Scheduled
  • Cancelled

Actions

Action buttons for the uploaded file. Following are the available options:

  • Download
  • Cancel

You can also search for the required batch file using the following search options:

  • Batch Upload Id: This option allows you to search using the upload ID.
  • Batch Type: This option lets you search using batch type. Select the required type from the Batch Type list.
  • Count: This option allows you to search using the number of rows uploaded.

Schedule a BatchπŸ”—

You can choose to process the batch upload immediately or schedule it for later.

To Schedule a batch:

  1. Log into the Razorpay Dashboard and click the Route menu.
  2. Click Batch Upload.
  3. Hover on Upload New Batch and click the required batch type. The Batch Upload pop-up page appears.
  4. Click download sample file to download the sample file.
  5. Update the file with the required details.
  6. Upload the updated file to the Dashboard in the Batch Upload pop-up page.
  7. Select Schedule for Later and select the date and time you want to start the batch upload. Watch Out!
    Ensure the scheduled time is at least 1 hour from the current time.
  8. Click Create.

The batch upload starts at the scheduled time.

Errors during UploadπŸ”—

Following errors may occur while uploading and processing a batch file.

Errors during UploadπŸ”—

If any error happens in the data rows during the upload step, it will be displayed on the screen. You can also download the report from the Dashboard that contains errors and their reasons. This helps you to fix the errors and upload the file.

Some of the common errors during upload are:

  • Same file uploaded multiple times
  • Uploaded file type not supported

You can fix the errors by making the required changes in the file and re-upload it in the Dashboard.

Errors after UploadπŸ”—

A processed batch file does not necessarily mean that all linked accounts and transfers were created successfully. Few rows may not get created because of certain issues in the entered data.

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

Field

Description

Status

The status of the Transfer. Possible values are:

  • Success
  • Failed

Error Code

The error code for the failure. For example, BAD_REQUEST_ERROR.

Error Description

The reason for the error. For example, The IFSC code field is required.

Transfer Id/Linked Account Id

string Unique identifier of the transfer/linked account.

×