Method: getDisputeInquiryReport

支払いに関する異議申し立ての可能性について、カスタマー サポートとユーザーとの会話を円滑に進めるための情報を提供するレポートを取得します。

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

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

リクエストの例を次に示します。


{
  "requestHeader": {
    "protocolVersion": {
      "major": 1,
      "minor": 1,
      "revision": 0
    },
    "requestId": "HsKv5pvtQKTtz7rdcw1YqE",
    "requestTimestamp": "1519996751331"
  },
  "paymentIntegratorAccountId": "InvisiCashUSA",
  "paymentLookupCriteria": {
    "googleTransactionReferenceNumberCriteria": {
      "googleTransactionReferenceNumber": "714545417102363157911822",
      "authorizationCode": "111111"
    }
  },
  "existingGoogleClaimId": "138431383281",
  "requestOriginator": {
    "organizationId": "ISSUER_256",
    "organizationDescription": "Community Bank of Some City",
    "agentId": "982749"
  }
}

レスポンスの例を次に示します。


{
  "responseHeader": {
    "responseTimestamp": "1519996752221"
  },
  "result": "SUCCESS",
  "googleClaimId": "138431383281",
  "report": {
    "customerAccount": {
      "customerEmail": "example@gmail.com",
      "customerName" : "Example Customer"
    },
    "order": {
      "timestamp": "1517992525972",
      "orderId": "SOP.8976-1234-1234-123456..99",
      "currencyCode": "USD",
      "subTotalAmount": "206990000",
      "totalAmount": "212990000",
      "shippingAddress": {
        "name": "Example Customer",
        "addressLine": ["123 Main St"],
        "localityName": "Springfield",
        "administrativeAreaName": "CO",
        "postalCodeNumber": "80309",
        "countryCode": "US"
      },
      "taxes": [
        {
          "description": "Colorado Sales Tax",
          "amount": "6000000"
        }
      ],
      "items": [
        {
          "description": "Super cool gizmo",
          "merchant": "HTC",
          "googleProductName": "Google Store",
          "quantity": "2",
          "totalPrice": "198000000"
        },
        {
          "description": "Gizmo charger",
          "merchant": "HTC",
          "googleProductName": "Google Store",
          "quantity": "1",
          "totalPrice": "8990000"
        }
      ]
    },
    "payment": {
      "billingAddress" : {
        "name": "Example Customer",
        "addressLine": ["123 Main St"],
        "localityName": "Springfield",
        "administrativeAreaName": "CO",
        "postalCodeNumber": "80309",
        "countryCode": "US"
      },
      "amount": "100000000",
      "refunds": [
        {
          "amount": "9250000",
          "initiatedTimestamp": "1518811245384"
        }
      ],
      "cardDetails": {
        "authResult": "APPROVED"
      }
    }
  }
}

HTTP リクエスト

POST https://vgw.googleapis.com/secure-serving/gsp/v1/getDisputeInquiryReport/:PIAID

リクエスト本文

リクエストの本文には、次の構造のデータが含まれます。

JSON 表現 
{
  "requestHeader": {
    object (RequestHeader)
  },
  "paymentIntegratorAccountId": string,
  "paymentLookupCriteria": {
    object (PaymentLookupCriteria)
  },
  "existingGoogleClaimId": string,
  "requestOriginator": {
    object (RequestOriginator)
  }
}
フィールド
requestHeader

object (RequestHeader)

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

string

必須: 呼び出し元と、このインタラクションに関連する契約上の制約を識別する決済インテグレータのアカウント ID。
paymentLookupCriteria

object (PaymentLookupCriteria)

必須: この問い合わせを検索する支払いを指定する条件。
existingGoogleClaimId

string

省略可: 前回の getDisputeInquiryReport の呼び出しによって返された、顧客の異議申し立てを一意に識別する文字列。Google が生成します。

このファイルが存在しない場合は、新しい申し立て ID が生成されます。同じ顧客からの異議申し立てが継続している場合、呼び出し元は、前回の getDisputeInquiryReport の呼び出しで返された googleClaimId を提供することがあります。

