List bulk payouts API

Environment: Sandbox

List bulk payout batches for a wallet.

# List bulk payouts API

List recent bulk payout batches for a wallet, newest first, with cursor pagination.

## Endpoint
- **Method**: POST
- **URL**: https://sandbox.moolre.com/open/transact/bulk_list

## Headers
| Header | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| X-API-USER | string | Yes | Your Moolre username. |
| X-API-KEY | string | Yes | Your wallet private API key. A public key is refused. |

## Request Body
| Parameter | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| accountnumber | string | Yes | Your Moolre wallet account number. |
| limit | integer | No | Batches per page, 1 to 100. Default 25. |
| starting_after | string | No | A batchid: send next_cursor from the previous page to read the next one. |
| status | string | No | Batch filter: queued, processing or completed. |

## Response (200 Success)
A page of batch summaries (without items), with cursor fields.

```json
{
  "status": 1,
  "code": "BLK31",
  "message": "Batches found.",
  "data": {
    "batches": [
      {
        "batchid": "bat_3f9c2a1d7e5b4c60",
        "batchref": "PAYROLL-2026-11",
        "accountnumber": "1000000000001",
        "currency": "GHS",
        "status": "processing",
        "unresolved": false,
        "total_amount": "150.00",
        "balance_warning": false,
        "counts": {
          "total": 2,
          "queued": 0,
          "submitted": 1,
          "pending": 0,
          "succeeded": 1,
          "failed": 0
        },
        "succeeded_amount": "100.00",
        "failed_amount": "0.00",
        "rejected_items": 1,
        "created": "2026-11-15T09:00:00Z",
        "started": "2026-11-15T09:00:40Z",
        "completed": null
      }
    ],
    "has_more": false,
    "next_cursor": null
  },
  "go": null,
  "meta": {
    "requestid": "req_c68f4c66115c26725c796242",
    "notices": []
  }
}
```


## Fields every response can carry

These fields are additive: existing fields keep their names, order and types.

| Field | Meaning |
| :--- | :--- |
| error | On a failure: { code, message, fields: [{ field, code, message }] } listing every failing field. |
| meta | Always present, last in the object. meta.replayed is true only when the response is the stored answer to a repeated Idempotency-Key (absent otherwise). meta.requestid is the unique id of the request (also the X-Request-Id response header): quote it when you contact support. meta.notices is always an array, empty when there is nothing to report; each notice is { code, message, docs? }, for example that a deprecated way of sending credentials was used. See [Deprecations](https://docs.moolre.com/guides/deprecations). |

There is no outcome field. Decide the result from status, code and, on payment and transfer endpoints, data.txstatus (0 pending, 1 succeeded, 2 failed). These codes mean the result is unknown and may still succeed, so treat them as pending and check the status: PY01, PY02, TR01, TR02, TP11, TP18, APY10, APY16, ASL06, SYS500. Status 1 with TR08, OBGH01, OTGH01, OBNG01, GHQ03 or OM03 is final success; any other status 1 is an accepted, unfinished request.

Send X-Moolre-Http-Status: strict to receive real HTTP status codes (400, 401, 403, 404, 409, 422, 429, 5xx) instead of HTTP 200. See [Responses and request IDs](https://docs.moolre.com/guides/responses).

Back to the Moolre AI documentation index