Members

A guest enrolled in the venue's loyalty program, with one wallet card.

The member object

iduuid: Our id of the guest.
card_numberstring: The number on the card. Ours (13 digits) or the one you set.
serialuuid: The wallet pass serial.
first_name, last_name, phone, email, birthday, languagestring: Profile. phone is international (+37366791102), birthday is YYYY-MM-DD.
marketing_consentboolean: The guest agreed to receive promotional messages.
programobject: id, name, mechanic and barcode format of the member's program.
stampsobject or null: current, required, rewards_available. Null for programs without stamps.
cashbackobject or null: balance (minor units), held by active holds, available to spend, currency, earn_rate (percent), level, level_basis, levels, next_level, redeem_max_percent, min_amount, expires_at. Null for programs without cashback. See cashback levels.
discountobject or null: percent, tier, next_at_visits for visit-based discount programs.
visits, total_spentinteger: Lifetime visits and amount spent.
walletobject or null: apple_url, google_url, card_url: signed links to add the card. Returned on create and with ?expand=wallet.

Parameter	Type	Description
id	uuid	Our id of the guest.
card_number	string	The number on the card. Ours (13 digits) or the one you set.
serial	uuid	The wallet pass serial.
first_name, last_name, phone, email, birthday, language	string	Profile. `phone` is international (`+37366791102`), `birthday` is `YYYY-MM-DD`.
marketing_consent	boolean	The guest agreed to receive promotional messages.
program	object	`id`, `name`, `mechanic` and `barcode` format of the member's program.
stamps	object or null	`current`, `required`, `rewards_available`. Null for programs without stamps.
cashback	object or null	`balance` (minor units), `held` by active holds, `available` to spend, `currency`, `earn_rate` (percent), `level`, `level_basis`, `levels`, `next_level`, `redeem_max_percent`, `min_amount`, `expires_at`. Null for programs without cashback. See cashback levels.
discount	object or null	`percent`, `tier`, `next_at_visits` for visit-based discount programs.
visits, total_spent	integer	Lifetime visits and amount spent.
wallet	object or null	`apple_url`, `google_url`, `card_url`: signed links to add the card. Returned on create and with `?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

Scope: members:write or devices:write

Enrols a guest and issues the wallet card. If a member with this phone already exists, returns that member with 200 instead of 201. Send an Idempotency-Key.

phonestring, required: International format. Local formats of the venue's country are accepted too.
first_namestring, required: Up to 80 characters.
consenttrue, required: Confirms the guest agreed to the processing of their data. Requests without it are refused.
last_name, email, birthday, languagestring: Optional profile fields. language (en, ro, ru, es...) is used for the card and messages.
card_numberstring: 4 to 32 letters, digits or dashes. Use the till's own card number. Unique per venue.
programstring: Program slug from GET /v1/account. Default: the venue's main program.
marketing_consentboolean: The guest agreed to promotional messages. Default false.

Parameter	Type	Description
phone	string, required	International format. Local formats of the venue's country are accepted too.
first_name	string, required	Up to 80 characters.
consent	true, required	Confirms the guest agreed to the processing of their data. Requests without it are refused.
last_name, email, birthday, language	string	Optional profile fields. `language` (`en`, `ro`, `ru`, `es`...) is used for the card and messages.
card_number	string	4 to 32 letters, digits or dashes. Use the till's own card number. Unique per venue.
program	string	Program `slug` from `GET /v1/account`. Default: the venue's main program.
marketing_consent	boolean	The guest agreed to promotional messages. Default 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
  }'

Some programs give a welcome stamp on sign-up, so a new member can start with stamps.current: 1.

GET/v1/members/{member}

Scope: members:read

{member} is a card number, a scanned barcode value, a wallet serial, a member id or a phone (URL-encoded). Add ?expand=wallet for fresh add-to-wallet links.

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}

Scope: members:write

Updates profile fields or attaches a card number from the till. Send only the fields you change: 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

Scope: members:read

Lists members, newest first. Paginated. With ?phone= or ?card_number= it returns a list of zero or one member instead.

curl

curl "https://loyaltyfy.io/api/v1/members?limit=50" \
  -H "Authorization: Bearer sk_test_..."

GET/v1/members/{member}/history

Scope: members:read

Every change on the card, newest first, whatever caused it: the API, the venue's cashier app, a POS, a booking connector. type is accrual, cashback, cashback_earn, gift, reward_redeemed, reversal and may get new values. source is api, pos, cashier or system. Paginated.

Response · 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

Scope: transactions:write or devices:write

Gives the member one earned stamp reward and decreases stamps.rewards_available. Refused with no_reward_available when there is none. Send an 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

Scope: members:adjust

Adds (positive amount) or takes away (negative) cashback with a reason of 3 to 300 characters. Works only when the venue allows adjustments, up to its limit per adjustment. Repeating an external_id returns the stored adjustment. Sends 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