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)

חובה: התוצאה של ההודעה בנוגע להצהרה.

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

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

StatementNotificationResultCode

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

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