Method: remittanceStatementDetails

החזרת פרטי עסקה לגבי דוח העברות כספים.

זהו API עם חלוקה לדפים. אפשר לציין את מספר אירועי העסקאות בכל דף באמצעות numberOfEvents. אם לא מציינים ערך, המערכת תחזיר עד 1,000 אירועים בכל דף. כל בקשה ל-API הזה תחזיר nextEventOffset שמצביע על אירוע העסקה הבא בדף הפירוט, וגם totalEvents שמציין את המספר הכולל של העסקאות בדף הפירוט. אם הדף הנוכחי שאוחזר מכיל את העסקאות האחרונות של הדוח, התגובה לא תכלול את nextEventOffset.

הערך של statementId הוא requestId מתוך remittanceStatementNotificationRequest

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

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

דוגמה לבקשה:


{
  "requestHeader": {
    "protocolVersion": {
      "major": 1,
      "minor": 0,
      "revision": 0
    },
    "requestId": "statement_detail_request_139932019",
    "requestTimestamp": "1502551332087"
  },
  "paymentIntegratorAccountId": "InvisiCashUSA_USD",
  "statementId": "0123434-statement-abc",
  "numberOfEvents": 4
}

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


{
  "responseHeader": {
    "responseTimestamp": "1481900013178"
  },
  "eventOffset": 0,
  "nextEventOffset": 4,
  "totalEvents": 15,
  "remittanceStatementSummary": {
    "statementDate": "1502521200000",
    "billingPeriod": {
      "startDate": "1502434800000",
      "endDate": "1502434800000"
    },
    "dateDue": "1502348400000",
    "currencyCode": "INR",
    "totalDueByIntegrator": "1076000000",
    "remittanceInstructions": {
      "memoLineId": "stmt-1AB-pp0-invisi"
    }
  },
  "captureEvents": [
    {
      "eventRequestId": "bWVyY2hhbnQgdHJhbnNhY3Rpb24gaWQ",
      "paymentIntegratorEventId": "ioj32SOIjf23oijSDfoij",
      "eventCharge": "700000000",
      "eventFee": "-28000000"
    },
    {
      "eventRequestId": "Ggghvh78200PQ3Yrpb",
      "paymentIntegratorEventId": "iasdf23dSdfijSDfoij",
      "eventCharge": "800000000",
      "eventFee": "-32000000"
    }
  ],
  "refundEvents": [
    {
      "eventRequestId": "liUrreQY233839dfFFb24gaQM",
      "paymentIntegratorEventId": "asd3SDf3f3oijSDfoij",
      "eventCharge": "-200000000",
      "eventFee": "8000000"
    },
    {
      "eventRequestId": "IIghhhUrreQY233839II9qM==",
      "paymentIntegratorEventId": "DFjidoso12FSDFSDE",
      "eventCharge": "-150000000",
      "eventFee": "6000000"
    }
  ]
}

בקשת HTTP

POST https://vgw.googleapis.com/secure-serving/gsp/v1/remittanceStatementDetails/:PIAID

גוף הבקשה

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

ייצוג ב-JSON 
{
  "requestHeader": {
    object (RequestHeader)
  },
  "paymentIntegratorAccountId": string,
  "statementId": string,
  "eventOffset": integer,
  "numberOfEvents": integer
}
שדות
requestHeader

object (RequestHeader)

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

string

חובה: זהו מזהה החשבון של משלב התשלומים שמזהה את ההגבלות החוזיות שקשורות לדוח הזה.
statementId

string

חובה: מזהה הבקשה של ההתראה על הדוח.
eventOffset

integer

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

numberOfEvents

integer

אופציונלי: מספר האירועים שיוצגו בכל דף. אם לא מציינים ערך או אם הערך גדול מ-1,000, הערך יהיה 1,000.

גוף התשובה

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

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

ייצוג ב-JSON 
{
  "responseHeader": {
    object (ResponseHeader)
  },
  "remittanceStatementSummary": {
    object (RemittanceStatementSummary)
  },
  "eventOffset": integer,
  "nextEventOffset": integer,
  "totalEvents": integer,
  "totalWithholdingTaxes": string,
  "captureEvents": [
    {
      object (Event)
    }
  ],
  "refundEvents": [
    {
      object (Event)
    }
  ],
  "reverseRefundEvents": [
    {
      object (Event)
    }
  ],
  "chargebackEvents": [
    {
      object (Event)
    }
  ],
  "reverseChargebackEvents": [
    {
      object (Event)
    }
  ],
  "adjustmentEvents": [
    {
      object (Event)
    }
  ]
}
שדות
responseHeader

object (ResponseHeader)

חובה: כותרת משותפת לכל התגובות.
remittanceStatementSummary

object (RemittanceStatementSummary)

חובה: סיכום של דף הפירוט הזה.
eventOffset

integer

חובה: ההיסט של האירוע בתגובה הזו.
nextEventOffset

integer

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

integer

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

string (Int64Value format)

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

הערך הזה הוא במיקרו.
captureEvents[]

object (Event)

