Prerequisite

Plural upload file API use the file uploaded in the request and process the individual payouts in a queue. You must enter the bank account details in the below format.

clientReferenceId	beneficiaryId	payeeName	accountNumber	branchCode	vpa	email	phone	amountCurrency	amountValue	mode	dateTime	remarks	saveBeneficiary	validate
`test1607-281915`	`0E32EB7CB2`	`Kevin`	`1234567890123`	`ICICI0000139`	`[email protected]`	`[email protected]`	`9876543210`	`INR`	`100`	`IMPS`	Format: `yyyy-MM-dd'T'HH:mm:ss'Z`	`Rent`	`true`	`false`
`test1607-281916`	`0E32EB7CB3`	`Bob`	`1234567890124`	`ICICI0000140`	`[email protected]`	`[email protected]`	`9876543211`	`INR`	`1000`	`IMPS`	Format: `yyyy-MM-dd'T'HH:mm:ss'Z`	`Salary`	`true`	`false`

The table below lists all the fields that must be included in the file to be uploaded using our Upload File API for processing a bulk payout.

Parameter	Type	Required Type	Description
clientReferenceId	`string`	`M`	Unique identifier entered while creating a Payout request. Example: `test1607-281915`
beneficiaryId	`string`	`O`	Unique Identifier representing the beneficiary. Example: `0E32EB7CB2`
payeeName	`string`	`C`	Beneficiary name. Example: `Kevin`
accountNumber	`string`	`C`	Beneficiary bank account number. Example: `1234567890123`
branchCode	`string`	`C`	Beneficiary branch IFSC. Example: `ICICI0000139`
vpa	`string`	`C`	Beneficiary VPA handle. Example: `[email protected]`
email	`string`	`O`	Beneficiary email address. Example: `[email protected]`
phone	`string`	`O`	Beneficiary phone number. Example: `9876543210`
amountCurrency	`string`	`M`	Type of currency. Example: `INR`
amountValue	`string`	`M`	The transaction amount is Paisa. Minimum value: `100` (₹1). Maximum value: `100000000` (₹10 lakh). Example: `100`
mode	`string`	`M`	Mode you wish to initiate a payout. Accepted values: `UPI` `IMPS` `NEFT` `RTGS`
dateTime	`string`	`O`	Use this parameter to schedule a payout for future. The time value is in UTC. Example: `yyyy-MM-dd'T'HH:mm:ss'Z`
remarks	`string`	`M`	Payout remarks. Example: `Rent`
saveBeneficiary	`boolean`	`O`	Accepted values to save beneficiary. `true`: Beneficiary details are saved against the account. `false`: Beneficiary details are not saved against the account.
validate	`boolean`	`O`	Accepted values to validate the VPA handle before initiating a payout. `true`: VPA verification is done. `false`: VPA verification is not done.