Documentation Health Check

Health Check

Monitor API service availability and status with our health check endpoint

Overview

The health check endpoint provides a simple way to verify that the ZenPay API is operational and accessible. This endpoint requires no authentication and returns a basic status response.

Note: This endpoint does not require any authentication.

Endpoint Details

GET /v1/health

This endpoint provides a quick way to check if the API service is running and responsive.

Request Example

Making a health check request is straightforward. Here are examples in cURL:

Request Example

curl --location  "https://api.thezenpay.com/v1/health"

Response Format

The health check endpoint returns a simple JSON response like this:

{
  "status": "ok"
}

Was this helpful?

Signature Generation

Retail