Method: getDisputeInquiryReport

קבלת דוח שמספק מידע שיעזור לכם לנהל שיחה עם משתמש במסגרת תמיכת לקוחות בנוגע לערעור אפשרי על תשלום.

אם השיטה הזו לא מחזירה HTTP 200, התשובות לשאילתה הזו יכולות להיות ריקות.

אם נקודת הקצה נתקלת בשגיאה במהלך עיבוד הבקשה, התשובה מנקודת הקצה הזו תהיה מסוג ErrorResponse.

אם השיטה הזו לא מחזירה HTTP 200, התשובות לשאילתה הזו יכולות להיות ריקות. גוף התגובה הוא ריק במצבים שבהם ErrorResponse עם תיאור ברור יכול לעזור לתוקפים להבין את מזהה החשבון של מבצע השילוב של התשלומים של משלבים אחרים. במצבים כאלה, שבהם מפתח החתימה לא תואם, המזהה של משלב התשלומים לא נמצא או שמפתח ההצפנה לא היה ידוע, השיטה הזו תחזיר קוד HTTP 404 עם גוף ריק. אם ניתן לאמת את חתימת הבקשה, בגוף התגובה יוחזר מידע נוסף לגבי השגיאה.

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


{
  "requestHeader": {
    "protocolVersion": {
      "major": 3
    },
    "requestId": "HsKv5pvtQKTtz7rdcw1YqE",
    "requestTimestamp": {
      "epochMillis": "1519996751331"
    },
    "paymentIntegratorAccountId": "InvisiCashUSA_USD"
  },
  "paymentLookupCriteria": {
    "googleTransactionReferenceNumberCriteria": {
      "googleTransactionReferenceNumber": "714545417102363157911822",
      "authorizationCode": "111111"
    }
  },
  "existingGoogleClaimId": "138431383281",
  "requestOriginator": {
    "organizationId": "ISSUER_256",
    "organizationDescription": "Community Bank of Some City",
    "agentId": "982749"
  }
}

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


{
  "responseHeader": {
    "responseTimestamp": {
      "epochMillis": "1519996752221"
    }
  },
  "result": {
    "success": {
      "googleClaimId": "138431383281",
      "report": {
        "customerAccount": {
          "customerEmail": "example@gmail.com",
          "customerName" : "Example Customer"
        },
        "order": {
          "timestamp": {
            "epochMillis": "1517992525972"
          },
          "orderId": "SOP.8976-1234-1234-123456..99",
          "subTotalAmount": {
            "amountMicros": "206990000",
            "currencyCode": "USD"
          },
          "totalAmount": {
            "amountMicros": "212990000",
            "currencyCode": "USD"
          },
          "shippingAddress": {
            "addressLine": ["123 Main St"],
            "localityName": "Springfield",
            "administrativeAreaName": "CO",
            "postalCodeNumber": "80309",
            "countryCode": "US"
          },
          "taxes": [
            {
              "description": "Colorado Sales Tax",
              "amount": {
                "amountMicros": "6000000",
                "currencyCode": "USD"
              }
            }
          ],
          "items": [
            {
              "description": "Super cool gizmo",
              "merchant": "HTC",
              "googleProductName": "Google Store",
              "quantity": "2",
              "totalPrice": {
                "amountMicros": "198000000",
                "currencyCode": "USD"
              }
            },
            {
              "description": "Gizmo charger",
              "merchant": "HTC",
              "googleProductName": "Google Store",
              "quantity": "1",
              "totalPrice": {
                "amountMicros": "8990000",
                "currencyCode": "USD"
              }
            }
          ]
        },
        "payment": {
          "billingAddress" : {
            "addressLine": ["123 Main St"],
            "localityName": "Springfield",
            "administrativeAreaName": "CO",
            "postalCodeNumber": "80309",
            "countryCode": "US"
          },
          "amount": {
            "amountMicros": "100000000",
            "currencyCode": "USD"
          },
          "refunds": [
            {
              "amount": {
                "amountMicros": "9250000",
                "currencyCode": "USD"
              },
              "initiatedTimestamp": {
                "epochMillis": "1518811245384"
              }
            }
          ],
          "cardDetails": {
            "authResult": "APPROVED"
          }
        }
      }
    }
  }
}

בקשת HTTP

