Method: remittanceStatementDetails

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

זהו ממשק API שעבר עימוד. ניתן לציין את מספר אירועי העסקה בכל דף באמצעות numberOfEvents. אם לא מצוין, מספר הדפים המקסימלי יוחזר לכל דף. כל בקשה ל-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 הוא אפס, האירועים יוחזרו החל מהאירוע הראשון. אם מדובר בשניים, האירועים יוחזרו החל מהאירוע השלישי. אם לא מצוין, המערכת תתייחס ל-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 כדי להתאים את אי-ההתאמות בחיובים. לדוגמה, אם בוצע חישוב של עמלות בגין קבוצה שונה של עסקאות קודמות, ייתכן שייעשה שימוש בהתאמה כדי להפוך את המספר המשולב לשלם.

סיכום מצבי תשלום

אובייקט סיכום של הצהרת תשלום.

ייצוג 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)

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

המדיניות הזו מוגדרת כל עוד הערך בשדה totalDueByIntegrator גדול מ-0.
currencyCode

string

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

string (Int64Value format)

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

object (RemittanceInstructions)

נדרש: פרטים על אופן העברת התשלום

תקופת חיוב

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

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

string (int64 format)

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

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

string (int64 format)

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

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

הוראות להעברת כספים

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

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

string

חובה: מזהה שיש להוסיף לשורת התזכיר עבור התשלום לצורך העברת תשלום.

אירוע

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

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

string

חובה: במקרה של אירועי קליטה או החזר כספי, זה יהיה ה-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

string (Int64Value format)

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

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

string (Int64Value format)

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

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

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