Skip to main content
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/stats
{
  "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

Page number

limit
number

Items per page

status
string

Filter by status

currency
enum<string>

Filter by currency

Available options:
KES,
GHS,
NGN,
ZAR,
ZAR,
USD,
XOF,
ZMW,
XAF,
SLE,
CDF,
TZS,
UGX,
EGP,
MWK,
RWF,
ETB,
MZN,
LSL,
GNF,
USDT,
BTC,
ETH,
USDC

Response

200 - application/json

Bulk payment statistics retrieved successfully

totalBatches
number
required

Total batches

totalSuccessfulPayments
number
required

Total successful payments

totalFailedPayments
number
required

Total failed payments

averageBatchSize
number
required

Average batch size

successRate
number
required

Success rate percentage

currencyBreakdown
object
required

Currency breakdown

Example:
{
"KES": {
"totalAmount": 50000,
"totalBatches": 3,
"totalPayments": 25
},
"ZMW": {
"totalAmount": 15000,
"totalBatches": 1,
"totalPayments": 10
}
}