Overview
Inspect connection health, create setup handoffs, control checkout availability, and manage custom payment methods.
Payment-method APIs accept an API key with the payment-method ability or OAuth with payments:read for reads and payments:write for mutations. Matching store permission is required for the store selected by X-STORE. API keys can also use the broader store ability with its matching permission.
Two fields answer different questions: status tells you whether a provider is disconnected, configured, or enabled; health_status tells you whether the connection is disconnected, healthy, or needs attention. Responses also describe the inputs setup needs and any setup errors. They never return API keys, OAuth tokens, wallet addresses, webhook secrets, or provider credentials.
For providers connected through OAuth, open the returned connect_url to authorize the connection, then check status_url for progress. You cannot enable a disconnected method; the API returns a validation error.
NMI, Mercado Pago, Razorpay, Mollie, LiFi, and Bitcart-backed crypto methods support direct configuration through the configuration endpoint. Secret inputs are marked writeOnly in OpenAPI. Provider credentials are validated with the same setup services used by the dashboard; crypto wallet addresses and keys are sent to the existing Bitcart wallet setup flow.
Custom payment methods are separate store-scoped resources. Redirect destinations use the same dashboard validation rules, and clients cannot submit arbitrary storage paths for icons.