---
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`

## Request

- Base URL: `https://sandbox-l.ppay.io`
- URL: `https://sandbox-l.ppay.io/api/channels/{entityId}/payments/batches`
- Auth: HTTP bearer

Query all batch statuses of a batch for a channel.

For sample calls, see the [public Postman collection](https://www.postman.com/peachpayments/peach-payments-public-workspace/request/x1aovu5/payment-links-public?action=share&creator=20323380&ctx=documentation&active-environment=13324425-10da86ae-9bc2-4124-8f55-f7255fa3ff55).

## 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`

Batch statuses successfully retrieved.

- 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.dev/peachpayments/apis/payment-links.md) - [All operations](https://skmtc.dev/peachpayments/apis/payment-links/llms.txt) - [OpenAPI document](https://skmtc.dev/peachpayments/apis/payment-links/revisions/3a63dca6b297?raw)