ここに入力、または生成された申し立て ID は、レスポンスの googleClaimId フィールドで返されます。

前回の getDisputeInquiryReport 呼び出しで返されていない googleClaimId を指定することはできません。この場合、HTTP 400 Bad Request が返されます。
requestOriginator

object (RequestOriginator)

必須: このリクエスト送信元の組織または組織サブグループに関する情報。

レスポンスの本文

getDisputeInquiryReport メソッドのレスポンス ペイロード。

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

JSON 表現 
{
  "responseHeader": {
    object (ResponseHeader)
  },
  "result": enum (GetDisputeInquiryReportResultCode),
  "googleClaimId": string,
  "report": {
    object (PurchaseReport)
  }
}
フィールド
responseHeader

object (ResponseHeader)

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

enum (GetDisputeInquiryReportResultCode)

必須: この呼び出しの結果。
googleClaimId

string

省略可: この顧客の異議申し立てを一意に識別する、Google が生成する文字列。（result が SUCCESS の場合のみ表示されます）。

リクエストで existingGoogleClaimId が入力されている場合は、同じ値になります。それ以外の場合は、新しく生成された値です。この値は、お客様から同じ異議申し立ての一部である場合は、今後の getDisputeInquiryReport リクエストで指定できます。
report

object (PurchaseReport)

任意: リクエストで指定された支払いに関する異議申し立てに関する詳細情報。（result が SUCCESS の場合のみ表示されます）。

PaymentLookupCriteria

支払いを一意に検索できる条件のコンテナ。メンバー フィールドは 1 つだけ入力する必要があります。

JSON 表現 
{

  // Union field criteria can be only one of the following:
  "arnCriteria": {
    object (ArnCriteria)
  },
  "googleTransactionReferenceNumberCriteria": {
    object (GoogleTransactionReferenceNumberCriteria)
  },
  "captureRequestCriteria": {
    object (CaptureRequestCriteria)
  }
  // End of list of possible types for union field criteria.
}
フィールド

共用体フィールド criteria。

criteria は次のいずれかになります。
arnCriteria

object (ArnCriteria)

省略可: アクワイアラ参照番号（ARN）に基づく検索。
googleTransactionReferenceNumberCriteria

object (GoogleTransactionReferenceNumberCriteria)

省略可: Google 取引照会番号に基づいて検索します。
captureRequestCriteria

object (CaptureRequestCriteria)

省略可: 回収リクエスト ID に基づいて検索します。

ArnCriteria

加盟店参照番号（ARN）に基づく支払い照合基準。

JSON 表現 
{
  "acquirerReferenceNumber": string,
  "authorizationCode": string
}
フィールド
acquirerReferenceNumber

string

必須: 支払いを一意に識別するカード発行会社参照番号（ARN）。23 桁で入力してください。
authorizationCode

string

必須: 取引の認証コード。

GoogleTransactionReferenceNumberCriteria

Google が生成した取引参照番号に基づく、支払いの照合条件。

JSON 表現 
{
  "googleTransactionReferenceNumber": string,
  "authorizationCode": string
}
フィールド
googleTransactionReferenceNumber

string

必須: Google が自動生成した、お支払いを一意に識別する取引照会番号。
authorizationCode

string

必須: 取引の認証コード。

CaptureRequestCriteria

元の回収リクエストに基づく支払い照合基準。

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

string

必須: この取引の一意の識別子。これは、ルックアップ中の capture 呼び出し中に Google が生成した requestId です。

RequestOriginator

この要求の発信元の組織または組織のサブグループに関する情報（およびオプションで従業員に関する情報）。これにより、Google は問題や不正使用を特定し、paymentIntegratorAccountId よりも細かいレベルで制御を実装できます。呼び出し元が、複数の外部クライアントからリクエストを調達する中間サービス プロバイダである場合に特に有用です。

JSON 表現 
{
  "organizationId": string,
  "organizationDescription": string,
  "agentId": string
}
フィールド
organizationId

string

