Method: refund

针对通过 capture 发起的交易的部分或全部退款。标头和 paymentIntegratorAccountId 中的 requestId 组合是幂等键，用于唯一标识此事务。

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

示例请求如下所示：


{
  "requestHeader": {
    "protocolVersion": {
      "major": 1,
      "minor": 0,
      "revision": 0
    },
    "requestId": "liUrreQY233839dfFFb24gaQM",
    "requestTimestamp": "1502220434778"
  },
  "paymentIntegratorAccountId": "InvisiCashUSA_USD",
  "captureRequestId": "bWVyY2hhbnQgdHJhbnNhY3Rpb24gaWQ",
  "currencyCode": "INR",
  "refundAmount": "208000000"
}

示例响应如下所示：


{
  "responseHeader": {
    "responseTimestamp": "1481900013178"
  },
  "result": "SUCCESS",
  "paymentIntegratorRefundId": "cmVmdW5kIGlkZW50aWZpZXINCg"
}

HTTP 请求

POST https://www.integratorhost.example.com/v1/refund

请求正文

请求正文中包含结构如下的数据：

JSON 表示法 
{
  "requestHeader": {
    object (RequestHeader)
  },
  "paymentIntegratorAccountId": string,
  "captureRequestId": string,
  "currencyCode": string,
  "refundAmount": string
}
字段
requestHeader

object (RequestHeader)

必需：所有请求的通用标头。
paymentIntegratorAccountId

string

必需：这是付款集成商帐号 ID，用于定义与此交易相关的合同限制条件。
captureRequestId

string

必需：此交易的唯一标识符。这是 Google 在 capture 调用期间与此请求关联的 requestId。
currencyCode

string

必需：ISO 4217 货币代码（3 个字母）
refundAmount

string (Int64Value format)

必需：退款金额，以货币单位表示的正数微单位。

响应正文

退款方法的响应对象。

如果成功，响应正文将包含结构如下的数据：

JSON 表示法 
{
  "responseHeader": {
    object (ResponseHeader)
  },
  "paymentIntegratorRefundId": string,
  "result": enum (RefundResultCode),
  "rawResult": {
    object (RawResult)
  }
}
字段
responseHeader

object (ResponseHeader)

必需：所有响应的通用标头。
paymentIntegratorRefundId

string

可选：此标识符特定于集成商，由集成商生成。这是集成商知道这笔退款的标识符。

为方便起见，汇款详情中包含此标识符
result

enum (RefundResultCode)

必需：退款结果。
rawResult

object (RawResult)

OPTIONAL：此退款的原始结果。用于帮助 Google 了解风险引擎和做出分析。在拒绝代码映射的情况下，数据有时会丢失。集成商可以选择向 Google 提供原始代码。例如，信用卡网关（集成商）可使用此字段向 Google 传达从 VISA 网络收到的确切被拒代码。在这种情况下，scope 将是“visa”，而 rawCode 将是 VISA 网络返回的值。

如果 result 不为 SUCCESS，则该值是必需的。

退款结果代码

唯一结果代码退款。

枚举
UNKNOWN_RESULT 切勿设置此默认值！
SUCCESS 退款成功。
NO_MONEY_LEFT_ON_TRANSACTION v1.refund 失败，交易中没有剩余资金。这通常代表集成商和 Google 之间的 bug。Google 不应要求退款金额高于原始照片的退款金额。
ACCOUNT_CLOSED

持有的集成商帐号已关闭。

返回此值会导致用户付款方式被 Google 关闭。系统将要求用户重新执行关联流程，以强制添加新付款方式。
ACCOUNT_CLOSED_ACCOUNT_TAKEN_OVER

用户与集成商的帐号已关闭，怀疑帐号接管。

返回此值会导致用户付款方式被 Google 关闭。系统将要求用户重新执行关联流程，以强制添加新付款方式。
ACCOUNT_CLOSED_FRAUD

由于欺诈行为，用户持有的集成者帐号已被关闭。

返回此值会导致用户付款方式被 Google 关闭。系统将要求用户重新执行关联流程，以强制添加新付款方式。
ACCOUNT_ON_HOLD 用户的帐号目前处于暂停状态，无法接受退款，但该用户帐号随后可能会接受退款。Google 将来可能会再次申请退款，但会使用新的 requestId 来申请退款，因此此请求应被视为已完成。
REFUND_EXCEEDS_MAXIMUM_BALANCE 目前无法处理退款，因为这样做会导致用户的余额超出允许的金额上限。Google 将来可能会再次申请退款，但会使用新的 requestId 来申请退款，因此此请求应被视为已完成。
REFUND_WINDOW_EXCEEDED 无法处理该请求，因为该请求超出了允许的退款期限。