☰ Menu · Overview
Loyaltyfy API
Connect a cash register, a booking system, a kiosk or your own app to Loyaltyfy loyalty cards, QR menus and table orders.
Loyaltyfy runs loyalty programs and digital menus for restaurants, cafes, shops and salons. Guests keep their card in Apple Wallet or Google Wallet; the venue sees every visit and every check. The API lets the systems the venue already uses take part: the till adds cashback on a closed check, a door kiosk stamps a visit, a booking system rewards an attended appointment, the POS picks up orders guests send from the QR menu.
It is a plain REST API over HTTPS. Requests and responses are JSON, amounts are integers in minor units (12500 is 125.00), times are ISO 8601. Each venue has its own keys, so one integration works for any number of venues: you store a key per venue and send it with every call.
Pick your starting point
Find a guest by card, phone or barcode, apply a check, redeem cashback, void a refund, issue cards with your own numbers.
Keep prices and the stop list in sync, receive orders from the table, run loyalty at the cafe till.
Turn any scan into a member and a list of allowed actions. Sign guests up on a tablet. Stamp visits without a check.
Reward attended appointments, sync clients, see how the built-in Altegio connector does it.
Base URL
All endpoints live under https://loyaltyfy.io/api/v1. The paths in this documentation start at /v1, so GET /v1/members means GET https://loyaltyfy.io/api/v1/members.
Main objects
| Object | What it is |
|---|---|
| member | A guest enrolled in the venue's loyalty program, with one wallet card. Found by card number, barcode, phone or id. |
| transaction | One closed check sent by a till. Earns cashback or stamps, can redeem cashback, can be voided. |
| visit | A check-in without a check, from a kiosk, a scanner or a booking system. |
| menu, menu_item | The venue's QR menu: categories, dishes, modifiers, prices, stop list. |
| order | A cart a guest sent from the QR menu at a table. The POS accepts it and moves it through statuses. |
| event | Something that happened (a check applied, an order placed), delivered to your webhook endpoint. |
Next
Make your first call in the Quickstart. It takes about five minutes with a test key.