---
title: "Get all batch statuses"
method: GET
path: "/api/channels/{entityId}/payments/batches"
tags: ["Batch"]
---

# Get all batch statuses

`GET /api/channels/{entityId}/payments/batches`

Query all batch statuses of a batch for a channel.

## Path parameters

- `entityId` string, required

## Query parameters

- `offset` number
- `perPage` number
- `filters[startDate]` string, date-time
- `filters[endDate]` string, date-time
- `filters[status]` 'initiated' | 'processing' | 'expired' | 'error' | 'completed'

## Response `200`

URL.

- object
  - `batches` BatchResponse[]
    - `id` string, required — Unique identifier for the payment attempt.
    - `createdAt` string, required — Timestamp when the batch link was created.
    - `updatedAt` string, required — Timestamp when the batch link was updated.
    - `entityId` string, required — The entity for the request.
    - `filename` string, required — The name of the file that was uploaded.
    - `status` 'initiated' | 'processing' | 'completed' | 'error', required — Payment link status.
    - `successfulRows` number, required — The amount of successfully created payment links.
    - `totalRows` number, required — The total amount of rows parsed from file.
    - `errorCode` string — The error code will only be returned if the file fails to upload.
  - `meta` object
    - `perPage` number — The amount of items to retrieve.
    - `offset` number — The offset from which to read data.
    - `nextOffset` number — The offset from which to read data on a subsequent request.
    - `total` number — The total number of payment links returned by the filter criteria.

## Other responses

- `401` — Request lacks valid authentication.
- `404` — The specified resource was not found.

---

[API](https://skmtc.net/peachpayments/apis/checkout.md) · [All operations](https://skmtc.net/peachpayments/apis/checkout/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/peachpayments/checkout/revisions/3a98165665f8/schema)