Upload bulk payout file
Upload an XLSX file containing multiple payouts for bulk processing. The file will be processed asynchronously, and the bulk upload status can be tracked using the returned bulk payout ID.
The XLSX file should contain columns for: currency, bankName, payoutMethod, amount, accountNumber, branchCode, reference, accountHolder.
The file might also include an optional notifyEmail column. When provided, it should contain one or more comma-separated email addresses. These recipients will receive the existing proof-of-payout email with PDF attachment once the payout succeeds. The file might also include an optional merchantReference column.
Path parameters
A unique merchant ID provided by Peach Payments in hexadecimal format.
A unique merchant ID provided by Peach Payments.
Response
File uploaded and processing initiated successfully
Example response
{
"message": "Bulk payout file uploaded and processed successfully",
"bulkPayoutId": "6e029f3f-21bf-425d-8f65-4eef2b5d8bb2"
}