---
title: "Generate batch link"
method: POST
path: "/api/channels/{entityId}/payments/batches"
tags: ["Batch"]
---

# Generate batch link

`POST /api/channels/{entityId}/payments/batches`

Returns a URL to which the batch file must be uploaded.

For more information, see the [documentation](https://developer.peachpayments.com/docs/generate-bulk-payment-links).

## Path parameters

- `entityId` string, required

## Request body

- object
  - `filename` string, required — The name of the CSV to be uploaded.
  - `notificationUrl` string, nullable — Webhooks are sent to this URL. It overrides the generic merchant webhook URL.

## Response `200`

Batch ID and URL.

- object
  - `id` string — The created batch ID for the upload.
  - `url` string — The created batch upload URL.

## Other responses

- `400` — Bad request.
- `401` — Request lacks valid authentication.
- `404` — The specified resource was not found.

---

[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)
