List batches
Use this method to retrieve a paginated list of your merchants’ batches that were submitted to the processor on a specific date.
Note: If you want to view a specific batch and you have its batchId, use our Retrieve Batch method.
In your request, include the date that the batch was submitted. You can also use a query parameter to view the batches of a specific merchant.
Our gateway returns the following information about each batch in the list:
- Transaction information, including the number of transactions and total value of sales.
- Merchant information, including the merchant ID (MID) and the processing account that the batch is associated with.
Headers
Authorization
Bearer authentication of the form Bearer <token>, where token is your auth token.
Query parameters
before
Points to the resource identifier that you want to receive your results before. Typically, this is the first resource on the previous page.
after
Points to the resource identifier that you want to receive your results after. Typically, this is the last resource on the previous page.
limit
States the total amount of results the response is limited to.
date
Filter batches by the date that they were submitted. The format of this value is YYYY-MM-DD.
merchantId
Filter results by the unique identifier that the processor assigned to the merchant.
Response
Successful request. Returns a paginated list of batches.
data
Array of batch objects.
count
Number of results that we returned.
hasMore
Indicates that further results are available.
limit
Maximum number of results that we return for each page.
links
Reference links to navigate to the previous page of results or to the next page of results.