Method: refund

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

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

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


{
  "requestHeader": {
    "protocolVersion": {
      "major": 1,
      "minor": 0,
      "revision": 0
    },
    "requestId": "liUrreQY233839dfFFb24gaQM",
    "requestTimestamp": "1502220434778"
  },
  "paymentIntegratorAccountId": "InvisiCashUSA_USD",
  "captureRequestId": "bWVyY2hhbnQgdHJhbnNhY3Rpb24gaWQ",
  "currencyCode": "INR",
  "refundAmount": "208000000"
}

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


{
  "responseHeader": {
    "responseTimestamp": "1481900013178"
  },
  "result": "SUCCESS",
  "paymentIntegratorRefundId": "cmVmdW5kIGlkZW50aWZpZXINCg"
}

בקשת HTTP

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

גוף הבקשה

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

ייצוג JSON 
{
  "requestHeader": {
    object (RequestHeader)
  },
  "paymentIntegratorAccountId": string,
  "captureRequestId": string,
  "currencyCode": string,
  "refundAmount": string
}
שדות
requestHeader

object (RequestHeader)

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

string

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

string

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

string

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

string (Int64Value format)

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

גוף התשובה

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

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

ייצוג JSON 
{
  "responseHeader": {
    object (ResponseHeader)
  },
  "paymentIntegratorRefundId": string,
  "result": enum (RefundResultCode),
  "rawResult": {
    object (RawResult)
  }
}
שדות
responseHeader

object (ResponseHeader)

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

string

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

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

enum (RefundResultCode)

חובה: תוצאה של החזר כספי זה.
rawResult

object (RawResult)

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

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

קוד החזר כספי

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

טיפוסים בני מנייה (enum)
UNKNOWN_RESULT אני לא רוצה להגדיר את ערך ברירת המחדל הזה!
SUCCESS ההחזר הכספי בוצע בהצלחה.
NO_MONEY_LEFT_ON_TRANSACTION גרסה 1.refund נכשלה. לא נשאר כסף לעסקה. בדרך כלל מדובר על באג בין המספר המשולב ל-Google. אין לבקש מ-Google לבצע החזר כספי בסכום הגבוה מהסכום שבצילום המקורי.
ACCOUNT_CLOSED

החשבון שהוחזר למספר הטלפון נסגר.

אם הוא יוחזר, אמצעי התשלום של המשתמש ייסגר עם Google. המשתמש ייאלץ להוסיף אמצעי חדש על ידי ביצוע שוב של תהליך השיוך.
ACCOUNT_CLOSED_ACCOUNT_TAKEN_OVER

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

אם הוא יוחזר, אמצעי התשלום של המשתמש ייסגר עם Google. המשתמש ייאלץ להוסיף אמצעי חדש על ידי ביצוע שוב של תהליך השיוך.
ACCOUNT_CLOSED_FRAUD

החשבון של המשתמש שמשלב את החשבון נסגר בגלל הונאה.

אם הוא יוחזר, אמצעי התשלום של המשתמש ייסגר עם Google. המשתמש ייאלץ להוסיף אמצעי חדש על ידי ביצוע שוב של תהליך השיוך.
ACCOUNT_ON_HOLD החשבון של המשתמש נמצא כרגע בהמתנה ולא יכול לקבל את ההחזר הכספי, אבל ייתכן שהמשתמש יוכל לקבל את ההחזר הכספי במועד מאוחר יותר. Google עשויה לבקש החזר כספי נוסף בעתיד, אבל היא תעשה זאת עם requestId חדש, לכן הבקשה הזו נחשבת כהושלמה.
REFUND_EXCEEDS_MAXIMUM_BALANCE לא ניתן לעבד את ההחזר הכספי בשלב זה, מכיוון שפעולה זו תגרום ליתרה של המשתמש לחרוג מהסכום המקסימלי המותר. Google עשויה לבקש החזר כספי נוסף בעתיד, אבל היא תעשה זאת עם requestId חדש, לכן הבקשה הזו נחשבת כהושלמה.
REFUND_WINDOW_EXCEEDED לא ניתן לעבד את ההחזר הכספי מפני שהבקשה חורגת מתקופת ההחזר הכספי המותרת.