Sign in

v1

latestOpenAPI 3.1.02026-07-136388308.2 KB
Batch Payments

List new payees in a batch

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.

get/v2/batches/{batchUuid}/newpayees

Path parameters

batchUuidstring required

The UUID for the batch

Example:2DF456A-1234-5ABC-BAC0-C0CED23544F1

Response

New Payee Object

totalinteger

The total number of new Payees

Example response

{
  "total": 1,
  "items": [
    {
      "batchItemUuid": "F2AF3F2B-4406-4199-B249-B354F2CC6019",
      "status": "SUCCEEDED",
      "result": {
        "code": 510001,
        "message": "SUCCESS"
      },
      "dateCreated": "2021-04-04T10:48:53.540Z",
      "lastUpdated": "2021-04-04T10:48:53.540Z",
      "iban": "IE81AIBK96735642764123",
      "accountName": "John Doe",
      "accountHolderName": "John Doe"
    }
  ]
}