Health Check Endpoints

Health check endpoints for monitoring service status.

Basic Health Check

GEThttps://api.zenpays.com/health

Bearer · API key

Returns basic service health status. No authentication required.

Response

{
  "status": "ok",
  "timestamp": "2024-01-15T10:30:00.000Z"
}

---

Readiness Probe

GEThttps://api.zenpays.com/ready

Bearer · API key

Kubernetes readiness probe. Returns 200 if service is ready to accept traffic.

Response

{
  "status": "ready",
  "checks": {
    "database": "ok",
    "cache": "ok",
    "queue": "ok"
  }
}

---

Liveness Probe

GEThttps://api.zenpays.com/live

Bearer · API key

Kubernetes liveness probe. Returns 200 if service is alive.

Response

{
  "status": "alive",
  "uptime": 86400
}

---

Service Info

GEThttps://api.zenpays.com/info

Bearer · API key

Returns service version and build information.

Response

{
  "service": "zenpay-merchant-service",
  "version": "1.0.0",
  "environment": "production",
  "buildTime": "2024-01-15T00:00:00.000Z"
}

Examples

cURL

# Basic health check
curl -X GET "https://api.zenpays.com/health"

# Readiness probe
curl -X GET "https://api.zenpays.com/ready"

# Liveness probe
curl -X GET "https://api.zenpays.com/live"

# Service info
curl -X GET "https://api.zenpays.com/info"

HTTP Status Codes

Status	Meaning
200	Service is healthy/ready
503	Service is unhealthy/not ready