申请解约api

更新时间：2024.12.31

场景介绍

商户与用户的签约关系有误或者商户主动要求与用户解除之前的签约协议时可调用此接口完成解约。目前商户侧支持两种模式的解约：

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

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

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

接口调用请求说明

请求Url	https://api.mch.weixin.qq.com/papay/partner/deletecontract
是否需要证书	否
请求方式	post

请求参数

字段名	变量名	必填	类型	示例值	说明
请求appid	appid	是	String(32)	wxcbda96de0b165486	appid是商户在微信申请公众号或移动应用成功后分配的账号ID，登录平台为mp.weixin.qq.com或open.weixin.qq.com
子商户公众账号ID	sub_appid	否	String(32)	wxcbda96de0b165489	微信分配的子商户公众账号ID
商户号	mch_id	是	String(32)	10000098	商户号是商户在微信申请微信支付成功后分配的账号ID，登录平台为pay.weixin.qq.com
子商户号	sub_mch_id	是	String(32)	1900000109	微信支付分配的子商户号
签名	sign	是	String(32)	C380BEC2BFD727A4B6845133519F3AD6	签名，详见签名生成算法
模板id	plan_id	否	String	12251	商户在微信商户平台配置的代扣模板id，选择plan_id+contract_code解约，则此参数必填
签约协议号	contract_code	否	String(128)	1234	商户请求签约时传入的签约协议号，商户侧须唯一。选择plan_id+contract_code解约，则此参数必填
委托代扣协议id	contract_id	否	String	Wx15463511252015071056489715	委托代扣签约成功后由微信返回的委托代扣协议id，选择contract_id解约，则此参数必填
解约备注	contract_termination_remark	是	String(512)	解约原因	解约原因的备注说明，如：签约信息有误，须重新签约
版本号	version	是	String	1.0	固定值1.0

数据示例（以contract_id解约模式为例）：

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

返回参数

字段名	变量名	必填	类型	示例值	说明
返回状态码	return_code	是	String(16)	SUCCESS	SUCCESS/FAIL 此字段是通信标识，非交易标识，交易是否成功需要查看result_code来判断
返回信息	return_msg	是	String(128)	签名失败	返回信息，如非空，为错误原因签名失败参数格式校验错误

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

字段名	变量名	必填	类型	示例值	说明
公众账号id	appid	是	String(32)	wxcbda96de0b165486	微信支付分配的公众账号id
子商户公众账号ID	sub_appid	否	String(32)	wxcbda96de0b165489	微信分配的子商户公众账号ID
商户号	mch_id	是	String(32)	10000098	微信支付分配的商户号
子商户号	sub_mch_id	是	String(32)	1900000109	微信支付分配的子商户号
委托代扣协议id	contract_id	是	String(32)	100005698	委托代扣签约成功后由微信返回的委托代扣协议id
模板id	plan_id	是	String(32)	123	商户在微信商户平台设置的代扣协议模板id
签约协议号	contract_code	是	String(128)	1234	商户请求签约时传入的签约协议号，商户侧须唯一
业务结果	result_code	是	String(16)	SUCCESS	SUCCESS/FAIL
错误代码	err_code	否	String(32)	SIGN_ERROR	错误码
错误代码描述	err_code_des	否	String(32)	签名错误	错误码描述
签名	sign	是	String(32)	C380BEC2BFD727A4B6845133519F3AD6	签名，详见签名生成算法

数据示例：

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

错误码

错误码	描述	解决方案
SIGN_ERROR	签名错误	验证签名算法
PARAMETER FAIL	参数错误	验证参数
XML FAIL	XML格式错误	检查XML格式
RESULT NULL	查询为空	传入正确查询参数
MERCHANT PERMISSION ERROR	商户没有权限	确认商户权限

文档是否有帮助

更多支持

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