Healthcheck

GET {{url}}/health_check

We expose a health check endpoint which can be used to test connections to our API. Requests to this endpoint do not require authorization and are not rate limited. This endpoint will return a 200 response while our API is available.

  • https://api.gocardless.com/health_check for live

  • https://api-sandbox.gocardless.com/health_check for sandbox

Health check API Docs

RESPONSES

status: OK

{"active_record":"up","system":"up"}