Skip to main content
Cresora Commerce

Health

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

ℹServer-to-server API
Run the examples on this page from your backend against the sandbox host. The API sends no CORS headers, so browser JavaScript cannot read its responses, and an API key must never be exposed in a browser. There is no interactive console here. Generating a client instead? Download the OpenAPI 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"  }}

Config

Partner configuration — webhook URL, IP allowlist, HPP defaults, rate-limit tier, AVS decline policy. Read your own config; write via `PUT /config/partners/{partnerId}`. Rate-limit tier and AVS decline policy are Cresora-managed (admin-only); webhook URL, HPP settings, and IP allowlist are partner self-service.

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.