Loyalty Platform developer docs

An independent, multi-tenant, POS-agnostic loyalty platform and restaurant/retail CRM. This site documents the public /v1 HTTP API: authentication, the ledger (earn/redeem), the generic POS-ingestion connector, and outbound webhook verification.

Start here

• Quickstart — sign up, create an organization, mint an API key, record a sale, and redeem a reward, with real curl requests end to end.
• Generic connector — the universal POS-ingestion payload shape, delivery dedup semantics, and async processing states.
• Webhook verification — the outbound signature scheme, replay tolerance, retry schedule, and a verification sample in plain Node.
• API reference — every /v1 operation, request/response schema, and error code, rendered from the committed OpenAPI document.

Conventions worth knowing before you start

• Money is minor units (integer cents) + an ISO-4217 currency code; points are integers. No floats, anywhere.
• Every error response is the same envelope: {code, message, details?, trace_id}.
• Mutating money routes require an Idempotency-Key header — same key + same body replays the stored response for 48h; same key + a different body is a 409 IDEMPOTENCY_CONFLICT.
• Organization-owned API keys are prefixed lp_live_ / lp_test_ and carry their own permission grants (e.g. transactions:write) — see the quickstart for how to mint one.