Method: remittanceStatementDetails

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

これはページ分けされた API です。ページあたりのトランザクション イベントの数は numberOfEvents で指定できます。指定しない場合は、1 ページあたり最大 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

必須: このステートメントに関連する契約上の制約を識別する決済インテグレーターのアカウント ID。
statementId

string

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

integer

省略可: このオフセットで始まるイベントを返します。返された場合は nextEventOffset に、最初のリクエストの場合は未指定のままにする必要があります。eventOffset がゼロの場合、最初のイベントからイベントが返されます。2 つ目の場合、3 つ目のイベントからイベントが返されます。指定しない場合、eventOffset はゼロとみなされます。
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 の裁量で調整イベントが追加される場合があります。たとえば、以前のトランザクションのセットに対して料金が過少計算されている場合、調整を使用してインテグレーター全体を作成できます。

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: 送金識別のために支払いのメモ行に入力する必要がある識別子。

イベント

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

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

string

必須: キャプチャ イベントや払い戻しイベントの場合、これはリクエストと一緒に Google から送信されるrequestIdになります。リバース 払い戻し、チャージバック、リバース チャージバック イベントの場合は、このイベントを通知として決済インテグレーターが送信する requestId になります。調整の場合は、調整イベントに Google が割り当てる一意の ID です。
paymentIntegratorEventId

string

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

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

リバース 払い戻し、チャージバック、リバース チャージバック イベントの場合、これは、決済インテグレーターがイベント通知とともに送信した requestId になります。

このフィールドの長さと形式は各 ID のソース フィールドによって異なります。長さと文字セットの要件について詳しくは、各ソース フィールドのドキュメントをご覧ください。特に、このフィールドには Google が生成した ID が含まれることがあり、この 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

string (Int64Value format)

省略可: 提示額を決済（請求書）額に換算するために使用される為替レート。

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

string (Int64Value format)

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

この値は nano ベース ポイント（1 ベースポイント = .0001 = .01%）です。為替レートを取得するには、このフィールドを 10^13 で割ります。

このフィールドと exchangeRate の両方が入力されます。換算レートはさまざまな精度で表現されます。今後のバージョンでは、exchangeRate が削除され、nanoExchangeRate に置き換えられます。