List Batch Payout Items

Retrieves a paginated list of items in a batch payout. Use this endpoint to inspect the validation, execution, or failure state of each item; filter by BatchPayoutItemStatus to focus on items that require attention (for example, INVALID items awaiting cleanup or FAILED items to be investigated).
Request Parameters
idstring
required
Unique identifier of the target existing batch payout.
limitinteger
Number of results per page. Value range: 1–100. Defaults to 20 if omitted.
cursorstring
Pagination cursor. Omit on the first call; pass the nextCursor (or prevCursor) returned by a previous call to move to the next (or previous) page. Max length: 256 characters.
statusstring
Filter items by latest status. See BatchPayoutItemStatus.
Response Parameters
resultResult
See Result.
itemsarray
Batch items on the current page. Max 100 elements. Each item follows the Query a Payout schema, with itemId replacing id.
nextCursorstring
Cursor for the next page. Returned only when more results are available. Pass it back as cursor to fetch the next page. Max length: 256 characters.
prevCursorstring
Cursor for the previous page. Returned only when a previous page exists. Max length: 256 characters.
Error Codes
resultCoderesultStatusresultMessageTroubleshooting
SUCCESSSSuccessN/A
PARAM_ILLEGALFIllegal parameters exist.Verify `id`, `limit` (1 - 100), and `cursor` format; check that `status` matches an accepted enum value.
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).
PROCESS_FAILFA general business failure occurred.Retry with the same `cursor`; if the issue persists, contact WorldFirst support.
Definition
POST /api/open/v1/batchPayouts/listItems
Request
{
"id": "20260808BATCH00001",
"limit": 20,
"status": "FAILED"
}
Response
{
"result": {
  "resultCode": "SUCCESS",
  "resultStatus": "S",
  "resultMessage": "success"
},
"items": [
  {
    "requestId": "req_item_20260808_0003",
    "itemId": "item_20260808_0003",
    "status": "FAILED",
    "businessSceneCode": "THIRD_PARTY_PAYOUT",
    "payer": {
      "balanceType": "BALANCE",
      "region": "SG"
    },
    "beneficiary": {
      "accountType": "BANK_ACCOUNT",
      "beneficiaryId": "ben_****0003"
    },
    "sourceAmount": {
      "value": 300000,
      "currency": "USD"
    },
    "payoutAmount": {
      "value": 300000,
      "currency": "USD"
    },
    "feeAmount": {
      "value": 500,
      "currency": "USD"
    },
    "purposeCode": "SAL",
    "reference": "PAYROLL-2026-08-003",
    "failureCode": "INSUFFICIENT_BALANCE",
    "failureMessage": "Insufficient balance to fund this payout. Top up the account and create a new batch for the failed items."
  }
],
"nextCursor": "eyJpdGVtU2VxIjoyMH0="
}