PEpeachpayments
Batch

Batch link status

Returns the status of the batch.

For sample calls, see the public Postman collection.

get/api/batches/{batchId}

Request

  • Base URL
    https://sandbox-l.ppay.io
  • URL
    https://sandbox-l.ppay.io/api/batches/{batchId}
  • Auth
    HTTP bearer

Response

Batch status successfully retrieved.

idstring required

Unique identifier for the payment attempt.

createdAtstring required

Timestamp when the batch link was created.

updatedAtstring required

Timestamp when the batch link was updated.

entityIdstring required

The entity for the request.

filenamestring required

The name of the file that was uploaded.

status'initiated' | 'processing' | 'completed' | 'error' required

Payment link status.

successfulRowsnumber required

The amount of successfully created payment links.

totalRowsnumber required

The total amount of rows parsed from file.

errorCodestring

The error code will only be returned if the file fails to upload.

Example response

{
  "id": "c2bb1dd6-008b-448d-a496-c224de432356",
  "createdAt": "2022-10-25T09:03:22.832Z",
  "updatedAt": "2022-10-25T09:03:22.832Z",
  "entityId": "8ac7a4ca694cec2601694cf5f9360026",
  "filename": "test.csv",
  "status": "initiated",
  "successfulRows": 24,
  "totalRows": 25,
  "errorCode": "1000.100.00"
}

Changes

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