Remove Items from a Batch Payout

Removes one or more payment items from an existing batch payout. Only batches in INIT status and items in INIT or INVALID status can be removed. Use this endpoint to clean up invalid items reported by Add Items to a Batch Payout or Calculate a Batch Payout before submission.
Request Parameters
idstring
required
Unique identifier of the target batch payout.
itemIdsarray
required
IDs of the batch items to remove. Provide item IDs returned by Add Items to a Batch Payout or List Batch Payout Items. Max 100 elements.
Response Parameters
resultResult
See Result.
idstring
Unique identifier of the batch payout.
statusstring
Current batch status. Remains INIT after item removal. 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.
transferMemostring
Internal memo attached to the batch, if provided at creation.
businessSceneCodestring
Business scene code set on the batch, if provided at creation. See BusinessSceneCode.
paymentNetworkstring
Payment clearing network set on the batch, if provided at creation. See PaymentNetwork.
paymentTypestring
Payment channel type set on the batch, if provided at creation. See PaymentType.
fvtPreferencestring
Full value transfer (FVT) preference set on the batch, if provided at creation. See FvtPreference.
oboPreferencestring
On-behalf-of (OBO) routing preference set on the batch, if provided at creation. See OboPreference.
totalItemCountinteger
Total number of items remaining in the batch after removal. Range: 0 - 100.
validItemCountinteger
Number of remaining items that pass validation. 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` and `itemIds` format; ensure `itemIds` has at most 100 elements.
AUTHORIZATION_NOT_EXISTFThe authorization does not exist.Confirm the OAuth authorization is still active for the target account.
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_STATUS_INVALIDFItems can only be removed when the batch payout is in INIT status.Check the batch `status` via [Query a Batch Payout](https://docs.worldfirst.com/wfdocs/api-sdk/query_a_batch_payout); removal is not allowed after submission.
Definition
POST /api/open/v1/batchPayouts/removeItems
Request
{
"id": "20260808BATCH00001",
"itemIds": [
  "item_20260808_0002",
  "item_20260808_0005"
]
}
Response
{
"result": {
  "resultCode": "SUCCESS",
  "resultStatus": "S",
  "resultMessage": "success"
},
"id": "20260808BATCH00001",
"status": "INIT",
"createdAt": "2026-08-08T09:15:00+08:00",
"updatedAt": "2026-08-08T10:20:00+08:00",
"requestId": "req_batch_20260808_0001",
"batchName": "Aug 8 supplier payouts",
"totalItemCount": 3,
"validItemCount": 3
}