GET /health
GET /api/v1/remittance/healthPublic liveness endpoint. No auth. Returns 200 if the API + database are healthy, 503 otherwise.
Response (200 OK)
json
{
"status": "healthy",
"service": "remittance-api",
"checks": { "database": "ok" },
"timestamp": "2026-08-14T14:00:00.000000"
}Response (503 Service Unavailable)
json
{
"status": "degraded",
"service": "remittance-api",
"checks": { "database": "unreachable" },
"timestamp": "2026-08-14T14:00:00.000000"
}When to use it
- Uptime monitoring on your side (Pingdom, UptimeRobot, StatusCake…) — hit this every 60 seconds.
- Deployment smoke test — after upgrading your integration, ping this before running the full test suite.
- Support runbook — the first thing to check when you suspect an outage.
Do not use /health as a keep-alive for a persistent connection — the endpoint is stateless and creates no session.
