Health

Health check endpoints

Health check

get

/api/v1

/health

Get API health status

Responses

200

API is healthy and operational

application/json

statusstringOptionalExample: ok

paymentNetworkstringOptionalExample: operational

corridorsobjectOptionalExample: {"ZAR->UGX":"operational","UGX->ZAR":"warning"}

uptimenumberOptionalExample: 556432

timestampstring · date-timeOptional

get

/health

HTTPcURLJavaScriptPython

GET /api/v1/health HTTP/1.1
Accept: */*

200

API is healthy and operational

{
  "status": "ok",
  "paymentNetwork": "operational",
  "corridors": {
    "ZAR->UGX": "operational",
    "UGX->ZAR": "warning"
  },
  "uptime": 9856932,
  "timestamp": "2025-11-17T10:30:00.000Z"
}