申请解约

更新时间：2024.11.14

商户与用户的签约关系有误或者商户主动要求与用户解除之前的签约协议时可调用此接口完成解约。

注意：

目前商户侧支持两种模式的解约：

1、contract_id模式：使用委托代扣协议id完成解约。

2、plan_id+contract_code模式：使用模板id和委托代扣协议号完成解约。

两种模式解约，返回结果相同

商户可以在商户后台（pay.weixin.qq.com）设置解约回调地址，当发生解约关系的时候，微信服务器会向此地址通知解约信息，内容与签约返回一致（详见签约返回）。

接口说明

适用对象：服务商

请求URL： https://api.mch.weixin.qq.com/papay/deletecontract

请求方式： POST

数据格式： XML

签名方式： MD5

是否需要证书：否

方式1：使用委托代扣协议解约

请求参数

参数名	变量	类型[长度限制]	必填	描述
应用ID	appid	string[1,32]	是	服务商申请的公众号或移动应用appid。示例值：wxcbda96de0b165486
商户号	mch_id	string[1,32]	是	商户号是商户在微信申请微信支付成功后分配的账号ID，登录平台为pay.weixin.qq.com 示例值：1200009811
子商户应用ID	sub_appid	string[1,32]	否	子商户号绑定的appid(非必填，如需操作，需要服务商在商户平台为子商户绑定) 示例值：wxcbda96de0b165489
子商户号	sub_mch_id	string[1,32]	是	微信支付分配的子商户号示例值：1900000109
签名	sign	string[1,32]	是	签名，详见签名生成算法示例值：C380BEC2BFD727A4B6845133519F3AD6
委托代扣协议id	contract_id	string[1,32]	是	委托代扣签约成功后由微信返回的委托代扣协议id，选择contract_id解约，则此参数必填示例值：Wx15463511252015071056489715
解约备注	contract_termination_remark	string[1,512]	是	解约原因的备注说明，如：签约信息有误，须重新签约示例值：解约原因
版本号	version	string[1,8]	是	固定值1.0 示例值：1.0

请求示例：

XML

1<xml>
2  <mch_id>10000098</mch_id>
3  <appid>wxcbda96de0b165486</appid>
4  <sub_mch_id>10010405</sub_mch_id>
5  <sign>E1EE61A91C8E90F299DE6AE075D60A2D</sign>
6  <contract_id>100005698</contract_id>
7  <contract_termination_remark>原因</contract_termination_remark>
8  <version>1.0</version>
9</xml>

方式2：使用模板id和签约协议号解约

请求参数

参数名	变量	类型[长度限制]	必填	描述
应用ID	appid	string[1,32]	是	服务商申请的公众号或移动应用appid。示例值：wxcbda96de0b165486
商户号	mch_id	string[1,32]	是	商户号是商户在微信申请微信支付成功后分配的账号ID，登录平台为pay.weixin.qq.com 示例值：1200009811
子商户应用ID	sub_appid	string[1,32]	否	子商户号绑定的appid(非必填，如需操作，需要服务商在商户平台为子商户绑定) 示例值：wxcbda96de0b165489
子商户号	sub_mch_id	string[1,32]	是	微信支付分配的子商户号示例值：1900000109
签名	sign	string[1,32]	是	签名，详见签名生成算法示例值：C380BEC2BFD727A4B6845133519F3AD6
模板id	plan_id	string[1,128]	是	商户在微信商户平台配置的代扣模板id，选择plan_id+contract_code解约，则此参数必填示例值：12251
签约协议号	contract_code	string[1,128]	是	商户请求签约时传入的签约协议号，商户侧须唯一。选择plan_id+contract_code解约，则此参数必填示例值：1234
解约备注	contract_termination_remark	string[1,512]	是	解约原因的备注说明，如：签约信息有误，须重新签约示例值：解约原因
版本号	version	string[1,8]	是	固定值1.0 示例值：1.0

请求示例：

XML

1<xml>
2  <mch_id>10000098</mch_id>
3  <appid>wxcbda96de0b165486</appid>
4  <sub_mch_id>10010405</sub_mch_id>
5  <sign>E1EE61A91C8E90F299DE6AE075D60A2D</sign>
6  <plan_id>12251</plan_id>
7  <contract_code>1234</contract_code>
8  <contract_termination_remark>原因</contract_termination_remark>
9  <version>1.0</version>
10</xml>

返回参数

参数名	变量	类型[长度限制]	必填	描述
返回状态码	return_code	string[1,16]	是	SUCCESS/FAIL 此字段是通信标识，非交易标识，交易是否成功需要查看result_code来判断示例值：SUCCESS
返回信息	return_msg	string[1,128]	否	返回信息，如非空，为错误原因如：签名失败等。示例值：签名失败

以下字段在return_code为SUCCESS的时候有返回

参数名	变量	类型[长度限制]	必填	描述
应用ID	appid	string[1,32]	是	服务商申请的公众号或移动应用appid。示例值：wxcbda96de0b165486
商户号	mch_id	string[1,32]	是	商户号是商户在微信申请微信支付成功后分配的账号ID，登录平台为pay.weixin.qq.com 示例值：1200009811
子商户应用ID	sub_appid	string[1,32]	否	子商户号绑定的appid(非必填，如需操作，需要服务商在商户平台为子商户绑定) 示例值：wxcbda96de0b165489
子商户号	sub_mch_id	string[1,32]	是	微信支付分配的子商户号示例值：1900000109
委托代扣协议id	contract_id	string[1,32]	是	签约成功后，微信返回的委托代扣协议id 示例值：Wx15463511252015071056489715
模板id	plan_id	string[1,128]	是	协议模板id 示例值：123
签约协议号	contract_code	string[1,128]	是	签约协议号示例值：100001256
签名	sign	string[1,32]	是	详见签名生成算法示例值：C380BEC2BFD727A4B6845133519F3AD6
业务结果	result_code	string[1,16]	是	SUCCESS/FAIL 示例值：SUCCESS
错误代码	err_code	string[1,32]	是	错误码示例值：SIGN_ERROR
错误代码描述	err_code_des	string[1,32]	是	错误码描述示例值：签名错误

返回示例：

正常示例

1<xml>
2  <return_code><![CDATA[SUCCESS]]></return_code>
3  <result_code><![CDATA[SUCCESS]]></result_code>
4  <sign><![CDATA[C380BEC2BFD727A4B6845133519F3AD6]]></sign>
5  <mch_id><![CDATA[10010404]]></mch_id>
6  <appid><![CDATA[wxcbda96de0b165486]]></appid>
7  <sub_mch_id>10010405</sub_mch_id>
8  <contract_id><![CDATA[100005698]]></contract_id>
9</xml>

错误码

错误码	描述	解决方案
SIGN_ERROR	签名错误	验证签名算法
PARAMETER FAIL	参数错误	验证参数
XML FAIL	XML格式错误	检查XML格式
RESULT NULL	查询为空	传入正确查询参数
MERCHANT PERMISSION ERROR	商户没有权限	确认商户权限
MERCHANT AUTHORITY ERROR	商户权限校验失败	联系相关接口人确认委托代扣权限

文档是否有帮助

更多支持

开发文档(商户)开发文档(V2版)开发者社区微信开放平台微信公众平台腾讯客服