Method: disburseFunds

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

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

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


{
  "requestHeader": {
    "protocolVersion": {
      "major": 1,
      "minor": 0,
      "revision": 0
    },
    "requestId": "liUrreQY233839dfFFb24gaQM",
    "requestTimestamp": "1502220434778"
  },
  "paymentIntegratorAccountId": "InvisiCashUSA_USD",
  "upiDetails": {
      "vpa": "foo@icici"
  },
  "transactionDescription": "Google - Music",
  "currencyCode": "INR",
  "amount": "208000000"
}

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


{
  "responseHeader": {
    "responseTimestamp": "1481900013178"
  },
  "paymentIntegratorTransactionId": "aW50ZWdyYXRvciB0cmFuc2FjdGlvbiBpZA",
  "disburseFundsResult": {
    "disburseFundsResultCode": "SUCCESS"
  }
}

בקשת HTTP

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

גוף הבקשה

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

ייצוג JSON 
{
  "requestHeader": {
    object (RequestHeader)
  },
  "paymentIntegratorAccountId": string,
  "transactionDescription": string,
  "currencyCode": string,
  "amount": string,

  // Union field destinationFopDetails can be only one of the following:
  "upiDetails": {
    object (UpiDetails)
  }
  // End of list of possible types for union field destinationFopDetails.
}
שדות
requestHeader

object (RequestHeader)

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

string

חובה: זהו מזהה החשבון של הכלי לשילוב תשלומים שמזהה מגבלות חוזיות סביב העסקה הזו.
transactionDescription

string

חובה: זהו התיאור של העסקה שניתן להציג בדף החשבון של הלקוח. מותאם לשוק המקומי של המשתמש שנמצא ב-requestHeader. אפשר לשנות את הפורמט הזה ללא הודעה מראש ולא לנתח אותו אף פעם.
currencyCode

string

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

string (Int64Value format)

חובה: סכום הרכישה, במיקרו של יחידת המטבע.

שדה איחוד destinationFopDetails.

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

object (UpiDetails)

אופציונלי: פרטי תשלום ספציפיים לאמצעי UPI.

גוף התגובה

אובייקט תגובה של השיטה 'תשלום כספי'.

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

ייצוג JSON 
{
  "responseHeader": {
    object (ResponseHeader)
  },
  "paymentIntegratorTransactionId": string,
  "disburseFundsResult": {
    object (DisburseFundsResult)
  }
}
שדות
responseHeader

object (ResponseHeader)

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

string

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

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

object (DisburseFundsResult)

חובה: תוצאת השיחה עם העברת הכספים.

UpiDetails

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

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

string

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

DisburseFundsResult

מידע על התוצאה הסופית של תשלום.

ייצוג JSON 
{
  "disburseFundsResultCode": enum (DisburseFundsResultCode),
  "rawResult": {
    object (RawResult)
  },

  // Union field FailureDetail can be only one of the following:
  "transactionMaxLimit": string,
  "transactionMinLimit": string
  // End of list of possible types for union field FailureDetail.
}
שדות
disburseFundsResultCode

enum (DisburseFundsResultCode)

חובה: קוד התוצאה של התשלום הזה.
rawResult

object (RawResult)

אופציונלי: תוצאה גולמית של התשלום הזה. הנתונים משמשים לקבלת מידע על מנגנון הסיכונים וניתוח הסיכונים של Google. במצבים של מיפוי קוד סירוב, לפעמים נתונים אובדים נתונים. מבצע השילוב יכול לבחור לתת ל-Google קוד גולמי. לדוגמה, שער כרטיס אשראי (המבצע השילוב) עשוי להשתמש בשדה הזה כדי להעביר ל-Google את קוד הדחייה המדויק שהתקבל מרשת VISA. במקרה כזה, הערך של scope יהיה "Visa" ו-rawCode יהיה הערך שהחזירה רשת ה-VISA.

הערך הזה הוא חובה אם הערך של result אינו SUCCESS.

שדה איחוד FailureDetail.

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

string (Int64Value format)

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

הסכום הזה הוא מיקרו- של אותו currencyCode כמו הקריאה המקורית ל-method disburseFunds.
transactionMinLimit

string (Int64Value format)

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

הסכום הזה הוא מיקרו- של אותו currencyCode כמו הקריאה המקורית ל-method disburseFunds.

DisburseFundsResultCode

קודים של תוצאות של שיחה עם כספי תשלום.

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

RawResult

אובייקט תוצאה גולמית.

ייצוג JSON 
{
  "scope": string,
  "rawCode": string
}
שדות
scope

string

אופציונלי: היקף הקוד של RAW, יכול להיות ריק.
rawCode

string

חובה: קוד גולמי מהמשלבים או מתת-המערכת שבתוכה.