Skip to main content

创建 Refund 对象

🚀 查看详细参数及数据样例请查看 OpenAPI 接口声明

通过发起一次退款请求创建一个新的 refund 对象,只能对已经发生交易并且没有全额退款的 charge 对象发起退款。当进行全额退款之前,可以进行多次退款,直至全额退款。当一次退款成功后,会发送 Webhooks 通知。

请求参数

NameTypeDescription
amountfloat[OPTIONAL] 退款金额大于 0, 单位为对应币种的最小货币单位,例如:人民币为分(如退款金额为 1 元,此处请填 100)。必须小于等于可退款金额,默认为全额退款。
app_idstring[REQUIRED] 应用 id
charge_idstring[REQUIRED] 支付 Charge Id
descriptionstring[REQUIRED] 退款原因,最多 255 个 Unicode 字符。
extraV1RefundExtra[OPTIONAL] 退款 extra 参数。
merchant_refund_idstring[REQUIRED] 商户系统的退款单号,必须保证唯一。由于 charge 支持多次退款,对于失败重试动作确保使用相同的订单号,以避免重复退款造成损失。
metadatahash[OPTIONAL] 参考元数据。

返回参数

如果发起退款成功,返回一个退款 refund 对象。如果发生错误,则会返回错误码和错误详情。