返回有关汇款对账单的交易详细信息。
这是一个分页 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 |
必需:为此对账单预扣的所有税费的总和。 此值以 micros 为单位。 |
captureEvents[] |
必需:一组捕获事件。 |
refundEvents[] |
必需:一组退款事件。 |
reverseRefundEvents[] |
可选:一组退款退款事件。 |
chargebackEvents[] |
可选:一组退款事件。 |
reverseChargebackEvents[] |
可选:一组反向退款事件。 |
adjustmentEvents[] |
可选:一组调整事件。Google 可以自行决定添加调整事件,以对账单差异进行对帐。例如,如果针对一组先前交易的费用计算不足,则可使用调整来弥补集成商的全部需求。 |
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 |
必需:必须提供在付款证明上的备注行上显示的标识符,用于提供汇款识别号。 |
事件
表示汇款语句中包含的单个事件的结构。
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 支付了款项。 例如,捕获交易数始终为正数,而退款交易数始终为负数。撤消退款和撤消退款事件将始终为正值。退款事件始终为负数。 此值以 micros 为单位。 |
eventFee |
必需:采用语句定义的货币代码。如果此值为负数,则表示从 Google 流向付款集成商的货币价值。如果为正数,则表示付款集成商应向 Google 支付了款项。 例如,如果协议规定 Google 将向付款集成商支付 此值以 micros 为单位。 |
presentmentChargeAmount |
可选:在外汇前,以呈现(也称为交易)货币表示的交易金额。此字段遵循与 此值以 micros 为单位。 |
presentmentCurrencyCode |
可选:用 ISO 4217 货币代码表示呈现(交易)货币,该代码由 3 个字母组成。 |
exchangeRate |
可选:将展示金额转换为结算(账单)金额时所用的汇率。 此值以微基点为单位(1 个基点 = 0.0001 = 0.01%)。也就是说,要计算汇率,请将此字段除以 10^10。 |
nanoExchangeRate |
可选:将演示金额转换为结算(账单)金额时所用的汇率,以纳米点数表示。 此值以 nano 基点表示(1 个基点 = 0.0001 = 0.01%)。也就是说,要计算汇率,请将此字段除以 10^13。 此字段和 ExchangeRate 都将被填充。它们是以不同精确度表示的等值汇率。在未来的版本中,将移除 ExchangeRate,改为使用 nanoExchangeRate。 |