---
title: "Batch link status"
method: GET
path: "/api/batches/{batchId}"
tags: ["Batch"]
---

# Batch link status

`GET /api/batches/{batchId}`

Returns the status of the batch.

## Path parameters

- `batchId` string, required

## Response `200`

Status received.

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

## Other responses

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