第三方应用开发
小程序
基础
连接微信
办公
JS-SDK
基础
连接微信
办公
第三方应用开发
客户端API
JS-SDK
家校沟通
发起班级收款
发起班级收款
最后更新:2025/04/09

目录

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

    兼容性:企业微信 iOS、Android、PC 3.1.10 开始支持

    功能描述

    发起班级收款。

    用于老师对学生家长发起付款请求,接口调用成功后会通过家校通知发送付款小程序给家长。

    ww.createSchoolPayment({
      projectName: '1班班费',
      amount: 100,
      payers: {
        students: ['zhagnshan', 'lisi'],
        departments: [1, 2]
      }
    })

    使用限制

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

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

    • 仅支持配置在家长可使用范围内的应用

    • 企业必须已验证或者已认证

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

    • 发起的用户需在个人微信零钱账户的可用范围内

    参数说明

    params: Object

    属性类型必填说明
    projectNamestring

    收款项目名称

    最多 32 个字。若为空或者超出最大长度,唤起原生收款页面时,客户端会忽略该字段,由用户填写

    amountnumber

    收款金额

    每个学生需付费的金额,单位为分,限额 100000,若非法客户端会忽略该字段

    payersObject

    收款范围

    传入的收款范围若不在老师管理的范围,客户端会过滤掉不展示范围外的数据

    使用限制

    收款范围内展开的学生个数不能超过 1000 人

    属性类型必填说明
    studentsstring[]

    需要收款的学生列表

    departmentsnumber[]

    需要收款的家校通讯录部门列表,支持班级、年级、校区

    successFunction

    成功回调

    failFunction

    失败回调

    cancelFunction

    取消回调

    completeFunction

    完成回调

    返回说明

    Promise<Object>

    属性类型必填说明
    errMsgstring

    通用错误信息

    errCodenumber

    通用错误码

    paymentIdstring

    收款项目 ID,可使用该 ID 调用获取学生付款结果接口

    使用说明

    • 用户可以手动调整收款金额,收款项目和收款范围

    • 通过接口发起的收款,默认收款账户为“我的微信零钱账户”,且不可修改

    • 若用户未授权个人付款码权限,会唤起授权付款码权限页面,授权完成返回页面后会返回错误信息 'require authorize the payment qr code'。用户授权完成后可引导用户重新发起收款

    旧版jweixin调用

    示例代码

    wx.invoke('createSchoolPayment', {
    	projectName:'1班班费',  //收款项目名称
           	amount:100//收款金额,每个学生需付费的金额,单位为分
            payers:{
                  students:['zhagnshan','lisi'], //需要收款的学生列表
                  departments:[1,2], //需要收款的家校通讯录部门列表、支持班级,年级,校区
            }
         }, 
         function(res){
            if(res.err_msg == "createSchoolPayment:ok"){
                paymentId  = res.paymentId ; //收款项目id
            }else {
                //错误处理
            }
        });
    上一篇发起退款
    下一篇微信H5页面唤起填写学生资料页面
      本节内容
    服务端API
    基础
    数据与智能专区
    应用接收专区通知
    连接微信
    客户联系
    办公
    小程序接入对外收款
    客户端API
    小程序
    基础
    连接微信
    办公
    JS-SDK
    基础
    连接微信
    办公
    更新日志
    联系我们