Skip to content

API reference

This reference is built from Maxana Public API version

1.0.0

: Merchant-facing integration endpoints.

The curated contract contains the merchant-facing operations, their security alternatives, request and response schemas, and response status definitions. Use the operation’s declared security block instead of assuming that every endpoint accepts the same credential.

  • Operations retains every summary, description, security alternative, request schema, response schema, and validated JSON sample.
  • Schemas lists the complete reusable schema registry and required properties.

Task-oriented guides provide the operating context:

The rendered operation and schema reference comes from this same curated OpenAPI fixture; no deployed API or handwritten copy is its source.

This is the curated merchant-facing Public API, not an inventory of dashboard, admin, or internal operations. The reference describes request and response contracts; use the tutorials for sequencing, readiness checks, and operational boundaries.