---
title: "List batches"
method: GET
path: "/batches"
tags: ["Settlement"]
---

# List batches

`GET /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.

## Query parameters

- `before` string
- `after` string
- `limit` integer
- `date` string, date, required
- `merchantId` string

## Headers

- `Authorization` string, required

## Response `200`

Successful request. Returns a paginated list of batches.

- ReportingSettlementListBatchesResponse200 — Contains the pagination properties that you use to navigate through a list of results.
  - `limit` integer — Maximum number of results that we return for each page.
  - `count` integer — Number of results we returned on this page. **Note:** This might not be the total number of results that match your query.
  - `hasMore` boolean — Indicates whether there is another page of results available.
  - `links` Link[] — Reference links to navigate to the previous page of results or to the next page of results.
    - `rel` string, required — Indicates the relationship between the current resource and the target resource.
    - `method` string, required — HTTP method that you need to use with the target resource.
    - `href` string, required — URL of the target resource.
  - `data` Batch[], required — Array of batch objects.
    - `batchId` integer — Unique identifier that we assigned to the batch.
    - `date` string, date — Date that the merchant submitted the batch. The format of this value is **YYYY-MM-DD**.
    - `createdDate` string, date — Date that we created a record for the batch. The format of this value is **YYYY-MM-DD**.
    - `lastModifiedDate` string, date — Date that the batch was last changed. The format of this value is **YYYY-MM-DD**.
    - `saleAmount` integer — Total value of sales in the batch. We return the value in the currency's lowest denomination, for example, cents.
    - `heldAmount` integer — Total value of authorizations in the batch. We return the value in the currency's lowest denomination, for example, cents.
    - `returnAmount` integer — Total value of returns in the batch. We return the value in the currency's lowest denomination, for example, cents.
    - `transactionCount` integer — Total number of transactions in the batch.
    - `currency` string — Currency of the transactions in the batch. The value for the currency follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard.
    - `merchant` MerchantSummary — Object that contains information about the merchant.
      - `merchantId` string — Unique identifier that the processor assigned to the merchant.
      - `doingBusinessAs` string — Trading name of the business.
      - `processingAccountId` integer — Unique identifier that we assigned to the processing account.
      - `link` Link — Object that contains HATEOAS links for the resource.
        - `rel` string, required — Indicates the relationship between the current resource and the target resource.
        - `method` string, required — HTTP method that you need to use with the target resource.
        - `href` string, required — URL of the target resource.
    - `links` Link[]
      - `rel` string, required — Indicates the relationship between the current resource and the target resource.
      - `method` string, required — HTTP method that you need to use with the target resource.
      - `href` string, required — URL of the target resource.

## Other responses

- `400` — Validation error
- `401` — Identity could not be verified
- `403` — Do not have permissions to perform this action
- `406` — Not acceptable
- `500` — An error has occured

---

[API](https://skmtc.dev/payroc/apis/schema.md) · [All operations](https://skmtc.dev/payroc/apis/schema/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/payroc/schema/revisions/1d9d3e305945/schema)