---
title: "Get the details of a batch"
method: GET
path: "/v1/batches/{batchUuid}"
tags: ["Batch Payments"]
---

# Get the details of a batch

`GET /v1/batches/{batchUuid}`

This endpoint will return the details of the batch specified in the API endpoint - {batchUuid}. You will need to enable PERM_BUSINESS_GET_BATCH to use this endpoint.

## Path parameters

- `batchUuid` string, required — The uuid of the batch.

## Response `200`

Returns the details of the batch specified in the API endpoint - {batchUuid}.

- Batch
  - `batchUuid` string — A UUID for this item.
  - `type` 'INTERNAL_TRANSFER' | 'BANK_TRANSFER' | 'INTERNATIONAL_TRANSFER' | 'NEW_PAYEE' — The type of the batch - can be one of the listed enums
  - `status` 'PENDING_APPROVAL' | 'REJECTED' | 'COMPLETE' | 'OPEN' | 'CANCELLED' | 'PENDING_PARENT_BATCH_APPROVAL' | 'READY_FOR_PROCESSING' | 'PROCESSING' — status of the batch object
  - `sourceName` string — A string describing where the batch originated - for instance the name of the API token that was used, or showing that the batch was automatically created by fire.com (in the case of a new payee batch).
  - `batchName` string — An optional name you give to the batch at creation time
  - `jobNumber` string — An optional job number you can give to the batch to help link it to your own system.
  - `callbackUrl` string — An optional POST URL that all events for this batch will be sent to.
  - `currency` string — All payments in the batch must be the same currency.
  - `numberOfItemsSubmitted` integer — A count of the number of items in the batch
  - `valueOfItemsSubmitted` integer — A sum of the value of items in the batch. Specified in pence or cent.
  - `numberOfItemsFailed` integer — Once processed, a count of the number of items that didn’t process successfully.
  - `valueOfItemsFailed` integer — Once processed, a sum of the value of items that didn’t process successfully. Specified in pence or cent.
  - `numberOfItemsSucceeded` integer — Once processed, a count of the number of items that processed successfully.
  - `valueOfItemsSucceeded` integer — Once processed, a sum of the value of items that processed successfully. Specified in pence or cent.
  - `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
  - `payeeChecks` PayeeCheck
    - `countFullMatch` integer
    - `countPartialMatch` integer
    - `countNoMatch` integer
    - `countUnableToMatch` integer — The number of payees on which a VoP check was not completed
    - `countPending` integer — The number of payees awaiting a VoP check result

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