# Lists transaction batch settlements

<span class="api-endpoint">GET {{<a href="#urlbases">baseURL</a>}}/pay-api/v1/settlements/batches</span>

Endpoint: GET /pay-api/v1/settlements/batches
Version: V1
Security: Bearer

## Query parameters:

  - `page` (integer)
    Specifies the page number of the returned search results.

A page is considered each set of the `pageSize` value.

The maximum page value is the `pageSize` divided by the `total` count rounded up.
The count is zero-based.
For example, if `pageSize` is 50 and the `total` is 130, there are three pages.
The maximum `page` value is 2.

Values above the maximum page value will complete successfully but not return any items.

Example: 0

  - `pageSize` (integer)
    Specifies the number of items for each page of the returned search results.

A page is considered each set of the `pageSize` value.

The maximum page value is the `pageSize` divided by the `total` count rounded up.
The count is zero-based.
For example, if `pageSize` is 50 and the `total` is 130, there are three pages.
The maximum `page` value is 2.

Example: 50

  - `orderBy` (string)
    Specifies the field the results get ordered by.

The sort order is specified by the `asc` value.

Example: contactName

  - `asc` (boolean)
    Specifies the sort order is ascending.

The sort field is specified by the `orderBy` value.

If `true`, the sort order is ascending.<br>
If `false`, the sort order is descending.

Example: true

  - `dateFrom` (string)
    Specifies returning items on or after this date (in an ISO 8601 date-time format).

If `dateFrom` only is specified, the search returns all available items from the `dateFrom` value to the present.
The fields `dateFrom` and `dateTo` may be used together to create an exclusive range.
We recommend creating an inclusive range to avoid a potentially excessive number of returns.

  - `dateTo` (string)
    Specifies returning items on or to this date (in an ISO 8601 date-time format).

If `dateTo` only is specified, the search returns all available items up to the `dateTo` value.
The fields `dateFrom` and `dateTo` may be used together to create an exclusive range.
We recommend creating an inclusive range to avoid a potentially excessive number of returns.

  - `batchIds` (array)
    <br>Specifies the payment identifiers included in the batch settlement.

  - `paymentProcessorIds` (array)

  - `statusId` (integer)
    Specifies the settlement batch status.

Possible values:

| Status | Description |
|:-----: |-------------|
| 1      | Open        |
| 2      | Settled     |

## Response 200 fields (application/json):

  - `items` (array)

  - `items.id` (string)

  - `items.paymentProcessorId` (string)
    Indicates the payment processor identifier.

Example: 2059fcc1-5507-42be-8e4c-f4fcce245027
    Example: 2059fcc1-5507-42be-8e4c-f4fcce245027

  - `items.paymentProcessorName` (string)

  - `items.externalBatchId` (string)

  - `items.batchDateTime` (string)
    Specifies the batch date time (in an ISO 8601 date-time UTC format).

Examples: 2026-02-19T20:24:52.934Z
    Example: 2026-02-19T20:24:52.934Z

  - `items.transactionCount` (number)

  - `items.netAmount` (number)

  - `items.refundsAmount` (number)

  - `items.salesAmount` (number)

  - `items.statusId` (integer)
    SettlementBatchStatus
Open = 1
Settled = 2

  - `items.statusName` (string)

  - `total` (integer)
    Indicates the total number of settlement batches found.

Example: 31
    Example: 31