List batches
Use this method to return a [paginated](https://docs.payroc.com/api/pagination) list of batches that your merchants submitted to the processor on a specific date.
**Note:** If you want to view the details of a specific batch and you have its batchId, use our [Retrieve Batch](https://docs.payroc.com/api/schema/reporting/settlement/retrieve-batch) method.
Use query parameters to filter the list of results that we return, for example, to search for batches that were submitted by a specific merchant.
> **Important:** You must provide a value for the date query parameter.
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
Return the previous page of results before the value that you specify.
You can’t send the before parameter in the same request as the after parameter.
after
Return the next page of results after the value that you specify.
You can’t send the after parameter in the same request as the before parameter.
limit
Limit the maximum number of results that we return for each page.
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 we returned on this page.
Note: This might not be the total number of results that match your query.
hasMore
Indicates whether there is another page of results 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.
