Участники

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

Объект участника

iduuid: Наш id гостя.
card_numberstring: Номер на карте. Наш (13 цифр) или заданный вами.
serialuuid: Серийный номер карты в Wallet.
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.

Параметр	Тип	Описание
id	uuid	Наш id гостя.
card_number	string	Номер на карте. Наш (13 цифр) или заданный вами.
serial	uuid	Серийный номер карты в Wallet.
first_name, last_name, phone, email, birthday, language	string	Профиль. `phone` в международном формате (`+37366791102`), `birthday` в формате `YYYY-MM-DD`.
marketing_consent	boolean	Гость согласился получать рекламные сообщения.
program	object	`id`, `name`, `mechanic` и формат `barcode` программы участника.
stamps	object или null	`current`, `required`, `rewards_available`. Null для программ без штампов.
cashback	object или null	`balance` (в минимальных единицах), `held` в активных резервах, `available` к списанию, `currency`, `earn_rate` (процент), `level`, `level_basis`, `levels`, `next_level`, `redeem_max_percent`, `min_amount`, `expires_at`. Null для программ без кэшбэка. Подробнее в разделе уровни кэшбэка.
discount	object или null	`percent`, `tier`, `next_at_visits` для программ со скидкой за визиты.
visits, total_spent	integer	Число визитов и потраченная сумма за всё время.
wallet	object или 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

Регистрирует гостя и выпускает карту для Wallet. Если участник с таким телефоном уже есть, возвращает его с 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.

Параметр	Тип	Описание
phone	string, обязательный	Международный формат. Принимаются и местные форматы страны заведения.
first_name	string, обязательный	До 80 символов.
consent	true, обязательный	Подтверждает согласие гостя на обработку персональных данных. Запросы без него отклоняются.
last_name, email, birthday, language	string	Необязательные поля профиля. `language` (`en`, `ro`, `ru`, `es`...) используется для карты и сообщений.
card_number	string	От 4 до 32 букв, цифр или дефисов. Используйте собственный номер карты кассы. Уникален в пределах заведения.
program	string	`slug` программы из `GET /v1/account`. По умолчанию основная программа заведения.
marketing_consent	boolean	Гость согласился получать рекламные сообщения. По умолчанию 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} это номер карты, отсканированное значение штрихкода, серийный номер карты в Wallet, 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