Get batch payments by a given set of parameters
This endpoint allows for a user who has submitted multiple batch to use some criteria to get the batch payments.
Query parameters
List of batch payment IDs
List of batch payment IDs
Batch payments External Reference contains this text.
Batch payments External Reference contains this text.
Batch payments created date equal or after to this date.
Batch payments created date equal or after to this date.
Batch payments created date equal or before this date.
Batch payments created date equal or before this date.
Payment approval status, multiple statuses can be specified by repeating the parameter
Only return batch payments the current user can approve.
Only return batch payments the current user can approve.
Limit results by the customer which created the batch payment request
Limit results by the customer which created the batch payment request
Limit results to batches with submission type specified
Limit results to batches with submission type specified
Page to fetch (0 indexed)
Page to fetch (0 indexed)
Size of Page to fetch
Size of Page to fetch
Response
OK
Example response
{
"content": [
{
"id": "D920000001",
"externalReference": "aReference_00001",
"status": "ACCEPTED",
"totalPayments": 9123,
"currentUserCanApprove": true,
"approvals": [
{
"approvedBy": "U2100021",
"approvedOn": "2022-06-25"
}
],
"createdDate": "2017-01-28T01:01:01+0000",
"processingDateFrom": "2017-01-28",
"processingDateTo": "2017-01-28",
"earliestScheduledPaymentDate": "2017-01-28"
}
]
}