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

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

IsReadyToPayResponse

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

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

אם true, למבקר יש אמצעי תשלום אחד או יותר כפי שמצוין במאפיין allowedPaymentMethods של IsReadyToPayRequest שסופק.

הפרמטר הזה קיים רק אם הערך של existingPaymentMethodRequired הוגדר ל-true ב- IsReadyToPayRequest.

אם PaymentsClient מאותחל עם מאפיין environment של TEST, אמצעי התשלום תמיד נחשב כקיים.

דוגמה

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

{
  "result": true
}

PaymentData

זהו אובייקט תגובה שמוחזר על ידי Google אחרי שהמשלם מאשר את התשלום.

PaymentDataRequest.PaymentDataRequest.PaymentDataRequest.
נכס סוג תמיד קיים תיאור
apiVersion number כן הגרסה הראשית של ה-API. הערך בתשובה זהה לערך שצוין ב- PaymentDataRequest.
apiVersionMinor number כן גרסה משנית של ה-API. הערך בתשובה זהה לערך שצוין ב- PaymentDataRequest.
paymentMethodData PaymentMethodData כן נתונים על אמצעי התשלום שנבחר.
email מחרוזת לא כתובת אימייל, אם הערך של emailRequired הוא true ב- PaymentDataRequest. אם בקשה אחרת מגדירה את המאפיין לערך true, לא תהיה לכך השפעה.
shippingAddress הכתובת לא כתובת למשלוח, אם הערך של shippingAddressRequired הוא true ב- PaymentDataRequest.

דוגמה

בדוגמה הזו של תגובה לגרסה 2.0 של Google Pay API מוצג CARD אמצעי תשלום שנבחר בגיליון התשלום של Google Pay. נוצר טוקן של אמצעי תשלום עבור שער התשלומים example.

{
  "apiVersion": 2,
  "apiVersionMinor": 0,
  "paymentMethodData": {
    "type": "CARD",
    "description": "Visa •••• 1234",
    "info": {
      "cardNetwork": "VISA",
      "cardDetails": "1234",
      "cardFundingSource": "CREDIT"
    },
    "tokenizationData": {
      "type": "PAYMENT_GATEWAY",
      "token": "examplePaymentMethodToken"
    }
  }
}

IntermediatePaymentData

האובייקט הזה מוחזר על ידי קלט onPaymentDataChanged() של Google Pay API כשכתובת המשלוח או אפשרויות המשלוח משתנות בדף התשלום.

נכס סוג הכרח תיאור
callbackTrigger מחרוזת אופציונלי

תיאור הסיבה להפעלת קריאה חוזרת (callback) של נתוני התשלום.

  • INITIALIZE
  • SHIPPING_ADDRESS
  • SHIPPING_OPTION
  • OFFER
offerData OfferData אופציונלי קוד השובר שהמשתמש סיפק.
shippingAddress IntermediateAddress אופציונלי הכתובת שנבחרה בדף התשלום.
shippingOptionData SelectionOptionData אופציונלי אפשרות המשלוח שנבחרה בדף התשלום.

דוגמה

בדוגמה הזו מוצג מטען ייעודי (payload) ביניים שמוחזר מ-Google Pay API.

{
  "callbackTrigger": "SHIPPING_ADDRESS",
  "offerData": {
    "redemptionCode": "exampleCode"
  },
  "shippingAddress": {
    "administrativeArea": "NY",
    "countryCode": "US",
    "locality": "New York",
    "postalCode": "10011"
  },
  "shippingOptionData": {
    "id": "shipping-001"
  }
}

PaymentMethodData

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

נכס סוג תמיד קיים תיאור
type מחרוזת כן PaymentMethod type נבחר בדף התשלום של Google Pay. ‫
description מחרוזת כן

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

דוגמה

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

{
  "type": "CARD",
  "description": "Visa •••• 1234",
  "info": {
    "cardNetwork": "VISA",
    "cardDetails": "1234"
  },
  "tokenizationData": {
    "type": "PAYMENT_GATEWAY",
    "token": "examplePaymentMethodToken"
  }
}

CardInfo

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

