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)

必須: このステートメント通知の結果。

RemittanceStatement の概要

送金明細書に関する概要オブジェクト。

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)

省略可: 送金の期限。エポックからのミリ秒数で表されます。これは日付であるため、課金のタイムゾーンでは常に最初の 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

REQUIRED: 送金識別のために支払いのメモ行に入力する必要がある識別子。

StatementNotificationResultCode

明細書通知の結果コード。

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