☰ Menü · Hesaplama
API referansı

Fiş hesaplama

Misafir ödeme yapmadan önce bir fişin ne kazandıracağını ve ne kadar cashback kullanılacağını sorgulayın. Hiçbir şey kaydedilmez.

POST/v1/checks/calculate
İzin: transactions:write veya devices:write

POST /v1/transactions ile aynı kuralları uygular: misafirin seviyesi, kategori kuralları, programın oranı, işletmenin limitleri ve rezervasyonlar. Sepet her değiştiğinde çağırabilirsiniz. Fiş kapanmadan önce başka bir kasa bakiyeyi yine de harcayabilir. Bu önemliyse bir rezervasyon kullanın.

memberstring, zorunlu
Kart numarası, okunan değer, seri numarası, üye id'si veya telefon.
amountinteger, zorunlu
Cashback düşülmeden önceki fiş toplamı, en küçük para biriminde.
redeem_amountinteger
Misafirin cashback ile ödemek istediği tutar.
hold_iduuid
Bu rezervasyon onaylanmış gibi hesaplar.
discount_typestring
Fişin indirim kodu, işlemdeki gibi. Satırlar kendi kodunu taşıyabilir.
line_items[].promoboolean
Ürün kampanyadaysa true. O zaman işletme sahibinin kampanya kuralları satırın kazandırıp kazandırmayacağına ve cashback ile ödenip ödenemeyeceğine karar verir. İşletme kuralı açmadıysa yok sayılır.
register_idstring
Kasanızın kodu. İşletme sahibi onu bir şubeye bağladıysa hesaplama şubenin kurallarına uyar.
store_idstring
Muhasebe sisteminizdeki mağaza (şube) kodu, en fazla 64 karakter. register_id yoksa veya hiçbir şubeye bağlı değilse kullanılır. İkisi farklı şubeleri gösterirse register_id kazanır. Bkz. şube ve kasa nasıl gönderilir.
cashierstring or object
Bir işlemdeki gibi kabul edilir, böylece kasa aynı gövdeyi gönderebilir. Hesaplama hiçbir şey kaydetmez.
line_itemsdizi
İşlemdekiyle aynı. Kategori kuralları için kullanılır.
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 }'
Yanıt · 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
Gerçekte kullanılacak tutar.
max_redeeminteger
Bu fişte şu anda kullanılabilecek en yüksek tutar.
limited_bystring veya null
İstek daha fazlasını istediyse: balance, program, per_check veya per_day.
location, redeem_allowed, redeem_blocked_reason
Yalnızca register_id kendi kuralları olan bir şubeye bağlıysa: şube, orada cashback harcanıp harcanamayacağı ve harcanamıyorsa max_redeem 0 ile redeem_blocked_reason: "redeem_not_allowed_here". Bu durumda limited_by değeri location olur. Şube register_id veya store_id ile bulunur; location nesnesinde store_code ve matched_by bulunur.
discount_typeobject or null
Yalnızca işletme indirim türlerini kullanıyorsa ve istek bir tür gönderdiyse: fişin türü, earn ve redeem ile. redeem: false olduğunda yanıtta max_redeem 0, limited_by: "discount_type" ve redeem_blocked_reason: "discount_redeem_not_allowed" bulunur.
cashback_earned, earn_rate, level
Fişin ne kazandıracağı ve hangi seviyede.
balance_afterinteger
Bu fişten sonraki bakiye.
line_itemsdizi
Her satırın kazandıracağı: amount, cashback_earned, earn_percent, redeemable. Fişte veya sepetin yanında gösterin.
line_items[].promoboolean
Yalnızca kampanya kuralları olan işletmelerde: satırın kampanyadaki ürün olarak gönderilip gönderilmediği.
hold_requiredboolean
İşletme yalnızca rezervasyonla kullandırıyor ve hold_id gönderilmedi.
stamps_earned, reward_unlocked, discount_percent
Damga ve ziyaret programları için.
displaynesne
Misafirin dilinde cashier_text ve receipt_lines.