# Cancel Batch Payout Cancel a batch payout. Payouts still in `initiated` status within the batch are cancelled. Payouts that are already `processing` or `completed` are not affected. ## Request ### Path Parameters ### Headers ## Response ### Success (200 OK) ```json { "success": true, "data": { "success": true, "message": "Batch batch_xxxxx cancelled. 12 pending jobs removed." } } ``` ### Error Responses ## Examples ```bash curl -X POST "https://api.zenpays.com/payment/api/v1/batch-payouts/batch_xxxxx/cancel" \ -H "Authorization: Bearer zp_test_xxxxx" \ -H "X-Timestamp: 2024-01-15T10:30:00.000Z" \ -H "X-Signature: a1b2c3d4e5f6..." \ -H "X-Secret-Salt: your_secret_salt" ``` ```javascript const result = await zenpays.payouts.cancelBatch('batch_xxxxx') console.log(result.message) ``` ## Related Endpoints - [Create Batch Payout](/docs/rest-api/endpoints/payouts/create-batch-payout) - [Get Batch Payout](/docs/rest-api/endpoints/payouts/get-batch-payout) - [Confirm Batch Payout](/docs/rest-api/endpoints/payouts/confirm-batch-payout)