mayarin
Concepts

API versioning

Mayarin uses a URL major version and a date revision header.

The public merchant API lives under /v1. A future breaking API is a new URL such as /v2; clients opt in and /v1 remains available during migration.

The Mayarin-Version header pins additive behavior within /v1. The TypeScript SDK sends its supported revision automatically.

Buyer-facing URLs are intentionally unversioned because shared links and printed QR codes must remain stable:

  • /checkout/:id and its buyer sub-routes;
  • /invoices/:id/view;
  • /health.

Execution paths

Three ways value moves — atomic contract execution, deposit matching, and a signed authorization from an agent. Chosen per payer, not per deployment.

Raw API quickstart

Create and inspect a payment using HTTP without the SDK.