Health

1 endpoint. Base URL https://api.paymentsonline.io, sandbox https://api.sandbox-paymentsonline.io.

Every request needs payments-api-key and payments-account.

GET/v1/health

Get the Overall Health of the API

Retrieves the details of the API’s Health. Note: a 503 HTTP response code will be returned for the fail status.

200HealthOutput

descriptionstringoptional
Human-friendly description of the API.
notesarray of stringoptional
Array of notes relevant to the current state of health.
statusstring (pass | fail | warn)required
The overall health of the API. pass is healthy, fail is unhealthy, and warn is healthy with some concerns.
versionstringoptional
Public version of the API.