Резервтер

Сканерлегенде бөлініп қойылатын және жабылған чек растайтын кэшбэк.

Резерв объектісі

iduuid: Оны чекпен бірге hold_id ретінде жіберіңіз.
memberstring: Карта нөмірі.
amountinteger: Бөлініп қойылған кэшбэк, кіші бірлікте.
statusstring: active, captured, released немесе expired.
captured_bystring немесе null: Резервті пайдаланған чектің external_id мәні.
expires_atdatetime: Пайдаланылмаған резерв өздігінен босатылатын уақыт.

Параметр	Түрі	Сипаттама
id	uuid	Оны чекпен бірге `hold_id` ретінде жіберіңіз.
member	string	Карта нөмірі.
amount	integer	Бөлініп қойылған кэшбэк, кіші бірлікте.
status	string	`active`, `captured`, `released` немесе `expired`.
captured_by	string немесе null	Резервті пайдаланған чектің `external_id` мәні.
expires_at	datetime	Пайдаланылмаған резерв өздігінен босатылатын уақыт.

POST/v1/holds

Құқық: transactions:write

Кэшбэкті бөліп қояды. Чектегідей шектер қолданылады. Көбірек сұралса, 402 insufficient_balance және limited_by арқылы қабылданбайды. Idempotency-Key жіберіңіз.

memberstring, міндетті: Карта нөмірі, сканерленген мән, сериялық нөмір, қатысушы id-і немесе телефон.
amountinteger, міндетті: Бөлініп қойылатын кэшбэк.
check_amountinteger, міндетті: Чек сомасы, бағдарламадағы үлес пен санат ережелері үшін.
register_idstring: Сіздегі касса id-і.
line_itemsмассив: Санат ережелері үшін.

Параметр	Түрі	Сипаттама
member	string, міндетті	Карта нөмірі, сканерленген мән, сериялық нөмір, қатысушы id-і немесе телефон.
amount	integer, міндетті	Бөлініп қойылатын кэшбэк.
check_amount	integer, міндетті	Чек сомасы, бағдарламадағы үлес пен санат ережелері үшін.
register_id	string	Сіздегі касса id-і.
line_items	массив	Санат ережелері үшін.

curl

curl https://loyaltyfy.io/api/v1/holds \
  -H "Authorization: Bearer sk_test_..." \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: hold-R3-000131" \
  -d '{ "member": "2000111703779", "amount": 3000, "check_amount": 20000, "register_id": "R3" }'

# at payment: the check captures it
curl https://loyaltyfy.io/api/v1/transactions \
  -H "Authorization: Bearer sk_test_..." \
  -H "Content-Type: application/json" \
  -d '{ "external_id": "000131", "register_id": "R3", "member": "2000111703779",
        "amount": 20000, "hold_id": "5b0d6c1e-8f3a-4d7e-9a61-2c4b8e0f7d19" }'

Жауап · 201

{
  "object": "hold",
  "id": "5b0d6c1e-8f3a-4d7e-9a61-2c4b8e0f7d19",
  "member": "2000111703779",
  "amount": 3000,
  "check_amount": 20000,
  "status": "active",
  "register_id": "R3",
  "captured_by": null,
  "expires_at": "2026-10-06T19:02:11.000+00:00",
  "livemode": false,
  "created_at": "2026-10-06T18:32:11.000+00:00",
  "member_after": { "object": "member", "cashback": { "balance": 10200, "held": 3000, "available": 7200, ... }, ... }
}

GET/v1/holds/{id}

Құқық: transactions:write

Ағымдағы мәртебесімен бір резерв.

POST/v1/holds/{id}/release

Құқық: transactions:write

Ақшаны дәл қазір қайтарады. Босатылған немесе мерзімі өткен резервті босату зиян келтірмейді. Расталған резерв 409 hold_captured қайтарады (оның орнына чекті болдырмаңыз).