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

目录

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

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

    功能描述

    发起对外收款。

    ww.createExternalPayment({
      paymentType: 0,
      totalFee: 300,
      description: '可乐一罐'
    })

    使用限制

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

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

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

    • 允许第三方应用、代开发应用和自建应用调用

    参数说明

    params: Object

    属性类型必填说明
    paymentTypenumber

    收款方式

    不填默认为在聊天中收款。

    合法值说明
    0

    在聊天中收款

    1

    收款码收款

    totalFeenumber

    收款金额

    单位为分,允许范围 1~5,000,000 分

    descriptionstring

    收款说明

    “在聊天中收款” 不超过32个字,“收款码收款”不超过16个字。若为空或者超出最大长度,唤起收款页面时,客户端会忽略该字段,由用户填写。

    successFunction

    成功回调

    failFunction

    失败回调

    cancelFunction

    取消回调

    completeFunction

    完成回调

    返回说明

    Promise<Object>

    属性类型必填说明
    errMsgstring

    通用错误信息

    errCodenumber

    通用错误码

    paymentIdstring

    收款项目 ID

    可使用该 ID 获取收款项目的商户单号

    旧版jweixin调用

    示例代码

    wx.invoke('createExternalPayment', {
    	    paymentType:0,  //收款方式
           	totalFee:300//收款金额,单位为分
            description:'可乐一罐' //收款说明
         }, 
         function(res){
            if(res.err_msg == "createExternalPayment:ok"){
                paymentId = res.paymentId ; //收款项目id
            }else {
                //错误处理
            }
        });
    上一篇进入微信客服消息界面
    下一篇发起退款
      本节内容
    服务端API
    基础
    连接微信
    办公
    会议
    会议统计管理
    客户端API
    小程序
    基础
    连接微信
    办公
    JS-SDK
    基础
    连接微信
    办公
    更新日志
    联系我们