微信支付境外文档-委托代扣

返回上一层委托代扣 / 申请解约API

申请解约API

最新更新时间：2021.08.15 版本说明

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

注意：

• 目前商户侧支持使用委托代扣协议id完成解约。同时，用户可以通过微信客户端发起解约，解约结果将通过“解约回调地址”通知商户侧。商户在申请代扣权限获取模板ID时，需要同时提供“解约回调地址”给到微信支付进行配置，当发生解约关系的时候，微信服务器会向此地址通知解约信息，内容与签约返回一致（详见签约返回）。

接口说明

适用对象：直连模式机构模式

接口URL：https://apihk.mch.weixin.qq.com/v3/global/papay/contracts/{contract_id}/terminate

请求方式：POST

接口规则：https://wechatpay-api.gitbook.io/wechatpay-api-v3/

path 指该参数为路径参数

query 指该参数为URL参数

body 指该参数需在请求JSON传参

请求参数

参数名	变量	类型[长度限制]	必填	描述
委托代扣协议ID	contract_id	string[1,64]	是	path委托代扣签约成功后由微信返回的委托代扣协议id，选择contract_id查询，则此参数必填示例值：100005698
应用ID	appid	string[1,32]	是	body商户号绑定的appid 注意：仅适用于直连模式示例值：wxcbda96de0b165486
服务商应用ID	sp_appid	string[1,32]	是	body服务商绑定的appid 注意：仅适用于机构模式示例值：wxcbda96de0b165486
子商户号	sub_mchid	string[1,32]	是	body微信支付分配的子商户号注意：仅适用于机构模式示例值：10000097
子商户应用ID	sub_appid	string[1,32]	否	body发起签约的子商户号绑定的appid 注意：仅适用于机构模式示例值：wxcbda96de0b165484
解约备注	termination_note	string[1,256]	否	body解约原因的备注说明，如：签约信息有误，须重新签约示例值：解约原因

请求示例


POST
https://apihk.mch.weixin.qq.com/v3/global/papay/contracts/100005698/terminate
{
"appid": "wxcbda96de0b165486", 
"termination_note": "Cause of termination" 
}


POST
https://apihk.mch.weixin.qq.com/v3/global/papay/contracts/100005698/terminate
{
"sp_appid": "wxcbda96de0b165486",
"sub_mchid": "10000097",
"sub_appid": "wxcbda96de0b165484", 
"termination_note": "Cause of termination" 
}

返回参数

处理成功，应答无内容

返回示例

正常示例

 
204
处理成功，应答无内容


http://2323weixin.qq.com

错误码

状态码	错误码	描述	解决方案
403	CONTRACT_NOT_EXIST	签约协议不存在	请检查签约协议号是否正确,是否已解约
400	PARAM_ERROR	参数错误	请确认参数都正确传入，然后重试
500	SYSTEM_ERROR	系统失败	先查询签约协议状态，再尝试重试

WeChat Pay

Feedback

Feedback

Submitted successfully

Feedback

Network exception, please try again later

委托代扣API

申请解约API

注意：

接口说明

请求参数

请求示例

返回参数

返回示例

错误码

版本说明