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)

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

RequestHeader

サーバーに送信されるすべてのリクエストに定義されるヘッダー オブジェクト。

JSON 表現 
{
  "requestId": string,
  "requestTimestamp": string,
  "userLocale": string,
  "protocolVersion": {
    object (Version)
  }
}
フィールド
requestId

string

必須: このリクエストの一意の識別子。

これは、最大長が 100 文字で、「a ～ z」、「A ～ Z」、「0 ～ 9」、「:」、「-」、「_」のみを含む文字列です。
requestTimestamp

string (int64 format)

必須: エポックからのミリ秒単位で表されるこのリクエストのタイムスタンプ。受信者は、このタイムスタンプが「現在」の ± 60 秒であることを確認する必要があります。このリクエストのタイムスタンプは、再試行時にべき等ではありません。
userLocale
(deprecated)

string

非推奨: 2 文字または 3 文字の ISO 639-2 Alpha-3 言語コード。必要に応じてハイフンと ISO 3166-1 Alpha-2 国コード（「pt」、「pt-BR」、「fil」、「fil-PH」など）が続きます。レスポンスの userMessage フィールドの処理に役立ちます。
protocolVersion

object (Version)

必須: このリクエストのバージョン。

バージョン

従来の a.b.c バージョン構造の構造化されたバージョン オブジェクト。同じ番号のメジャー バージョンは互換性が保証されています。マイナーおよびリビジョンは、予告なく頻繁に変更される場合があります。インテグレータは、同じメジャー バージョンのすべてのリクエストをサポートする必要があります。

JSON 表現 
{
  "major": integer,
  "minor": integer,
  "revision": integer
}
フィールド
major

integer

必須: メジャー バージョン。これは、異なるバージョンの互換性リクエストには互換性が保証されていないため、マークされています。
minor

integer

必須: マイナー バージョン。これは、重要なバグ修正を意味します。
revision

integer

必須: マイナー バージョン。マイナーなバグ修正を示します。

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

必須: 送金 ID の支払いのためのメモ欄に必ず記載する ID。

ResponseHeader

サーバーから送信されるすべてのレスポンスに定義されるヘッダー オブジェクト。

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

string (int64 format)

必須: エポックからのミリ秒として表される、このレスポンスのタイムスタンプ。受信者は、このタイムスタンプが「現在」の ± 60 秒であることを確認する必要があります。

StatementNotificationResultCode

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

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