חובה: קבוצה של אירועים שמתועדים.
refundEvents[]

object (Event)

חובה: קבוצה של אירועי החזר כספי.
reverseRefundEvents[]

object (Event)

אופציונלי: קבוצה של אירועים שקשורים להחזר כספי.
chargebackEvents[]

object (Event)

אופציונלי: קבוצה של אירועים שקשורים לביטול תשלום.
reverseChargebackEvents[]

object (Event)

אופציונלי: קבוצה של אירועים שקשורים לביטול החזר כספי.
adjustmentEvents[]

object (Event)

אופציונלי: קבוצה של אירועי התאמה. יכול להיות ש-Google תוסיף אירועי התאמה לפי שיקול דעתה כדי ליישב אי התאמות בחיוב. לדוגמה, אם החישוב של העמלות עבור קבוצה של עסקאות קודמות היה נמוך מדי, יכול להיות ש-Google תשתמש בהתאמה כדי לפצות את המשלב.

RemittanceStatementSummary

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

ייצוג ב-JSON 
{
  "statementDate": string,
  "billingPeriod": {
    object (BillingPeriod)
  },
  "dateDue": string,
  "currencyCode": string,
  "totalDueByIntegrator": string,
  "remittanceInstructions": {
    object (RemittanceInstructions)
  }
}
שדות
statementDate

string (int64 format)

חובה: התאריך (באזור הזמן אמריקה/לוס אנג'לס) שבו נוצרה ההצהרה הזו.
billingPeriod

object (BillingPeriod)

חובה: תקופת החיוב שהדוח הזה מתייחס אליה.
dateDue

string (int64 format)

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

הערך הזה מוגדר כל עוד totalDueByIntegrator גדול מ-0.
currencyCode

string

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

string (Int64Value format)

חובה: הערך הזה הוא במיקרו במטבע של currencyCode. הערך הזה תמיד חיובי.
remittanceInstructions

object (RemittanceInstructions)

חובה: פרטים על העברת התשלום

BillingPeriod

תקופת החיוב של הדוח הזה.

ייצוג ב-JSON 
{
  "startDate": string,
  "endDate": string
}
שדות
startDate

string (int64 format)

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

זוהי המילישנייה הראשונה של היום בתקופת החיוב, 00:00:00.000
endDate

string (int64 format)

חובה: תאריך הסיום של תקופת החיוב. הערך הזה מיוצג באלפיות שנייה מאז ראשית זמן יוניקס (Unix epoch).

זו המילי-שנייה האחרונה של היום האחרון בתקופת החיוב, 23:59:59.999

RemittanceInstructions

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

ייצוג ב-JSON 
{
  "memoLineId": string
}
שדות
memoLineId

string

חובה: מזהה שחובה לציין בשורת התקציר של התשלום לצורך זיהוי התשלום.

אירוע

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

ייצוג ב-JSON 
{
  "eventRequestId": string,
  "paymentIntegratorEventId": string,
  "eventCharge": string,
  "eventFee": string,
  "presentmentChargeAmount": string,
  "presentmentCurrencyCode": string,
  "exchangeRate": string,
  "nanoExchangeRate": string
}
שדות
eventRequestId

string

חובה: באירועים מסוג capture או refund, זה יהיה הערך requestId ש-Google שולחת עם הבקשה. במקרה של אירועים שקשורים להחזר כספי, לביטול עסקה ולביטול החזר כספי, זה יהיה הערך requestId שהמערכת לשילוב אמצעי תשלום שולחת עם ההתראה על האירוע הזה. במקרה של התאמות, זה יהיה מזהה ייחודי ש-Google מקצה לאירוע ההתאמה.
paymentIntegratorEventId

string

חובה: המזהה ששירות שילוב התשלומים החזיר לאירוע הזה. במקרה של תפיסה, זהו paymentIntegratorTransactionId מהתשובה לקריאה של capture. במקרה של החזר כספי, זהו paymentIntegratorRefundId מהתשובה לקריאה של refund.

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

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

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

string (Int64Value format)

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

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

הערך הזה הוא במיקרו.
eventFee

string (Int64Value format)

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

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

הערך הזה הוא במיקרו.
presentmentChargeAmount

string (Int64Value format)

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

הערך הזה הוא במיקרו.

presentmentCurrencyCode

string

אופציונלי: קוד מטבע בן 3 אותיות בפורמט ISO 4217 שמייצג את המטבע שבו העסקה בוצעה.

exchangeRate
(deprecated)

string (Int64Value format)

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

הערך הזה הוא במיקרו נקודות בסיס (1 נקודת בסיס = 0 .0001 = 0 .01%). כלומר, כדי לקבל את שער החליפין, צריך לחלק את הערך בשדה הזה ב-‎10^10.
nanoExchangeRate

string (Int64Value format)

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

הערך הזה הוא בנקודות בסיס ננו (1 נקודת בסיס = 0 .0001 = 0 .01%). כלומר, כדי לקבל את שער החליפין, צריך לחלק את הערך בשדה הזה ב-‎10^13.

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