最新更新時間：2020.04.17 版本說明
商戶與用戶的簽約關(guān)系有誤或者商戶主動要求與用戶解除之前的簽約協(xié)議時可調(diào)用此接口完成解約。
目前商戶側(cè)支持兩種模式的解約：
1、contract_id模式：使用委托代扣協(xié)議id完成解約。
2、plan_id+contract_code模式：使用模板id和委托代扣協(xié)議號完成解約。
兩種模式解約，返回結(jié)果相同
商戶可以在商戶后臺（www.tg885.com）設(shè)置解約回調(diào)地址，當(dāng)發(fā)生解約關(guān)系的時候，微信服務(wù)器會向此地址通知解約信息，內(nèi)容與簽約返回一致（詳見簽約返回）。
適用對象：直連商戶
請求URL： https://api.mch.weixin.qq.com/papay/deletecontract
請求方式： POST
數(shù)據(jù)格式： XML
簽名方式： MD5
是否需要證書： 否
| 參數(shù)名 | 變量 | 類型[長度限制] | 必填 | 描述 |
|---|---|---|---|---|
| 應(yīng)用ID | appid | string[1,32] | 是 | 直連商戶申請的公眾號或移動應(yīng)用appid。 示例值：wxcbda96de0b165486 |
| 商戶號 | mch_id | string[1,32] | 是 | 商戶號是商戶在微信申請微信支付成功后分配的賬號ID，登錄平臺為www.tg885.com 示例值：10000098 |
| 簽名 | sign | string[1,32] | 是 | 簽名，詳見簽名生成算法 示例值：C380BEC2BFD727A4B6845133519F3AD6 |
| 委托代扣協(xié)議id | contract_id | string[1,32] | 是 | 委托代扣簽約成功后由微信返回的委托代扣協(xié)議id，選擇contract_id解約，則此參數(shù)必填 示例值：Wx15463511252015071056489715 |
| 解約備注 | contract_termination_remark | string[1,512] | 是 | 解約原因的備注說明，如：簽約信息有誤，須重新簽約 示例值：解約原因 |
| 版本號 | version | string[1,8] | 是 | 固定值1.0 示例值：1.0 |
<xml>
<mch_id>10000098</mch_id>
<appid>wxcbda96de0b165486</appid>
<sign>E1EE61A91C8E90F299DE6AE075D60A2D</sign>
<contract_id>100005698</contract_id>
<contract_termination_remark>原因</contract_termination_remark>
<version>1.0</version>
</xml>
| 參數(shù)名 | 變量 | 類型[長度限制] | 必填 | 描述 |
|---|---|---|---|---|
| 應(yīng)用ID | appid | string[1,32] | 是 | 直連商戶申請的公眾號或移動應(yīng)用appid。 示例值：wxcbda96de0b165486 |
| 商戶號 | mch_id | string[1,32] | 是 | 商戶號是商戶在微信申請微信支付成功后分配的賬號ID，登錄平臺為www.tg885.com 示例值：10000098 |
| 簽名 | sign | string[1,32] | 是 | 簽名，詳見簽名生成算法 示例值：C380BEC2BFD727A4B6845133519F3AD6 |
| 模板id | plan_id | string[1,128] | 是 | 商戶在微信商戶平臺配置的代扣模板id，選擇plan_id+contract_code解約，則此參數(shù)必填 示例值：12251 |
| 簽約協(xié)議號 | contract_code | string[1,128] | 是 | 商戶請求簽約時傳入的簽約協(xié)議號，商戶側(cè)須唯一。選擇plan_id+contract_code解約，則此參數(shù)必填 示例值：1234 |
| 解約備注 | contract_termination_remark | string[1,512] | 是 | 解約原因的備注說明，如：簽約信息有誤，須重新簽約 示例值：解約原因 |
| 版本號 | version | string[1,8] | 是 | 固定值1.0 示例值：1.0 |
<xml>
<mch_id>10000098</mch_id>
<appid>wxcbda96de0b165486</appid>
<sign>E1EE61A91C8E90F299DE6AE075D60A2D</sign>
<plan_id>12251</plan_id>
<contract_code>1234</contract_code>
<contract_termination_remark>原因</contract_termination_remark>
<version>1.0</version>
</xml>
| 參數(shù)名 | 變量 | 類型[長度限制] | 必填 | 描述 |
|---|---|---|---|---|
| 返回狀態(tài)碼 | return_code | string[1,16] | 是 | SUCCESS/FAIL 此字段是通信標(biāo)識，非交易標(biāo)識，交易是否成功需要查看result_code來判斷 示例值：SUCCESS |
| 返回信息 | return_msg | string[1,128] | 否 | 返回信息，如非空，為錯誤原因 如：簽名失敗 等。 示例值：簽名失敗 |
以下字段在return_code為SUCCESS的時候有返回
| 參數(shù)名 | 變量 | 類型[長度限制] | 必填 | 描述 |
|---|---|---|---|---|
| 商戶號 | mch_id | string[1,32] | 是 | 微信支付分配的商戶號 示例值：10000098 |
| 應(yīng)用ID | appid | string[1,32] | 是 | 直連商戶申請的公眾號或移動應(yīng)用appid。 示例值：wxcbda96de0b165486 |
| 委托代扣協(xié)議id | contract_id | string[1,32] | 是 | 簽約成功后，微信返回的委托代扣協(xié)議id 示例值：Wx15463511252015071056489715 |
| 模板id | plan_id | string[1,128] | 是 | 協(xié)議模板id 示例值：123 |
| 簽約協(xié)議號 | contract_code | string[1,128] | 是 | 簽約協(xié)議號 示例值：100001256 |
| 簽名 | sign | string[1,32] | 是 | 詳見簽名生成算法 示例值：C380BEC2BFD727A4B6845133519F3AD6 |
| 業(yè)務(wù)結(jié)果 | result_code | string[1,16] | 是 | SUCCESS/FAIL 示例值：SUCCESS |
| 錯誤代碼 | err_code | string[1,32] | 否 | 錯誤碼 示例值：SIGN_ERROR |
| 錯誤代碼描述 | err_code_des | string[1,32] | 否 | 錯誤碼描述 示例值：簽名錯誤 |
<xml>
<return_code><![CDATA[SUCCESS]]></return_code>
<result_code><![CDATA[SUCCESS]]></result_code>
<sign><![CDATA[C380BEC2BFD727A4B6845133519F3AD6]]></sign>
<mch_id><![CDATA[10010404]]></mch_id>
<appid><![CDATA[wxcbda96de0b165486]]></appid>
<contract_id><![CDATA[100005698]]></contract_id>
</xml> | 錯誤碼 | 描述 | 解決方案 |
|---|---|---|
| SIGN_ERROR | 簽名錯誤 | 驗證簽名算法 |
| PARAMETER FAIL | 參數(shù)錯誤 | 驗證參數(shù) |
| XML FAIL | XML格式錯誤 | 檢查XML格式 |
| RESULT NULL | 查詢?yōu)榭? | 傳入正確查詢參數(shù) |
| MERCHANT PERMISSION ERROR | 商戶沒有權(quán)限 | 確認(rèn)商戶權(quán)限 |
| MERCHANT AUTHORITY ERROR | 商戶權(quán)限校驗失敗 | 聯(lián)系相關(guān)接口人確認(rèn)委托代扣權(quán)限 |