Get Batch Recipients
curl --request GET \
--url https://waas-staging.embedly.ng/api/v1/payment-scheduler/batch/{batchId}/recipients \
--header 'x-api-key: <api-key>'import requests
url = "https://waas-staging.embedly.ng/api/v1/payment-scheduler/batch/{batchId}/recipients"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://waas-staging.embedly.ng/api/v1/payment-scheduler/batch/{batchId}/recipients', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://waas-staging.embedly.ng/api/v1/payment-scheduler/batch/{batchId}/recipients",
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;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://waas-staging.embedly.ng/api/v1/payment-scheduler/batch/{batchId}/recipients"
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))
}HttpResponse<String> response = Unirest.get("https://waas-staging.embedly.ng/api/v1/payment-scheduler/batch/{batchId}/recipients")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://waas-staging.embedly.ng/api/v1/payment-scheduler/batch/{batchId}/recipients")
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{
"statusCode": 200,
"message": "Recipients retrieved successfully",
"data": [
{
"id": "2a3b4c5d-6e7f-8a9b-0c1d-2e3f4a5b6c7d",
"batchId": "08ddaf4f-77d9-4336-8e62-358d622f09e9",
"rowNumber": 1,
"recipientName": "John Doe",
"accountNumber": "0987654321",
"bankCode": "058",
"bankName": "Guaranty Trust Bank",
"amount": 500,
"narration": "June Salary",
"validationStatus": "VALID",
"validationMessage": "Valid recipient",
"createdAt": "2026-06-01T09:00:00Z",
"isActive": true
}
]
}
Payment Scheduler
Get Batch Recipients
Returns all recipients associated with a batch.
GET
/
api
/
v1
/
payment-scheduler
/
batch
/
{batchId}
/
recipients
Get Batch Recipients
curl --request GET \
--url https://waas-staging.embedly.ng/api/v1/payment-scheduler/batch/{batchId}/recipients \
--header 'x-api-key: <api-key>'import requests
url = "https://waas-staging.embedly.ng/api/v1/payment-scheduler/batch/{batchId}/recipients"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://waas-staging.embedly.ng/api/v1/payment-scheduler/batch/{batchId}/recipients', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://waas-staging.embedly.ng/api/v1/payment-scheduler/batch/{batchId}/recipients",
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;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://waas-staging.embedly.ng/api/v1/payment-scheduler/batch/{batchId}/recipients"
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))
}HttpResponse<String> response = Unirest.get("https://waas-staging.embedly.ng/api/v1/payment-scheduler/batch/{batchId}/recipients")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://waas-staging.embedly.ng/api/v1/payment-scheduler/batch/{batchId}/recipients")
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{
"statusCode": 200,
"message": "Recipients retrieved successfully",
"data": [
{
"id": "2a3b4c5d-6e7f-8a9b-0c1d-2e3f4a5b6c7d",
"batchId": "08ddaf4f-77d9-4336-8e62-358d622f09e9",
"rowNumber": 1,
"recipientName": "John Doe",
"accountNumber": "0987654321",
"bankCode": "058",
"bankName": "Guaranty Trust Bank",
"amount": 500,
"narration": "June Salary",
"validationStatus": "VALID",
"validationMessage": "Valid recipient",
"createdAt": "2026-06-01T09:00:00Z",
"isActive": true
}
]
}
string
required
The unique identifier of the batch.
{
"statusCode": 200,
"message": "Recipients retrieved successfully",
"data": [
{
"id": "2a3b4c5d-6e7f-8a9b-0c1d-2e3f4a5b6c7d",
"batchId": "08ddaf4f-77d9-4336-8e62-358d622f09e9",
"rowNumber": 1,
"recipientName": "John Doe",
"accountNumber": "0987654321",
"bankCode": "058",
"bankName": "Guaranty Trust Bank",
"amount": 500,
"narration": "June Salary",
"validationStatus": "VALID",
"validationMessage": "Valid recipient",
"createdAt": "2026-06-01T09:00:00Z",
"isActive": true
}
]
}
⌘I