This page is a ZenPay-styled copy of the Zenith Payments developer documentation. View the original docs

Diagnostics API

API health and connectivity endpoints for verifying the service is operational.

Ping the API#

GET/v2/diagnostics/ping

View this endpoint in the original docs

Returns the server date time and version information.

Authentication: Api-Key + BasicAuth

Responses

200 Ping response including server date time and version information.

application/json · object (PingResponse)

Example: Ping

One health-check response.

JSON

{
  "buildVersion": "1.137.1.19365",
  "serverDateTime": "2026-09-24T00:36:40.2830196",
  "timeZoneInfo": "Australian Eastern Standard Time",
  "version": "v2.0"
}

Example request (cURL, sandbox host)

cURL

curl -X GET 'https://api.sandbox.zenpay.com.au/v2/diagnostics/ping' \
  -H 'Api-Key: <your API key>' \
  -u '<username>:<password>' \
  -H 'Accept: application/json'

Need help with your integration?Talk to the Zenith Integrations Team.

Email integrations Talk to us