אובייקט: תשובה לשגיאה

גוף התגובה

גוף ה-HTTP לכל התגובות שאינן 200 HTTP.

דוגמה לתשובה:

  {
    "responseHeader": {
      "requestTimestamp": "1481899949611"
    },
    "errorResponseCode": "INVALID_IDENTIFIER",
    "errorDescription": "Unknown paymentIntegratorAccountId: PIAID1",
  }

ייצוג JSON
{ "responseHeader": { object(ResponseHeader) }, "errorResponseCode": string, "errorDescription": string, }

שדות
responseHeader	object(ResponseHeader) חובה: כותרת נפוצה לכל התשובות.
errorResponseCode	string אופציונלי: אפשר לציין אחד מהקודים המפורטים בטבלה שבהמשך. קודי שגיאה שהוחזרו וקודי HTTP מומלצים INVALID_API_VERSION 400 משמש אם מבצע השילוב לא תומך בגרסת ה-API של הבקשה. INVALID_PAYLOAD_SIGNATURE 401 משמש אם החתימה של המטען הייעודי היא מפתח לא ידוע או לא פעיל. INVALID_PAYLOAD_ENCRYPTION 400 משמש אם ההצפנה של המטען הייעודי היא מפתח לא ידוע או לא פעיל. REQUEST_TIMESTAMP_OUT_OF_RANGE 400 משמש אם request_timestamp הוא לא ± 60 שניות כרגע. INVALID_IDENTIFIER 404 משמש אם מזהה שנשלח בבקשה לא היה חוקי או לא ידוע. הנתונים האלה יכולים לכלול paymentIntegratorAccountId, googlePaymentToken, captureRequestId וכו'. יש לציין את סוג המזהה הלא חוקי בerrorDescription. IDEMPOTENCY_VIOLATION 412 משמש אם הבקשה מפרה את דרישות הזיהוי של הבקשה. INVALID_FIELD_VALUE 400 משמש אם הבקשה מכילה ערך בשדה שלא בקבוצת הערכים הנתמכים. MISSING_REQUIRED_FIELD 400 משמש אם שדה חובה לא מוגדר בבקשה. PRECONDITION_VIOLATION 400 משמש למצב שבו מופרת מגבלה על הפעולה (למשל, כשבקשה להחזר כספי גבוהה מהסכום שנותר בעסקה). USER_ACTION_IN_PROGRESS 400 משמש אם לא ניתן לעבד את הבקשה כרגע, כי היא תפריע לפעולת משתמש בתהליך שבפועל משמשת כנעילת מערכת. אין להשתמש בקוד כדי לציין כשלים עקב שגיאות פנימיות ספציפיות להטמעה של בו-זמנית. INVALID_DECRYPTED_REQUEST 400 משמש אם ניתן לפענח את המטען הייעודי של הבקשה, אבל לא ניתן היה לנתח את ההודעה שהתקבלה.
errorDescription	string אופציונלי: ניתן לציין תיאור של הסטטוס הזה כדי שנציגי התמיכה יוכלו לנפות באגים. לתשומת ליבך: המידע הזה אף פעם לא מוצג למשתמשים. הוא יכול להכיל טקסט תיאורי ולא רגיש שמשמש לניפוי באגים. לתשומת ליבך, לחלק מהערכים של errorResponseCode צריך להיות פירוט נוסף בשדה הזה (למשל, INVALID_IDENTIFIER צריך לכלול מידע בשדה הזה לגבי סוג המזהה שלא היה חוקי). אזהרה: אין לכלול אסימונים בהודעה הזו, אלא אם הם מוגדרים כגלויים לכולם.