必須: このリクエスト送信元の会社、組織、組織グループの識別子。この paymentIntegratorAccountId 内で一意にする必要があります。
organizationDescription

string

必須: 人が読める形式の組織の名前または説明。Google の従業員とインテグレータとの間のコミュニケーションを容易にします。
agentId

string

省略可: このリクエストの送信元である organizationId によって特定される組織の特定のエージェント（従業員）の一意の識別子。この organizationId 内で一意にする必要があります。

GetDisputeInquiryReportResultCode

getDisputeInquiryReport メソッド呼び出しの結果。

列挙型
UNKNOWN_RESULT このデフォルト値は設定しないでください。
SUCCESS 支払いが見つかったため、レポートが提供されます。
PAYMENT_NOT_FOUND リクエストされたお支払いが見つかりませんでした。
PAYMENT_TOO_OLD リクエストされたお支払いは見つかりましたが、お支払いの期限によりレポートが提供されませんでした。
ORDER_CANNOT_BE_RETURNED リクエストされた支払いは、存在する注文に属していますが、返品できません。たとえば、注文が所有者の要請によって削除された場合などです。
NO_ADDITIONAL_DETAILS リクエストされたお支払いが見つかりましたが、レポートはありません。

PurchaseReport

リクエストされた支払いに関連する購入の関連情報を含むレポート。

JSON 表現 
{
  "customerAccount": {
    object (CustomerAccount)
  },
  "order": {
    object (Order)
  },
  "payment": {
    object (Payment)
  }
}
フィールド
customerAccount

object (CustomerAccount)

必須: お客様とお客様のアカウントに関する情報。
order

object (Order)

必須: 支払いが行われた注文に関する情報。
payment

object (Payment)

省略可: 支払いに関する情報。注: 1 件の注文に対して複数のお支払いが可能ですが、これには元のリクエストで特定されたお支払いに関する情報のみが含まれます。注文の種類によっては利用できない場合があります。

CustomerAccount

お客様のアカウントに関する情報

JSON 表現 
{
  "customerEmail": string,
  "customerName": string
}
フィールド
customerEmail

string

必須: お客様の Google アカウントに関連付けられているメールアドレス。
customerName

string

必須: お客様の名前。

注文

注文に関する情報。

JSON 表現 
{
  "timestamp": string,
  "orderId": string,
  "currencyCode": string,
  "subTotalAmount": string,
  "totalAmount": string,
  "shippingAddress": {
    object (Address)
  },
  "items": [
    {
      object (Item)
    }
  ],
  "taxes": [
    {
      object (Tax)
    }
  ]
}
フィールド
timestamp

string (int64 format)

省略可: 注文が行われたときのタイムスタンプ。エポックからのミリ秒で表します。注文の種類によっては利用できない場合があります。
orderId

string

省略可: この注文を一意に識別する文字列。注文の種類によっては利用できない場合があります。
currencyCode

string

省略可: 注文のすべての金額に適用される ISO 4217 の 3 文字の通貨コード。注文の種類によっては利用できない場合があります。
subTotalAmount

string (Int64Value format)

省略可: この注文（税抜き）の合計金額。order.currencyCode で指定した通貨の 100% として表されます。これは SUM(items.totalPrice) に相当します。注文の種類によっては利用できない場合があります。
totalAmount

string (Int64Value format)

省略可: この注文の合計額（税金を含む）。order.currencyCode で指定した通貨のマイクロ単位で表します。これは subTotalAmount + SUM(taxes.amount) に相当します。注文の種類によっては利用できない場合があります。
shippingAddress

object (Address)

省略可: この注文に含まれる商品の配送先住所。
items[]

object (Item)

必須: この注文に含まれていた商品アイテムのリスト。
taxes[]

object (Tax)

必須: この注文に含まれていた商品アイテムのリスト。このリストは空です。

住所

住所に関する情報を保持する構造体。

JSON 表現 
{
  "name": string,
  "addressLine": [
    string
  ],
  "localityName": string,
  "administrativeAreaName": string,
  "postalCodeNumber": string,
  "countryCode": string
}
フィールド
name

