Sign in

v1

latestOpenAPI 3.0.3Proprietary2026-07-2441103204.8 KB
Batch

Generate batch link

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

For more information, see the documentation.

post/api/channels/{entityId}/payments/batches

Path parameters

entityIdstring required
Example:8ac7a4ca694cec2601694cf5f9360026

The entity for the request.

Request body

filenamestring required

The name of the CSV to be uploaded.

notificationUrlstring nullable

Webhooks are sent to this URL. It overrides the generic merchant webhook URL.

Example request

{
  "filename": "test.csv",
  "notificationUrl": "https://example.com/example-webhook/"
}

Response

Batch ID and URL.

idstring

The created batch ID for the upload.

urlstring

The created batch upload URL.

Example response

{
  "id": "421e1e63-ddd5-46ec-8812-74eda861259b"
}