דף זה תורגם על ידי Cloud Translation API.

Method: asynchronousCapture

בקשת HTTP
גוף הבקשה
- ייצוג JSON
גוף התשובה
- ייצוג JSON
UpiDetails
- ייצוג JSON
TokenizedInstrumentDetails
- ייצוג JSON
AsynchronousCaptureResultCode

הפעלת הפעולה של העברת כספים בין חשבון הלקוח לבין מבצע השילוב. מבצע השילוב צריך לאשר את הבקשה ולבצע את כל הפעולות הדרושות כדי להשלים את ההקלטה (למשל, לקבל מהמשתמש קוד אימות). מבצע השילוב יודיע ל-Google על התוצאה הסופית של הצילום באמצעות קריאה ל-API של CaptureResultsNotification.

השילוב של requestId בכותרת ו-paymentIntegratorAccountId הוא מפתח המיקום, ומזהה באופן ייחודי את העסקה הזו. כל המוטציות בעסקה הזו (החזרים כספיים) מאכלסים את הערך requestId בשדה captureRequestId.

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

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


{
  "requestHeader": {
    "protocolVersion": {
      "major": 1,
      "minor": 1,
      "revision": 0
    },
    "requestId": "bWVyY2hhbnQgdHJhbnNhY3Rpb24gaWQ",
    "requestTimestamp": "1502220196077"
  },
  "paymentIntegratorAccountId": "InvisiCashIN_INR",
  "upiDetails": {
      "vpa": "foo@icici"
  },
  "transactionDescription": "Google - Music",
  "currencyCode": "INR",
  "amount": "728000000"
}

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


{
  "responseHeader": {
    "responseTimestamp": "1481900013178"
  },
  "result": "ACKNOWLEDGED",
  "paymentIntegratorTransactionId": "aW50ZWdyYXRvciB0cmFuc2FjdGlvbiBpZA"
}

בקשת HTTP

POST https://www.integratorhost.example.com/v1/asynchronousCapture

גוף הבקשה

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

ייצוג JSON

