Monitor integration health
Use the health-check endpoints to verify the Chargeflow API is reachable and your API key is valid, for uptime monitoring and pre-flight checks.
Use the health check endpoints to verify that the Chargeflow API is reachable and that your API key is valid. These are lightweight endpoints designed for integration monitoring and pre-flight checks.
Each one answers exactly one question, so a failure is never ambiguous:
| Question | Endpoint | Auth |
|---|---|---|
| Is Chargeflow up? (availability) | GET /health-check | none, no key sent |
| Is my key valid? (authentication) | GET /health-check/access-key | x-api-key |
Authorization (is this key allowed to call a given resource) is answered by the resource itself, not by either health check. See Error handling.
Check service availability
Verifies that the Chargeflow API is reachable and returning responses. This endpoint takes no credentials: it returns 200 even with no x-api-key header, so it never tells you anything about your key.
GET /public/2025-04-01/health-checkExample request
curl https://api.chargeflow.io/public/2025-04-01/health-checkExample response
"OK"A 200 OK response confirms the service is available. Any non-200 response indicates a service-level issue. Check the Chargeflow status page for incident updates.
Validate your API key
Verifies that your x-api-key is valid and currently active. This is the one endpoint that answers the credentials question.
GET /public/2025-04-01/health-check/access-keyExample request
curl https://api.chargeflow.io/public/2025-04-01/health-check/access-key \
-H "x-api-key: YOUR_PLATFORM_API_KEY"Example response
"OK"A 200 OK confirms the key is valid and active. A 403 with {"message": "Forbidden"} means the key is missing, invalid, or revoked: regenerate your credentials in the Developer Hub. The Chargeflow API does not return 401 today, so 403 is the single status for a rejected request.
If this endpoint returns 200 but another endpoint returns 403, your credentials are fine and the problem is authorization or the request itself: a missing entitlement (for example 403_eaas_not_enabled) or, with HMAC enabled, a signature mismatch. See Error handling.
When to use these endpoints
Info
Add health checks to your integration monitoring. Call both endpoints in your uptime checks to catch connectivity issues before they affect your merchants.
Recommended use cases:
- Startup/initialization check: call before making other API calls when your service starts or redeploys, to confirm the integration is healthy.
- Incident investigation: if webhooks stop arriving or API calls fail unexpectedly, run these checks first to rule out connectivity and authentication issues before deeper debugging.
- Canary monitoring: include in synthetic monitoring to get alerted on Chargeflow availability issues without waiting for a real dispute to fail.