- 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 |
REQUIRED:此匯款表單的摘要。 |
回應主體
匯款陳述式通知方法的回應物件。
如果成功,回應主體即會包含具有以下結構的資料:
JSON 表示法 |
---|
{ "responseHeader": { object ( |
欄位 | |
---|---|
responseHeader |
必要:所有回應的通用標頭。 |
paymentIntegratorStatementId |
必要:整合商知道這個陳述式的 ID。此為系統的整合商。 |
result |
REQUIRED:此陳述式通知的結果。 |
RemittanceStatementSummary
匯款通知的摘要物件。
JSON 表示法 |
---|
{ "statementDate": string, "billingPeriod": { object ( |
欄位 | |
---|---|
statementDate |
REQUIRED:這個陳述式的建立日期 (位於美國/洛杉磯)。 |
billingPeriod |
必要:這個對帳單涵蓋的帳單週期。 |
dateDue |
OPTIONAL:匯款的截止日。這代表從 Epoch 紀元時間起算的毫秒數。這是一個日期 (因此一律會在帳單時區的第一天開始)。 只要 |
currencyCode |
必要:由 3 個字母組成的 ISO 4217 貨幣代碼。 |
totalDueByIntegrator |
必要:這個值以微量為單位,以 |
remittanceInstructions |
必要:如何匯款 |
帳單週期
這個對帳單的帳單週期。
JSON 表示法 |
---|
{ "startDate": string, "endDate": string } |
欄位 | |
---|---|
startDate |
必要:帳單週期的開始日期。這代表從 Epoch 紀元時間起算的毫秒數。這是一個日期 (因此一律會在帳單時區的第一天開始)。 這是帳單週期的第一天 (00:00:00.000) |
endDate |
必要:帳單週期的結束日期。這代表從 Epoch 紀元時間起算的毫秒數。 這是帳單週期的最後一天,23:59:59.999 |
匯款操作說明
收取此匯款通知相關資訊的結構。
JSON 表示法 |
---|
{ "memoLineId": string } |
欄位 | |
---|---|
memoLineId |
REQUIRED:必須在匯款證明表單中附上的身分證件,用於匯款。 |
Statement 通知代碼
陳述式通知的結果代碼。
列舉 | |
---|---|
UNKNOWN_RESULT |
不要設定這個預設值! |
ACCEPTED |
整合商已接受這項陳述。 |