Skip to main content
GET /admin/psp/health returns the active probe state, circuit-breaker status, and probe-enabled flag for every PSP the platform currently supports. Probes are OFF by default per PSP (each has its own env flag, e.g. STRIPE_PROBE_ENABLED, BONUM_PROBE_ENABLED). When a probe is OFF, the response still returns the breaker state (which is always tracked) and probeEnabled: false so the caller knows the probe metrics are stale.
This endpoint requires:
  • JWT with role = SUPER_ADMIN
  • IpAllowlistGuard — caller IP must be in the operator allowlist
  • GeoBlockGuard — caller geo must be permitted
Calls that miss any of the three return 403.

GET /admin/psp/health

Authentication

Query parameters

None.

Response — 200 OK

Field reference

Error responses

Example

When to use

Probes are off by default for low-traffic PSPs (Paymob, Coinbase, PayPal) because the synthetic call incurs vendor-side cost or burns sandbox quota. Enable only when the PSP is in active use for the operating region.