Batches

Get All Batches

get

Retrieves the list of batches within a specified date range.

Query parameters
statusstringOptional

The status used to filter batches. Valid values are Open, Closed, Pending, and Failed.

refund-countstringOptional

Total number of refund transactions in the batch.

refund-totalstringOptional

Total number of refund transactions in the batch.

sales-countstringOptional

Total number of sale transactions in the batch.

sales-totalstringOptional

Total amount of sale transactions in the batch.

net-amountstringOptional

Total amount of transactions in the batch.

total-countstringOptional

Total number of transactions in the batch.

confirmation-codestringOptional

Confirmation code for the settled batch.

settledstringOptional

Date and time when the batch was settled.

levelstringOptional

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.

start-datestringOptional

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.

end-datestringOptional

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.

pageintegerOptional

Page number for paginated results. Defaults to the first page if not specified.

page-sizeintegerOptional

Number of records to return per page.

descendingbooleanOptional

If true, results are sorted by date in descending order.

Header parameters
api-keystringRequired

An access API key issued to you by Xplor Pay.

Responses
get
/rest/v2/batches

Last updated

Was this helpful?