---
title: "List new payees in a batch"
method: GET
path: "/v2/batches/{batchUuid}/newpayees"
tags: ["Batch Payments"]
---

# List new payees in a batch

`GET /v2/batches/{batchUuid}/newpayees`

This endpoint will retrieve a list of details of batch items with new payees. You will need to enable PERM_BUSINESS_GET_BATCH_NEWPAYEES to use this endpoint.

## Path parameters

- `batchUuid` string, required — The UUID for the batch

## Response `200`

New Payee Object

- NewPayeesBatch
  - `total` integer — The total number of new Payees
  - `items` Item[]
    - `batchItemUuid` string — A UUID for this item
    - `status` 'SUBMITTED' | 'REMOVED' | 'SUCCEEDED' | 'FAILED' — status of the batch
    - `result` object
      - `code` integer — This is the code returned indicating response type
      - `message` string — This is the message indicating whether the call was a success
    - `dateCreated` string, date-time — The datestamp the batch was created - ISO format - e.g. 2018-04-04T00:53:21.910Z
    - `lastUpdated` string, date-time — The datestamp of the last action on this batch - ISO format - e.g. 2018-04-04T10:48:53.540Z
    - `iban` string — International Banking Account number belonging to the new Payees
    - `accountName` string — The name on the account of the new payee
    - `accountHolderName` string — The name of the new payee

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