LLoyaltyfyAPI v1
RO
☰ Meniu · Membri
Referință API

Membri

Un oaspete înscris în programul de fidelitate al localului, cu un card în wallet.

Obiectul member

iduuid
Id-ul nostru al oaspetelui.
card_numberstring
Numărul de pe card. Al nostru (13 cifre) sau cel setat de tine.
serialuuid
Seria cardului din wallet.
first_name, last_name, phone, email, birthday, languagestring
Profilul. phone este în format internațional (+37366791102), birthday este YYYY-MM-DD.
marketing_consentboolean
Oaspetele a acceptat să primească mesaje promoționale.
programobject
id, name, mechanic și formatul barcode al programului membrului.
stampsobject sau null
current, required, rewards_available. Null pentru programele fără ștampile.
cashbackobject sau null
balance (subunități), held în rezervările active, available de folosit, currency, earn_rate (procent), level, level_basis, levels, next_level, redeem_max_percent, min_amount, expires_at. Null pentru programele fără cashback. Vezi nivelurile de cashback.
discountobject sau null
percent, tier, next_at_visits pentru programele cu reducere în funcție de vizite.
visits, total_spentinteger
Totalul vizitelor și al sumei cheltuite.
walletobject sau null
apple_url, google_url, card_url: linkuri semnate pentru adăugarea cardului. Întoarse la creare și cu ?expand=wallet.
JSON
{
  "object": "member",
  "id": "6dacfe0a-2500-44c6-a37c-05c660b093b4",
  "card_number": "2000111703779",
  "serial": "b90273b1-10c9-46eb-ba74-8fef48266b5d",
  "first_name": "Ion",
  "last_name": "Popescu",
  "phone": "+37366791102",
  "email": null,
  "birthday": null,
  "language": "ro",
  "marketing_consent": false,
  "program": {
    "id": "06af6eba-eaf5-4662-8a5e-2b6b52c65314",
    "name": "Sandbox Cashback",
    "mechanic": "cashback",
    "barcode": "card_code128"
  },
  "stamps": null,
  "cashback": {
    "balance": 1250,
    "currency": "MDL",
    "earn_rate": 5,
    "level": null,
    "redeem_max_percent": 30,
    "min_amount": 10000,
    "expires_at": "2027-01-04T18:17:17.721+00:00"
  },
  "discount": null,
  "visits": 1,
  "total_spent": 25000,
  "wallet": {
    "apple_url": "https://loyaltyfy.io/api/wallet/issue/3832466f-...?platform=apple&t=...",
    "google_url": "https://loyaltyfy.io/api/wallet/issue/3832466f-...?platform=google&t=...",
    "card_url": "https://loyaltyfy.io/wallet/3832466f-...?t=..."
  },
  "created_at": "2026-10-06T18:17:15.594+00:00"
}
POST/v1/members
Permisiune: members:write sau devices:write

Înscrie un oaspete și emite cardul în wallet. Dacă există deja un membru cu acest telefon, îl întoarce cu 200 în loc de 201. Trimite un Idempotency-Key.

phonestring, obligatoriu
Format internațional. Sunt acceptate și formatele locale ale țării localului.
first_namestring, obligatoriu
Până la 80 de caractere.
consenttrue, obligatoriu
Confirmă că oaspetele a fost de acord cu prelucrarea datelor sale. Cererile fără acest câmp sunt refuzate.
last_name, email, birthday, languagestring
Câmpuri opționale de profil. language (en, ro, ru, es...) este folosit pentru card și mesaje.
card_numberstring
Între 4 și 32 de litere, cifre sau cratime. Folosește numărul de card din casă. Unic per local.
programstring
slug-ul programului din GET /v1/account. Implicit: programul principal al localului.
marketing_consentboolean
Oaspetele a acceptat mesajele promoționale. Implicit false.
curl
curl https://loyaltyfy.io/api/v1/members \
  -H "Authorization: Bearer sk_test_..." \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: 7d1b2c4e-enrol-000123" \
  -d '{
    "phone": "+37366791102",
    "first_name": "Ion",
    "last_name": "Popescu",
    "card_number": "2000111703779",
    "language": "ro",
    "consent": true
  }'
