v1
latestOpenAPI 3.1.02026-07-241660500.9 KBGet Batches
Get List of Batches
get/v3/batch
Query parameters
merchantIdstring required
Id of the merchant
dateTypestring
Date type filter. Values: Any, Today, Yesterday, This Week, This Month, Last 7 Days, Last 30 Days, Custom
startDatestring
YYYY-MM-DDThh:mm:ssZ (Required for Custom dateType)
endDatestring
YYYY-MM-DDThh:mm:ssZ (Required for Custom dateType)
statusstring
Batch status. Values: Open, Closed
tenderstring
Batch tender type. Values: Card, Cash, Check, ACH
minAmountinteger
Amount filter
maxAmountinteger
Amount filter
limitinteger
How many records to show
offsetinteger
Response
200
Example response
{
"records": [
{
"id": 10000000550618,
"reference": "0001",
"status": "Closed",
"opened": "2018-08-13T16:32:47.29Z",
"closed": "2018-08-13T17:10:00.85Z",
"saleCount": 2,
"saleAmount": "89.52",
"netTip": "0",
"returnAmount": "0",
"netCount": 2,
"netAmount": "89.52",
"netTotal": "89.52",
"displayColor": "Green",
"processorName": "Omaha Settlement",
"device": "Z11X",
"tenderType": "Card",
"closerName": "System"
}
],
"recordCount": 1,
"totals": {
"recordCount": 1,
"netTotal": "89.52"
}
}