Cancel a batch

delete https://api.fire.com/business/v1/batches/{batchUuid}

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.

Responses

200

Batch payment deleted successfully.

Language

Credentials

Bearer

API Access Token


xxxxxxxxxx
1
curl --request DELETE \
2
     --url https://api.fire.com/business/v1/batches/batchUuid \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

400An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint.

401An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint.

403An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint.