---
title: "Get all transaction batches"
method: GET
path: "/rest/v2/batches"
tags: ["Batches"]
---

# Get all transaction batches

`GET /rest/v2/batches`

Retrieves the list of batches within a specified date range.

## Query parameters

- `param` object, required
- `status` string
- `pageable` Pageable, required
  - `offset` integer
  - `sort` Sort — Sorting details applied to the result set.
    - `field` object — Specifies the field name used to sort the result set.
  - `pageSize` integer
  - `pageNumber` integer
  - `unpaged` boolean
  - `paged` boolean
- `refund-count` string
- `refund-total` string
- `sales-count` string
- `sales-total` string
- `net-amount` string
- `total-count` string
- `confirmation-code` string
- `settled` string
- `level` string
- `start-date` string
- `end-date` string
- `page` integer
- `page-size` integer
- `descending` boolean

## Headers

- `api-key` string, required

## Response `200`

Success

- ClearentBatchResponsePayload — payload
  - `batch` Payload — Batches
    - `id` string — Unique identifier for the batch.
    - `status` 'OPEN' | 'CLOSED' — Current status of the batch. Available statuses: Open, Close, Pending, Failed.
    - `settled` string — Date and time when the batch was settled.
    - `refund-count` string — Total number of refund transactions processed in the batch.
    - `refund-total` string — Total amount refunded in the batch.
    - `sales-count` string — Total number of sales transactions processed in the batch.
    - `sales-total` string — Total amount of all sale transactions in the batch.
    - `net-amount` string — Net amount after processing sale and refund transactions, in currency format.
    - `total-count` string — Total number of transactions, including sales and refunds.
    - `confirmation-code` string — The batch confirmation code.
    - `merchant-id` string — Identifier for the merchant associated with the batch.
    - `terminal-id` string — Identifier of the terminal that processed the batch.
    - `terminal-name` string — Name of the terminal.
    - `date-opened` string — Date when the batch was opened.
    - `switch-batch-id` string — Identifier used by the payment switch for the batch.
  - `payloadType` string — Type of payload returned in the response.

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not Found
- `500` — Internal server error

---

[API](https://skmtc.net/xplorpay/apis/external-us-onboarding-workflow.md) · [All operations](https://skmtc.net/xplorpay/apis/external-us-onboarding-workflow/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/xplorpay/external-us-onboarding-workflow/revisions/f37077c24b66/schema)