Skip to main content

Health Check

API data

API Gateway
This API is used for payment gateway operations:

Introduction​

The Health Check endpoint lets you verify whether the Payment Gateway API is operational and responding correctly. This endpoint is useful for system monitoring, connectivity checks, and validating the API status.

Check API status​

HEAD /v1/health-check

Checks whether the API is functioning correctly and returns the system health status.

Data dictionary - Parameters​

This endpoint does not require input parameters.

API is healthy
HTTP/1.1 200 OK

Data dictionary - Response​

STATUS CODEDESCRIPTION
200API is up and running

Use cases​

System monitoring​

Use this endpoint to implement automatic API health checks in your monitoring systems.

Connectivity checks​

Test connectivity to the API before performing critical operations.

Recommendations

Best practices for using Health Check:

  • Set up automatic checks every 1–5 minutes
  • Implement alerts based on consecutive failures
  • Use it as an initial test before critical operations
  • Configure appropriate timeouts (recommended: 10–30 seconds)
Important

This endpoint:

  • Does not require authentication
  • Does not return sensitive data
  • Should respond quickly (< 5 seconds)
  • Can be used for frequent checks without rate-limiting impact