- HTTP 要求
- 要求主體
- 回應主體
- RemittanceStatementSummary
- BillingPeriod
- RemittanceInstructions
- StatementNotificationResultCode
通知整合者有新的匯款聲明。
每當有新的對帳單提出問題,Google 就會付款整合商或整合商應支付給 Google 的金額。
如果整合商傳回成功,我們會假設對方已接受聲明,並將款項支付給您。
requestId
也是對帳單 ID (可在其他地方使用)。標頭中的 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 |
必要項目:這是付款整合商帳戶 ID,可用來識別這項聲明中的合約限制。 |
remittanceStatementSummary |
必要項目:這份匯款聲明的摘要。 |
回應主體
匯款陳述式通知方法的回應物件。
如果成功,回應主體會含有以下結構的資料:
JSON 表示法 |
---|
{ "responseHeader": { object ( |
欄位 | |
---|---|
responseHeader |
必要項目:所有回應的通用標頭。 |
paymentIntegratorStatementId |
必要項目:整合商會將此陳述式知道。這是已產生的整合商。 |
result |
必要項目:這則聲明通知的結果。 |
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 |
必要項目:必須提供 ID,這項資訊才能在憑單號碼輸入,以便順利識別匯款。 |
StatementNotificationResultCode
陳述式通知的結果代碼。
列舉 | |
---|---|
UNKNOWN_RESULT |
切勿設定這個預設值! |
ACCEPTED |
整合商已接受這份聲明。 |