☰ Меню · Расчёт чека
Справочник API

Расчёт чека

Узнайте, что чек начислит и спишет, до того как гость заплатит. Ничего не записывается.

POST/v1/checks/calculate
Право: transactions:write или devices:write

Применяет те же правила, что и POST /v1/transactions: уровень гостя, правила категорий, долю программы, лимиты заведения и резервы. Вызывайте при каждом изменении корзины. Другая касса всё ещё может потратить баланс до закрытия чека; если это важно, используйте резерв.

memberstring, обязательный
Номер карты, отсканированное значение, серийный номер, id участника или телефон.
amountinteger, обязательный
Сумма чека до списания кэшбэка, в минимальных единицах.
redeem_amountinteger
Сколько гость хочет оплатить кэшбэком.
hold_iduuid
Рассчитать так, будто этот резерв подтверждён.
discount_typestring
Код скидки чека, как в транзакции. У позиций может быть свой.
line_items[].promoboolean
true, если товар в акции. Тогда правила для акций владельца решают, начисляет ли строка и можно ли оплатить её кэшбэком. Игнорируется, если заведение не включило правило.
register_idstring
Код вашей кассы. Если владелец привязал его к точке, расчёт идёт по правилам точки.
store_idstring
Код магазина (точки) из вашей учётной системы, до 64 символов. Используется, если register_id не передан или не привязан ни к одной точке. Если оба указывают на разные точки, побеждает register_id. См. как передать точку и кассу.
cashierstring or object
Принимается как в транзакции, чтобы касса могла отправлять одно и то же тело. Расчёт ничего не сохраняет.
line_itemsarray
Как в транзакции, используются правилами категорий.
curl
curl https://loyaltyfy.io/api/v1/checks/calculate \
  -H "Authorization: Bearer sk_test_..." \
  -H "Content-Type: application/json" \
  -d '{ "member": "2000111703779", "amount": 20000, "redeem_amount": 5000 }'
Ответ · 200
{
  "object": "check_calculation",
  "amount": 20000,
  "redeem_amount": 1250,
  "max_redeem": 1250,
  "limited_by": "balance",
  "net_amount": 18750,
  "cashback_earned": 938,
  "earn_rate": 5,
  "level": "Base",
  "balance_after": 938,
  "category_rules_applied": false,
  "line_items": [
    { "sku": "1001", "name": "Espresso", "quantity": 2, "unit_price": 4000, "category": "Coffee", "amount": 8000, "earn_percent": 5, "cashback_earned": 375, "redeemable": true },
    { "sku": "2005", "name": "Cheesecake", "quantity": 1, "unit_price": 12000, "category": "Desserts", "amount": 12000, "earn_percent": 5, "cashback_earned": 563, "redeemable": true }
  ],
  "hold_required": false,
  "stamps_earned": 0,
  "reward_unlocked": false,
  "member": { "object": "member", ... },
  "display": {
    "cashier_text": "Paid with cashback: 12.50 MDL · Cashback earned: 9.38 MDL · Cashback balance: 9.38 MDL",
    "receipt_lines": [
      "Paid with cashback: 12.50 MDL",
      "Cashback earned: 9.38 MDL",
      "Cashback balance: 9.38 MDL"
    ]
  }
}
redeem_amountinteger
Сколько будет списано на самом деле.
max_redeeminteger
Максимум, который этот чек может списать сейчас.
limited_bystring или null
Если запрошено больше: balance, program, per_check или per_day.
location, redeem_allowed, redeem_blocked_reason
Только если register_id привязан к точке со своими правилами: точка, можно ли на ней списывать и, если нельзя, redeem_blocked_reason: "redeem_not_allowed_here" и max_redeem 0. limited_by тогда location. Точка находится по register_id или store_id; в объекте location есть store_code и matched_by.
discount_typeobject or null
Только если заведение использует типы скидок и запрос его передал: тип чека с earn и redeem. При redeem: false в ответе max_redeem 0, limited_by: "discount_type" и redeem_blocked_reason: "discount_redeem_not_allowed".
cashback_earned, earn_rate, level
Что начислит чек и по какому уровню.
balance_afterinteger
Баланс после этого чека.
line_itemsarray
Что начислит каждая позиция: amount, cashback_earned, earn_percent, redeemable. Показывайте на чеке или рядом с корзиной.
line_items[].promoboolean
Только у заведений с правилами для акций: была ли строка отправлена как товар в акции.
hold_requiredboolean
Заведение списывает только через резерв, а hold_id не передан.
stamps_earned, reward_unlocked, discount_percent
Для программ со штампами и визитами.
displayobject
cashier_text и receipt_lines на языке гостя.