🚀 New Feature: Bulk Payouts! Send funds to multiple beneficiaries in a single request. Check the guide
JavaScript
const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}}; fetch('https://sandboxapi.me-cash.com/v1/bulk/payout/{batchId}/status', options) .then(res => res.json()) .then(res => console.log(res)) .catch(err => console.error(err));
{ "status": "success", "message": "Transaction Processing", "data": { "state": "pending", "batchId": "44cbef79-3b95-4214-bda2-78014f400d11", "startTimestamp": "2026-04-08T17:35:54.070396Z", "endTimestamp": null, "batchTotal": 15, "totalSuccessful": 0, "totalFailed": 0, "totalPending": 15, "items": [ { "referenceNumber": "REF_ZZOEAZH8ZJI6", "status": "pending", "targetAmount": "1500", "reason": "Salary payment", "recipient": { "id": "f55914fe-0568-473d-bf6f-95c32c71094e", "name": "NNOROM UZOMA CHUKWUDI", "account": { "bankName": "FCMB", "sortCode": "214", "accountNumber": "2483520014" }, "paymentChannel": "BANK_TRANSFER", "currency": "NGN", "country": "NG" } } ], "source": { "currency": "NGN", "country": "NG" }, "target": { "currency": "NGN", "country": "NG" }, "paymentChannel": "BANK_TRANSFER", "remark": "June 2026 Salary" } }
Retrieve the processing status and results of a bulk payout batch.
batchId
The unique identifier for the batch submission.
Batch status retrieved successfully.
"success"
"Transaction Processing"
Show child attributes
Was this page helpful?