string

省略可: 顧客の氏名。
addressLine[]

string

省略可: 構造化されていない住所テキストを保持します。
localityName

string

省略可: 曖昧な用語ですが、通常は住所の市区町村の部分を指します。地域区分が十分に定義されていない地域や、この構造にうまく適合しない地域（日本や中国など）では、localityName を空にして、addressLine を使用します。

例: 米国の都市、イタリアのコミューン、英国の郵便区域。
administrativeAreaName

string

省略可: この国の最上位の行政区域例: 米国の州、IT 地域、中国の都道府県、日本の都道府県。
postalCodeNumber

string

省略可: その名前にもかかわらず、postalCodeNumber の値には英数字が使用されることがよくあります。例: 「94043」、「SW1W」、「SW1W 9TQ」
countryCode

string

省略可: お客様の住所の国コード。ISO-3166-1 Alpha-2 が想定されます。

項目

注文に含まれる商品に関する情報。

JSON 表現 
{
  "description": string,
  "merchant": string,
  "quantity": string,
  "totalPrice": string,
  "googleProductName": string
}
フィールド
description

string

省略可: 購入された商品の説明。注文の種類によっては利用できない場合があります。
merchant

string

必須: 商品アイテムの販売者、アーティスト、またはメーカー。
quantity

string (Int64Value format)

省略可: この商品アイテムの注文数。

整数の数量が商品に適用されない場合（たとえば、従量制の商品には小数値の数量が含まれる場合）、このフィールドは省略されます。
totalPrice

string (Int64Value format)

省略可: この商品アイテムの合計価格。order.currencyCode で指定した通貨の マイクロ単位で表します。quantity が入力されている場合、数量全体の合計金額が反映されます。注文の種類によっては利用できない場合があります。
googleProductName

string

必須: 商品アイテムの Google サービスの名前。

税金

この注文に適用される税金に関する情報です。

JSON 表現 
{
  "description": string,
  "amount": string
}
フィールド
description

string

必須: 税金の説明。
amount

string (Int64Value format)

必須: 税額。order.currencyCode で指定された通貨のマイクロ単位で表します。

お支払い

お支払いに関する情報。

JSON 表現 
{
  "billingAddress": {
    object (Address)
  },
  "amount": string,
  "refunds": [
    {
      object (Refund)
    }
  ],

  // Union field fopDetails can be only one of the following:
  "cardDetails": {
    object (PaymentCardDetails)
  }
  // End of list of possible types for union field fopDetails.
}
フィールド
billingAddress

object (Address)

必須: このお支払いの請求先住所。
amount

string (Int64Value format)

必須: この支払いの金額。order.currencyCode で指定された通貨のマイクロ単位で表します。注: 注文が複数の支払い方法で支払われた場合は、order.totalAmount と一致しないことがあります。
refunds[]

object (Refund)

必須: この支払いに対して行われた払い戻しの一覧。このリストは空です。

共用体フィールド fopDetails。

fopDetails は次のいずれかになります。
cardDetails

object (PaymentCardDetails)

省略可: クレジットとデビットカードの FoP。

払い戻し

お支払いに対する払い戻しに関する情報。

JSON 表現 
{
  "amount": string,
  "initiatedTimestamp": string
}
フィールド
amount

string (Int64Value format)

必須: 払い戻し額。order.currencyCode で指定された通貨のマイクロの正の数。
initiatedTimestamp

string (int64 format)

必須: 払い戻しが開始された時点のタイムスタンプ。エポックからのミリ秒数で表されます。

PaymentCardDetails

クレジット / サービス固有のお支払いの詳細。

JSON 表現 
{
  "authResult": enum (AuthResult)
}
フィールド
authResult

enum (AuthResult)

必須: 支払い承認の結果。

AuthResult

支払い承認の結果。

列挙型
UNKNOWN_RESULT このデフォルト値は設定しないでください。
APPROVED 認証が承認されました。
DENIED 認証が拒否されました。
NOT_ATTEMPTED 認証を試みませんでした。