Skip to main content
GET
/
v1
/
bulk
/
payout
/
{batchId}
/
status
Fetch Batch Status
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));
curl --request GET \
--url https://sandboxapi.me-cash.com/v1/bulk/payout/{batchId}/status \
--header 'x-api-key: <api-key>'
import requests

url = "https://sandboxapi.me-cash.com/v1/bulk/payout/{batchId}/status"

headers = {"x-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const url = 'https://sandboxapi.me-cash.com/v1/bulk/payout/{batchId}/status';
const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://sandboxapi.me-cash.com/v1/bulk/payout/{batchId}/status",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
HttpResponse<String> response = Unirest.get("https://sandboxapi.me-cash.com/v1/bulk/payout/{batchId}/status")
.header("x-api-key", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://sandboxapi.me-cash.com/v1/bulk/payout/{batchId}/status")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body
import Foundation

let url = URL(string: "https://sandboxapi.me-cash.com/v1/bulk/payout/{batchId}/status")!
var request = URLRequest(url: url)
request.httpMethod = "GET"
request.timeoutInterval = 10
request.allHTTPHeaderFields = ["x-api-key": "<api-key>"]

let (data, _) = try await URLSession.shared.data(for: request)
print(String(decoding: data, as: UTF8.self))
val client = OkHttpClient()

val request = Request.Builder()
.url("https://sandboxapi.me-cash.com/v1/bulk/payout/{batchId}/status")
.get()
.addHeader("x-api-key", "<api-key>")
.build()

val response = client.newCall(request).execute()
false
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://sandboxapi.me-cash.com/v1/bulk/payout/{batchId}/status"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("x-api-key", "<api-key>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
{
  "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"
        }
      }
    ],
    "paymentChannel": "BANK_TRANSFER",
    "remark": "June 2026 Salary"
  }
}
{
"message": "Invalid API key",
"status": "failed"
}
{
"message": "Access denied: IP address not whitelisted",
"status": "failed"
}
This endpoint allows you to check the realtime status of a previously submitted bulk payout batch using its batchId.

Authorizations

x-api-key
string
header
required

Path Parameters

batchId
string<uuid>
required

The unique identifier for the batch submission.

Response

Batch status retrieved successfully.

status
string
Example:

"success"

message
string
Example:

"Transaction Processing"

data
object