Method: remittanceStatementNotification

新しい送金明細書についてインテグレータに通知します。

ステートメント通知は、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": string,
  "remittanceStatementSummary": {
    object (RemittanceStatementSummary)
  }
}
フィールド
requestHeader

object (RequestHeader)

必須: すべてのリクエストに共通のヘッダー。
paymentIntegratorAccountId

string

必須: これは、この明細書に関する契約上の制約を識別する、決済インテグレータのアカウント ID です。
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)

必須: このステートメントが作成された日付（アメリカ、ロサンゼルス）。
billingPeriod

object (BillingPeriod)

必須: この明細書の対象となる請求対象期間。
dateDue

string (int64 format)

省略可: 送金の支払い期限。これは、エポックからのミリ秒数で表されます。日付（課金タイムゾーンでは常に日付の最初のミリ秒）となります。

これは、totalDueByIntegrator が 0 より大きい限り設定されます。
currencyCode

string

必須: ISO 4217 の 3 文字の通貨コード。
totalDueByIntegrator

string (Int64Value format)

必須: この値は、currencyCode の通貨のマイクロ秒単位です。この値は常に正です。
remittanceInstructions

object (RemittanceInstructions)

必須: 支払い方法の詳細

BillingPeriod

この明細書の請求対象期間。

JSON 表現 
{
  "startDate": string,
  "endDate": string
}
フィールド
startDate

string (int64 format)

必須: 請求対象期間の開始日。これは、エポックからのミリ秒数で表されます。日付（課金タイムゾーンでは常に日付の最初のミリ秒）となります。

これは、請求対象期間の日の最初のミリ秒 00:00:00.000
endDate

string (int64 format)

必須: 請求対象期間の終了日。これは、エポックからのミリ秒数で表されます。

これは、請求対象期間の最終日 23:59:59.999 の最後のミリ秒です。

RemittanceInstructions

この送金通知の支払い方法に関する情報を保持するストラクチャ。

JSON 表現 
{
  "memoLineId": string
}
フィールド
memoLineId

string

必須: 送金識別のために支払いのメモ行に記載する必要がある識別子。

StatementNotificationResultCode

ステートメント通知の結果コード。

列挙型
UNKNOWN_RESULT このデフォルト値は設定しないでください。
ACCEPTED インテグレーターがこの声明を承認しました。