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

# Batch link status

`GET /api/batches/{batchId}`

## Request

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

Returns the status of the batch.

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

## Response `200`

Batch status successfully retrieved.

- BatchResponse: The response containing the status and details of a batch payment link operation.
  - `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.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)