Health Check

Check the health of the Payment Links API.

Endpoint

GET /health

Response Parameters

Status Code: 200 OK

Parameter	Type	Description
status	string	Overall status to indicate whether the API is healthy - healthy
version	string	Version of the API major.minor.patch
uptimeMs	integer	Milliseconds the service has been running
durationMs	integer	Milliseconds the health check request took to complete
components	object	List of components and their health status

Components Object

Parameter	Type	Description
self.status	string	Indicates the state of the component
self.durationMs	integer	Time taken to call the component (ms)
SQL Server.status	string	Indicates the state of the component
SQL Server.durationMs	integer	Time taken to call the component (ms)
Merchant API.status	string	Indicates the state of the component
Merchant API.durationMs	integer	Time taken to call the component (ms)

Example Request

GET /health

Example Response

{
    "status": "healthy",
    "version": "1.0.109-manual",
    "uptimeMs": 7949156,
    "durationMs": 73,
    "components": {
        "self": {
            "status": "healthy",
            "durationMs": 0
        },
        "SQL Server": {
            "status": "healthy",
            "durationMs": 1
        },
        "Merchant API": {
            "status": "healthy",
            "durationMs": 73
        }
    }
}

Status Code: 503 Service Unavailable

Returned when one or more components are unhealthy.