---
title: "Retrieve an invoice batch"
method: GET
path: "/billing/invoices/batches/{invoiceBatchId}"
---

# Retrieve an invoice batch

`GET /billing/invoices/batches/{invoiceBatchId}`

## Request

- Base URL: `https://api-sandbox.ezypay.com/v2`
- URL: `https://api-sandbox.ezypay.com/v2/billing/invoices/batches/{invoiceBatchId}`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://identity-sandbox.ezypay.com/token`

Get the full details of an invoice batch.

## Path parameters

- `invoiceBatchId` string, required

## Query parameters

- `status` string
- `cursor` integer
- `limit` integer

## Headers

- `merchant` string, required

## Response `200`

200

- object
  - `id` string
  - `batchReference` string
  - `createdOn` string
  - `status` string
  - `invoiceBatchItemList` object
    - `data` object[]
      - `id` string
      - `externalInvoiceId` string
      - `invoiceId` string
      - `status` string
      - `processingResult` string
      - `createdOn` string
    - `paging` object
      - `nextUrl` unknown
      - `nextCursor` integer
      - `limit` integer
      - `totalCount` integer

## Other responses

- `400`: 400

## Changes

- **2026-11-03** `924be4030f56`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/ezypay/apis/vault/changes/billing/invoices/batches/:invoiceBatchId/get.md)

---

[API](https://skmtc.dev/ezypay/apis/vault.md) - [All operations](https://skmtc.dev/ezypay/apis/vault/llms.txt) - [OpenAPI document](https://skmtc.dev/ezypay/apis/vault/revisions/924be4030f56?raw)