解除协议

更新时间:2025.10.31
||

服务商可通过本接口使用服务商签约协议号来解除已经签订的自动还款协议

接口说明

支持商户:【普通服务商】

请求方式:【POST】/v3/credit-repayment/partner/contracts/terminate

请求域名:【主域名】https://api.mch.weixin.qq.com 使用该域名将访问就近的接入点

     【备域名】https://api2.mch.weixin.qq.com 使用该域名将访问异地的接入点 ,指引点击查看

请求参数

Header  HTTP头参数

 Authorization  必填 string

请参考签名认证生成认证信息


 Accept  必填 string

请设置为application/json


 Content-Type  必填 string

请设置为application/json


body  包体参数

 out_contract_code  必填   string(64)

【服务商签约协议号】 服务商签约协议号;使用预签约时传入的out_contract_code。服务商需保证唯一性;只能是数字、大小写字母的组合


 contract_termination_remark  必填   string(128)

【协议解约备注】 解约原因的备注说明

请求示例

curl
Java
Go

POST

1curl -X POST \
2  https://api.mch.weixin.qq.com/v3/credit-repayment/partner/contracts/terminate \
3  -H "Authorization: WECHATPAY2-SHA256-RSA2048 mchid=\"1900000001\",..." \
4  -H "Accept: application/json" \
5  -H "Content-Type: application/json" \
6  -d '{
7    "out_contract_code" : "WxCreditRepayment20200910100000",
8    "contract_termination_remark" : "签约信息有误,需解约然后重新签约"
9  }'
10

应答参数
折叠全部参数

200 OK

 contract_info  选填   object

【协议信息】 协议信息;解约成功之后返回

属性

 contract_id  必填   string(64)

【协议ID】 协议ID


 plan_id  必填   string(64)

【模板ID】 信贷还款模板ID; 在服务商平台上成功申请模板后系统自动分配的


 out_contract_code  必填   string(64)

【服务商签约协议号】 服务商签约协议号;预签约时传入的out_contract_code。服务商必须保证唯一;只能是数字、大小写字母的组合


 display_name  必填   string(64)

【用户展示名称】 用户展示名称,用于在签约页面展示


 contract_state  必填   string

【协议状态】 协议状态

可选取值

  • CONTRACT_STATE_INVALID:  初始值,一般表示正在签约中

  • CONTRACT_STATE_EFFECTIVE:  已签约

  • CONTRACT_STATE_TERMINATED:  未签约(包括已解约)


 contract_signed_time  选填   string

【协议签署时间】 协议签署时间;只有协议状态是已签约才返回;按照使用rfc3339所定义的格式,格式为yyyy-MM-DDTHH:mm:ss+TIMEZONE,yyyy-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss表示时分秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。例如:2015-05-20T13:29:35+08:00表示,北京时间2015年5月20日 13点29分35秒


 contract_terminated_time  选填   string

【协议解约时间】 协议解约时间;只有协议状态是未签约且是商户/用户/客服主动解约时才返回;按照使用rfc3339所定义的格式,格式为yyyy-MM-DDTHH:mm:ss+TIMEZONE,yyyy-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss表示时分秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。例如:2015-05-20T13:29:35+08:00表示,北京时间2015年5月20日 13点29分35秒


 contract_terminated_mode  选填   string

【协议解约方式】 协议解约方式;只有协议状态是未签约且是商户/用户/客服主动解约时才返回

可选取值

  • TERMINATION_MODE_INVALID:  无效值

  • TERMINATION_MODE_BY_USER:  用户解约

  • TERMINATION_MODE_BY_MERCHANT:  商户解约

  • TERMINATION_MODE_BY_CUSTOMER_SERVICE:  客服解约


 contract_termination_remark  选填   string(128)

【协议解约备注】 协议解约备注;只有协议状态是未签约且是商户/用户/客服主动解约时才返回


 repayment_day  选填   integer

【还款日】 每月还款的日期;只有预签约时传入了还款日期才会返回


 openid  选填   string

【用户服务商标识】 用户在服务商AppID下唯一标识


 appid  选填   string

【服务商AppID】 商户在微信申请的公众号或移动应用AppID,与服务商商户号绑定。可参考服务商模式开发必要参数说明


 repayment_amount_limit  必填   string

【还款金额上限】 每次最多还款金额;单位:分

应答示例

200 OK

1{
2  "contract_info" : {
3    "contract_id" : "20250101000000123456789",
4    "plan_id" : "WxCreditRepaymentPlan12345678",
5    "out_contract_code" : "WxCreditRepayment20200910100000",
6    "display_name" : "*明",
7    "contract_state" : "CONTRACT_STATE_EFFECTIVE",
8    "contract_signed_time" : "2020-09-10T13:29:35+08:00",
9    "contract_terminated_time" : "2020-09-10T13:29:35+08:00",
10    "contract_terminated_mode" : "TERMINATION_MODE_BY_USER",
11    "contract_termination_remark" : "签约信息有误,需解约然后重新签约",
12    "repayment_day" : 1,
13    "openid" : "oUpF8uMuAJO_M2pxb1Q9zNjWeS6o",
14    "appid" : "wxd678efh567hg6787",
15    "repayment_amount_limit" : "10000"
16  }
17}
18

 

错误码

以下是本接口返回的错误码列表。详细错误码规则,请参考微信支付接口规则-错误码和错误提示

状态码

错误码

描述

解决方案

400

PARAM_ERROR

参数错误

请根据错误提示正确传入参数

400

INVALID_REQUEST

HTTP 请求不符合微信支付 APIv3 接口规则

请参阅 接口规则

401

SIGN_ERROR

验证不通过

请参阅 签名常见问题

500

SYSTEM_ERROR

系统异常,请稍后重试

请稍后重试

404

NOT_FOUND

协议不存在

确认服务商签约协议号是否正确

429

RATELIMIT_EXCEEDED

请求超过接口频率限制

降低频率,稍后重试

 

 

反馈
目录
置顶