Payment Batches

List the recipients in a batch

Requires the PAYMENT_BATCH.READ key permission.

get/api/v1/payment-batch/{batchId}/recipients

Request

Base URL
https://sandbox.api.afriex.com
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.

pageinteger

Zero-based page number for pagination.

limitinteger

Number of items per page (max 100).

The recipients

totalinteger

pageinteger

{
  "data": [
    {
      "amount": {
        "value": "15000",
        "currencyCode": "NGN"
      }
    }
  ]
}

No recorded changes to this operation across all 1 revision of this API.