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}
Request
- Base URLhttps://api.fire.com/business
- AuthHTTP bearer
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
batchUuidstring required
The uuid of the batch.
Example:4ADFB67A-0F5B-4A9A-9D74-34437250045C
Response
Batch payment deleted successfully.
Changes
No recorded changes to this operation across all 7 revisions of this API.