第三方应用开发 客户端API 小程序 对外收款 发起退款
发起退款
最后更新:2022/08/04
可联系渠道经理采购或代理智慧硬件接口已支持设备 联系渠道经理
发起退款
最后更新:2022/08/04

该接口可以用于商户对客户发起退款请求。
接口定义

wx.qy.refundExternalPayment({
	paymentId:'xxxx',  //收款项目id
	outTradeNo:'yyyy', //收款单号
    refundFee:100,  //退款金额,单位为分
    refundComment:'7天无理由退货'//退款说明
    success: function(res) {
            //正确处理
    }
    fail: function(res) {
            //错误处理
    }
});

输入参数说明:

参数类型是否必须说明
paymentIdString收款项目id。 在发起对外收款中返回。
outTradeNoString收款单号。每笔支付对应一个商户单号
refundFeeInt退款金额,单位为分。要求低于该次付款的金额。若为空,将退回该次付款的全额。
refundCommentString退款说明,不超过32个字,可为空。若为空或者超出最大长度,唤起退款页面时,客户端会忽略该字段,由用户填写

 

返回参数 json 结构示例:

{
     "errMsg":"refundExternalPayment:ok"
}

调用前提:

  1. 在企业微信4.0.12及以后版本支持;
  2. 必须先调用过wx.qy.login,且session_key未过期,开发者可调用checkSession 检查当前登录态;
  3. 应用需要具有对外收款权限;
  4. 发起的用户必须在应用可见范围,且实名;
  5. 只允许退款由应用本身发起的收款;
  6. 允许第三方应用、代开发应用和自建应用调用。
上一篇
发起对外收款
下一篇
wx.qy.createSchoolPayment