Moolre Documentation

API Reference / Bulk payouts

Bulk payout status

POSThttps://api.moolre.com/open/transact/bulk_status

Read the progress of one batch: counts, amounts and a page of items with each item's state, code, transaction id and receiver name.

Headers

  • X-API-USER string required

    Your Moolre username.

  • X-API-KEY string required

    Your wallet private API key. A public key is refused.

Body parameters

  • accountnumber string required

    Your Moolre wallet account number.

  • batchid string optional

    The batchid returned when the batch was created. Send batchid or batchref.

  • batchref string optional

    Your batchref. Send batchid or batchref.

  • status string optional

    Item filter: queued, submitted, pending, succeeded or failed.

  • after integer optional

    Item index to continue after: send next_after from the previous page.

  • limit integer optional

    Items per page, 1 to 500. Default 100.

Responses

200 Success

The batch, its counts and a page of items. Batch status is queued, processing or completed; unresolved is true when the batch completed after 72 hours with some items still pending.

{  "status": 1,  "code": "BLK21",  "message": "Batch found.",  "data": {    "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,    "items": [      {        "index": 0,        "externalref": "PAY-1",        "receiver": "0240000001",        "channel": "MTN",        "amount": "100.00",        "status": "succeeded",        "code": "OBGH01",        "message": "Pay out Successful",        "transactionid": "123456",        "thirdpartyref": "98765",        "receivername": "KOFI A",        "attempts": 1,        "updated": "2026-11-15T09:01:10Z"      }    ],    "next_after": null  },  "go": null,  "meta": {    "requestid": "req_c68f4c66115c26725c796242",    "notices": []  }}

200 (HTTP 404 in strict mode) Batch not found

No batch with that batchid or batchref on this wallet.

{  "status": 0,  "code": "BLK22",  "message": "Batch not found.",  "data": "batchid",  "go": null,  "meta": {    "requestid": "req_c68f4c66115c26725c796242",    "notices": []  }}