Sign in

v1

latestOpenAPI 3.1.02026-07-136388308.2 KB
Batch Payments

List approvals for a batch.

This endpoint will return a list of the approvers for the selected batch. You will need to enable PERM_BUSINESS_GET_BATCH_APPROVALS to use this endpoint.

get/v1/batches/{batchUuid}/approvals

Path parameters

batchUuidstring required

The uuid of the batch.

Example:4ADFB67A-0F5B-4A9A-9D74-34437250045C

Response

A list of approvers for this batch.

Example response

{
  "approvals": [
    {
      "userId": 3138,
      "emailAddress": "jane.doe@example.com",
      "firstName": "Jane",
      "lastName": "Doe",
      "status": "PENDING_APPROVAL",
      "lastUpdated": "2021-04-04T10:48:53.540Z"
    }
  ]
}