- בקשת HTTP
- גוף הבקשה
- גוף התשובה
- RequestHeader
- גרסה
- RemittanceStatementSummary
- BillingPeriod
- RemittanceInstructions
- ResponseHeader
- StatementNotificationResultCode
מודיע למחבר הצהרת תשלום חדשה.
התראות על הצהרה מופיעות בכל פעם שמועלה הצהרה חדשה שמייצגת כסף ש-Google תשלם למבצע השילוב או את הכסף שהשותף חייב ל-Google.
אם מבצע השילוב מחזיר הצלחה, הוא מאשר את קבלת ההצהרה.
ה-requestId
הוא גם מזהה ההצהרה (בשימוש במקום אחר). השילוב של requestId
בתוך הכותרת ו-paymentIntegratorAccountId
הוא מפתח המיקום, ומזהה באופן ייחודי את ההצהרה הזו.
אם נקודת הקצה נתקלת בשגיאה במהלך עיבוד הבקשה, גוף התגובה מנקודת הקצה הזו צריך להיות מסוג
.ErrorResponse
בקשה לדוגמה נראית כך:
{
"requestHeader": {
"protocolVersion": {
"major": 1,
"minor": 0,
"revision": 0
},
"requestId": "0123434-statement-abc",
"requestTimestamp": "1502632800000"
},
"paymentIntegratorAccountId": "InvisiCashUSA_USD",
"remittanceStatementSummary": {
"statementDate": "1502607600000",
"billingPeriod": {
"startDate": "1502434800000",
"endDate": "1502521199000"
},
"dateDue": "1503212400000",
"currencyCode": "INR",
"totalDueByIntegrator": "1076000000",
"remittanceInstructions": {
"memoLineId": "stmt-1AB-pp0-invisi"
}
}
}
דוגמה לתשובה:
{
"responseHeader": {
"responseTimestamp": "1502632802000"
},
"paymentIntegratorStatementId": "334a",
"result": "ACCEPTED"
}
בקשת HTTP
POST https://www.integratorhost.example.com/v1/remittanceStatementNotification
גוף הבקשה
גוף הבקשה מכיל נתונים במבנה הבא:
ייצוג JSON |
---|
{ "requestHeader": { object ( |
שדות | |
---|---|
requestHeader |
חובה: כותרת משותפת לכל הבקשות. |
paymentIntegratorAccountId |
חובה: זהו מזהה החשבון של הכלי לשילוב תשלומים שמזהה מגבלות חוזיות סביב ההצהרה הזו. |
remittanceStatementSummary |
חובה: סיכום של הצהרת התשלום הזו. |
גוף התגובה
אובייקט תגובה לשיטה להתראה על הצהרת תשלום.
אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכלול נתונים במבנה הבא:
ייצוג JSON |
---|
{ "responseHeader": { object ( |
שדות | |
---|---|
responseHeader |
חובה: כותרת נפוצה לכל התשובות. |
paymentIntegratorStatementId |
חובה: המזהה של מבצע השילוב יודע את ההצהרה הזו. זהו השילוב שנוצר. |
result |
חובה: התוצאה של ההודעה עם ההצהרה הזו. |
RequestHeader
אובייקט כותרת שמוגדר בכל הבקשות שנשלחות לשרת.
ייצוג JSON |
---|
{
"requestId": string,
"requestTimestamp": string,
"userLocale": string,
"protocolVersion": {
object ( |
שדות | |
---|---|
requestId |
חובה: המזהה הייחודי של הבקשה. זוהי מחרוזת באורך מקסימלי של 100 תווים והיא מכילה רק את התווים "a-z", "A-Z", "0-9", ":", "-" ו-"_". |
requestTimestamp |
חובה: חותמת הזמן של הבקשה הזו מיוצגת כאלפיות שנייה מאז תחילת התקופה של זמן מערכת. המקבל צריך לוודא שחותמת הזמן הזו היא ± 60 שניות של 'עכשיו'. חותמת הזמן של הבקשה אינה מזהה ביחס לניסיונות החוזרים. |
userLocale |
הוצא משימוש: קוד שפה בן שתיים או שלוש אותיות לפי תקן ISO 639-2 Alpha 3, ואחריו מקף וקוד מדינה לפי תקן ISO 3166-1 Alpha-2. לדוגמה: 'pt', 'pt-BR', 'fil' או 'fil-PH'. אפשר להשתמש בה כדי לכתוב את השדות |
protocolVersion |
חובה: הגרסה של הבקשה. |
גרסה
אובייקט גרסה שהוא צורה מובנית של מבנה הגרסה הקלאסי של a.b.c
. מובטחות תאימות של גרסאות ראשיות של אותו מספר. חשוב לזכור שתיקונים קלים ותיקונים קטנים עשויים להשתנות לעיתים קרובות וללא הודעה מוקדמת. מבצע השילוב חייב לתמוך בכל הבקשות לאותה גרסה ראשית.
ייצוג JSON |
---|
{ "major": integer, "minor": integer, "revision": integer } |
שדות | |
---|---|
major |
חובה: הגרסה הראשית. מצב זה מסומן עבור בקשות תאימות עם גרסאות שונות לא מובטח שהן יהיו תואמות. |
minor |
חובה: הגרסה המשנית. מדובר בתיקוני באגים משמעותיים. |
revision |
חובה: הגרסה המשנית. מדובר בתיקונים של באגים קטנים. |
RemittanceStatementSummary
אובייקט סיכום לגבי הצהרת תשלום.
ייצוג JSON |
---|
{ "statementDate": string, "billingPeriod": { object ( |
שדות | |
---|---|
statementDate |
חובה: התאריך (באמריקה/לוס אנג'לס) שבו נוצרה ההצהרה. |
billingPeriod |
חובה: תקופת החיוב שמוגדרת בדף החשבון. |
dateDue |
אופציונלי: התאריך שבו יש להעביר את התשלום. הנתונים האלה מיוצגים כאלפיות שנייה מתחילת התקופה (epoch). זהו תאריך (ולכן הוא יתחיל תמיד באלפיות השנייה הראשונה של היום באזור הזמן של החיוב). ערך זה מוגדר כל עוד הערך של |
currencyCode |
חובה: קוד מטבע בן 3 אותיות לפי תקן ISO 4217. |
totalDueByIntegrator |
חובה: הערך הזה הוא במיקרו במטבע |
remittanceInstructions |
נדרש: פרטים על אופן ביצוע התשלום |
BillingPeriod
תקופת החיוב בדף החשבון הזה.
ייצוג JSON |
---|
{ "startDate": string, "endDate": string } |
שדות | |
---|---|
startDate |
חובה: תאריך ההתחלה של תקופת החיוב. הנתונים האלה מיוצגים כאלפיות שנייה מתחילת התקופה (epoch). זהו תאריך (ולכן הוא יתחיל תמיד באלפיות השנייה הראשונה של היום באזור הזמן של החיוב). זוהי אלפית השנייה הראשונה של היום בתקופת החיוב, 00:00:00.000 |
endDate |
חובה: תאריך הסיום של תקופת החיוב. הנתונים האלה מיוצגים כאלפיות שנייה מתחילת התקופה (epoch). זוהי אלפית השנייה האחרונה של היום האחרון של תקופת החיוב, 23:59:59.999 |
RemittanceInstructions
מבנה שמכיל מידע לגבי אופן התשלום של הודעת התשלום.
ייצוג JSON |
---|
{ "memoLineId": string } |
שדות | |
---|---|
memoLineId |
חובה: מזהה שחובה להוסיף בשורת התזכיר של התשלום לצורך זיהוי תשלום. |
ResponseHeader
אובייקט כותרת שמוגדר בכל התגובות שנשלחות מהשרת.
ייצוג JSON |
---|
{ "responseTimestamp": string } |
שדות | |
---|---|
responseTimestamp |
חובה: חותמת הזמן של התשובה הזו מיוצגת כאלפיות שנייה מאז תחילת התקופה של זמן מערכת. המקבל צריך לוודא שחותמת הזמן הזו היא ± 60 שניות של 'עכשיו'. |
StatementNotificationResultCode
קודים של תוצאות להתראה על דוח.
טיפוסים בני מנייה (enums) | |
---|---|
UNKNOWN_RESULT |
אל תגדיר את ערך ברירת המחדל הזה אף פעם! |
ACCEPTED |
השילוב אישר את ההצהרה הזו. |