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

# Generate batch link

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

## Request

- Base URL: `https://sandbox-l.ppay.io`
- URL: `https://sandbox-l.ppay.io/api/channels/{entityId}/payments/batches`
- Auth: HTTP bearer

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), and for sample calls, see the [public Postman collection](https://www.postman.com/peachpayments/peach-payments-public-workspace/request/2pm712c/payment-links-public?action=share&creator=20323380&ctx=documentation&active-environment=13324425-10da86ae-9bc2-4124-8f55-f7255fa3ff55).

## 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 created with upload URL returned.

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

## Other responses

- `400`: The request body failed validation.
- `401`: Request lacks valid authentication.
- `404`: The specified resource was not found.

---

[API](https://skmtc.dev/peachpayments/apis/payment-links.md) - [All operations](https://skmtc.dev/peachpayments/apis/payment-links/llms.txt) - [OpenAPI document](https://skmtc.dev/peachpayments/apis/payment-links/revisions/3a63dca6b297?raw)