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

גוף התשובה

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

תגובה לדוגמה נראית כך:


  {
    "responseHeader": {
      "responseTimestamp": "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

משמש אם החתימה של המטען הייעודי (payload) היא לא ידועה או מפתח לא פעיל.

INVALID_PAYLOAD_ENCRYPTION 400

משתמשים בו אם ההצפנה של המטען הייעודי (Payload) היא לא ידועה או מפתח לא פעיל.

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

נעשה בו שימוש אם לא ניתן לעבד את הבקשה בשלב זה כי היא תפריע לפעולת משתמש בתהליך, שלמעשה משמש כנעילת מערכת. אין להשתמש בקוד הזה כדי: לציין כשלים עקב שגיאות פנימיות ספציפיות להטמעה שגיאות בו-זמניות (concurrency).

INVALID_DECRYPTED_REQUEST 400

משתמשים בו אם ניתן לפענח את המטען הייעודי (payload) של הבקשה, אבל אי אפשר לנתח את ההודעה שהתקבלה.

errorDescription

string

אופציונלי: צריך לספק תיאור של הסטטוס הזה עבור תמיכה בנציגים לניפוי באגים בשגיאות. חשוב לשים לב שהמידע הזה אף פעם לא מוצג למשתמשים. היא יכולה להכיל טקסט תיאורי ולא רגיש שמשמש לניפוי באגים. שימו לב שחלק מהערכים של errorResponseCode צריכים להיות בצירוף פרטים נוספים בשדה הזה (למשל, אל INVALID_IDENTIFIER יש לציין את בשדה הזה כדי לציין איזה סוג של מזהה לא היה חוקי).