v1
latestOpenAPI 3.0.12026-07-2356172250.9 KBGet all transaction batches
Retrieves the list of batches within a specified date range.
Query parameters
The status used to filter batches. Valid values are Open, Closed, Pending, and Failed.
Total number of refund transactions in the batch.
Total number of refund transactions in the batch.
Total number of sale transactions in the batch.
Total amount of sale transactions in the batch.
Total amount of transactions in the batch.
Total number of transactions in the batch.
Confirmation code for the settled batch.
Date and time when the batch was settled.
The scope of the batch search. Default is Terminal, which returns batches for the current terminal; set to Merchant to retrieve batches across all terminals for the merchant.
Required start date for the batch search. Accepted formats: MM-dd-yyyy hh:mm a, MM-dd-yy HH:mm, MM-dd-yy HH:mm z, yyyy-MM-dd HH:mm, yyyy-MM-dd HH:mm z.
Required end date for the batch search. Accepted formats are the same as start-date: MM-dd-yyyy hh:mm a, MM-dd-yy HH:mm, MM-dd-yy HH:mm z, yyyy-MM-dd HH:mm, yyyy-MM-dd HH:mm z.
Page number for paginated results. Defaults to the first page if not specified.
Number of records to return per page.
If true, results are sorted by date in descending order.
Headers
An access API key issued to you by Xplor Pay.
Response
Success