Skip to content

Health check

Check that the API of your platform is up, that your API key works and that transactions are processed.

Three checks, from simple to thorough. Monitor them from your own systems, at an interval that suits your alerting.

API health check

The simplest health check is polling the /_hc endpoint of the API. It returns ALIVE when the API is up and running, and needs no authentication.

curl https://api.example.com/_hc

See API health check in the API reference.

System health check

A more thorough check retrieves the details of your own project. An HTTP 200 response means the basic system works. It doesn't check transaction processing.

curl https://api.example.com/v1/merchants/self/projects/self/ \
  --user "$API_KEY:"

See System health check in the API reference.

Transaction health check

To check that transactions are processed, either:

  • Retrieve an order that you created before. This is the easiest, but the least accurate.
  • Create a new order at an interval. This is more accurate, but fills the database with abandoned transactions, and doesn't work with every payment method.

API reference

See the Health check API reference for both calls.