送金明細書に関するトランザクションの詳細情報を返します。
これはページ分けされた API です。ページあたりのトランザクション イベントの数は、numberOfEvents
で指定できます。指定しない場合、1 ページあたり最大 1, 000 件のイベントが返されます。この API に対する各リクエストは、ステートメント内の次のトランザクション イベントを示す nextEventOffset
と、ステートメント内のトランザクションの合計数を示す totalEvents
を返します。現在取得されたページにステートメントの最後のトランザクションが含まれている場合、レスポンスに nextEventOffset
は含まれません。
statementId
の値は、remittanceStatementNotificationRequest
の requestId
です。
リクエストの処理中にエンドポイントでエラーが発生した場合、このエンドポイントからのレスポンスは
タイプになります。ErrorResponse
このメソッドが HTTP 200 を返さない場合、このクエリに対するレスポンスは空になる可能性があります。明確な説明の
を使用して攻撃者が他のインテグレータの決済インテグレータ アカウント ID を把握できるようにする場合は、レスポンスの本文が空になります。署名鍵が一致しない、決済インテグレータ ID が見つからなかった、暗号鍵が不明ななどの状況の場合、このメソッドは空の本文を含む HTTP 404 を返します。リクエストの署名を検証できた場合は、レスポンスの本文でエラーに関する追加情報が返されます。ErrorResponse
リクエストの例を次に示します。
{
"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 |
必須: この明細に関する契約上の制約を識別する、決済インテグレータのアカウント ID です。 |
statementId |
必須: ステートメント通知のリクエスト ID。 |
eventOffset |
省略可: このオフセットから始まるイベントを返します。このフィールドが返された場合は |
numberOfEvents |
省略可: 1 ページに表示するイベント数。指定されていない場合または 1,000 を超える場合、この値は 1,000 になります。 |
レスポンスの本文
送金明細書の詳細メソッドに対するレスポンス オブジェクト。
成功すると、レスポンスの本文に次の構造のデータが含まれます。
JSON 表現 |
---|
{ "responseHeader": { object ( |
フィールド | |
---|---|
responseHeader |
必須: すべてのレスポンスに共通のヘッダー。 |
remittanceStatementSummary |
必須: この送金明細書の概要。 |
eventOffset |
必須: このレスポンスのイベント オフセット。 |
nextEventOffset |
省略可: 次に返されるイベントのオフセット。指定しない場合、このステートメントで取得するイベントはそれ以上ありません。 |
totalEvents |
必須: このステートメントのイベントの合計数。 |
totalWithholdingTaxes |
必須: この明細書で源泉徴収されたすべての税金の合計。 値の単位はマイクロです。 |
captureEvents[] |
必須: キャプチャ イベントのセット。 |
refundEvents[] |
必須: 払い戻しイベントのセット。 |
reverseRefundEvents[] |
省略可: リバース払い戻しイベントのセット。 |
chargebackEvents[] |
省略可: 一連のチャージバック イベント。 |
reverseChargebackEvents[] |
省略可: リバース チャージバック イベントのセット。 |
adjustmentEvents[] |
省略可: 一連の調整イベント。請求の不一致を調整するために、Google の裁量で調整イベントが追加されることがあります。たとえば、以前の一連のトランザクションの料金が過小計算された場合は、調整を使用してインテグレータが全体となることがあります。 |
RemittanceStatementSummary
送金明細書に関するサマリー オブジェクト。
JSON 表現 |
---|
{ "statementDate": string, "billingPeriod": { object ( |
フィールド | |
---|---|
statementDate |
必須: このステートメントが作成された日付(アメリカ/ロサンゼルス)。 |
billingPeriod |
必須: この明細で対象となる請求対象期間。 |
dateDue |
省略可: 送金期限。これはエポックからのミリ秒数で表されます。日付です(したがって、常に請求タイムゾーンでその日の最初のミリ秒に開始されます)。 これは、 |
currencyCode |
必須: ISO 4217 の 3 文字の通貨コード。 |
totalDueByIntegrator |
必須: この値はマイクロ単位( |
remittanceInstructions |
必須: 支払いの詳細 |
BillingPeriod
この明細書の請求対象期間。
JSON 表現 |
---|
{ "startDate": string, "endDate": string } |
フィールド | |
---|---|
startDate |
必須: 請求対象期間の開始日。これはエポックからのミリ秒数で表されます。日付です(したがって、常に請求タイムゾーンでその日の最初のミリ秒に開始されます)。 請求対象期間の最初のミリ秒(00:00:00.000)です。 |
endDate |
必須: 請求対象期間の終了日。これはエポックからのミリ秒数で表されます。 請求対象期間の最終日である 23:59:59.999 の最後のミリ秒です。 |
RemittanceInstructions
この送金通知のお支払い方法に関する情報を構造化します。
JSON 表現 |
---|
{ "memoLineId": string } |
フィールド | |
---|---|
memoLineId |
必須: 送金 ID の支払いのためのメモ欄に必ず記載する ID。 |
イベント
送金明細書に含まれる単一のイベントを表す構造。
JSON 表現 |
---|
{ "eventRequestId": string, "paymentIntegratorEventId": string, "eventCharge": string, "eventFee": string, "presentmentChargeAmount": string, "presentmentCurrencyCode": string, "exchangeRate": string, "nanoExchangeRate": string } |
フィールド | |
---|---|
eventRequestId |
必須: 回収イベントまたは払い戻しイベントの場合、これは Google がリクエストとともに送信する |
paymentIntegratorEventId |
必須: このイベントに対して返された決済インテグレータの ID。キャプチャの場合、これは このフィールドは可変長です。インテグレータのため、このイベントに指定した ID がここに反映されます。対応するイベントの値がインテグレータによって提供されていない場合、このフィールドには リバース 払い戻し、チャージバック、リバース チャージバック イベントの場合、イベントの通知とともに決済インテグレータが送信した このフィールドの長さと形式は、各 ID のソース フィールドによって異なります。長さと文字セットの要件について詳しくは、各ソースフィールドのドキュメントをご覧ください。特に、このフィールドには Google が生成した ID が含まれることがあり、その場合、インテグレータが生成した ID とは異なる最大長の要件が適用されることがあります。 |
eventCharge |
必須: ステートメントで定義されている通貨コードで指定します。この値が負の場合、Google から決済インテグレータに移る金銭的価値を表します。これが正しい場合は、Google に対する決済インテグレータからの支払いです。 たとえば、回収トランザクションは常に正になり、払い戻しトランザクションは常に負になります。リバース 払い戻しとリバース チャージバック イベントは常に正の値となります。チャージバック イベントは常にマイナスになります。 値の単位はマイクロです。 |
eventFee |
必須: ステートメントで定義されている通貨コードで指定します。この値が負の場合、Google から決済インテグレータに移る金銭的価値を表します。これが正しい場合は、Google に対する決済インテグレータからの支払いです。 たとえば、Google が決済インテグレータに 値の単位はマイクロです。 |
presentmentChargeAmount |
省略可: 外国為替前の提示(トランザクション)通貨での取引金額。このフィールドは、 値の単位はマイクロです。 |
presentmentCurrencyCode |
省略可: 提示(トランザクション)の通貨を示す 3 文字の ISO 4217 通貨コード。 |
exchangeRate |
省略可: 提示額を決済(請求書)金額に変換するために使用される為替レート。 この値はマイクロ ベーシス ポイント(1 ベーシス ポイント = 0.0001 = 0.01%)で表します。つまり、為替レートを求めるには、このフィールドを 10 の 10 の乗算で割ります。 |
nanoExchangeRate |
省略可: 提示額を決済額(請求書)に変換するために使用される為替レート。ナノベーシスポイントで表されます。 この値は、ナノ ベーシス ポイントで表されます(1 ベーシス ポイント = 0.0001 = 0.01%)。つまり、為替レートを求めるには、このフィールドを 10 の 13 乗で割ります。 このフィールドと exchangeRate の両方にデータが入力されます。これらは異なる精度で表される同等の為替レートです。今後のバージョンでは、ExchangeRate が削除され、nanoExchangeRate に置き換えられる予定です。 |