Method: remittanceStatementDetails

送金明細書の取引詳細情報を返します。

これはページネーションされた API です。ページあたりのトランザクション イベントの数は、numberOfEvents で指定できます。指定されていない場合、ページごとに最大 1, 000 件のイベントが返されます。この API への各リクエストは、明細書の次のトランザクション イベントを指す nextEventOffset と、明細書のトランザクションの合計数を指定する totalEvents を返します。取得した現在のページに明細書の最後の取引が含まれている場合、レスポンスに nextEventOffset は含まれません。

statementId の値は、remittanceStatementNotificationRequest の requestId です。

リクエストの処理中にエンドポイントでエラーが発生した場合、このエンドポイントからのレスポンスはタイプ ErrorResponse になります。

このメソッドが HTTP 200 を返さない場合、このクエリに対するレスポンスは空になることがあります。明確な説明を示した ErrorResponse を利用して、攻撃者が他のインテグレーターの決済インテグレーターのアカウント識別子を把握できてしまう可能性がある状況では、レスポンスの本文は空になります。署名鍵が一致しない、決済インテグレーター識別子が見つからない、または暗号鍵が不明な場合、このメソッドは空の本文を含む HTTP 404 を返します。リクエストの署名が検証できた場合、エラーに関する追加情報がレスポンスの本文で返されます。

リクエストの例は次のようになります。


{
  "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": string,
  "statementId": string,
  "eventOffset": integer,
  "numberOfEvents": integer
}
フィールド
requestHeader

object (RequestHeader)

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

string

必須: このステートメントに関する契約上の制約を識別する、支払いインテグレーターのアカウント識別子。
statementId

string

必須: 明細書通知のリクエスト ID。
eventOffset

integer

省略可: このオフセットから始まるイベントを返します。これが最初のリクエストの場合は、nextEventOffset に設定するか、未指定のままにします。eventOffset がゼロの場合、最初のイベントから始まるイベントが返されます。2 の場合、3 番目のイベントからイベントが返されます。指定しない場合、eventOffset は 0 と見なされます。
numberOfEvents

integer

省略可: ページごとに表示するイベントの数。指定されていない場合、または 1,000 より大きい場合は、1,000 になります。

レスポンスの本文

送金明細書詳細メソッドのレスポンス オブジェクト。

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

JSON 表現 
{
  "responseHeader": {
    object (ResponseHeader)
  },
  "remittanceStatementSummary": {
    object (RemittanceStatementSummary)
  },
  "eventOffset": integer,
  "nextEventOffset": integer,
  "totalEvents": integer,
  "totalWithholdingTaxes": string,
  "captureEvents": [
    {
      object (Event)
    }
  ],
  "refundEvents": [
    {
      object (Event)
    }
  ],
  "reverseRefundEvents": [
    {
      object (Event)
    }
  ],
  "chargebackEvents": [
    {
      object (Event)
    }
  ],
  "reverseChargebackEvents": [
    {
      object (Event)
    }
  ],
  "adjustmentEvents": [
    {
      object (Event)
    }
  ]
}
フィールド
responseHeader

object (ResponseHeader)

必須: すべてのレスポンスに共通のヘッダー。
remittanceStatementSummary

object (RemittanceStatementSummary)

必須: この送金明細書の概要。
eventOffset

integer

必須: このレスポンスのイベント オフセット。
nextEventOffset

integer

省略可: 返される次のイベントのオフセット。指定されていない場合、このステートメントで取得するイベントはなくなります。
totalEvents

integer

必須: このステートメントのイベントの合計数。
totalWithholdingTaxes

string (Int64Value format)

必須: この明細書で源泉徴収されたすべての税金の合計。

この値は マイクロ秒単位です。
captureEvents[]

object (Event)

必須: キャプチャ イベントのセット。
refundEvents[]

object (Event)

必須: 払い戻しイベントのセット。
reverseRefundEvents[]

object (Event)

省略可: 払い戻し取り消しイベントのセット。
chargebackEvents[]

object (Event)

省略可: チャージバック イベントのセット。
reverseChargebackEvents[]

object (Event)

省略可: チャージバックの取り消しイベントのセット。
adjustmentEvents[]

object (Event)

省略可: 調整イベントのセット。調整イベントは、請求の不一致を調整するために Google の裁量で追加されることがあります。たとえば、過去の一連の取引で手数料が過少に計算された場合、調整を使用してインテグレータを補償することがあります。

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)

省略可: 送金期限。これは、エポックからのミリ秒数として表されます。日付であるため、請求タイムゾーンの 1 日の最初のミリ秒から常に開始されます。

