Skip to main content
GET
Authenticated health check endpoint that returns status, environment, timestamp, and API version.

Headers

string
required
Bearer token authentication.
string
API version to use. Defaults to 2024-09-01 if not specified.

Response

string
Always ok for successful health checks.
string
Environment indicator: test for testmode keys, prod for production keys.
string
Current ISO 8601 timestamp.
string
The API version being used.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-API-Version
enum<string>
Available options:
2026-11-01

Response

Successful health check response

status
enum<string>
Available options:
ok
env
enum<string>
Available options:
test,
prod
timestamp
string<date-time>
api_version
string