Skip to main content
GET
Reports whether the conversion feature is switched on platform-wide. When it is off, /quote, POST /, /best-route and /cheaper-targets reject with CONVERSIONS_DISABLED (403); the history/detail reads keep working. This endpoint takes no parameters — the flag is platform-wide, not tied to your account.

Authorization

Dual auth — a secret API key with the conversions:read scope, or a dashboard JWT with the conversions:view permission. Dashboard sessions must belong to a merchant_admin, merchant_member or super_admin role; API-key callers are gated by scope only. See the Authentication guide. Rate limit: the global default.
Check this once when your conversion UI loads and hide the quote/execute actions while it returns false — /quote and POST / would reject with CONVERSIONS_DISABLED (403) anyway, so gating up front saves a failed round-trip.

Response fields

boolean
true when the conversion feature is switched on platform-wide; false when it is disabled.

Errors

No endpoint-specific error codes are documented for this route — it keeps answering even while conversions are disabled. See the Conversions Overview for the shared error envelope.

See also

  • Get liquidity: which target currencies can currently be backed once the feature is on.
  • Get a quote: the first call of every conversion flow.
  • Conversions Overview: execution modes, fee floors and the shared error envelope.