LLoyaltyfyAPI v1
UK
☰ Меню · Учасники
Довідник API

Учасники

Гість, зареєстрований у програмі лояльності закладу, з однією карткою в гаманці.

Об’єкт учасника

iduuid
Наш id гостя.
card_numberstring
Номер на картці. Наш (13 цифр) або той, який задали ви.
serialuuid
Серійний номер картки в гаманці.
first_name, last_name, phone, email, birthday, languagestring
Профіль. phone у міжнародному форматі (+37366791102), birthday у форматі YYYY-MM-DD.
marketing_consentboolean
Гість погодився отримувати рекламні повідомлення.
programobject
id, name, mechanic і формат barcode програми учасника.
stampsobject або null
current, required, rewards_available. Null для програм без штампів.
cashbackobject або null
balance (у дрібних одиницях), held в активних резервах, available для списання, currency, earn_rate (відсоток), level, level_basis, levels, next_level, redeem_max_percent, min_amount, expires_at. Null для програм без кешбеку. Докладніше в розділі рівні кешбеку.
discountobject або null
percent, tier, next_at_visits для програм зі знижкою за візити.
visits, total_spentinteger
Кількість візитів і витрачена сума за весь час.
walletobject або null
apple_url, google_url, card_url: підписані посилання для додавання картки. Повертаються під час створення та з ?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
Право: members:write або devices:write

Реєструє гостя та випускає картку для гаманця. Якщо учасник із таким телефоном уже існує, повертає його з 200 замість 201. Передавайте Idempotency-Key.

phonestring, обов’язковий
Міжнародний формат. Місцеві формати країни закладу теж приймаються.
first_namestring, обов’язковий
До 80 символів.
consenttrue, обов’язковий
Підтверджує, що гість погодився на обробку своїх даних. Запити без нього відхиляються.
last_name, email, birthday, languagestring
Необов’язкові поля профілю. language (en, ro, ru, es...) використовується для картки та повідомлень.
card_numberstring
Від 4 до 32 літер, цифр або дефісів. Використовуйте номер картки з каси. Унікальний у межах закладу.
programstring
slug програми з GET /v1/account. За замовчуванням основна програма закладу.
marketing_consentboolean
Гість погодився отримувати рекламні повідомлення. За замовчуванням 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
  }'
Деякі програми дають вітальний штамп під час реєстрації, тож новий учасник може починати з stamps.current: 1.
GET/v1/members/{member}
Право: members:read

{member} може бути номером картки, відсканованим значенням штрихкоду, серійним номером картки в гаманці, id учасника або телефоном (закодованим для URL). Додайте ?expand=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}
Право: members:write

Оновлює поля профілю або прив’язує номер картки з каси. Передавайте лише поля, які змінюєте: 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
Право: members:read

Повертає список учасників, від найновіших. З пагінацією. З ?phone= або ?card_number= повертає список із нуля чи одного учасника.

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

Усі зміни на картці, від найновіших, незалежно від джерела: API, касовий застосунок закладу, POS, конектор системи запису. type набуває значень accrual, cashback, cashback_earn, gift, reward_redeemed, reversal, і з часом можуть з’явитися нові. source набуває значень api, pos, cashier або system. З пагінацією.

Відповідь · 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
Право: transactions:write або devices:write

Видає учаснику одну отриману нагороду за штампи та зменшує stamps.rewards_available. Якщо нагород немає, запит відхиляється з no_reward_available. Передавайте 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
Право: members:adjust

Нараховує (додатний amount) або знімає (від’ємний) кешбек із причиною в reason довжиною від 3 до 300 символів. Працює, лише якщо заклад дозволив коригування, і в межах його ліміту на одне коригування. Повтор external_id повертає збережене коригування. Надсилає 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
Питання щодо інтеграції: api@loyaltyfy.io. Відповідаємо протягом одного робочого дня.