APP方式预签约

更新时间:2024.11.18

电商服务商从外部App拉起微信客户端发起签约前,需先后台调用预签约接口完成预签约,获取pre_entrustweb_id,再拉起微信客户端;用户完成签约授权后,再返回App。

注意:

  • 用户在微信的页面中完成委托代扣签约后,微信会同时将签约信息通过异步通知的方式通知给商户后台。如果用户放弃签约或签约失败则不通知。

  • 商户获取的签约会话有效期为2小时。

  • 使用前请确认已开通委托代扣能力

接口说明

支持商户:【平台商户】

请求方式:【POST】/v3/ecommerce/combine-papay/contracts/pre-entrust-sign

请求域名:【主域名】https://api.mch.weixin.qq.com 使用该域名将访问就近的接入点

     【备域名】https://api2.mch.weixin.qq.com 使用该域名将访问异地的接入点 ,指引点击查看

请求参数

Header HTTP头参数

Authorization  必填 string

请参考签名认证生成认证信息


Accept  必填 string

请设置为application/json


Content-Type  必填 string

请设置为application/json


body 包体参数

appid  必填 string(32)

【商户APPID】 appid是电商服务商在微信公众平台 开发平台申请的移动应用成功后分配的账号ID


plan_id  必填 integer

【委托代扣协议模板ID】 委托代扣协议模板ID,申请见接入指引中的接入流程相关内容。


out_contract_code  必填 string(32)

【商户签约协议号】 商户侧的签约协议号,商户侧需保证唯一性。


contract_display_account  必填 string(32)

【用户账户展示名称】 签约用户的名称,用于签约页面展示,在签约时由商户传入。


notify_url  必填 string(256)

【回调通知地址】 接收微信支付异步通知回调地址,通知url必须为直接可访问的URL,不能携带参数。


return_app  选填 boolean

【返回APP标识】 用来控制签约页面结束后的返回路径(不传此参数,则签约完成后停留在微信内)。设置TRUE表示返回APP, 不填则不返回。注:签约参数APPID必须为发起签约的APP所有,且在微信开放平台注册过。

请求示例

POST

1curl -X POST \
2  https://api.mch.weixin.qq.com/v3/ecommerce/combine-papay/contracts/pre-entrust-sign \
3  -H "Authorization: WECHATPAY2-SHA256-RSA2048 mchid=\"1900000001\",..." \
4  -H "Accept: application/json" \
5  -H "Content-Type: application/json" \
6  -d '{
7    "appid" : "wxd678efh567hg6787",
8    "plan_id" : 12535,
9    "out_contract_code" : "wxwtdk20200910100000",
10    "contract_display_account" : "微信代扣用户A",
11    "notify_url" : "https://yourapp.com/notify",
12    "return_app" : true
13  }'
14

应答参数

200 OK

pre_entrustweb_id  必填 string(128)

【预签约ID】 委托代扣签约会话ID,两个小时内有效


mchid  必填 string(32)

【商户号】 微信支付分配的商户号


plan_id  必填 integer

【委托代扣协议模板ID】 委托代扣协议模板ID


out_contract_code  必填 string(32)

【商户签约协议号】 商户侧的签约协议号,商户侧需保证唯一性。

应答示例

200 OK

1{
2  "pre_entrustweb_id" : "5778aadY9nltAsZzXixCkFIGYnV2V",
3  "mchid" : "1900000109",
4  "plan_id" : 12535,
5  "out_contract_code" : "wxwtdk20200910100000"
6}
7

 

错误码

公共错误码

状态码

错误码

描述

解决方案

400

PARAM_ERROR

参数错误

请根据错误提示正确传入参数

400

INVALID_REQUEST

HTTP 请求不符合微信支付 APIv3 接口规则

请参阅 接口规则

401

SIGN_ERROR

验证不通过

请参阅 签名常见问题

500

SYSTEM_ERROR

系统异常,请稍后重试

请稍后重试

业务错误码

状态码

错误码

描述

解决方案

500

SYSTEM_ERROR

接口返回错误

系统异常,请用相同参数重新调用

429

FREQUENCY_LIMITED

频率超限

请降低请求接口频率

400

APPID_MCHID_NOT_MATCH

appid和mch_id不匹配

请确认appid和mch_id是否匹配

404

RESOURCE_NOT_EXISTS

模板不存在

请传入正确的模板Id

403

NO_AUTH

商户无委托代扣权限

请前往商户平台开通对应的委托代扣产品权限

 

 

反馈
咨询
目录
置顶