POST https://vgw.googleapis.com/secure-serving/gsp/v3/getDisputeInquiryReport/:PIAID

גוף הבקשה

גוף הבקשה מכיל נתונים במבנה הבא:

ייצוג JSON 
{
  "requestHeader": {
    object (RequestHeader)
  },
  "paymentLookupCriteria": {
    object (PaymentLookupCriteria)
  },
  "existingGoogleClaimId": string,
  "requestOriginator": {
    object (RequestOriginator)
  }
}
שדות
requestHeader

object (RequestHeader)

חובה: כותרת משותפת לכל הבקשות.
paymentLookupCriteria

object (PaymentLookupCriteria)

חובה: קריטריונים המציינים את התשלום שאמור לבדוק את הנושא.
existingGoogleClaimId

string

אופציונלי: מחרוזת ש-Google יוצרת, שהוחזרה על-ידי קריאה קודמת אל getDisputeInquiryReport, שמזהה באופן ייחודי את התלונה הזו על ערעור של לקוח.

אם הוא לא נמצא, המערכת תיצור מזהה תלונה חדש. המתקשר עשוי לספק googleClaimId שהוחזר על ידי שיחה קודמת אל getDisputeInquiryReport אם הערעור נמשך את אותו מחלוקת של הלקוח.

מזהה התלונה שמאוכלס כאן או שנוצר כאן יוחזר בשדה googleClaimId של התשובה.

לא חוקי לספק googleClaimId שלא הוחזר על ידי שיחה קודמת אל getDisputeInquiryReport. במקרה כזה, תוחזר 'בקשה לא תקינה' מסוג HTTP 400.
requestOriginator

object (RequestOriginator)

נדרש: מידע על הארגון או על קבוצת המשנה הארגונית שיצרה את הבקשה.

גוף התשובה

השיטה הזו תומכת בכמה סוגים של החזרת מוצרים. למידע נוסף על קוד מצב HTTP 4XX או 5XX שיש להחזיר עם ErrorResponse, יש לעיין באובייקט ErrorResponse ובתיעוד של קודי המצב של HTTP.

השיטה הזו תומכת בכמה סוגים של החזרת מוצרים. למידע נוסף על קוד מצב HTTP 4XX או 5XX שיש להחזיר עם ErrorResponse, יש לעיין באובייקט ErrorResponse ובתיעוד של קודי המצב של HTTP.

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכלול נתונים במבנה הבא:

הודעות תשובה אפשריות
סטטוס HTTP 200

object (GetDisputeInquiryReportResponse)
סטטוס HTTP 4XX / 5XX

object (ErrorResponse)

RequestHeader

אובייקט כותרת שמוגדר בכל הבקשות שנשלחות לשרת.

ייצוג JSON 
{
  "requestId": string,
  "requestTimestamp": {
    object (Timestamp)
  },
  "protocolVersion": {
    object (Version)
  },
  "paymentIntegratorAccountId": string
}
שדות
requestId

string

חובה: המזהה הייחודי של הבקשה.

זוהי מחרוזת באורך מקסימלי של 100 תווים והיא מכילה רק את התווים "a-z", "A-Z", "0-9", ":", "-" ו-"_".
requestTimestamp

object (Timestamp)

חובה: חותמת הזמן של הבקשה. המקבל חייב לוודא שחותמת הזמן הזו היא ± 60 שניות של 'עכשיו' ולדחות את הבקשה אם היא לא נכונה. חותמת הזמן של הבקשה אינה מזהה ביחס לניסיונות החוזרים.
protocolVersion

object (Version)

חובה: הגרסה של הבקשה.
paymentIntegratorAccountId

string

חובה: זיהוי חשבון ייחודי עם מגבלות חוזיות.

חותמת זמן

אובייקט של חותמת זמן שמייצג נקודה בציר הזמן של ISO, באלפיות השנייה מאז תחילת מערכת Unix.

ייצוג JSON 
{
  "epochMillis": string
}
שדות
epochMillis

string (Int64Value format)

חובה: אלפיות השנייה מאז תקופת ה-Unix

גרסה

אובייקט הגרסה מכיל את הגרסה הראשית של ה-API. בטוח שגרסאות של אותה הגרסה הראשית יהיו תואמות. מבצע השילוב חייב לתמוך בכל הבקשות לאותה גרסה ראשית.

