Endpoints

Payment endpoints require authentication with your X-Public-Key and X-Secret-Key headers. Health endpoints are public and need no API keys.

Payments

MethodEndpointDescription
GET/api/v1/auth/testTest API keys
POST/api/v1/payments/createCreate payment
GET/api/v1/payments/:idGet status
DELETE/api/v1/payments/:idCancel payment

Health

No authentication required.

MethodEndpointDescription
GET/healthFull health check, including the database. Returns 200, or 503 when the database check fails.
GET/health/liveLiveness check. Returns 200 with {"status": "ok"}.
GET/health/readyReadiness check. Returns 200 with {"status": "ready"}, or 503 with {"status": "not_ready"} when the database is unreachable.

GET /health response

json
{
"status": "ok",
"timestamp": "2026-09-16T14:32:07.512Z",
"version": "1.0.0",
"checks": {
"database": {
"status": "ok",
"latencyMs": 3
}
}
}

When the database check fails, /health returns HTTP 503 with status set to unhealthy:

json
{
"status": "unhealthy",
"timestamp": "2026-09-16T14:32:07.512Z",
"version": "1.0.0",
"checks": {
"database": {
"status": "unhealthy",
"error": "Database connection failed"
}
}
}
↑ ↓ navigate↵ select