Method: remittanceStatementNotification

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

התראות על הצהרה מופיעות בכל פעם שמועלה הצהרה חדשה שמייצגת כסף ש-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": string,
  "remittanceStatementSummary": {
    object (RemittanceStatementSummary)
  }
}
שדות
requestHeader

object (RequestHeader)

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

string

חובה: זהו מזהה החשבון של הכלי לשילוב תשלומים שמזהה מגבלות חוזיות סביב ההצהרה הזו.
remittanceStatementSummary

object (RemittanceStatementSummary)

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

גוף התגובה

אובייקט תגובה לשיטה להתראה על הצהרת תשלום.

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

ייצוג JSON 
{
  "responseHeader": {
    object (ResponseHeader)
  },
  "paymentIntegratorStatementId": string,
  "result": enum (StatementNotificationResultCode)
}
שדות
responseHeader

object (ResponseHeader)

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

string

חובה: המזהה של מבצע השילוב יודע את ההצהרה הזו. זהו השילוב שנוצר.
result

enum (StatementNotificationResultCode)

חובה: התוצאה של ההודעה עם ההצהרה הזו.

RequestHeader

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

ייצוג JSON 
{
  "requestId": string,
  "requestTimestamp": string,
  "userLocale": string,
  "protocolVersion": {
    object (Version)
  }
}
שדות
requestId

string

חובה: המזהה הייחודי של הבקשה.

זוהי מחרוזת באורך מקסימלי של 100 תווים והיא מכילה רק את התווים "a-z", "A-Z", "0-9", ":", "-" ו-"_".
requestTimestamp

string (int64 format)

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

string

הוצא משימוש: קוד שפה בן שתיים או שלוש אותיות לפי תקן ISO 639-2 Alpha 3, ואחריו מקף וקוד מדינה לפי תקן ISO 3166-1 Alpha-2. לדוגמה: 'pt', 'pt-BR', 'fil' או 'fil-PH'. אפשר להשתמש בה כדי לכתוב את השדות userMessage בתגובה.
protocolVersion

object (Version)

חובה: הגרסה של הבקשה.

גרסה

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

ייצוג JSON 
{
  "major": integer,
  "minor": integer,
  "revision": integer
}
שדות
major

integer

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

integer

חובה: הגרסה המשנית. מדובר בתיקוני באגים משמעותיים.
revision

integer

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

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)

אופציונלי: התאריך שבו יש להעביר את התשלום. הנתונים האלה מיוצגים כאלפיות שנייה מתחילת התקופה (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)

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

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

string (int64 format)

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

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

RemittanceInstructions

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

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

string

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

ResponseHeader

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

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

string (int64 format)

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

StatementNotificationResultCode

קודים של תוצאות להתראה על דוח.

טיפוסים בני מנייה (enums)
UNKNOWN_RESULT אל תגדיר את ערך ברירת המחדל הזה אף פעם!
ACCEPTED השילוב אישר את ההצהרה הזו.