Versioning

Changes we make to v1 without notice: new endpoints, new optional request fields, new fields in responses, new event types, new values in fields documented as open lists (like mechanic or history_entry.type), new error codes. Write your code so that unknown fields and values are ignored, not rejected.

Anything that could break a working integration (removing or renaming a field, changing a type, making an optional field required) goes into a new version. We announce it at least six months ahead, and v1 keeps working during that time.

Every change is listed in the Changelog.

The earlier POS API

Integrations built on https://loyaltyfy.io/api/pos/v1 keep working. New integrations should use /api/v1: it accepts the same card_number and gross_amount fields, works for every program type, not only cashback, and adds webhooks, idempotency keys and scopes.