- HTTP 请求
- 请求正文
- 响应正文
- RequestHeader
- 版本
- RemittanceStatementSummary
- BillingPeriod
- RemittanceInstructions
- ResponseHeader
- 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 |
必需:这是付款集成商帐号标识符,用于标识有关此对账单的合同限制。 |
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 |
必需:此请求的版本。 |
版本
Version 对象,是经典 a.b.c
版本结构的结构化形式。相同编号的主要版本保证兼容。请注意,次要和修订可能会频繁变动,恕不另行通知。集成商必须支持针对同一主要版本的所有请求。
JSON 表示法 |
---|
{ "major": integer, "minor": integer, "revision": integer } |
字段 | |
---|---|
major |
必需:主要版本。此属性会被标记为不同版本的兼容性请求,但这并不保证兼容。 |
minor |
必需:次要版本。这表示修复了重大问题。 |
revision |
必需:次要版本。表示小的 bug 修复。 |
RemittanceStatementSummary
有关汇款语句的摘要对象。
JSON 表示法 |
---|
{ "statementDate": string, "billingPeriod": { object ( |
字段 | |
---|---|
statementDate |
必需:此对账单的创建日期(美国/洛杉矶)。 |
billingPeriod |
必需:此对账单所涵盖的结算周期。 |
dateDue |
可选:汇款截止日期。该时间以从公元纪年开始计算的毫秒数表示。它是一个日期(因此始终从结算时区的当天第一毫秒开始)。 只要 |
currencyCode |
必需:ISO 4217 货币代码(由 3 个字母组成)。 |
totalDueByIntegrator |
必需:此值以微单位表示,以 |
remittanceInstructions |
必需:有关如何付款的详细信息 |
BillingPeriod
此对账单的结算周期。
JSON 表示法 |
---|
{ "startDate": string, "endDate": string } |
字段 | |
---|---|
startDate |
必需:结算周期的开始日期。该时间以从公元纪年开始计算的毫秒数表示。它是一个日期(因此始终从结算时区的当天第一毫秒开始)。 这是结算周期当天的第一毫秒,即 00:00:00.000 |
endDate |
必需:结算周期的结束日期。该时间以从公元纪年开始计算的毫秒数表示。 这是结算周期最后一天的最后一毫秒,即 23:59:59.999 |
RemittanceInstructions
包含有关如何支付此汇款通知的信息的结构。
JSON 表示法 |
---|
{ "memoLineId": string } |
字段 | |
---|---|
memoLineId |
必需:必须提供在付款证明上的备注行上显示的标识符,用于提供汇款识别号。 |
ResponseHeader
从服务器发送的所有响应中定义的标头对象。
JSON 表示法 |
---|
{ "responseTimestamp": string } |
字段 | |
---|---|
responseTimestamp |
必需:此响应的时间戳,以自纪元以来的毫秒数表示。接收者应验证此时间戳是否为“现在”的 ± 60 秒。 |
StatementNotificationResultCode
语句通知的结果代码。
枚举 | |
---|---|
UNKNOWN_RESULT |
切勿设置此默认值! |
ACCEPTED |
集成商已接受此声明。 |