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

חובה: קבוצת אירועים של refund.
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)

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

הערך מוגדר כל עוד הערך בשדה 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)

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

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

string (int64 format)

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

זוהי אלפית השנייה האחרונה ביום האחרון של תקופת החיוב, 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

חובה: לאירועי תיעוד או החזר כספי, אלה יהיו ה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)

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

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

string (Int64Value format)

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

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

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