Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.kler.africa/llms.txt

Use this file to discover all available pages before exploring further.

Operators represent the people collecting payments at your event — cashiers, gate staff, or ticket scanners. Each operator can be linked to transactions for accountability.

​
Add operator

POST /v1/sessions/:session_id/operators
​
name
string
required
Operator’s full name.
​
email
string
Operator’s email address.
​
phone
string
Operator’s phone number.
​
role
string
default:"cashier"
Role label (e.g. cashier, supervisor).
curl -X POST https://api.kler.africa/v1/sessions/3f1e2d.../operators \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Amina Bello",
    "phone": "08012345678",
    "role": "cashier"
  }'

{
  "success": true,
  "data": {
    "id": "op_...",
    "session_id": "3f1e2d...",
    "name": "Amina Bello",
    "phone": "08012345678",
    "role": "cashier",
    "created_at": "2025-08-01T09:00:00.000Z"
  }
}

​
List operators

GET /v1/sessions/:session_id/operators 
curl https://api.kler.africa/v1/sessions/3f1e2d.../operators \
  -H "x-api-key: YOUR_API_KEY"

​
Get operator transactions

GET /v1/sessions/:session_id/operators/:operator_id/transactions Returns all transactions linked to a specific operator. 
curl https://api.kler.africa/v1/sessions/3f1e2d.../operators/op_.../transactions \
  -H "x-api-key: YOUR_API_KEY"