Method: remittanceStatementNotification

向集成商通知新的汇款对帐单。

每当有新的对账单表示 Google 向集成商支付的款项或集成商欠 Google 的金额时,就会触发对账单通知。

如果集成商返回成功消息,系统会假定已经接受了声明且支付了相应费用。

requestId 也是语句 ID(在其他位置使用)。标头和 paymentIntegratorAccountId 中的 requestId 的组合是幂等键,唯一标识此语句。

如果端点在处理请求时遇到错误,则来自此端点的响应正文的类型应为 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": string,
  "remittanceStatementSummary": {
    object (RemittanceStatementSummary)
  }
}
字段
requestHeader

object (RequestHeader)

必需:所有请求的通用标头。

paymentIntegratorAccountId

string

必需:这是付款集成商帐号标识符,用于标识此声明涉及的合同限制。

remittanceStatementSummary

object (RemittanceStatementSummary)

必需:此汇款对帐单摘要。

响应正文

汇款对帐单通知方法的响应对象。

如果成功,响应正文将包含结构如下的数据:

JSON 表示法
{
  "responseHeader": {
    object (ResponseHeader)
  },
  "paymentIntegratorStatementId": string,
  "result": enum (StatementNotificationResultCode)
}
字段
responseHeader

object (ResponseHeader)

必需:所有响应的通用标头。

paymentIntegratorStatementId

string

必需:集成商知道此声明的标识符。这是由集成商生成的代码。

result

enum (StatementNotificationResultCode)

必需:此语句通知的结果。

RemittanceStatementSummary

关于汇款对帐单的摘要对象。

JSON 表示法
{
  "statementDate": string,
  "billingPeriod": {
    object (BillingPeriod)
  },
  "dateDue": string,
  "currencyCode": string,
  "totalDueByIntegrator": string,
  "remittanceInstructions": {
    object (RemittanceInstructions)
  }
}
字段
statementDate

string (int64 format)

REQUIRED:相应语句的创建日期(美洲/洛杉矶)。

billingPeriod

object (BillingPeriod)

必需:此对帐单涵盖的结算周期。

dateDue

string (int64 format)

可选:汇款截止日期。以从公元纪年开始计算的毫秒数表示。这是日期(因此,系统始终会按照账单时区中的一天的第 1 毫秒开始计算)。

totalDueByIntegrator 大于 0 时,此字段会被设置。

currencyCode

string

必需:ISO 4217 货币代码(由 3 个字母组成)。

totalDueByIntegrator

string (Int64Value format)

必需:此值采用微单位(currencyCode 币种)。此值始终为正。

remittanceInstructions

object (RemittanceInstructions)

必需:有关如何汇款的详细信息

结算周期

此对账单的结算周期。

JSON 表示法
{
  "startDate": string,
  "endDate": string
}
字段
startDate

string (int64 format)

必需:结算周期的开始日期。以从公元纪年开始计算的毫秒数表示。这是日期(因此,系统始终会按照账单时区中的一天的第 1 毫秒开始计算)。

这是结算周期内第一毫秒,00:00:00.000

endDate

string (int64 format)

必需:结算周期的结束日期。以从公元纪年开始计算的毫秒数表示。

这是结算周期的最后一天 23:59:59.999

汇款说明

该结构旨在存储有关如何支付此汇款通知的信息。

JSON 表示法
{
  "memoLineId": string
}
字段
memoLineId

string

必需:必须在付款行中输入标识符,用于汇款标识。

StatementNotificationResultCode

语句通知的结果代码。

枚举
UNKNOWN_RESULT 切勿设置此默认值!
ACCEPTED 集成商已接受此声明。