---
title: "List the recipients in a batch"
method: GET
path: "/api/v1/payment-batch/{batchId}/recipients"
tags: ["Payment Batches"]
---

# List the recipients in a batch

`GET /api/v1/payment-batch/{batchId}/recipients`

## Request

- Base URL: `https://sandbox.api.afriex.com`
- URL: `https://sandbox.api.afriex.com/api/v1/payment-batch/{batchId}/recipients`
- Auth: API key in header `x-api-key`
- TypeScript: <https://skmtc.dev/afriex/apis/afriex-business-api/docs/api/v1/payment-batch/:batchId/recipients/get.ts> (a function with typed inputs; its response is checked against the schema)

Requires the `PAYMENT_BATCH.READ` key permission.

## Query parameters

- `page` integer
- `limit` integer

## Response `200`

The recipients

- object
  - `data` PaymentBatchRecipient[]
    - `id` string: The saved account's id. Only the create and update responses return it (see `PaymentBatchRecipientSaved`); the list returns `paymentMethodId` and `recipientId` instead.
    - `paymentMethodId` string
    - `recipientId` string: The recipient's id in this batch, used to update or remove it.
    - `channel` string
    - `countryCode` string
    - `accountName` string
    - `accountNumber` string
    - `institution` object
    - `amount` object: The amount to pay this recipient on each run of the batch.
      - `value` string
      - `currencyCode` string
  - `total` integer
  - `page` integer

## Other responses

- `400`: The request is invalid, the `batchId` in the path is not a valid id (`INVALID_BUSINESS_PAYMENT_BATCH_REQUEST`), or it came from an IP outside the business's whitelist, carried a bad payload signature or named an unsupported `x-api-version`.
- `401`: Missing or invalid API key, or a key without the permission this endpoint requires.
- `404`: No batch with this id belongs to the calling business.
- `500`: Server error.
- `503`: Temporarily unavailable: an upstream service failed or timed out, or the API is momentarily offline. Retry with backoff and honour the Retry-After header when present.

---

[API](https://skmtc.dev/afriex/apis/afriex-business-api.md) - [All operations](https://skmtc.dev/afriex/apis/afriex-business-api/llms.txt) - [OpenAPI document](https://skmtc.dev/afriex/apis/afriex-business-api/revisions/d94198b6c256?raw)