☰ Μενού · Υπολογισμός
Αναφορά API
Υπολογισμός απόδειξης
Μάθετε τι θα δώσει και τι θα εξαργυρώσει μια απόδειξη πριν πληρώσει ο πελάτης. Δεν καταγράφεται τίποτα.
POST
/v1/checks/calculateΔικαίωμα: transactions:write ή devices:write
Εφαρμόζει τους ίδιους κανόνες με το POST /v1/transactions: το επίπεδο του πελάτη, τους κανόνες κατηγοριών, το ποσοστό του προγράμματος, τα όρια και τις δεσμεύσεις της επιχείρησης. Καλέστε το όσο συχνά αλλάζει το καλάθι. Ένα άλλο ταμείο μπορεί ακόμη να ξοδέψει το υπόλοιπο πριν κλείσει η απόδειξη· όταν αυτό έχει σημασία, χρησιμοποιήστε δέσμευση.
- memberstring, υποχρεωτικό
- Αριθμός κάρτας, τιμή σάρωσης, serial, id μέλους ή τηλέφωνο.
- amountinteger, υποχρεωτικό
- Το σύνολο της απόδειξης πριν από το cashback, στη μικρότερη υποδιαίρεση.
- redeem_amountinteger
- Πόσα θέλει να πληρώσει ο πελάτης με cashback.
- hold_iduuid
- Υπολογισμός σαν να είχε επιβεβαιωθεί αυτή η δέσμευση.
- 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,
"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
- Για προγράμματα σφραγίδων και επισκέψεων.
- displayobject
- Τα
cashier_textκαιreceipt_linesστη γλώσσα του πελάτη.