ייצוג JSON
{ "requestHeader": { object (`RequestHeader`) }, "paymentIntegratorAccountId": string, "transactionDescription": string, "currencyCode": string, "amount": string, // Union field `fopDetails` can be only one of the following: "upiDetails": { object (`UpiDetails`) }, "tokenizedInstrumentDetails": { object (`TokenizedInstrumentDetails`) } // End of list of possible types for union field `fopDetails`. }

{
  "requestHeader": {
    object (RequestHeader)
  },
  "paymentIntegratorAccountId": string,
  "transactionDescription": string,
  "currencyCode": string,
  "amount": string,

  // Union field fopDetails can be only one of the following:
  "upiDetails": {
    object (UpiDetails)
  },
  "tokenizedInstrumentDetails": {
    object (TokenizedInstrumentDetails)
  }
  // End of list of possible types for union field fopDetails.
}

שדות
`requestHeader`	`object (RequestHeader)` חובה: כותרת משותפת לכל הבקשות.
`paymentIntegratorAccountId`	`string` חובה: זהו מזהה החשבון של הכלי לשילוב תשלומים שמזהה מגבלות חוזיות סביב העסקה הזו.
`transactionDescription`	`string` חובה: זהו התיאור של העסקה שניתן להציג בדף החשבון של הלקוח. מותאם לשוק המקומי של המשתמש שנמצא ב-`requestHeader`. אפשר לשנות את הפורמט הזה ללא הודעה מראש ולא לנתח אותו אף פעם.
`currencyCode`	`string` חובה: קוד מטבע בן 3 אותיות לפי תקן ISO 4217
`amount`	`string (Int64Value format)` חובה: סכום הרכישה, במיליוניות השנייה של יחידת המטבע.
שדה איחוד `fopDetails`. הערך של `fopDetails` יכול להיות רק אחת מהאפשרויות הבאות:
`upiDetails`	`object (UpiDetails)` אופציונלי: פרטי תשלום ספציפיים לאמצעי UPI.
`tokenizedInstrumentDetails`	`object (TokenizedInstrumentDetails)` אופציונלי: פרטי תשלום ספציפיים לאמצעים שעברו הצפנה באמצעות אסימון (טוקניזציה).

גוף התגובה

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

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

ייצוג JSON
{ "responseHeader": { object (`ResponseHeader`) }, "paymentIntegratorTransactionId": string, "result": enum (`AsynchronousCaptureResultCode`) }

שדות

שדות
`responseHeader`	`object (ResponseHeader)` חובה: כותרת נפוצה לכל התשובות.
`paymentIntegratorTransactionId`	`string` חובה: המזהה הזה הוא ספציפי למבצע השילוב, והוא נוצר על ידי מבצע השילוב. זהו המזהה שלפיו מבצע השילוב יודע את העסקה הזו. לשם נוחות, המזהה הזה נכלל בפרטי ההעברה
`result`	`enum (AsynchronousCaptureResultCode)` חובה: התוצאה של שיחת לכידה אסינכרונית.

responseHeader

object (ResponseHeader)

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

paymentIntegratorTransactionId

string

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

לשם נוחות, המזהה הזה נכלל בפרטי ההעברה

result

enum (AsynchronousCaptureResultCode)

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

UpiDetails

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

ייצוג JSON
{ "vpa": string }

שדות

שדות
`vpa`	`string` חובה: הכתובת הווירטואלית לתשלום (VPA) של המשתמש, המשמשת להעברת כספים באמצעות פרוטוקול UPI. לדוגמה: foo@icici.

vpa

string

חובה: הכתובת הווירטואלית לתשלום (VPA) של המשתמש, המשמשת להעברת כספים באמצעות פרוטוקול UPI. לדוגמה: foo@icici.

TokenizedInstrumentDetails

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

ייצוג JSON
{ "googlePaymentToken": string }

שדות

שדות
`googlePaymentToken`	`string` חובה: האסימון הזה ישמש את שתי החברות כדי לזהות את החשבון שממנו מתבצעות רכישות בין החברות.

googlePaymentToken

string

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

AsynchronousCaptureResultCode

קודים של תוצאות עבור צילום אסינכרוני.

טיפוסים בני מנייה (enums)
`UNKNOWN_RESULT`	אל תגדיר את ערך ברירת המחדל הזה אף פעם!
`ACKNOWLEDGED`	יש בקשה לבצע את הלכידה, והמחבר יבצע שלבים נוספים כדי לקבוע אם הצילום הצליח או נדחה. לאחר שהמחבר יידע מה תוצאת הלכידה, הוא יודיע ל-Google על התוצאה באמצעות קריאה ל-API של `captureResultNotification`.
`ACCOUNT_CLOSED`	חשבון המשתמש אצל מבצע השילוב נסגר. החזרת הערך הזה תגרום לסגירה של הכלי של המשתמש ב-Google. המשתמש ייאלץ להוסיף אמצעי חדש על ידי חזרה על תהליך השיוך.
`ACCOUNT_CLOSED_ACCOUNT_TAKEN_OVER`	חשבון המשתמש אצל מבצע השילוב נסגר, חשד שהחשבון השתלט על. החזרת הערך הזה תגרום לסגירה של הכלי של המשתמש ב-Google. המשתמש ייאלץ להוסיף אמצעי חדש על ידי חזרה על תהליך השיוך.
`ACCOUNT_ON_HOLD`	החשבון מושהה.
`ACCOUNT_CLOSED_FRAUD`	חשבון המשתמש אצל מבצע השילוב נסגר עקב הונאה. החזרת הערך הזה תגרום לסגירה של הכלי של המשתמש ב-Google. המשתמש ייאלץ להוסיף אמצעי חדש על ידי חזרה על תהליך השיוך.