Get bulk payment statistics
curl --request GET \
--url https://sandbox-api.kotanipay.com/api/v3/dashboard/bulk-payments/api/statsimport requests
url = "https://sandbox-api.kotanipay.com/api/v3/dashboard/bulk-payments/api/stats"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://sandbox-api.kotanipay.com/api/v3/dashboard/bulk-payments/api/stats', 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://sandbox-api.kotanipay.com/api/v3/dashboard/bulk-payments/api/stats",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$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://sandbox-api.kotanipay.com/api/v3/dashboard/bulk-payments/api/stats"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://sandbox-api.kotanipay.com/api/v3/dashboard/bulk-payments/api/stats")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox-api.kotanipay.com/api/v3/dashboard/bulk-payments/api/stats")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"totalBatches": 123,
"totalSuccessfulPayments": 123,
"totalFailedPayments": 123,
"averageBatchSize": 123,
"successRate": 123,
"currencyBreakdown": {
"KES": {
"totalAmount": 50000,
"totalBatches": 3,
"totalPayments": 25
},
"ZMW": {
"totalAmount": 15000,
"totalBatches": 1,
"totalPayments": 10
}
}
}Bulk Payments
Get Bulk Payment Statistics
GET
/
api
/
v3
/
dashboard
/
bulk-payments
/
api
/
stats
Get bulk payment statistics
curl --request GET \
--url https://sandbox-api.kotanipay.com/api/v3/dashboard/bulk-payments/api/statsimport requests
url = "https://sandbox-api.kotanipay.com/api/v3/dashboard/bulk-payments/api/stats"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://sandbox-api.kotanipay.com/api/v3/dashboard/bulk-payments/api/stats', 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://sandbox-api.kotanipay.com/api/v3/dashboard/bulk-payments/api/stats",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$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://sandbox-api.kotanipay.com/api/v3/dashboard/bulk-payments/api/stats"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://sandbox-api.kotanipay.com/api/v3/dashboard/bulk-payments/api/stats")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox-api.kotanipay.com/api/v3/dashboard/bulk-payments/api/stats")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"totalBatches": 123,
"totalSuccessfulPayments": 123,
"totalFailedPayments": 123,
"averageBatchSize": 123,
"successRate": 123,
"currencyBreakdown": {
"KES": {
"totalAmount": 50000,
"totalBatches": 3,
"totalPayments": 25
},
"ZMW": {
"totalAmount": 15000,
"totalBatches": 1,
"totalPayments": 10
}
}
}Get statistics and analytics for bulk payments.
Query Parameters
Page number
Items per page
Filter by status
Filter by currency
Response
200 - application/json
Bulk payment statistics retrieved successfully
Total batches
Total successful payments
Total failed payments
Average batch size
Success rate percentage
Currency breakdown
Example:
{
"KES": {
"totalAmount": 50000,
"totalBatches": 3,
"totalPayments": 25
},
"ZMW": {
"totalAmount": 15000,
"totalBatches": 1,
"totalPayments": 10
}
}
⌘I