Skip to main content
Cresora Commerce

Health

Service health and liveness probes — for partner integration monitoring and uptime dashboards. Unauthenticated endpoint.

🔬Planned operations — published for review, not callable
This reference includes operations marked x-cresora-status: planned in the canonical contract: they have no route on any host and return 404 (or 501 for reserved discriminator variants) until released. There is no separate preview stream, no feature flag to enable one, and no enrollment — the badge on each operation tells you whether it is served. See the stable /api/v1 reference for what you can call today. Like the stable API, these operations are server-to-server: there is no interactive console here. Download the preview spec (YAML).

Health probe

GET/health

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

curl -X GET "https://example.com/health"
{  "status": "healthy",  "version": "1.0.0",  "timestamp": "2026-04-24T09:30:15Z",  "dependencies": {    "database": "healthy",    "cache": "healthy",    "gateway": "healthy"  }}

Notifications

Partner-portal notification feed — the bell dropdown and `/notifications` page. Read state is tracked per portal user: one teammate marking a notification as read does not clear it for the rest of the team. Primarily a portal-session surface; API keys can read it with the `notification:read` / `notification:update` scopes.

Custom Fields

Per-merchant custom-field definitions — up to 10 fields per merchant (a Cresora product cap; the gateway documents none). Definitions are delivered onto the merchant's gateway record and the field VALUES ride transaction creates (Sale / Authorization / ACH debit + recurring contract create) and hosted-page checkouts. Partner self-service (`custom_fields:config:read` / `custom_fields:config:write`); the merchant is scoped from your API key, never a path/body param.