これは、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)

必須: 請求対象期間の開始日。これは、エポックからのミリ秒数として表されます。日付であるため、請求タイムゾーンの 1 日の最初のミリ秒から常に開始されます。

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

string (int64 format)

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

請求対象期間の最終日の最後のミリ秒（23:59:59.999）

RemittanceInstructions

この送金通知の支払い方法に関する情報を保持する構造体。

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

string

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

イベント

送金明細書に含まれる単一のイベントを表す構造体。

JSON 表現 
{
  "eventRequestId": string,
  "paymentIntegratorEventId": string,
  "eventCharge": string,
  "eventFee": string,
  "presentmentChargeAmount": string,
  "presentmentCurrencyCode": string,
  "exchangeRate": string,
  "nanoExchangeRate": string
}
フィールド
eventRequestId

string

必須: 支払い確定または払い戻しイベントの場合、これは Google がリクエストとともに送信する requestId になります。払い戻し、チャージバック、チャージバックの取り消しイベントの場合、これは Payment Integrator がそのイベントの通知とともに送信する requestId になります。調整の場合、これは Google が調整イベントに割り当てた一意の ID になります。
paymentIntegratorEventId

string

必須: このイベントに対して支払いインテグレーターが返した ID。キャプチャの場合は capture 呼び出しへのレスポンスの paymentIntegratorTransactionId、払い戻しの場合は refund 呼び出しへのレスポンスの paymentIntegratorRefundId です。

このフィールドの長さは可変です。インテグレーターがこのイベントに指定した ID がここに反映されます。対応するイベントの値をインテグレーターが指定していない場合、このフィールドには eventRequestId フィールドと同じ値が含まれます。

払い戻し、チャージバック、チャージバックの取り消しイベントの場合、これはイベントの通知とともに Payment Integrator が送信した requestId になります。

このフィールドの長さと形式は、各 ID のソースフィールドによって異なります。長さと文字セットの要件については、各ソースフィールドのドキュメントを参照してください。特に、このフィールドには Google が生成した ID が含まれる場合があることに注意してください。Google が生成した ID の最大長要件は、インテグレータが生成した ID の最大長要件と異なる場合があります。
eventCharge

string (Int64Value format)

必須: 明細書で定義された通貨コード。この値が負の場合、Google から決済インテグレータに移動する金銭的価値を表します。プラスの場合は、Google に支払うべき金額が決済インテグレータから支払われたことを示します。

たとえば、キャプチャ トランザクションは常に正の値になり、払い戻しトランザクションは常に負の値になります。払い戻しとチャージバックの取り消しイベントは常に正の値になります。チャージバック イベントは常に負の値になります。

この値は マイクロ秒単位です。
eventFee

string (Int64Value format)

必須: 明細書で定義された通貨コード。この値が負の場合、Google から決済インテグレータに移動する金銭的価値を表します。プラスの場合は、Google に支払うべき金額が決済インテグレータから支払われたことを示します。

たとえば、Google が transactionCharge の 1% を決済インテグレータに支払い、その取引の払い戻し時にその 1% を取り消すという契約の場合、キャプチャ手数料はマイナスになり、払い戻し時に払い戻し手数料はプラスになります。

この値は マイクロ秒単位です。
presentmentChargeAmount

string (Int64Value format)

省略可: 外貨換算前の提示（取引）通貨での取引金額。このフィールドは、eventCharge フィールドと同じ符号規則に従います。

この値はマイクロ秒単位です。
presentmentCurrencyCode

string

省略可: 提示（取引）通貨を示す ISO 4217 の 3 文字の通貨コード。
exchangeRate
(deprecated)

string (Int64Value format)

非推奨: 提示金額を決済（請求書）金額に換算する際に使用される為替レート。

この値はマイクロベーシス ポイント（1 ベーシス ポイント = 0.0001 = 0.01%）で表されます。つまり、為替レートを取得するには、このフィールドを 10^10 で割ります。
nanoExchangeRate

string (Int64Value format)

省略可: 提示金額を決済（請求書）金額に換算する際に使用される為替レート（ナノベーシスポイントで表されます）。

この値はナノベーシス ポイント（1 ベーシス ポイント = 0.0001 = 0.01%）で表されます。つまり、為替レートを取得するには、このフィールドを 10^13 で割ります。

このフィールドと exchangeRate の両方が入力されます。これらは、異なる精度で表された同等の為替レートです。今後のバージョンでは、nanoExchangeRate を優先して exchangeRate が削除されます。