☰ Menü · Üyeler
API referansı

Üyeler

İşletmenin sadakat programına kayıtlı, tek bir Wallet kartı olan misafir.

Üye nesnesi

iduuid
Misafirin bizdeki id'si.
card_numberstring
Karttaki numara. Bizim atadığımız (13 hane) veya sizin belirlediğiniz.
serialuuid
Wallet kartının seri numarası.
first_name, last_name, phone, email, birthday, languagestring
Profil. phone uluslararası formattadır (+37366791102), birthday ise YYYY-MM-DD biçimindedir.
marketing_consentboolean
Misafir tanıtım mesajları almayı kabul etti.
programnesne
Üyenin programının id, name, mechanic ve barcode biçimi.
stampsnesne veya null
current, required, rewards_available. Damgasız programlarda null.
cashbacknesne veya null
balance (en küçük para birimi), aktif rezervasyonlarda tutulan held, harcanabilir available, currency, earn_rate (yüzde), level, level_basis, levels, next_level, redeem_max_percent, min_amount, expires_at. Cashback olmayan programlarda null. Bkz. cashback seviyeleri.
discountnesne veya null
Ziyarete dayalı indirim programları için percent, tier, next_at_visits.
visits, total_spentinteger
Toplam ziyaret sayısı ve harcanan toplam tutar.
walletnesne veya null
apple_url, google_url, card_url: kartı eklemek için imzalı bağlantılar. Oluşturma yanıtında ve ?expand=wallet ile döner.
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
İzin: members:write veya devices:write

Misafiri kaydeder ve Wallet kartını çıkarır. Bu telefonla kayıtlı bir üye zaten varsa 201 yerine 200 ile o üyeyi döndürür. Idempotency-Key gönderin.

phonestring, zorunlu
Uluslararası format. İşletmenin bulunduğu ülkenin yerel formatları da kabul edilir.
first_namestring, zorunlu
En fazla 80 karakter.
consenttrue, zorunlu
Misafirin kişisel verilerinin işlenmesine onay verdiğini doğrular. Bu alan olmadan gelen istekler reddedilir.
last_name, email, birthday, languagestring
İsteğe bağlı profil alanları. language (en, ro, ru, es...) kart ve mesajlar için kullanılır.
card_numberstring
4 ile 32 arası harf, rakam veya tire. Kasanın kendi kart numarasını kullanın. İşletme bazında benzersizdir.
programstring
GET /v1/account yanıtındaki program slug değeri. Varsayılan: işletmenin ana programı.
marketing_consentboolean
Misafir tanıtım mesajlarını kabul etti. Varsayılan 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
  }'
Bazı programlar kayıtta hoş geldin damgası verir, bu yüzden yeni bir üye stamps.current: 1 ile başlayabilir.
GET/v1/members/{member}
İzin: members:read

{member} bir kart numarası, okunan barkod değeri, Wallet seri numarası, üye id'si veya telefon (URL-encode edilmiş) olabilir. Güncel Wallet'a ekleme bağlantıları için ?expand=wallet ekleyin.

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}
İzin: members:write

Profil alanlarını günceller veya kasadan gelen kart numarasını atar. Yalnızca değiştirdiğiniz alanları gönderin: 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
İzin: members:read

Üyeleri en yeniden eskiye listeler. Sayfalıdır. ?phone= veya ?card_number= ile sıfır ya da bir üyelik bir liste döndürür.

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

Karttaki tüm değişiklikler, en yeniden eskiye, kaynağı ne olursa olsun: API, işletmenin kasiyer uygulaması, POS, randevu entegrasyonu. type değeri accrual, cashback, cashback_earn, gift, reward_redeemed, reversal olabilir ve yeni değerler eklenebilir. source değeri api, pos, cashier veya system olur. Sayfalıdır.

Yanıt · 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
İzin: transactions:write veya devices:write

Üyeye kazandığı bir damga ödülünü verir ve stamps.rewards_available değerini azaltır. Ödül yoksa no_reward_available ile reddedilir. Idempotency-Key gönderin.

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
İzin: members:adjust

3 ile 300 karakter arasında bir reason ile cashback ekler (pozitif amount) veya düşer (negatif). Yalnızca işletme düzeltmelere izin veriyorsa ve düzeltme başına limitine kadar çalışır. Aynı external_id tekrar gönderilirse kayıtlı düzeltme döner. balance.adjusted gönderir.

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
Entegrasyonla ilgili sorularınız için: api@loyaltyfy.io. Bir iş günü içinde yanıt veriyoruz.