JSAPI预签约
更新时间:2025.03.21该方式适用于微信公众号内发起签约。用户在完成签约后可返回商户签约页面。
|
1. 接口说明
适用对象: 直连模式 机构模式
请求URL:https://apihk.mch.weixin.qq.com/v3/global/papay/contracts/jsapi-pre-entrust-sign
请求方式:POST
Path 指该参数为路径参数
Query 指该参数为URL参数
Body 指该参数需在请求JSON传参
时序图
2. 请求参数
参数名 | 变量 | 类型[长度限制] | 必填 | 描述 |
---|---|---|---|---|
应用ID | appid | string[1, 32] | 是 | Body 商户号绑定的AppID |
子商户号 | sub_mchid | string[1, 32] | 是 | Body 微信支付分配的子商户号 |
服务商应用ID | sp_appid | string[1, 32] | 是 | Body 服务商绑定的AppID |
子商户应用ID | sub_appid | string[1, 32] | 否 | Body 发起签约的子商户号绑定的AppID |
模板ID | plan_id | int | 是 | Body 协议模板ID,该模板ID是商户在向微信支付提交代扣权限申请时由微信支付生成 |
商户侧签约协议号 | out_contract_code | string[1, 32] | 是 | Body 商户请求签约时传入的签约协议号,商户侧须唯一 |
用户账户展示名称 | user_display_name | string[1, 32] | 是 | Body 签约用户的名称,用于页面展示,不需要对值进行URL编码,参数值不支持UTF8非3字节编码的字符,例如表情符号,所以请勿传微信昵称到该字段 |
签约成功通知URL | success_notify_url | string[1, 256] | 是 | Body HTTPS开头的回调通知URL ,不需要对值进行URL编码 |
商户AppID下的用户标识 | openid | string[1, 128] | 是 | Body 用户在商户AppID下的OpenID,服务商模式为子商户下的用户OpenID,可详见获取openid |
签约完成跳转URL | return_url | string[1, 256] | 否 | Body 用来控制签约页面结束后的返回路径(不传此参数,则签约完成后停留在微信内)。非空时,URL路径前缀需在申请模板时提供给微信支付运营人员配置,未配置或者前缀不匹配则不跳转 |
过期时间 | expired_time | string[1, 64] | 否 | Body 境外代扣签约会话ID过期时间,遵循rfc3339标准格式,格式为YYYY-MM-DDTHH:mm:ss+TIMEZONE,YYYY-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss表示时分秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。例如:2021-11-20T13:29:35+08:00表示,北京时间2021年11月20日 13点29分35秒。 |
请求示例
场景一:直连模式
场景二:服务商模式/机构模式
3. 返回参数
参数名 | 变量 | 类型[长度限制] | 必填 | 描述 |
---|---|---|---|---|
签约跳转URL | sign_url | string[1,512] | 是 | 有效期为10分钟,跳转签约页面URL,用户通过跳转访问此URL即可进入微信签约页面,进行签约。签约完成后,按照 return_appid 的描述跳转回对应的应用 |
返回示例
正常示例
4. 错误码
状态码 | 错误码 | 描述 | 解决方案 |
---|---|---|---|
403 | CONTRACT_EXISTED | 已开通自动扣费服务功能,无需重复开通 | 已开通自动扣费服务功能,无需重复开通;如需重新签约,需解约后再发起签约 |
400 | PARAM_ERROR | 参数错误 | 传入正确查询参数 |
500 | SYSTEM_ERROR | 系统错误 | 请稍等重试 |