---
title: "Upload bulk payout file"
method: POST
path: "/merchants/{merchantId}/payouts/upload"
tags: ["Bulk Payouts"]
---

# Upload bulk payout file

`POST /merchants/{merchantId}/payouts/upload`

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

- `merchantId` string, required — A unique merchant ID provided by Peach Payments in hexadecimal format.

## Response `201`

File uploaded and processing initiated successfully

- object
  - `message` string
  - `bulkPayoutId` string — A valid v4 UUID expressed in lowercase with dashes.

## Other responses

- `400` — There was an error with the request. Please fix the request and try again.
- `401` — The request is not authenticated. Please re-authenticate and provide a new token.
- `403` — The request is not authorised. Please contact your business administrator.

---

[API](https://skmtc.net/peachpayments/apis/checkout.md) · [All operations](https://skmtc.net/peachpayments/apis/checkout/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/peachpayments/checkout/revisions/3a98165665f8/schema)
