Method: getDisputeInquiryReport

获取报告，其中提供的信息有助于与用户就潜在的付款争议进行客户服务对话。

如果端点在处理请求时遇到错误，来自此端点的响应将是 ErrorResponse 类型。

如果此方法没有返回 HTTP 200，则对此查询的响应可能为空。如果包含明确说明的 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

必需：付款集成商账号标识符，用于标识调用者以及此互动的相关合同限制。
paymentLookupCriteria

object (PaymentLookupCriteria)

必需：用于指明要在此查询中查询的付款的条件。
existingGoogleClaimId

string

可选：由 Google 生成的字符串（之前对 getDisputeInquiryReport 的调用返回），用于唯一标识此客户异议主张。

否则，系统会生成新的版权主张 ID。如果这是同一客户异议的延续，那么调用方可以提供先前对 getDisputeInquiryReport 的调用所返回的 googleClaimId。

系统将在响应的 googleClaimId 字段中返回在此处填充或生成的版权主张 ID。

提供之前对 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

用于唯一地查找付款的条件容器。必须填充一个（且只能有一个）成员字段。

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

必需：此交易的唯一标识符。这是 Google 在查询 capture 调用期间生成的 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)

可选：有关付款的信息。注意：一个订单可进行多笔付款，但其中将仅包含原始请求中指明的付款信息。只适用于部分订单类型。

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 所指定货币的微单位表示。等于 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

可选：此术语不太准确，但通常是指地址的城市/城镇部分。对于没有明确定义 locality 或者其无法很好地对应这个结构的区域，应将 localityName 留空并使用 addressLine。

示例：美国的城市、意大利的市镇、英国的邮镇。
administrativeAreaName

string

可选：此国家/地区的顶级行政区划示例：美国的州、意大利的地区、中国的省、日本的都道府县。”
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 中所指定货币的微单位表示。注意：如果订单采用多次付款的方式支付，此 ID 可能会与 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 未尝试进行身份验证。