נכס סוג תמיד קיים תיאור
cardDetails מחרוזת כן הפרטים על הכרטיס. בדרך כלל זה הערך של ארבע הספרות האחרונות של מספר חשבון התשלומים שנבחר.
assuranceDetails AssuranceDetailsSpecifications כן האובייקט הזה מספק מידע על האימות שבוצע בנתוני התשלום שהוחזרו אם הערך של assuranceDetailsRequired הוא true ב- CardParameters.
cardNetwork מחרוזת כן

חברת האשראי של התשלום שנבחר. הערכים שמוחזרים תואמים לפורמט של allowedCardNetworks ב- [CardParameters].

הערך של רשת הכרטיסים הזו לא צריך להיות מוצג לקונה. הוא משמש כשצריך את פרטי הכרטיס של הקונה. לדוגמה, אם צוות תמיכת הלקוחות צריך את הערך הזה כדי לזהות את הכרטיס שבו הקונה השתמש לעסקה. כדי להציג למשתמש תיאור, צריך להשתמש במאפיין description של PaymentMethodData.
billingAddress הכתובת לא הכתובת לחיוב שמשויכת לאמצעי התשלום שצוין, אם הערך של billingAddressRequired הוא true ב- CardParameters.
cardFundingSource מחרוזת כן

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

  • UNKNOWN
  • CREDIT
  • DEBIT
  • PREPAID

דוגמה

בדוגמה הזו מוצג כרטיס ברשת ויזה.

{
  "cardNetwork": "VISA",
  "cardDetails": "1234",
  "cardFundingSource": "CREDIT",
  "assuranceDetails": {
    "cardHolderAuthenticated": false,
    "accountVerified": true
  }
}

AssuranceDetailsSpecifications

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

שם סוג תיאור
accountVerified בוליאני אם true, מציין שבוצע אימות בעלות על פרטי הכניסה לתשלום שהוחזרו Cardholder.
cardHolderAuthenticated בוליאני

אם true, מציין שבוצעו זיהוי ואימות (ID&V) של פרטי התשלום שהוחזרו.

אם false, אפשר לבצע את אותו אימות מבוסס-סיכונים כמו בעסקאות בכרטיס. אימות מבוסס-סיכון יכול לכלול, בין היתר, אימות נוסף באמצעות פרוטוקול 3D Secure, אם רלוונטי.

אתם יכולים לקבל ולעבד את אובייקט התגובה גם אם אתם לא משתמשים בשדה assuranceDetails. כדי לקבל את האובייקט הזה, צריך לכלול את assuranceDetailsRequired: true באובייקט Request של CardParameters.

PaymentMethodTokenizationData

האובייקט הזה מספק נתוני טוקניזציה של אמצעי התשלום.

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

האסימון של אמצעי התשלום שנוצר.

דוגמה

זוהי דוגמה לתשובה עם טוקנים שהוכנה עבור שער example.

{
  "type": "PAYMENT_GATEWAY",
  "token": "examplePaymentMethodToken"
}

PaymentAuthorizationResult

האובייקט הזה מספק מידע על תוצאת אישור התשלום.

נכס סוג הכרח תיאור
transactionState מחרוזת חובה סטטוס העסקה נקבע לפי אחת מהתוצאות הבאות של המוכר:
  • SUCCESS
  • ERROR
error PaymentDataError אופציונלי השגיאה שתוצג בגיליון התשלום למשתמש כשצריך לנסות שוב לבצע את התשלום.

דוגמה

בדוגמה הבאה מוצגת התוצאה של התשלום שמוחזרת אחרי עיבוד התשלום:

{
  "transactionState": "ERROR",
  "error": {
    "reason": "PAYMENT_DATA_INVALID",
    "message": "Cannot pay with payment credentials",
    "intent": "PAYMENT_AUTHORIZATION"
  }
}

PaymentDataError

נכס סוג הכרח תיאור
reason מחרוזת חובה

רשימה של סיבות מוגדרות מראש לשגיאות:

  • OFFER_INVALID
  • PAYMENT_DATA_INVALID
  • SHIPPING_ADDRESS_INVALID
  • SHIPPING_ADDRESS_UNSERVICEABLE
  • SHIPPING_OPTION_INVALID
  • OTHER_ERROR
message מחרוזת חובה הודעת שגיאה שמוצגת למשתמש בתיבת דו-שיח.
intent מחרוזת חובה

הכוונה של השגיאה. החשבון צריך להיות חשבון שרשום ב-PaymentDataRequest מההתחלה של התהליך.

  • OFFER
  • PAYMENT_AUTHORIZATION
  • SHIPPING_ADDRESS
  • SHIPPING_OPTION

דוגמה

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

{
  "error": {
    "reason": "SHIPPING_OPTION_INVALID",
    "message": "This shipping option is invalid for the given address",
    "intent": "SHIPPING_OPTION"
  }
}

כתובת

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

אפשר להחזיר כתובות בפורמטים MIN,‏ FULL ו-FULL-ISO3166. בטבלה הבאה אפשר לראות את המאפיינים ששייכים לכל פורמט.

נכס פורמט הכתובת תיאור
name MIN,‏ FULL,‏ FULL-ISO3166 השם המלא של הנמען.
postalCode MIN,‏ FULL,‏ FULL-ISO3166 המיקוד.
countryCode MIN,‏ FULL,‏ FULL-ISO3166 קוד מדינה בפורמט ISO 3166-1 alpha-2.
phoneNumber MIN,‏ FULL,‏ FULL-ISO3166 מספר טלפון, אם הערך של phoneNumberRequired מוגדר ל-true ב- PaymentDataRequest.
address1 FULL, FULL-ISO3166 השורה הראשונה של הכתובת.
address2 FULL, FULL-ISO3166 השורה השנייה של הכתובת.
address3 FULL, FULL-ISO3166 השורה השלישית של הכתובת.
locality FULL, FULL-ISO3166 עיר, יישוב, שכונה או פרבר.
administrativeArea FULL, FULL-ISO3166 חלוקה משנית של מדינה, כמו מדינה (State) או מחוז.
sortingCode FULL, FULL-ISO3166 קוד המיון.
iso3166AdministrativeArea FULL-ISO3166 קוד אזור מנהלי לפי תקן ISO 3166-2, שמתאים לערך של administrativeArea.

דוגמה

זו דוגמה לפורמט FULL-ISO3166 של כתובת בארצות הברית עם כמה שורות של נתוני כתובת.

{
  "name": "John Doe",
  "address1": "c/o Google LLC",
  "address2": "1600 Amphitheatre Pkwy",
  "address3": "Building 40",
  "locality": "Mountain View",
  "administrativeArea": "CA",
  "countryCode": "US",
  "postalCode": "94043",
  "sortingCode": ""
  "iso3166AdministrativeArea": "US-CA"
}

IntermediateAddress

נכס סוג הכרח תיאור
administrativeArea מחרוזת חובה חלוקה משנית של מדינה, כמו מדינה (State) או מחוז.
countryCode מחרוזת חובה קוד מדינה בפורמט ISO 3166-1 alpha-2.
locality מחרוזת חובה עיר, יישוב, שכונה או פרבר.
postalCode מחרוזת חובה המיקוד שצונזר על סמך המדינה. בקנדה ובבריטניה, הערך הזה מכיל רק את שלושת התווים הראשונים. בארה"ב, הערך הזה מכיל את חמש הספרות הראשונות.
iso3166AdministrativeArea מחרוזת אופציונלי קוד אזור מנהלי לפי תקן ISO 3166-2, שמתאים לערך של administrativeArea. מוצג רק אם הפורמט של כתובת המשלוח הוא FULL-ISO3166.

דוגמה

בדוגמה הזו אפשר לראות את הכתובת שנבחרה בדף התשלום.

{
  "administrativeArea": "NY",
  "countryCode": "US",
  "locality": "New York",
  "postalCode": "10011"
  "iso3166AdministrativeArea": "US-NY"
}

SelectionOptionData

נכס סוג הכרח תיאור
id מחרוזת חובה התאמות עם SelectionOption.id

דוגמה

בדוגמה הזו מוצגת אפשרות המשלוח שנבחרה בדף התשלום.

{
  "id": "shipping-001"
}

OfferData

האובייקט הזה מספק מידע על קוד מבצע שהוזן בדף התשלום.

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

דוגמה

בדוגמה הבאה מוצג אובייקט OfferData עם מערך redemptionCodes.

"offerData": {
    "redemptionCodes": ["PROMOTIONALCODE"]
}