Create Bulk Payout
const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
items: [
{
referenceNumber: '12345',
targetAmount: '1500',
reason: 'Salary payment',
recipient: {
name: 'NNOROM UZOMA CHUKWUDI',
account: {bankName: 'FCMB', sortCode: '214', accountNumber: '2483520014'},
paymentChannel: 'BANK_TRANSFER',
currency: 'NGN',
country: 'NG'
}
},
{
referenceNumber: '67890',
targetAmount: '1100',
reason: 'Salary payment',
recipient: {
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'
})
};
fetch('https://sandboxapi.me-cash.com/v1/bulk/payout', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));curl --request POST \
--url https://sandboxapi.me-cash.com/v1/bulk/payout \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"items": [
{
"referenceNumber": "12345",
"targetAmount": "1500",
"reason": "Salary payment",
"recipient": {
"name": "NNOROM UZOMA CHUKWUDI",
"account": {
"bankName": "FCMB",
"sortCode": "214",
"accountNumber": "2483520014"
},
"paymentChannel": "BANK_TRANSFER",
"currency": "NGN",
"country": "NG"
}
},
{
"referenceNumber": "67890",
"targetAmount": "1100",
"reason": "Salary payment",
"recipient": {
"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"
}
'import requests
url = "https://sandboxapi.me-cash.com/v1/bulk/payout"
payload = {
"items": [
{
"referenceNumber": "12345",
"targetAmount": "1500",
"reason": "Salary payment",
"recipient": {
"name": "NNOROM UZOMA CHUKWUDI",
"account": {
"bankName": "FCMB",
"sortCode": "214",
"accountNumber": "2483520014"
},
"paymentChannel": "BANK_TRANSFER",
"currency": "NGN",
"country": "NG"
}
},
{
"referenceNumber": "67890",
"targetAmount": "1100",
"reason": "Salary payment",
"recipient": {
"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"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const url = 'https://sandboxapi.me-cash.com/v1/bulk/payout';
const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
items: [
{
referenceNumber: '12345',
targetAmount: '1500',
reason: 'Salary payment',
recipient: {
name: 'NNOROM UZOMA CHUKWUDI',
account: {bankName: 'FCMB', sortCode: '214', accountNumber: '2483520014'},
paymentChannel: 'BANK_TRANSFER',
currency: 'NGN',
country: 'NG'
}
},
{
referenceNumber: '67890',
targetAmount: '1100',
reason: 'Salary payment',
recipient: {
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'
})
};
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",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'items' => [
[
'referenceNumber' => '12345',
'targetAmount' => '1500',
'reason' => 'Salary payment',
'recipient' => [
'name' => 'NNOROM UZOMA CHUKWUDI',
'account' => [
'bankName' => 'FCMB',
'sortCode' => '214',
'accountNumber' => '2483520014'
],
'paymentChannel' => 'BANK_TRANSFER',
'currency' => 'NGN',
'country' => 'NG'
]
],
[
'referenceNumber' => '67890',
'targetAmount' => '1100',
'reason' => 'Salary payment',
'recipient' => [
'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'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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.post("https://sandboxapi.me-cash.com/v1/bulk/payout")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"items\": [\n {\n \"referenceNumber\": \"12345\",\n \"targetAmount\": \"1500\",\n \"reason\": \"Salary payment\",\n \"recipient\": {\n \"name\": \"NNOROM UZOMA CHUKWUDI\",\n \"account\": {\n \"bankName\": \"FCMB\",\n \"sortCode\": \"214\",\n \"accountNumber\": \"2483520014\"\n },\n \"paymentChannel\": \"BANK_TRANSFER\",\n \"currency\": \"NGN\",\n \"country\": \"NG\"\n }\n },\n {\n \"referenceNumber\": \"67890\",\n \"targetAmount\": \"1100\",\n \"reason\": \"Salary payment\",\n \"recipient\": {\n \"name\": \"NNOROM UZOMA CHUKWUDI\",\n \"account\": {\n \"bankName\": \"FCMB\",\n \"sortCode\": \"214\",\n \"accountNumber\": \"2483520014\"\n },\n \"paymentChannel\": \"BANK_TRANSFER\",\n \"currency\": \"NGN\",\n \"country\": \"NG\"\n }\n }\n ],\n \"source\": {\n \"currency\": \"NGN\",\n \"country\": \"NG\"\n },\n \"target\": {\n \"currency\": \"NGN\",\n \"country\": \"NG\"\n },\n \"paymentChannel\": \"BANK_TRANSFER\",\n \"remark\": \"June 2026 Salary\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandboxapi.me-cash.com/v1/bulk/payout")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"items\": [\n {\n \"referenceNumber\": \"12345\",\n \"targetAmount\": \"1500\",\n \"reason\": \"Salary payment\",\n \"recipient\": {\n \"name\": \"NNOROM UZOMA CHUKWUDI\",\n \"account\": {\n \"bankName\": \"FCMB\",\n \"sortCode\": \"214\",\n \"accountNumber\": \"2483520014\"\n },\n \"paymentChannel\": \"BANK_TRANSFER\",\n \"currency\": \"NGN\",\n \"country\": \"NG\"\n }\n },\n {\n \"referenceNumber\": \"67890\",\n \"targetAmount\": \"1100\",\n \"reason\": \"Salary payment\",\n \"recipient\": {\n \"name\": \"NNOROM UZOMA CHUKWUDI\",\n \"account\": {\n \"bankName\": \"FCMB\",\n \"sortCode\": \"214\",\n \"accountNumber\": \"2483520014\"\n },\n \"paymentChannel\": \"BANK_TRANSFER\",\n \"currency\": \"NGN\",\n \"country\": \"NG\"\n }\n }\n ],\n \"source\": {\n \"currency\": \"NGN\",\n \"country\": \"NG\"\n },\n \"target\": {\n \"currency\": \"NGN\",\n \"country\": \"NG\"\n },\n \"paymentChannel\": \"BANK_TRANSFER\",\n \"remark\": \"June 2026 Salary\"\n}"
response = http.request(request)
puts response.read_bodyimport Foundation
let parameters = [
"items": [
[
"referenceNumber": "12345",
"targetAmount": "1500",
"reason": "Salary payment",
"recipient": [
"name": "NNOROM UZOMA CHUKWUDI",
"account": [
"bankName": "FCMB",
"sortCode": "214",
"accountNumber": "2483520014"
],
"paymentChannel": "BANK_TRANSFER",
"currency": "NGN",
"country": "NG"
]
],
[
"referenceNumber": "67890",
"targetAmount": "1100",
"reason": "Salary payment",
"recipient": [
"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"
] as [String : Any?]
let postData = try JSONSerialization.data(withJSONObject: parameters, options: [])
let url = URL(string: "https://sandboxapi.me-cash.com/v1/bulk/payout")!
var request = URLRequest(url: url)
request.httpMethod = "POST"
request.timeoutInterval = 10
request.allHTTPHeaderFields = [
"x-api-key": "<api-key>",
"Content-Type": "application/json"
]
request.httpBody = postData
let (data, _) = try await URLSession.shared.data(for: request)
print(String(decoding: data, as: UTF8.self))val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"items\": [\n {\n \"referenceNumber\": \"12345\",\n \"targetAmount\": \"1500\",\n \"reason\": \"Salary payment\",\n \"recipient\": {\n \"name\": \"NNOROM UZOMA CHUKWUDI\",\n \"account\": {\n \"bankName\": \"FCMB\",\n \"sortCode\": \"214\",\n \"accountNumber\": \"2483520014\"\n },\n \"paymentChannel\": \"BANK_TRANSFER\",\n \"currency\": \"NGN\",\n \"country\": \"NG\"\n }\n },\n {\n \"referenceNumber\": \"67890\",\n \"targetAmount\": \"1100\",\n \"reason\": \"Salary payment\",\n \"recipient\": {\n \"name\": \"NNOROM UZOMA CHUKWUDI\",\n \"account\": {\n \"bankName\": \"FCMB\",\n \"sortCode\": \"214\",\n \"accountNumber\": \"2483520014\"\n },\n \"paymentChannel\": \"BANK_TRANSFER\",\n \"currency\": \"NGN\",\n \"country\": \"NG\"\n }\n }\n ],\n \"source\": {\n \"currency\": \"NGN\",\n \"country\": \"NG\"\n },\n \"target\": {\n \"currency\": \"NGN\",\n \"country\": \"NG\"\n },\n \"paymentChannel\": \"BANK_TRANSFER\",\n \"remark\": \"June 2026 Salary\"\n}")
val request = Request.Builder()
.url("https://sandboxapi.me-cash.com/v1/bulk/payout")
.post(body)
.addHeader("x-api-key", "<api-key>")
.addHeader("Content-Type", "application/json")
.build()
val response = client.newCall(request).execute()falsepackage main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://sandboxapi.me-cash.com/v1/bulk/payout"
payload := strings.NewReader("{\n \"items\": [\n {\n \"referenceNumber\": \"12345\",\n \"targetAmount\": \"1500\",\n \"reason\": \"Salary payment\",\n \"recipient\": {\n \"name\": \"NNOROM UZOMA CHUKWUDI\",\n \"account\": {\n \"bankName\": \"FCMB\",\n \"sortCode\": \"214\",\n \"accountNumber\": \"2483520014\"\n },\n \"paymentChannel\": \"BANK_TRANSFER\",\n \"currency\": \"NGN\",\n \"country\": \"NG\"\n }\n },\n {\n \"referenceNumber\": \"67890\",\n \"targetAmount\": \"1100\",\n \"reason\": \"Salary payment\",\n \"recipient\": {\n \"name\": \"NNOROM UZOMA CHUKWUDI\",\n \"account\": {\n \"bankName\": \"FCMB\",\n \"sortCode\": \"214\",\n \"accountNumber\": \"2483520014\"\n },\n \"paymentChannel\": \"BANK_TRANSFER\",\n \"currency\": \"NGN\",\n \"country\": \"NG\"\n }\n }\n ],\n \"source\": {\n \"currency\": \"NGN\",\n \"country\": \"NG\"\n },\n \"target\": {\n \"currency\": \"NGN\",\n \"country\": \"NG\"\n },\n \"paymentChannel\": \"BANK_TRANSFER\",\n \"remark\": \"June 2026 Salary\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"message": "Batch Created",
"status": "success",
"data": {
"batchId": "76c41591-4040-4908-abac-77609769e385",
"referenceNo": "SUUSBGMHIHVVW",
"timestamp": "2026-10-07T09:53:24.573586779Z",
"batchTotal": 4,
"totalSuccessful": 0,
"totalFailed": 0,
"totalPending": 4
}
}Bulk Payout
Create Bulk Payout
Submits multiple payout orders in a single request using the Bulk Payout API. Orders are validated and processed independently — a failure in one order does not block the others.
POST
/
v1
/
bulk
/
payout
Create Bulk Payout
const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
items: [
{
referenceNumber: '12345',
targetAmount: '1500',
reason: 'Salary payment',
recipient: {
name: 'NNOROM UZOMA CHUKWUDI',
account: {bankName: 'FCMB', sortCode: '214', accountNumber: '2483520014'},
paymentChannel: 'BANK_TRANSFER',
currency: 'NGN',
country: 'NG'
}
},
{
referenceNumber: '67890',
targetAmount: '1100',
reason: 'Salary payment',
recipient: {
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'
})
};
fetch('https://sandboxapi.me-cash.com/v1/bulk/payout', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));curl --request POST \
--url https://sandboxapi.me-cash.com/v1/bulk/payout \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"items": [
{
"referenceNumber": "12345",
"targetAmount": "1500",
"reason": "Salary payment",
"recipient": {
"name": "NNOROM UZOMA CHUKWUDI",
"account": {
"bankName": "FCMB",
"sortCode": "214",
"accountNumber": "2483520014"
},
"paymentChannel": "BANK_TRANSFER",
"currency": "NGN",
"country": "NG"
}
},
{
"referenceNumber": "67890",
"targetAmount": "1100",
"reason": "Salary payment",
"recipient": {
"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"
}
'import requests
url = "https://sandboxapi.me-cash.com/v1/bulk/payout"
payload = {
"items": [
{
"referenceNumber": "12345",
"targetAmount": "1500",
"reason": "Salary payment",
"recipient": {
"name": "NNOROM UZOMA CHUKWUDI",
"account": {
"bankName": "FCMB",
"sortCode": "214",
"accountNumber": "2483520014"
},
"paymentChannel": "BANK_TRANSFER",
"currency": "NGN",
"country": "NG"
}
},
{
"referenceNumber": "67890",
"targetAmount": "1100",
"reason": "Salary payment",
"recipient": {
"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"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const url = 'https://sandboxapi.me-cash.com/v1/bulk/payout';
const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
items: [
{
referenceNumber: '12345',
targetAmount: '1500',
reason: 'Salary payment',
recipient: {
name: 'NNOROM UZOMA CHUKWUDI',
account: {bankName: 'FCMB', sortCode: '214', accountNumber: '2483520014'},
paymentChannel: 'BANK_TRANSFER',
currency: 'NGN',
country: 'NG'
}
},
{
referenceNumber: '67890',
targetAmount: '1100',
reason: 'Salary payment',
recipient: {
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'
})
};
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",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'items' => [
[
'referenceNumber' => '12345',
'targetAmount' => '1500',
'reason' => 'Salary payment',
'recipient' => [
'name' => 'NNOROM UZOMA CHUKWUDI',
'account' => [
'bankName' => 'FCMB',
'sortCode' => '214',
'accountNumber' => '2483520014'
],
'paymentChannel' => 'BANK_TRANSFER',
'currency' => 'NGN',
'country' => 'NG'
]
],
[
'referenceNumber' => '67890',
'targetAmount' => '1100',
'reason' => 'Salary payment',
'recipient' => [
'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'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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.post("https://sandboxapi.me-cash.com/v1/bulk/payout")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"items\": [\n {\n \"referenceNumber\": \"12345\",\n \"targetAmount\": \"1500\",\n \"reason\": \"Salary payment\",\n \"recipient\": {\n \"name\": \"NNOROM UZOMA CHUKWUDI\",\n \"account\": {\n \"bankName\": \"FCMB\",\n \"sortCode\": \"214\",\n \"accountNumber\": \"2483520014\"\n },\n \"paymentChannel\": \"BANK_TRANSFER\",\n \"currency\": \"NGN\",\n \"country\": \"NG\"\n }\n },\n {\n \"referenceNumber\": \"67890\",\n \"targetAmount\": \"1100\",\n \"reason\": \"Salary payment\",\n \"recipient\": {\n \"name\": \"NNOROM UZOMA CHUKWUDI\",\n \"account\": {\n \"bankName\": \"FCMB\",\n \"sortCode\": \"214\",\n \"accountNumber\": \"2483520014\"\n },\n \"paymentChannel\": \"BANK_TRANSFER\",\n \"currency\": \"NGN\",\n \"country\": \"NG\"\n }\n }\n ],\n \"source\": {\n \"currency\": \"NGN\",\n \"country\": \"NG\"\n },\n \"target\": {\n \"currency\": \"NGN\",\n \"country\": \"NG\"\n },\n \"paymentChannel\": \"BANK_TRANSFER\",\n \"remark\": \"June 2026 Salary\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandboxapi.me-cash.com/v1/bulk/payout")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"items\": [\n {\n \"referenceNumber\": \"12345\",\n \"targetAmount\": \"1500\",\n \"reason\": \"Salary payment\",\n \"recipient\": {\n \"name\": \"NNOROM UZOMA CHUKWUDI\",\n \"account\": {\n \"bankName\": \"FCMB\",\n \"sortCode\": \"214\",\n \"accountNumber\": \"2483520014\"\n },\n \"paymentChannel\": \"BANK_TRANSFER\",\n \"currency\": \"NGN\",\n \"country\": \"NG\"\n }\n },\n {\n \"referenceNumber\": \"67890\",\n \"targetAmount\": \"1100\",\n \"reason\": \"Salary payment\",\n \"recipient\": {\n \"name\": \"NNOROM UZOMA CHUKWUDI\",\n \"account\": {\n \"bankName\": \"FCMB\",\n \"sortCode\": \"214\",\n \"accountNumber\": \"2483520014\"\n },\n \"paymentChannel\": \"BANK_TRANSFER\",\n \"currency\": \"NGN\",\n \"country\": \"NG\"\n }\n }\n ],\n \"source\": {\n \"currency\": \"NGN\",\n \"country\": \"NG\"\n },\n \"target\": {\n \"currency\": \"NGN\",\n \"country\": \"NG\"\n },\n \"paymentChannel\": \"BANK_TRANSFER\",\n \"remark\": \"June 2026 Salary\"\n}"
response = http.request(request)
puts response.read_bodyimport Foundation
let parameters = [
"items": [
[
"referenceNumber": "12345",
"targetAmount": "1500",
"reason": "Salary payment",
"recipient": [
"name": "NNOROM UZOMA CHUKWUDI",
"account": [
"bankName": "FCMB",
"sortCode": "214",
"accountNumber": "2483520014"
],
"paymentChannel": "BANK_TRANSFER",
"currency": "NGN",
"country": "NG"
]
],
[
"referenceNumber": "67890",
"targetAmount": "1100",
"reason": "Salary payment",
"recipient": [
"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"
] as [String : Any?]
let postData = try JSONSerialization.data(withJSONObject: parameters, options: [])
let url = URL(string: "https://sandboxapi.me-cash.com/v1/bulk/payout")!
var request = URLRequest(url: url)
request.httpMethod = "POST"
request.timeoutInterval = 10
request.allHTTPHeaderFields = [
"x-api-key": "<api-key>",
"Content-Type": "application/json"
]
request.httpBody = postData
let (data, _) = try await URLSession.shared.data(for: request)
print(String(decoding: data, as: UTF8.self))val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"items\": [\n {\n \"referenceNumber\": \"12345\",\n \"targetAmount\": \"1500\",\n \"reason\": \"Salary payment\",\n \"recipient\": {\n \"name\": \"NNOROM UZOMA CHUKWUDI\",\n \"account\": {\n \"bankName\": \"FCMB\",\n \"sortCode\": \"214\",\n \"accountNumber\": \"2483520014\"\n },\n \"paymentChannel\": \"BANK_TRANSFER\",\n \"currency\": \"NGN\",\n \"country\": \"NG\"\n }\n },\n {\n \"referenceNumber\": \"67890\",\n \"targetAmount\": \"1100\",\n \"reason\": \"Salary payment\",\n \"recipient\": {\n \"name\": \"NNOROM UZOMA CHUKWUDI\",\n \"account\": {\n \"bankName\": \"FCMB\",\n \"sortCode\": \"214\",\n \"accountNumber\": \"2483520014\"\n },\n \"paymentChannel\": \"BANK_TRANSFER\",\n \"currency\": \"NGN\",\n \"country\": \"NG\"\n }\n }\n ],\n \"source\": {\n \"currency\": \"NGN\",\n \"country\": \"NG\"\n },\n \"target\": {\n \"currency\": \"NGN\",\n \"country\": \"NG\"\n },\n \"paymentChannel\": \"BANK_TRANSFER\",\n \"remark\": \"June 2026 Salary\"\n}")
val request = Request.Builder()
.url("https://sandboxapi.me-cash.com/v1/bulk/payout")
.post(body)
.addHeader("x-api-key", "<api-key>")
.addHeader("Content-Type", "application/json")
.build()
val response = client.newCall(request).execute()falsepackage main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://sandboxapi.me-cash.com/v1/bulk/payout"
payload := strings.NewReader("{\n \"items\": [\n {\n \"referenceNumber\": \"12345\",\n \"targetAmount\": \"1500\",\n \"reason\": \"Salary payment\",\n \"recipient\": {\n \"name\": \"NNOROM UZOMA CHUKWUDI\",\n \"account\": {\n \"bankName\": \"FCMB\",\n \"sortCode\": \"214\",\n \"accountNumber\": \"2483520014\"\n },\n \"paymentChannel\": \"BANK_TRANSFER\",\n \"currency\": \"NGN\",\n \"country\": \"NG\"\n }\n },\n {\n \"referenceNumber\": \"67890\",\n \"targetAmount\": \"1100\",\n \"reason\": \"Salary payment\",\n \"recipient\": {\n \"name\": \"NNOROM UZOMA CHUKWUDI\",\n \"account\": {\n \"bankName\": \"FCMB\",\n \"sortCode\": \"214\",\n \"accountNumber\": \"2483520014\"\n },\n \"paymentChannel\": \"BANK_TRANSFER\",\n \"currency\": \"NGN\",\n \"country\": \"NG\"\n }\n }\n ],\n \"source\": {\n \"currency\": \"NGN\",\n \"country\": \"NG\"\n },\n \"target\": {\n \"currency\": \"NGN\",\n \"country\": \"NG\"\n },\n \"paymentChannel\": \"BANK_TRANSFER\",\n \"remark\": \"June 2026 Salary\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"message": "Batch Created",
"status": "success",
"data": {
"batchId": "76c41591-4040-4908-abac-77609769e385",
"referenceNo": "SUUSBGMHIHVVW",
"timestamp": "2026-10-07T09:53:24.573586779Z",
"batchTotal": 4,
"totalSuccessful": 0,
"totalFailed": 0,
"totalPending": 4
}
}Submitting a bulk payout queues the batch for asynchronous processing. The endpoint does not wait for individual payouts to complete. It returns a
For a newly created batch,
batchId immediately after the batch is accepted.
Use the batchId with the Fetch Batch Status endpoint to monitor processing and retrieve individual payout results.
Response fields
| Field | Type | Description |
|---|---|---|
message | String | Confirmation that the batch was created. |
status | String | API-level response status (success or failed). |
data.batchId | String | Unique identifier for the created bulk payout batch. Pass this to Fetch Batch Status. |
data.referenceNo | String | Reference number associated with the batch. |
data.timestamp | String | ISO 8601 timestamp of when the batch was created. |
data.batchTotal | Number | Total number of payout items submitted in the batch. |
data.totalSuccessful | Number | Number of payouts that have completed successfully at the time of the response. |
data.totalFailed | Number | Number of payouts that have failed at the time of the response. |
data.totalPending | Number | Number of payouts still pending at the time of the response. |
totalSuccessful, totalFailed, and totalPending reflect the state at creation time. Payouts are settled asynchronously, so these counts change as the batch processes.
Check the batch status
After creating a bulk payout, use the returnedbatchId to monitor the batch and retrieve the status of individual payouts.
Pass data.batchId from the response above to the Fetch Batch Status endpoint:
GET /v1/bulk/payout/{batchId}/status
Error responses
| Status | Message | What it means | How to fix |
|---|---|---|---|
| 400 | Insufficient wallet balance for transaction | Wallet balance cannot cover the total payout amount plus fees. | Top up the wallet or reduce the number of orders before retrying. |
| 400 | Quotes only last for 10 minutes | One or more referenced quotes expired before submission. | Generate fresh bulk quotes and submit the payout immediately. |
| 400 | Invalid country or currency ISO code | Unsupported country/currency combination in a recipient. | Use corridor-supported ISO codes for both quote and recipient data. |
| 400 | Account name mismatch, use account enquiry endpoint | Account name in payload differs from bank enquiry results. | Re-run account enquiry and match the returned account name. |
| 400 | Invalid Bank Sortcode | Sort code missing, malformed, or unsupported. | Fetch the correct sort code from the bank list and verify formatting. |
| 400 | {field_name} cannot be empty | Required recipient field omitted from the payload. | Fill in every mandatory field (name, account number, etc.) before submitting. |
| 400 | Duplicate quote ID in bulk order | The same quote ID was provided multiple times in the bulk order request. | Ensure each quote ID is unique within the same bulk order. |
| 401 | API key missing or incorrect | x-api-key header absent, invalid, or expired. | Supply the correct API key for the environment you are targeting. |
| 403 | IP not whitelisted | Request originated from an unapproved IP. | Add your server IP to the dashboard allowlist. |
| 422 | Invalid quote ID provided | Quote ID missing, invalid, expired, or already consumed. | Create new bulk quotes and reference them in the payout call. |
| 500 | Service temporarily unavailable | Temporary backend/service disruption. | Retry with exponential backoff; contact support if it persists. |
Authorizations
Body
application/json
List of payout orders to process in the bulk payload.
Show child attributes
Show child attributes
The source currency and country for the batch.
Show child attributes
Show child attributes
The target currency and country for the batch.
Show child attributes
Show child attributes
The overall payment channel intended for the batch.
Available options:
BANK_TRANSFER, MOBILE_MONEY Example:
"BANK_TRANSFER"
A general remark for the bulk payout.
Example:
"June 2026 Salary"
Was this page helpful?