Get settlement summary
GET/v1/settlement/:session_id
Returns settled vs pending-settlement amounts for a session.
Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
curl https://api.kler.africa/v1/settlement/3f1e2d... \
-H "x-api-key: YOUR_API_KEY"
{
"success": true,
"data": {
"session_id": "3f1e2d...",
"total_settled": "200000.00",
"total_pending_settlement": "45000.00",
"settled_count": 40,
"pending_count": 7,
"by_date": {
"2025-08-01": { "count": 25, "total": "125000.00" },
"2025-08-02": { "count": 15, "total": "75000.00" }
},
"generated_at": "2025-08-02T09:00:00.000Z"
}
}
Track what has been settled and what is pending payout.
curl https://api.kler.africa/v1/settlement/3f1e2d... \
-H "x-api-key: YOUR_API_KEY"
{
"success": true,
"data": {
"session_id": "3f1e2d...",
"total_settled": "200000.00",
"total_pending_settlement": "45000.00",
"settled_count": 40,
"pending_count": 7,
"by_date": {
"2025-08-01": { "count": 25, "total": "125000.00" },
"2025-08-02": { "count": 15, "total": "75000.00" }
},
"generated_at": "2025-08-02T09:00:00.000Z"
}
}
/v1/settlement/:session_id
Returns settled vs pending-settlement amounts for a session.
curl https://api.kler.africa/v1/settlement/3f1e2d... \
-H "x-api-key: YOUR_API_KEY"
{
"success": true,
"data": {
"session_id": "3f1e2d...",
"total_settled": "200000.00",
"total_pending_settlement": "45000.00",
"settled_count": 40,
"pending_count": 7,
"by_date": {
"2025-08-01": { "count": 25, "total": "125000.00" },
"2025-08-02": { "count": 15, "total": "75000.00" }
},
"generated_at": "2025-08-02T09:00:00.000Z"
}
}
| Field | Description |
|---|---|
total_settled | Amount confirmed settled to your account |
total_pending_settlement | Successful transactions awaiting settlement |
by_date | Settled volume grouped by settlement date |