Unele programe oferă o ștampilă de bun venit la înscriere, așa că un membru nou poate începe cu stamps.current: 1.
GET/v1/members/{member}
Permisiune: members:read

{member} este un număr de card, valoarea scanată a unui cod de bare, seria din wallet, id-ul membrului sau un telefon (codificat pentru URL). Adaugă ?expand=wallet pentru linkuri noi de adăugare în wallet.

curl
# by the number on the card (or the barcode the scanner read)
curl https://loyaltyfy.io/api/v1/members/2000111703779 \
  -H "Authorization: Bearer sk_test_..."

# by phone, with fresh add-to-wallet links
curl "https://loyaltyfy.io/api/v1/members/%2B37366791102?expand=wallet" \
  -H "Authorization: Bearer sk_test_..."
PATCH/v1/members/{member}
Permisiune: members:write

Actualizează câmpurile profilului sau atașează un număr de card din casă. Trimite doar câmpurile pe care le schimbi: phone, first_name, last_name, email, birthday, language, card_number, marketing_consent.

curl
curl -X PATCH https://loyaltyfy.io/api/v1/members/%2B37366791102 \
  -H "Authorization: Bearer sk_test_..." \
  -H "Content-Type: application/json" \
  -d '{ "card_number": "2000111703779", "birthday": "1990-04-12" }'
GET/v1/members
Permisiune: members:read

Listează membrii, cei mai noi primii. Cu paginare. Cu ?phone= sau ?card_number= întoarce în schimb o listă cu zero sau un membru.

curl
curl "https://loyaltyfy.io/api/v1/members?limit=50" \
  -H "Authorization: Bearer sk_test_..."
GET/v1/members/{member}/history
Permisiune: members:read

Fiecare modificare de pe card, cele mai noi primele, indiferent de sursă: API-ul, aplicația de casă a localului, un POS, un conector de programări. type este accrual, cashback, cashback_earn, gift, reward_redeemed, reversal și poate primi valori noi. source este api, pos, cashier sau system. Cu paginare.

Răspuns · 200
{
  "object": "list",
  "url": "/v1/members/2000111703779/history",
  "has_more": false,
  "data": [
    {
      "object": "history_entry",
      "id": "937310bd-cb77-49a0-a4ff-855399f5cde3",
      "type": "cashback_earn",
      "stamps_delta": 0,
      "cashback_delta": 1250,
      "amount": 25000,
      "reward_unlocked": false,
      "source": "system",
      "external_id": null,
      "created_at": "2026-10-06T18:17:17.790+00:00"
    }
  ]
}
POST/v1/members/{member}/rewards/redeem
Permisiune: transactions:write sau devices:write

Acordă membrului o recompensă câștigată pentru ștampile și scade stamps.rewards_available. Refuzat cu no_reward_available dacă nu există niciuna. Trimite un Idempotency-Key.

curl
curl -X POST https://loyaltyfy.io/api/v1/members/4285324286429/rewards/redeem \
  -H "Authorization: Bearer sk_test_..." \
  -H "Idempotency-Key: reward-4285324286429-0001"
POST/v1/members/{member}/adjustments
Permisiune: members:adjust

Adaugă (amount pozitiv) sau scade (negativ) cashback, cu un reason între 3 și 300 de caractere. Funcționează doar dacă localul permite corecțiile, până la limita stabilită pentru o corecție. Un external_id repetat întoarce corecția salvată. Trimite balance.adjusted.

curl
curl https://loyaltyfy.io/api/v1/members/2000111703779/adjustments \
  -H "Authorization: Bearer sk_test_..." \
  -H "Content-Type: application/json" \
  -d '{ "external_id": "ADJ-2026-0009", "amount": 2000, "reason": "Goodwill after a complaint" }'

# a negative amount takes cashback away
Întrebări despre integrare: api@loyaltyfy.io. Răspundem în cel mult o zi lucrătoare.