Delete a Batch Payout

Permanently deletes a batch payout in INIT status along with all its items. Use this endpoint to discard a draft batch that has not yet been submitted. To withdraw a batch that has already been submitted, call Cancel a Batch Payout instead.
Request Parameters
idstring
required
Unique identifier of the batch payout to delete. Note: the batch must be in INIT status.
Response Parameters
resultResult
See Result.
Error Codes
resultCoderesultStatusresultMessageTroubleshooting
SUCCESSSSuccessN/A
PARAM_ILLEGALFIllegal parameters exist.Verify `id` is present and no longer than 64 characters.
BATCH_NOT_EXISTFThe batch payout does not exist.Confirm `id` matches a batch returned by [Create a Batch Payout](https://docs.worldfirst.com/wfdocs/api-sdk/create_a_batch_payout); a previously deleted batch cannot be deleted again.
BATCH_PAYOUT_STATUS_NOT_SUPPORTEDFOnly a batch payout in INIT status can be deleted. To withdraw a submitted batch payout, cancel it instead.Check the batch `status` via [Query a Batch Payout](https://docs.worldfirst.com/wfdocs/api-sdk/query_a_batch_payout); use [Cancel a Batch Payout](https://docs.worldfirst.com/wfdocs/api-sdk/cancel_a_batch_payout) once the batch has been submitted.
Definition
POST /api/open/v1/batchPayouts/delete
Request
{
"id": "20260808BATCH00001"
}
Response
{
"result": {
  "resultCode": "SUCCESS",
  "resultStatus": "S",
  "resultMessage": "success"
}
}