返回有关汇款对帐单的交易详细信息。
这是一个分页 API。可使用 numberOfEvents
指定每页的交易事件数量。如果未指定,则每页最多返回 1000 个事件。对此 API 的每个请求都将返回一个 nextEventOffset
,指向语句中的下一个事务事件,同时返回 totalEvents
以指定语句中的事务总数。如果当前检索到的页面包含该语句的最后一个事务,nextEventOffset
将不会出现在响应中。
statementId
值是 remittanceStatementNotificationRequest
中的 requestId
如果端点在处理请求时出错,则来自此端点的响应类型为
。ErrorResponse
如果此方法未返回 HTTP 200,此查询的响应可能为空。如果可以使用带有明确说明的
帮助攻击者了解其他集成商的付款集成商帐号标识符,响应正文将为空。在这些情况下,如果签名密钥不匹配,未找到付款集成商标识符,或者加密密钥未知,则此方法将返回正文为空的 HTTP 404。如果请求签名可以通过验证,则响应正文中会返回有关错误的更多信息。ErrorResponse
示例请求如下所示:
{
"requestHeader": {
"protocolVersion": {
"major": 1,
"minor": 0,
"revision": 0
},
"requestId": "statement_detail_request_139932019",
"requestTimestamp": "1502551332087"
},
"paymentIntegratorAccountId": "InvisiCashUSA_USD",
"statementId": "0123434-statement-abc",
"numberOfEvents": 4
}
示例响应如下所示:
{
"responseHeader": {
"responseTimestamp": "1481900013178"
},
"eventOffset": 0,
"nextEventOffset": 4,
"totalEvents": 15,
"remittanceStatementSummary": {
"statementDate": "1502521200000",
"billingPeriod": {
"startDate": "1502434800000",
"endDate": "1502434800000"
},
"dateDue": "1502348400000",
"currencyCode": "INR",
"totalDueByIntegrator": "1076000000",
"remittanceInstructions": {
"memoLineId": "stmt-1AB-pp0-invisi"
}
},
"captureEvents": [
{
"eventRequestId": "bWVyY2hhbnQgdHJhbnNhY3Rpb24gaWQ",
"paymentIntegratorEventId": "ioj32SOIjf23oijSDfoij",
"eventCharge": "700000000",
"eventFee": "-28000000"
},
{
"eventRequestId": "Ggghvh78200PQ3Yrpb",
"paymentIntegratorEventId": "iasdf23dSdfijSDfoij",
"eventCharge": "800000000",
"eventFee": "-32000000"
}
],
"refundEvents": [
{
"eventRequestId": "liUrreQY233839dfFFb24gaQM",
"paymentIntegratorEventId": "asd3SDf3f3oijSDfoij",
"eventCharge": "-200000000",
"eventFee": "8000000"
},
{
"eventRequestId": "IIghhhUrreQY233839II9qM==",
"paymentIntegratorEventId": "DFjidoso12FSDFSDE",
"eventCharge": "-150000000",
"eventFee": "6000000"
}
]
}
HTTP 请求
POST https://vgw.googleapis.com/secure-serving/gsp/v1/remittanceStatementDetails/:PIAID
请求正文
请求正文中包含结构如下的数据:
JSON 表示法 |
---|
{
"requestHeader": {
object ( |
字段 | |
---|---|
requestHeader |
必需:所有请求的通用标头。 |
paymentIntegratorAccountId |
必需:这是付款集成商帐号标识符,用于标识此声明涉及的合同限制。 |
statementId |
必需:对账单通知的请求 ID。 |
eventOffset |
可选:返回从此偏移量开始的事件。如果返回了第一个请求,或者该软件包是第一个请求,则应该将其设置为 |
numberOfEvents |
可选:每页显示的事件数量。如果未指定或大于 1000,此值将为 1000。 |
响应正文
汇款对帐单详细信息方法的响应对象。
如果成功,响应正文将包含结构如下的数据:
JSON 表示法 |
---|
{ "responseHeader": { object ( |
字段 | |
---|---|
responseHeader |
必需:所有响应的通用标头。 |
remittanceStatementSummary |
必需:此汇款对帐单摘要。 |
eventOffset |
必需:该响应的事件偏移量。 |
nextEventOffset |
可选:要返回的下一个事件的偏移量。如果未指定,则此语句没有更多要检索的事件。 |
totalEvents |
必需:此语句中的事件总数。 |
totalWithholdingTaxes |
必需:针对此语句预扣的所有税费的总和。 |
captureEvents[] |
必需:拍摄事件集。 |
refundEvents[] |
必需:一组退款事件。 |
reverseRefundEvents[] |
可选:一组退款事件。 |
chargebackEvents[] |
可选:一组退款事件。 |
reverseChargebackEvents[] |
可选:一组反向退款事件。 |
adjustmentEvents[] |
可选:一组调整事件。为调整结算差异,Google 可能会自行添加调整事件,例如,如果针对一组先前交易的费用计算不足,则可以使用调整来使集成商整体受益。 |
RemittanceStatementSummary
关于汇款对帐单的摘要对象。
JSON 表示法 |
---|
{ "statementDate": string, "billingPeriod": { object ( |
字段 | |
---|---|
statementDate |
REQUIRED:相应语句的创建日期(美洲/洛杉矶)。 |
billingPeriod |
必需:此对帐单涵盖的结算周期。 |
dateDue |
可选:汇款截止日期。以从公元纪年开始计算的毫秒数表示。这是日期(因此,系统始终会按照账单时区中的一天的第 1 毫秒开始计算)。 当 |
currencyCode |
必需:ISO 4217 货币代码(由 3 个字母组成)。 |
totalDueByIntegrator |
必需:此值采用微单位( |
remittanceInstructions |
必需:有关如何汇款的详细信息 |
结算周期
此对账单的结算周期。
JSON 表示法 |
---|
{ "startDate": string, "endDate": string } |
字段 | |
---|---|
startDate |
必需:结算周期的开始日期。以从公元纪年开始计算的毫秒数表示。这是日期(因此,系统始终会按照账单时区中的一天的第 1 毫秒开始计算)。 这是结算周期内第一毫秒,00:00:00.000 |
endDate |
必需:结算周期的结束日期。以从公元纪年开始计算的毫秒数表示。 这是结算周期的最后一天 23:59:59.999 |
汇款说明
该结构旨在存储有关如何支付此汇款通知的信息。
JSON 表示法 |
---|
{ "memoLineId": string } |
字段 | |
---|---|
memoLineId |
必需:必须在付款行中输入标识符,用于汇款标识。 |
事件
表示汇款对帐单中包含的单个事件的结构。
JSON 表示法 |
---|
{ "eventRequestId": string, "paymentIntegratorEventId": string, "eventCharge": string, "eventFee": string, "presentmentChargeAmount": string, "presentmentCurrencyCode": string, "exchangeRate": string, "nanoExchangeRate": string } |
字段 | |
---|---|
eventRequestId |
必需:对于拍摄或退款事件,这将是 Google 随请求发送的 |
paymentIntegratorEventId |
必需:为此事件返回的付款集成商 ID。对于捕获,这是对 此字段的长度可变,作为集成商,您为此事件提供的任何 ID 都将在此处体现。如果集成商未提供相应事件的值,此字段将包含与 对于反向退款、退款和反向退款事件,这将是付款集成商在事件通知中发送的 此字段的长度和格式取决于每个 ID 的来源字段。如需详细了解长度和字符集要求,请参阅各个来源字段对应的文档。特别要注意的是,此字段有时可能包含 Google 生成的 ID,这些 ID 的长度要求可能与集成商生成的 ID 不同。 |
eventCharge |
必需:以语句定义的货币代码表示。如果此值为负数,则表示从 Google 迁移到付款集成商。如果此值为正,则表示付款工具集成商因 Google 而支付了相应款项。 例如,捕获交易将始终为正值,而退款交易将始终为负数。反向退款和反向退款事件将始终为正值。退款事件始终为负数。 |
eventFee |
必需:以语句定义的货币代码表示。如果此值为负数,则表示从 Google 迁移到付款集成商。如果此值为正,则表示付款工具集成商因 Google 而支付了相应款项。 例如,如果协议表明 Google 会向付款集成商支付 1% 的 |
presentmentChargeAmount |
可选:交易前的金额(也称为交易)币种,涉及外汇兑换。此字段的签名规范与 |
presentmentCurrencyCode |
可选:ISO 4217 货币代码(由 3 个字母组成),用于表示演示(交易)货币。 |
exchangeRate |
可选:将演示金额转换为结算(发票)金额时所使用的汇率。 此值以“微”基点(1 个基点 = 0.0001 = 0.01%)表示。也就是说,要获得汇率,请将此字段除以 10^10。 |
nanoExchangeRate |
可选:将演示金额转换为结算(账单)金额时所使用的汇率,以纳米为单位。 此值以 nano 为基准(1 个基准点 = .0001 = .01%)。也就是说,要获得汇率,请将此字段除以 10^13。 此字段和 ExchangeRate 都会填充。它们是等效币种,以不同的精度表示。在未来的版本中,ExchangeRate 将被移除,取而代之的是 nanoExchangeRate。 |