企业内部开发
小程序
基础
连接微信
办公
JS-SDK
基础
连接微信
办公
企业内部开发
客户端API
JS-SDK
对外收款
发起退款
发起退款
最后更新:2025/03/27

目录

  • ww.refundExternalPayment(params)
  • 功能描述
  • 使用限制
  • 参数说明
  • params: Object
  • 返回说明
  • 旧版jweixin调用
  • 示例代码
  • ww.refundExternalPayment(params)

    兼容性:企业微信 4.0.12 开始支持

    功能描述

    发起退款。

    ww.refundExternalPayment({
      paymentId: 'xxxx',
      outTradeNo: 'yyyy',
      refundFee: 100,
      refundComment: '7天无理由退货'
    })

    使用限制

    • 本接口必须使用应用身份进行注册

    • 应用必须具有对外收款权限

    • 发起的用户必须在应用可见范围并实名

    • 只允许退款由应用本身发起的收款

    参数说明

    params: Object

    属性类型必填说明
    paymentIdstring

    收款项目 ID,在发起对外收款中返回

    outTradeNostring

    收款单号,每笔支付对应一个商户单号

    refundFeenumber

    退款金额

    单位为分,要求低于该次付款的金额,要求低于该次付款的金额。若为空,将退回该次付款的全额

    refundCommentstring

    退款说明,不超过32个字,可为空。若为空或者超出最大长度,唤起退款页面时,客户端会忽略该字段,由用户填写

    successFunction

    成功回调

    failFunction

    失败回调

    cancelFunction

    取消回调

    completeFunction

    完成回调

    返回说明

    Promise<Object>

    属性类型必填说明
    errMsgstring

    通用错误信息

    errCodenumber

    通用错误码

    旧版jweixin调用

    示例代码

    wx.invoke('refundExternalPayment', {
    	    paymentId:'xxxx',  //收款项目id
    		outTradeNo:'yyyy', //收款单号
           	refundFee:100//退款金额,单位为分
            refundComment:'7天无理由退货' //退款说明
         }, 
         function(res){
            if(res.err_msg == "refundExternalPayment:ok"){
                //正确处理
            }else {
                //错误处理
            }
        });
    上一篇发起对外收款
    下一篇发起班级收款
      本节内容
    服务端API
    基础
    连接微信
    办公
    会议
    会议统计管理
    客户端API
    小程序
    基础
    连接微信
    办公
    JS-SDK
    基础
    连接微信
    办公
    更新日志
    联系我们