ייצוג JSON 
{
  "major": integer
}
שדות
major

integer

חובה: הגרסה הראשית. מצב זה מסומן עבור בקשות תאימות עם גרסאות שונות לא מובטח שהן יהיו תואמות.

PaymentLookupCriteria

מאגר לקריטריונים שיכול לחפש תשלום באופן ייחודי. יש לאכלס שדה חבר אחד (ואחד בלבד).

ייצוג JSON 
{

  // Union field criteria can be only one of the following:
  "arnCriteria": {
    object (ArnCriteria)
  },
  "googleTransactionReferenceNumberCriteria": {
    object (GoogleTransactionReferenceNumberCriteria)
  },
  "captureRequestCriteria": {
    object (CaptureRequestCriteria)
  }
  // End of list of possible types for union field criteria.
}
שדות

שדה איחוד criteria.

הערך של criteria יכול להיות רק אחת מהאפשרויות הבאות:
arnCriteria

object (ArnCriteria)

אופציונלי: חיפוש מבוסס על מספר אסמכתה של רוכש (ARN).
googleTransactionReferenceNumberCriteria

object (GoogleTransactionReferenceNumberCriteria)

אופציונלי: חיפוש על סמך מספר האסמכתה של העסקה ב-Google.
captureRequestCriteria

object (CaptureRequestCriteria)

אופציונלי: חיפוש מבוסס על בקשת הצילום המקורית.

ArnCriteria

קריטריונים לחיפוש תשלום על סמך מספר אסמכתה של משלם (ARN).

ייצוג JSON 
{
  "acquirerReferenceNumber": string,
  "authorizationCode": string
}
שדות
acquirerReferenceNumber

string

חובה: מספר האסמכתה של הלקוח (ARN) שמזהה את התשלום באופן ייחודי. חייב להכיל 23 ספרות.
authorizationCode

string

נדרש: קוד ההרשאה לעסקה.

GoogleTransactionReferenceNumberCriteria

קריטריונים לחיפוש תשלום על סמך מספר האסמכתה של העסקה שנוצרה על ידי Google.

ייצוג JSON 
{
  "googleTransactionReferenceNumber": string,
  "authorizationCode": string
}
שדות
googleTransactionReferenceNumber

string

חובה: מספר הסימוכין של העסקה שנוצר על ידי Google, שמזהה באופן ייחודי את התשלום.
authorizationCode

string

נדרש: קוד ההרשאה לעסקה.

CaptureRequestCriteria

קריטריונים לחיפוש תשלום על סמך בקשת הקליטה המקורית.

ייצוג JSON 
{
  "captureRequestId": string
}
שדות
captureRequestId

string

חובה: מזהה ייחודי לעסקה הזו. זהו ה-requestId שנוצר על ידי Google במהלך השיחה ב-capture. אנחנו בודקים את הנושא.

RequestOriginator

מידע על הארגון או על קבוצת המשנה הארגונית, ובאופן אופציונלי על העובד, שממנה נשלחה הבקשה הזו. כך Google יכולה לזהות בעיות או ניצול לרעה ולהטמיע אמצעי בקרה ברמת פירוט גבוהה יותר מאשר paymentIntegratorAccountId. הערך הזה חשוב במיוחד כשמדובר בספק שירות מתווך שמקורו בבקשות מלקוחות חיצוניים.

ייצוג JSON 
{
  "organizationId": string,
  "organizationDescription": string,
  "agentId": string
}
שדות
organizationId

string

נדרש: מזהה של החברה, הארגון או הקבוצה הארגונית שמהם הגיעה הבקשה. חייב להיות ייחודי בpaymentIntegratorAccountId.
organizationDescription

string

חובה: שם קריא (לבני אדם) או תיאור של הארגון, וניתן להשתמש בו כדי להקל על התקשורת בין עובדי Google לבין המארגן של אותו ארגון.
agentId

string

אופציונלי: מזהה ייחודי של הסוכן (עובד) הספציפי של הארגון, שזוהה על ידי organizationId שממנו נשלחה הבקשה הזו. חייב להיות ייחודי בorganizationId.

GetDisputeInquiryReportResponse

מטען ייעודי (payload) של תגובה ל-method getDisputeInquiryReport.

ייצוג JSON 
{
  "responseHeader": {
    object (ResponseHeader)
  },
  "result": {
    object (GetDisputeInquiryReportResult)
  }
}
שדות
responseHeader

object (ResponseHeader)

חובה: כותרת נפוצה לכל התשובות.
result

object (GetDisputeInquiryReportResult)

חובה: התוצאה של השיחה הזו.

ResponseHeader

אובייקט כותרת שמוגדר בכל התגובות שנשלחות מהשרת.

ייצוג JSON 
{
  "responseTimestamp": {
    object (Timestamp)
  }
}
שדות
responseTimestamp

object (Timestamp)

חובה: חותמת הזמן של התשובה הזו. המקבל חייב לוודא שחותמת הזמן הזו היא ± 60 שניות של 'עכשיו' ולדחות את התשובה אם היא לא נכונה.

GetDisputeInquiryReportResult

ייצוג JSON 
{

  // Union field result can be only one of the following:
  "success": {
    object (SuccessDetails)
  },
  "paymentNotFound": {
    object (Empty)
  },
  "paymentTooOld": {
    object (Empty)
  },
  "orderCannotBeReturned": {
    object (Empty)
  },
  "noAdditionalDetails": {
    object (Empty)
  }
  // End of list of possible types for union field result.
}
שדות

שדה איחוד result.

הערך של result יכול להיות רק אחת מהאפשרויות הבאות:
success

object (SuccessDetails)

התשלום נמצא ונשלח דוח.
paymentNotFound

object (Empty)

התשלום המבוקש לא נמצא.
paymentTooOld

object (Empty)

התשלום המבוקש נמצא, אבל לא סופק דוח בגלל גיל התשלום.
orderCannotBeReturned

object (Empty)

התשלום המבוקש שייך להזמנה קיימת, אך לא ניתן להחזירו. הסיבות כוללות מקרים שבהם ההזמנה הוסרה לבקשת הבעלים.

noAdditionalDetails

object (Empty)

התשלום המבוקש נמצא, אבל אין דוח.

SuccessDetails

ייצוג JSON 
{
  "googleClaimId": string,
  "report": {
    object (PurchaseReport)
  }
}
שדות
googleClaimId

string

חובה: מחרוזת ש-Google יוצרת ומזהה באופן ייחודי את המחלוקת של הלקוח.

אם השדה existingGoogleClaimId היה מאוכלס בבקשה, הערך יהיה זהה. אחרת, יהיה ערך חדש שנוצר. אפשר לספק את הערך הזה בבקשות עתידיות של getDisputeInquiryReport אם הן חלק מאותו ערעור של הלקוח.
report

object (PurchaseReport)

נדרש: פרטים שרלוונטיים לערעור על התשלום שצוין בבקשה.

PurchaseReport

דוח שמכיל פרטים רלוונטיים לגבי הרכישה שמשויכת לתשלום המבוקש.

ייצוג JSON 
{
  "customerAccount": {
    object (CustomerAccount)
  },
  "order": {
    object (Order)
  },
  "payment": {
    object (Payment)
  }
}
שדות
customerAccount

object (CustomerAccount)

חובה: מידע בנוגע ללקוח ולחשבון שלו.
order

object (Order)

אופציונלי: מידע בנוגע להזמנה שבה בוצע התשלום. לא זמין בכל דוחות הרכישה.
payment

object (Payment)

חובה: מידע בנוגע לתשלום. הערה: אפשר לבצע כמה תשלומים בהזמנה אחת, אבל יופיע רק מידע על התשלום שזוהה בבקשה המקורית.

CustomerAccount

מידע על החשבון של הלקוח.

ייצוג JSON 
{
  "customerEmail": string,
  "customerName": string
}
שדות
customerEmail

string

אופציונלי: כתובת האימייל המשויכת לחשבון Google של הלקוח.
customerName

string

חובה: שם הלקוח.

הזמנה

מידע על ההזמנה.

ייצוג JSON 
{
  "timestamp": {
    object (Timestamp)
  },
  "orderId": string,
  "subTotalAmount": {
    object (Amount)
  },
  "totalAmount": {
    object (Amount)
  },
  "shippingAddress": {
    object (Address)
  },
  "items": [
    {
      object (Item)
    }
  ],
  "taxes": [
    {
      object (Tax)
    }
  ]
}
שדות
timestamp

object (Timestamp)

חובה: חותמת הזמן של מועד ביצוע ההזמנה.
orderId

string

חובה: מחרוזת המזהה את הסדר הזה באופן ייחודי.
subTotalAmount

object (Amount)

חובה: הסכום הכולל של ההזמנה לפני מס.
totalAmount

object (Amount)

חובה: הסכום הכולל של ההזמנה, כולל מס.
shippingAddress

object (Address)

אופציונלי: כתובת למשלוח של הפריטים הפיזיים בהזמנה.
items[]

object (Item)

חובה: רשימת פריטים שהיו חלק מהזמנה זו.
taxes[]

object (Tax)

חובה: רשימת המיסים שהיו חלק מהזמנה זו. יכול להיות שהרשימה הזו ריקה.

Amount

משייכת סכום במיליוניות השנייה לקוד מטבע.

ייצוג JSON 
{
  "amountMicros": string,
  "currencyCode": string
}
שדות
amountMicros

string (Int64Value format)

חובה: סכום במיקרו.
currencyCode

string

חובה: קוד מטבע בן 3 אותיות לפי תקן ISO 4217

כתובת

מבנה שמכיל מידע על כתובת פיזית.

ייצוג JSON 
{
  "addressLine": [
    string
  ],
  "localityName": string,
  "administrativeAreaName": string,
  "postalCodeNumber": string,
  "countryCode": string
}
שדות
addressLine[]

string

אופציונלי: שדה זה כולל טקסט כתובת לא מובנה.
localityName

string

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

דוגמאות: עיר בארה"ב, קומוניית IT, עיר דואר בבריטניה.
administrativeAreaName

string

אופציונלי: חלוקת משנה מנהלית ברמה העליונה של המדינה הזו. דוגמאות: מדינה בארה"ב, אזור IT, מחוז CN, מחוז יפן."
postalCodeNumber

string

אופציונלי: למרות השם, בדרך כלל הערכים של postCodeNumber הם אלפאנומריים. דוגמאות: 94043, SW1W, SW1W 9TQ.
countryCode

string

אופציונלי: קוד המדינה של כתובת הלקוח, הצפוי להיות ISO-3166-1 Alpha-2.

פריט

מידע על הפריט שבהזמנה.

ייצוג JSON 
{
  "description": string,
  "merchant": string,
  "quantity": string,
  "totalPrice": {
    object (Amount)
  },
  "googleProductName": string
}
שדות
description

string

חובה: תיאור של הפריט שנרכש.
merchant

string

חובה: המוכר, האומן או היוצר של הפריט.
quantity

string (Int64Value format)

אופציונלי: הכמות שהוזמנה מהפריט.

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

object (Amount)

חובה: המחיר הכולל של הפריט.
googleProductName

string

חובה: שם שירות המוצר של Google עבור הפריט.

מס

מידע על מס שחל על הזמנה זו.

ייצוג JSON 
{
  "description": string,
  "amount": {
    object (Amount)
  }
}
שדות
description

string

חובה: תיאור של המס.
amount

object (Amount)

חובה: סכום המס.

תשלום

מידע על התשלום

ייצוג JSON 
{
  "billingAddress": {
    object (Address)
  },
  "amount": {
    object (Amount)
  },
  "refunds": [
    {
      object (Refund)
    }
  ],

  // Union field fopDetails can be only one of the following:
  "cardDetails": {
    object (PaymentCardDetails)
  }
  // End of list of possible types for union field fopDetails.
}
שדות
billingAddress

object (Address)

חובה: כתובת לחיוב שמשויכת לתשלום הזה.
amount

object (Amount)

חובה: סכום התשלום הזה.
refunds[]

object (Refund)

חובה: רשימת ההחזרים הכספיים שבוצעו לתשלום הזה. יכול להיות שהרשימה הזו ריקה.

שדה איחוד fopDetails.

הערך של fopDetails יכול להיות רק אחת מהאפשרויות הבאות:
cardDetails

object (PaymentCardDetails)

אופציונלי: פרטי תשלום ספציפיים לחשבונות של כרטיסי אשראי וכרטיסי חיוב מיידי.

החזר כספי

מידע על החזר כספי במהלך תשלום.

ייצוג JSON 
{
  "amount": {
    object (Amount)
  },
  "initiatedTimestamp": {
    object (Timestamp)
  }
}
שדות
amount

object (Amount)

חובה: הסכום שניתן בהחזר כספי.
initiatedTimestamp

object (Timestamp)

חובה: חותמת הזמן של מועד ביצוע ההחזר הכספי.

PaymentCardDetails

פרטי תשלום ספציפיים לכרטיסי אשראי וכרטיסי חיוב מיידי.

ייצוג JSON 
{
  "authResult": enum (AuthResult)
}
שדות
authResult

enum (AuthResult)

חובה: תוצאה של אימות תשלום.

AuthResult

תוצאות של אימות תשלום.

טיפוסים בני מנייה (enums)
UNKNOWN_RESULT אין להגדיר את ערך ברירת המחדל הזה אף פעם.
APPROVED האימות אושר.
DENIED האימות נדחה.
NOT_ATTEMPTED לא בוצע ניסיון אימות.

ריק

אין שדות בסוג הזה.

האובייקט הזה משמש להרחבה כי לעיתים קרובות צריך להרחיב בוליאנים וספירות עם נתונים נוספים. ההטמעה משתמשת בו כדי לקבוע את הנוכחות. ניתן להרחיב את הספירה שמייצגת כך שתכלול נתונים בגרסאות עתידיות.

ייצוג ה-JSON של Empty הוא אובייקט JSON ריק {}.

ErrorResponse

אובייקט של תגובת שגיאה בכל השיטות.

ייצוג JSON 
{
  "responseHeader": {
    object (ResponseHeader)
  },
  "errorDescription": string,
  "paymentIntegratorErrorIdentifier": string,
  "errorResponseResult": {
    object (ErrorResponseResult)
  }
}
שדות
responseHeader

object (ResponseHeader)

חובה: כותרת נפוצה לכל התשובות.
errorDescription

string

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

string

אופציונלי: המזהה הזה הוא ספציפי למבצע השילוב, והוא נוצר על ידי מבצע השילוב. הוא משמש למטרות ניפוי באגים בלבד כדי לזהות את השיחה. זהו המזהה שלפיו מבצע השילוב יודע את הקריאה הזו.
errorResponseResult

object (ErrorResponseResult)

אופציונלי: קוד שמתעד את סוג השגיאה שהתרחשה.

ErrorResponseResult

קודי שגיאות

ייצוג JSON 
{

  // Union field result can be only one of the following:
  "invalidApiVersion": {
    object (InvalidApiVersion)
  },
  "invalidPayloadSignature": {
    object (InvalidPayloadSignature)
  },
  "invalidPayloadEncryption": {
    object (InvalidPayloadEncryption)
  },
  "requestTimestampOutOfRange": {
    object (RequestTimestampOutOfRange)
  },
  "invalidIdentifier": {
    object (InvalidIdentifier)
  },
  "idempotencyViolation": {
    object (IdempotencyViolation)
  },
  "invalidFieldValue": {
    object (InvalidFieldValue)
  },
  "missingRequiredField": {
    object (MissingRequiredField)
  },
  "preconditionViolation": {
    object (PreconditionViolation)
  },
  "userActionInProgress": {
    object (UserActionInProgress)
  },
  "invalidDecryptedRequest": {
    object (InvalidDecryptedRequest)
  },
  "forbidden": {
    object (Forbidden)
  }
  // End of list of possible types for union field result.
}
שדות

שדה איחוד result.

הערך של result יכול להיות רק אחת מהאפשרויות הבאות:
invalidApiVersion

object (InvalidApiVersion)

משמש אם גרסת ה-API של הבקשה אינה נתמכת. קוד HTTP מומלץ: 400
invalidPayloadSignature

object (InvalidPayloadSignature)

משמש אם החתימה של המטען הייעודי (payload) היא במפתח לא ידוע או לא פעיל. קוד HTTP מומלץ: 401
invalidPayloadEncryption

object (InvalidPayloadEncryption)

משמש אם ההצפנה של המטען הייעודי היא מפתח לא ידוע או לא פעיל. קוד HTTP מומלץ: 400
requestTimestampOutOfRange

