该接口可以用于商户对客户发起退款请求。
接口定义
wx.qy.refundExternalPayment({
paymentId:'xxxx', //收款项目id
outTradeNo:'yyyy', //收款单号
refundFee:100, //退款金额,单位为分
refundComment:'7天无理由退货', //退款说明
success: function(res) {
//正确处理
},
fail: function(res) {
//错误处理
},
});
输入参数说明:
参数 | 类型 | 是否必须 | 说明 |
---|---|---|---|
paymentId | String | 是 | 收款项目id。 在发起对外收款中返回。 |
outTradeNo | String | 是 | 收款单号。每笔支付对应一个商户单号 |
refundFee | Int | 否 | 退款金额,单位为分。要求低于该次付款的金额。若为空,将退回该次付款的全额。 |
refundComment | String | 否 | 退款说明,不超过32个字,可为空。若为空或者超出最大长度,唤起退款页面时,客户端会忽略该字段,由用户填写 |
返回参数 json 结构示例:
{
"errMsg":"refundExternalPayment:ok"
}
调用前提: