Келулер

Штамп және келу бағдарламаларына арналған чексіз келу.

POST/v1/visits

Құқық: transactions:write немесе devices:write

Келуді тіркеп, бағдарламаның әр келуге беретін сыйақысын береді. object: "visit" және amount: 0 мәндері бар, транзакцияға ұқсас объект қайтарады. Қайталанған external_id сақталған келуді 200 кодымен қайтарады. Кэшбэк бағдарламалары 400 visit_not_supported қайтарады.

external_idstring, міндетті: Осы келудің сіздегі id-і. Транзакциялармен ортақ аттар кеңістігінде.
memberstring, міндетті: Қатысушыны анықтайтын кез келген мән, соның ішінде сканерден келген өңделмеген мән.
device_idstring: Келуді қай құрылғы тіркегені. Есептерде касса ретінде көрсетіледі.
visited_atdatetime: Келу уақыты. Әдепкі: қазіргі уақыт.

Параметр	Түрі	Сипаттама
external_id	string, міндетті	Осы келудің сіздегі id-і. Транзакциялармен ортақ аттар кеңістігінде.
member	string, міндетті	Қатысушыны анықтайтын кез келген мән, соның ішінде сканерден келген өңделмеген мән.
device_id	string	Келуді қай құрылғы тіркегені. Есептерде касса ретінде көрсетіледі.
visited_at	datetime	Келу уақыты. Әдепкі: қазіргі уақыт.

curl

curl https://loyaltyfy.io/api/v1/visits \
  -H "Authorization: Bearer sk_test_..." \
  -H "Content-Type: application/json" \
  -d '{
    "external_id": "door-1-2026-10-06-0042",
    "member": "4285324286429",
    "device_id": "door-1"
  }'

Жауап · 201

{
  "object": "visit",
  "id": "feb2ad75-ac7b-4bb6-8b64-192323b7f6ea",
  "external_id": "door-1-2026-10-06-0042",
  "status": "completed",
  "amount": 0,
  "stamps_earned": 1,
  "reward_unlocked": false,
  "register_id": "door-1",
  "livemode": false,
  "created_at": "2026-10-06T18:17:28.209+00:00",
  "member": {
    "object": "member",
    "card_number": "4285324286429",
    "stamps": { "current": 2, "required": 5, "rewards_available": 0 },
    ...
  },
  ...
}

Келуді чек сияқты болдырмауға болады: POST /v1/transactions/{external_id}/void.