---
title: "Get mass payment status"
method: GET
path: "/v3/payments/mass/{paymentBatchId}"
tags: ["payments"]
---

# Get mass payment status

`GET /v3/payments/mass/{paymentBatchId}`

## Request

- Base URL: `https://gateway.stage.bill.com/connect`
- URL: `https://gateway.stage.bill.com/connect/v3/payments/mass/{paymentBatchId}`
- Auth: none declared

Get details about an existing mass payment batch.

In the response, you get the status of each payment in the mass payment batch. Each payment is either `scheduled`, `completed`, or `failed`. In addition, you get the `count` for the total number of payments in the mass payments batch.

**Note**: From the list of `completed` payments in the response, BILL begins processing payments based on the payment `processDate`.

## Path parameters

- `paymentBatchId` string, required: BILL-generated ID of the mass payment batch. The value begins with `bbq`.

## Headers

- `sessionId` string, nullable: API session ID generated with `/v3/login`
- `devKey` string, nullable: Developer key generated with your BILL developer account

## Response `200`

Get mass payment status response

- MassPaymentDetailsResponseDto: Mass payment details response DTO.
  - `count` integer: Total number of payments in the mass payment batch
  - `scheduled` ScheduledPaymentDto[]: Scheduled payments. For each payment in the list, BILL has not started generating a payment `id` value and API response.
    - `billId` string: BILL-generated ID of the bill. The value begins with `00n`.
  - `completed` CompletedPaymentDto[]: Completed payments. For each payment in the list, BILL has successfully generated a payment `id` value and API response. In the response, if the payment `id` is the same for multiple bills, the vendor has `combinePayments` set as `true`. **Note**: From the list of `completed` payments, BILL begins processing payments based on the payment `processDate`.
    - `billId` string: BILL-generated ID of the bill. The value begins with `00n`.
    - `paymentId` string: BILL-generated ID of the payment. The value begins with `stp`.
  - `failed` FailedPaymentDto[]: Failed payments. An error response is available for each failed payment.
    - `billId` string: BILL-generated ID of the bill. The value begins with `00n`.
    - `errorCode` string: Failed payment error code
    - `errorMessage` string: Failed payment error message

## Other responses

- `4XX`: List of errors.
- `5XX`: List of errors.

## Changes

- **2026-11-03** `54edddceb0a5`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/bill/apis/bill-v3-api/changes/v3/payments/mass/:paymentBatchId/get.md)

---

[API](https://skmtc.dev/bill/apis/bill-v3-api.md) - [All operations](https://skmtc.dev/bill/apis/bill-v3-api/llms.txt) - [OpenAPI document](https://skmtc.dev/bill/apis/bill-v3-api/revisions/54edddceb0a5?raw)