v1

latestOpenAPI 3.1.02026-07-136388308.2 KB
Batch Payments

Cancel a batch

This endpoint will cancel a Batch from being processed. You can only cancel a batch before it is submitted for approval (while it is in the OPEN state). You will need to enable PERM_BUSINESS_DELETE_BATCH to use this endpoint.

delete/v1/batches/{batchUuid}

Path parameters

batchUuidstring required

The uuid of the batch.

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

Response

Batch payment deleted successfully.