Batches
Batches Controller
Valid formats for the ‘start-date’ and ‘end-date’ fields include the following: 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
param
Level of search. Default is terminal level. Set to 'merchant' to query all batches for this merchant.
filters the batches list by the created date/time. Setting start date will return batches that were processed after this date/time. Setting both start and end date creates a range
use with start date to create range
The page number. Use the page and page-size for pagination
Number of results per page
list results in descending order, default is true
Batch status (OPEN,CLOSED,PENDING,FAILED). A PENDING status means the batch is being processed. The FAILED means a batch was attempted and failed. A batch that has FAILED can be resubmitted.
api-key-value
Number of refunds in the batch
total dollar amount of refunds in the batch
Number of sales/auths in batch
Total dollar amount of sales in the batch
Total dollar amount in the batch
Total number of transactions in the batch
on a settled batch the confirmation code
date and time of settled batch
Success
No Content
Something is wrong with your request
Unauthorized
Forbidden
Not Found
Internal server error
Last updated
Was this helpful?