Cancel a Batch Payout

Cancels a batch payout that is under drafting or awaiting approval. Only batches in INITor PENDING_APPROVAL status can be cancelled through this endpoint; once execution has begun, cancellation is no longer possible.
Request Parameters
idstring
required
Unique identifier of the batch payout to cancel. The batch must be in INITor PENDING_APPROVAL status.
memostring
Optional note describing why the batch is being cancelled. Max length: 256 characters.
Response Parameters
resultResult
See Result.
idstring
Unique identifier of the batch payout.
statusstring
Batch status after cancellation. Always CANCELLED. See BatchPayoutStatus.
createdAtdatetime
Time the batch was created, in ISO 8601 extended format.
updatedAtdatetime
Time the batch was most recently updated, in ISO 8601 extended format.
requestIdstring
Idempotency key supplied when the batch was created.
batchNamestring
Human-readable batch name, if provided at creation.
paymentTypestring
Payment channel type set on the batch, if provided at creation. See PaymentType.
cancelledAtdatetime
Time the cancellation was recorded, in ISO 8601 extended format.
memostring
Note describing why the batch is being cancelled if provided.
totalItemCountinteger
Total number of items in the batch at cancellation. Range: 0 - 100.
validItemCountinteger
Number of items that had passed validation at cancellation. Range: 0 - 100.
calculationSummaryCalculationSummary
Latest reference pricing summary. Returned once calculate (or submit) has completed pricing. All totals and rates are indicative — final values are determined at payout processing.
Show child parametersShow child parameters
Error Codes
resultCoderesultStatusresultMessageTroubleshooting
SUCCESSSSuccessN/A
PARAM_ILLEGALFIllegal parameters exist.Verify `id` is present and no longer than 64 characters; ensure `memo` is at most 256 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).
BATCH_PAYOUT_STATUS_NOT_SUPPORTEDFOnly a batch payout in INIT or PENDING_APPROVAL status can be cancelled.Check the batch `status` via [Query a Batch Payout](https://docs.worldfirst.com/wfdocs/api-sdk/query_a_batch_payout); use [Delete a Batch Payout](https://docs.worldfirst.com/wfdocs/api-sdk/delete_a_batch_payout) for drafts in `INIT`, and contact support if execution has already started.
Definition
POST /api/open/v1/batchPayouts/cancel
Request
{
"id": "20260808BATCH00001",
"memo": "Superseded by a corrected batch created on 2026-08-09."
}
Response
{
"result": {
  "resultCode": "SUCCESS",
  "resultStatus": "S",
  "resultMessage": "success"
},
"id": "20260808BATCH00001",
"status": "CANCELLED",
"createdAt": "2026-08-08T09:15:00+08:00",
"updatedAt": "2026-08-08T18:00:00+08:00",
"requestId": "req_batch_20260808_0001",
"batchName": "Aug 8 supplier payouts",
"cancelledAt": "2026-08-08T18:00:00+08:00",
"memo": "Superseded by a corrected batch created on 2026-08-09.",
"totalItemCount": 3,
"validItemCount": 3
}