object (RequestTimestampOutOfRange)

משמש אם ה- requestTimestamp לא מוגדר ל-± 60 שניות מעכשיו. קוד HTTP מומלץ: 400
invalidIdentifier

object (InvalidIdentifier)

משמש אם מזהה שנשלח בבקשה לא היה חוקי או לא ידוע. קוד זה עשוי לכלול PIAID, captureRequestId, Google Payment Token וכו'. קוד HTTP מומלץ: 404
idempotencyViolation

object (IdempotencyViolation)

משמש אם הבקשה מפרה את דרישות הזיהוי של הבקשה. קוד HTTP מומלץ: 412
invalidFieldValue

object (InvalidFieldValue)

משמש אם הבקשה מכילה ערך בשדה שלא נכלל בקבוצת הערכים הנתמכים. קוד HTTP מומלץ: 400
missingRequiredField

object (MissingRequiredField)

משמש אם שדה חובה לא מוגדר בבקשה. קוד HTTP מומלץ: 400
preconditionViolation

object (PreconditionViolation)

משמש במקרה שבו מופרת מגבלה על הפעולה (למשל, כשבקשה להחזר כספי גבוהה מהסכום שנותר בעסקה). קוד HTTP מומלץ: 400
userActionInProgress

object (UserActionInProgress)

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

object (InvalidDecryptedRequest)

משמש אם ניתן לפענח את המטען הייעודי של הבקשה, אבל לא ניתן היה לנתח את ההודעה שהתקבלה. קוד HTTP מומלץ: 400
forbidden

object (Forbidden)

הגישה למשאב המבוקש אסורה. קוד Http מומלץ: 403

InvalidApiVersion

ייצוג JSON 
{
  "requestVersion": {
    object (Version)
  },
  "expectedVersion": {
    object (Version)
  }
}
שדות
requestVersion

object (Version)

נדרשת: הגרסה הלא חוקית שצוינה בבקשה.
expectedVersion

object (Version)

נדרשת: הגרסה הצפויה.

InvalidPayloadSignature

אין שדות בסוג הזה.

ההודעה הזו ריקה בכוונה כרגע. אפשר להוסיף שדות חדשים בעתיד.

InvalidPayloadEncryption

אין שדות בסוג הזה.

ההודעה הזו ריקה בכוונה כרגע. אפשר להוסיף שדות חדשים בעתיד.

RequestTimestampOutOfRange

ייצוג JSON 
{
  "requestTimestamp": {
    object (Timestamp)
  },
  "serverTimestampAtReceipt": {
    object (Timestamp)
  }
}
שדות
requestTimestamp

object (Timestamp)

חובה: חותמת הזמן שצוינה בבקשה
serverTimestampAtReceipt

object (Timestamp)

חובה: שעת הקבלה של השרת, המשמשת להשוואה

InvalidIdentifier

ייצוג JSON 
{
  "invalidIdentifierType": string
}
שדות
invalidIdentifierType

string

חובה: סוג המזהה לא היה חוקי, למשל PIAID, captureRequestId וכו'.

IdempotencyViolation

אין שדות בסוג הזה.

ההודעה הזו ריקה בכוונה כרגע. אפשר להוסיף שדות חדשים בעתיד.

InvalidFieldValue

ייצוג JSON 
{
  "invalidFieldName": string
}
שדות
invalidFieldName

string

חובה: שם השדה שנמצא לא חוקי.

MissingRequiredField

ייצוג JSON 
{
  "missingFieldNames": [
    string
  ]
}
שדות
missingFieldNames[]

string

חובה: שמות השדות החסרים.

PreconditionViolation

אין שדות בסוג הזה.

ההודעה הזו ריקה בכוונה כרגע. אפשר להוסיף שדות חדשים בעתיד.

UserActionInProgress

אין שדות בסוג הזה.

ההודעה הזו ריקה בכוונה כרגע. אפשר להוסיף שדות חדשים בעתיד.

InvalidDecryptedRequest

אין שדות בסוג הזה.

ההודעה הזו ריקה בכוונה כרגע. אפשר להוסיף שדות חדשים בעתיד.

אסור

אין שדות בסוג הזה.

ההודעה הזו ריקה בכוונה כרגע. אפשר להוסיף שדות חדשים בעתיד.