☰ Мәзір · Есептеу
API анықтамалығы
Чекті есептеу
Қонақ төлемей тұрып, чек қанша беретінін және қанша кэшбэк жұмсалатынын сұраңыз. Ештеңе жазылмайды.
POST
/v1/checks/calculateҚұқық: transactions:write немесе devices:write
POST /v1/transactions сияқты ережелерді қолданады: қонақтың деңгейі, санат ережелері, бағдарламадағы үлес, мекеменің лимиттері мен резервтері. Себет өзгерген сайын шақыра беріңіз. Чек жабылғанша басқа касса балансты жұмсап қоюы мүмкін. Бұл маңызды болса, резервті пайдаланыңыз.
- memberstring, міндетті
- Карта нөмірі, сканерленген мән, сериялық нөмір, қатысушы id-і немесе телефон.
- amountinteger, міндетті
- Кэшбэкке дейінгі чек сомасы, кіші бірлікте.
- redeem_amountinteger
- Қонақ кэшбэкпен қанша төлегісі келеді.
- hold_iduuid
- Осы резерв расталғандай етіп есептейді.
- line_itemsмассив
- Транзакциядағыдай. Санат ережелері үшін қолданылады.
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,
"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. - cashback_earned, earn_rate, level
- Чек не беретіні және қай деңгей бойынша.
- balance_afterinteger
- Осы чектен кейінгі баланс.
- hold_requiredboolean
- Мекеме тек резерв арқылы төлетеді, ал
hold_idжіберілмеген. - stamps_earned, reward_unlocked, discount_percent
- Штамп және келу бағдарламалары үшін.
- displayобъект
- Қонақтың тіліндегі
cashier_textжәнеreceipt_lines.