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