Batch
Get all batch statuses
Query all batch statuses of a batch for a channel.
get/api/channels/{entityId}/payments/batches
Path parameters
entityIdstring required
Example:8ac7a4ca694cec2601694cf5f9360026
The entity for the request.
Query parameters
offsetnumber
The offset from which to read data.
perPagenumber
The amount of items to retrieve.
filters[startDate]string date-time
Example:2018-03-20T09:12:28Z
Retrieve all batches from the start date onwards.
filters[endDate]string date-time
Example:2018-03-20T09:12:28Z
Retrieve all batches until the end date.
filters[status]'initiated' | 'processing' | 'expired' | 'error' | 'completed'
Example:initiated
The payment link status to filter on.
Response
URL.
Example response
{
"batches": [
{
"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"
}
]
}