PEpeachpayments
Batch

Generate batch link

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

For more information, see the documentation, and for sample calls, see the public Postman collection.

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

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

idstring

The created batch ID for the upload.

urlstring

The created batch upload URL.

Example response

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

Changes

No recorded changes to this operation across all 1 revision of this API.