Method: remittanceStatementDetails

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

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

statementId の値は remittanceStatementNotificationRequest の requestId です。

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

このメソッドが HTTP 200 を返さない場合、このクエリに対するレスポンスは空になる可能性があります。攻撃者が他のインテグレーターの決済インテグレーターのアカウント ID を攻撃者が理解できるように、明確な説明付きの 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 ページに表示するイベント数。指定しない場合または 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)

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

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

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

イベント

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

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 とは、最大長の要件が異なる場合があります。
eventCharge

string (Int64Value format)

必須: ステートメントで定義された通貨コード。この値が負の場合、Google から決済インテグレータに移動した金銭的価値を表します。これが正当である場合は、Google に対する支払いインテグレータからの支払いです。

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

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

string (Int64Value format)

必須: ステートメントで定義された通貨コード。この値が負の場合、Google から決済インテグレータに移動した金銭的価値を表します。これが正当である場合は、Google に対する支払いインテグレータからの支払いです。

たとえば、Google が transactionCharge の 1% を決済事業者に支払い、その取引の払い戻し時にその 1% を差し戻すことが契約で規定されている場合、回収手数料はマイナスになり、払い戻しの際には払い戻し手数料が正の値になります。

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

string (Int64Value format)

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

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

string

省略可: 提示（トランザクション）通貨を表す 3 文字の ISO 4217 通貨コード。
exchangeRate

string (Int64Value format)

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

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

string (Int64Value format)

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

この値はナノnano ベーシス ポイント（1 ベーシス ポイント = .0001 = .01%）で表されます。為替レートを取得するには、このフィールドを 10 の 13 で割ってください。

このフィールドと ExchangeRate の両方に値が入力されます。異なる精度で表される同等の為替レートです。今後のバージョンでは、ExchangeRate が削除され、nanoExchangeRate が使われるようになります。