---
title: "List all batches"
method: GET
path: "/v1/batches"
tags: ["Batch Payments"]
---

# List all batches

`GET /v1/batches`

This endpoint will return a list of batches with the specified types and statuses. You will need to enable PERM_BUSINESS_GET_BATCHES to use this endpoint.

## Query parameters

- `batchTypes` 'INTERNAL_TRANSFER' | 'BANK_TRANSFER' | 'INTERNATIONAL_TRANSFER' | 'NEW_PAYEE' — The type of the batch. Can be one of the listed enums.
- `orderBy` 'DATE' — You can order the batches by date. No other options at this time
- `order` 'DESC' | 'ASC' — You can order the batches by ascending or descending order.
- `offset` integer — The page offset. Defaults to 0. This is the record number that the returned list will start at. E.g. offset = 40 and limit = 20 will return records 40 to 59.
- `limit` integer — The number of records to return. Defaults to 10 - max is 200.

## Response `200`

List all batches.

- object
  - `total` integer — total number of batches returned
  - `batchRequests` BatchRequest[]
    - `batchItemUuid` string — A UUID for this item.
    - `type` 'INTERNAL_TRANSFER' | 'BANK_TRANSFER' | 'NEW_PAYEE' | 'DEPRECATED_LOGIN' | 'DEPRECATED_MANUALLY_ADDED_NEW_PAYEE' | 'DEPRECATED_NEW_USER' | 'INTERNATIONAL_TRANSFER' — The type of batch
    - `status` 'PENDING_APPROVAL' | 'REJECTED' | 'COMPLETE' | 'OPEN' | 'CANCELLED' | 'PENDING_PARENT_BATCH_APPROVAL' | 'READY_FOR_PROCESSING' — Status of the batch
    - `sourceName` string — Source name
    - `batchName` string — The name assigned to the batch
    - `jobNumber` string — A name assigned to identiy the batch job executed
    - `currency` string — The currency the batch job is executed in
    - `numberOfItemsSubmitted` integer — Number of payments in the batch
    - `valueOfItemsSubmitted` integer — Total value of the payments in the batch
    - `numberOfItemsFailed` integer — Number of payments in the batch that failed
    - `valueOfItemsFailed` integer — Total value of failed payments in the batch
    - `numberOfItemsSucceeded` integer — Number of payments in the batch that succeeded
    - `valueOfItemsSucceeded` integer — Total value of successful payments in the batch
    - `lastUpdated` string, date-time — The datestamp of the last action on this batch - ISO format - e.g. 2018-04-04T10:48:53.540Z
    - `dateCreated` string, date-time — The datestamp the batch was created - ISO format - e.g. 2018-04-04T00:53:21.910Z

## Other responses

- `400` — An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint.
- `401` — An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint.
- `403` — An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint.

---

[API](https://skmtc.net/firefinancialservices/apis/fire-financial-services-business-api.md) · [All operations](https://skmtc.net/firefinancialservices/apis/fire-financial-services-business-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/firefinancialservices/fire-financial-services-business-api/revisions/1d19896d095c/schema)