Δεσμεύσεις

Cashback που δεσμεύεται στη σάρωση και επιβεβαιώνεται από την κλεισμένη απόδειξη.

Το αντικείμενο hold

iduuid: Στείλτε το ως hold_id με την απόδειξη.
memberstring: Ο αριθμός κάρτας.
amountinteger: Το δεσμευμένο cashback, στη μικρότερη υποδιαίρεση.
statusstring: active, captured, released ή expired.
captured_bystring ή null: Το external_id της απόδειξης που τη χρησιμοποίησε.
expires_atdatetime: Πότε μια αχρησιμοποίητη δέσμευση λύνεται αυτόματα.

Παράμετρος	Τύπος	Περιγραφή
id	uuid	Στείλτε το ως `hold_id` με την απόδειξη.
member	string	Ο αριθμός κάρτας.
amount	integer	Το δεσμευμένο cashback, στη μικρότερη υποδιαίρεση.
status	string	`active`, `captured`, `released` ή `expired`.
captured_by	string ή null	Το `external_id` της απόδειξης που τη χρησιμοποίησε.
expires_at	datetime	Πότε μια αχρησιμοποίητη δέσμευση λύνεται αυτόματα.

POST/v1/holds

Δικαίωμα: transactions:write

Δεσμεύει cashback. Ισχύουν τα ίδια όρια όπως για μια απόδειξη· αν ζητηθούν περισσότερα, το αίτημα απορρίπτεται με 402 insufficient_balance και limited_by. Στείλτε Idempotency-Key.

memberstring, υποχρεωτικό: Αριθμός κάρτας, τιμή σάρωσης, serial, id μέλους ή τηλέφωνο.
amountinteger, υποχρεωτικό: Το cashback που θα δεσμευτεί.
check_amountinteger, υποχρεωτικό: Το σύνολο της απόδειξης, για το ποσοστό του προγράμματος και τους κανόνες κατηγοριών.
register_idstring: Το id του ταμείου σας.
line_itemsarray: Για τους κανόνες κατηγοριών.

Παράμετρος	Τύπος	Περιγραφή
member	string, υποχρεωτικό	Αριθμός κάρτας, τιμή σάρωσης, serial, id μέλους ή τηλέφωνο.
amount	integer, υποχρεωτικό	Το cashback που θα δεσμευτεί.
check_amount	integer, υποχρεωτικό	Το σύνολο της απόδειξης, για το ποσοστό του προγράμματος και τους κανόνες κατηγοριών.
register_id	string	Το id του ταμείου σας.
line_items	array	Για τους κανόνες κατηγοριών.

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 (σε αυτή την περίπτωση ακυρώστε την απόδειξη).