Skip to main content
GET
/
health
Health check endpoint
curl --request GET \
  --url http://localhost:3156/health \
  --header 'x-api-key: <api-key>' \
  --header 'x-merchant-id: <api-key>'
{
  "success": true,
  "pg": true,
  "redis": true
}

Documentation Index

Fetch the complete documentation index at: https://docs.cheqpay.mx/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-key
string
header
required

API key for authentication (required)

​
x-merchant-id
string
header
required

Merchant ID for identifying the merchant (required)

Response

Service is healthy - all dependencies are connected

​
success
boolean

Always true in the response

Example:

true

​
pg
boolean

PostgreSQL database connection status

Example:

true

​
redis
boolean

Redis connection status

Example:

true