Σφάλματα

Ο κωδικός κατάστασης HTTP λέει τι είδους πρόβλημα υπάρχει· το σώμα JSON λέει ακριβώς ποιο και, όταν αφορά ένα πεδίο, ποιο πεδίο.

JSON

{
  "error": {
    "type": "invalid_request_error",
    "code": "parameter_invalid",
    "message": "consent: must be true: confirm the guest agreed to data processing",
    "param": "consent"
  },
  "request_id": "req_0d4d15b86c484738b46b"
}

error.typestring: Γενική κατηγορία: invalid_request_error, authentication_error, permission_error, idempotency_error, rate_limit_error, api_error.
error.codestring: Σταθερός κωδικός για μηχανική επεξεργασία, για παράδειγμα member_not_found. Βασίστε τη λογική σας σε αυτόν, όχι στο μήνυμα.
error.messagestring: Μια πρόταση για τον developer. Μπορεί να αλλάξει· μην την αναλύετε.
error.paramstring: Το πεδίο του αιτήματος που αφορά το σφάλμα, όταν υπάρχει.
request_idstring: Υπάρχει και στην κεφαλίδα X-Request-Id κάθε απάντησης. Συμπεριλάβετέ το όταν μας γράφετε.

Παράμετρος	Τύπος	Περιγραφή
error.type	string	Γενική κατηγορία: `invalid_request_error`, `authentication_error`, `permission_error`, `idempotency_error`, `rate_limit_error`, `api_error`.
error.code	string	Σταθερός κωδικός για μηχανική επεξεργασία, για παράδειγμα `member_not_found`. Βασίστε τη λογική σας σε αυτόν, όχι στο μήνυμα.
error.message	string	Μια πρόταση για τον developer. Μπορεί να αλλάξει· μην την αναλύετε.
error.param	string	Το πεδίο του αιτήματος που αφορά το σφάλμα, όταν υπάρχει.
request_id	string	Υπάρχει και στην κεφαλίδα `X-Request-Id` κάθε απάντησης. Συμπεριλάβετέ το όταν μας γράφετε.

Κωδικοί κατάστασης

Κατάσταση	Σημασία	Τι να κάνετε
200, 201	Επιτυχία. Το 201 σημαίνει ότι δημιουργήθηκε κάτι νέο.
400	Το αίτημα είναι λανθασμένο ή κάποιο πεδίο δεν είναι έγκυρο.	Διορθώστε το αίτημα. Η επανάληψη με το ίδιο σώμα δίνει την ίδια απάντηση.
401	Χωρίς κλειδί, άγνωστο ή ανακληθέν κλειδί.	Ελέγξτε το κλειδί.
402	Το αίτημα είναι έγκυρο αλλά δεν μπορεί να εκτελεστεί, για παράδειγμα λόγω ανεπαρκούς υπολοίπου.	Δείξτε το μήνυμα στον πελάτη· οι λεπτομέρειες είναι στο σώμα.
403	Το κλειδί δεν έχει το δικαίωμα που απαιτεί η κλήση.	Χρησιμοποιήστε κλειδί με το δικαίωμα που αναφέρει το μήνυμα.
404	Το μέλος, η συναλλαγή, το πιάτο ή η παραγγελία δεν υπάρχει σε αυτή την επιχείρηση.	Ελέγξτε το αναγνωριστικό.
409	Σύγκρουση: ο αριθμός κάρτας είναι κατειλημμένος, η αλλαγή κατάστασης δεν επιτρέπεται ή το υπόλοιπο άλλαξε κατά την κλήση.	Διαβάστε τον κωδικό. Για `balance_conflict`, επαναλάβετε με το ίδιο `external_id`.
429	Πάρα πολλά αιτήματα.	Περιμένετε όσα δευτερόλεπτα ορίζει το `Retry-After`.
500, 502, 503	Κάτι απέτυχε από τη δική μας πλευρά.	Επαναλάβετε με backoff και το ίδιο `external_id` ή `Idempotency-Key`. Τίποτα δεν εφαρμόζεται δύο φορές.

Συνηθισμένοι κωδικοί

Κωδικός	Πότε
parameter_invalid	Κάποιο πεδίο λείπει ή έχει λάθος μορφή. Δείτε το `param`.
member_not_found	Κανένα μέλος δεν αντιστοιχεί στον αριθμό κάρτας, το barcode, το τηλέφωνο ή το id.
card_number_taken	Άλλο μέλος της επιχείρησης έχει ήδη αυτόν τον αριθμό κάρτας.
insufficient_balance	Το `redeem_amount` υπερβαίνει το υπόλοιπο cashback. Το `available` περιέχει το υπόλοιπο.
redeem_not_supported	Το πρόγραμμα του μέλους δεν έχει υπόλοιπο cashback για εξαργύρωση.
visit_not_supported	Στάλθηκε επίσκεψη για πρόγραμμα cashback. Στείλτε αντί γι' αυτό απόδειξη με ποσό.
no_reward_available	Το μέλος δεν έχει κερδισμένη επιβράβευση για εξαργύρωση.
transaction_not_found	Δεν υπάρχει συναλλαγή με αυτό το `external_id`.
invalid_status_transition	Η παραγγελία δεν μπορεί να περάσει από την τρέχουσα κατάσταση σε αυτή που στείλατε.
missing_scope	Το κλειδί δεν έχει το απαιτούμενο δικαίωμα.
hold_required	Η επιχείρηση εξαργυρώνει cashback μόνο μέσω δεσμεύσεων. Δημιουργήστε μία με `POST /v1/holds`.
hold_expired, hold_captured, hold_released	Η δέσμευση δεν μπορεί πλέον να χρησιμοποιηθεί. Δημιουργήστε νέα.
register_id_required	Η επιχείρηση αριθμεί τις αποδείξεις ανά ταμείο, οπότε το `register_id` είναι υποχρεωτικό.
check_too_old	Το `closed_at` είναι παλαιότερο από όσο δέχεται η επιχείρηση.
scan_required	Η επιχείρηση το δέχεται μόνο για κάρτα που σάρωσε αυτό το κλειδί λίγο πριν.
refund_exceeds_check	Η επιστροφή υπερβαίνει ό,τι απομένει από την απόδειξη. Το `refundable` περιέχει το υπόλοιπο.
adjustments_disabled	Η επιχείρηση δεν επέτρεψε διορθώσεις υπολοίπου μέσω του API.
idempotency_key_reused	Το ίδιο `Idempotency-Key` χρησιμοποιήθηκε με διαφορετικό σώμα.
rate_limited	Πάρα πολλά αιτήματα από αυτό το κλειδί.