解除协议
更新时间: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
【服务商签约协议号】 服务商签约协议号;使用预签约时传入的out_contract_code。服务商需保证唯一性;只能是数字、大小写字母的组合
contract_termination_remark 必填 string(128)
【协议解约备注】 解约原因的备注说明
请求示例
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
需配合微信支付工具库 WXPayUtility 使用,请参考Java
1package com.java.demo; 2 3import com.java.utils.WXPayUtility; // 引用微信支付工具库,参考:https://pay.weixin.qq.com/doc/v3/partner/4014985777 4 5import com.google.gson.annotations.SerializedName; 6import com.google.gson.annotations.Expose; 7import okhttp3.MediaType; 8import okhttp3.OkHttpClient; 9import okhttp3.Request; 10import okhttp3.RequestBody; 11import okhttp3.Response; 12 13import java.io.IOException; 14import java.io.UncheckedIOException; 15import java.security.PrivateKey; 16import java.security.PublicKey; 17import java.util.ArrayList; 18import java.util.HashMap; 19import java.util.List; 20import java.util.Map; 21 22/** 23 * 解除协议 24 */ 25public class PartnerTerminateContractByCode { 26 private static String HOST = "https://api.mch.weixin.qq.com"; 27 private static String METHOD = "POST"; 28 private static String PATH = "/v3/credit-repayment/partner/contracts/terminate"; 29 30 public static void main(String[] args) { 31 // TODO: 请准备商户开发必要参数,参考:https://pay.weixin.qq.com/doc/v3/partner/4013080340 32 PartnerTerminateContractByCode client = new PartnerTerminateContractByCode( 33 "19xxxxxxxx", // 商户号,是由微信支付系统生成并分配给每个商户的唯一标识符,商户号获取方式参考 https://pay.weixin.qq.com/doc/v3/partner/4013080340 34 "1DDE55AD98Exxxxxxxxxx", // 商户API证书序列号,如何获取请参考 https://pay.weixin.qq.com/doc/v3/partner/4013058924 35 "/path/to/apiclient_key.pem", // 商户API证书私钥文件路径,本地文件路径 36 "PUB_KEY_ID_xxxxxxxxxxxxx", // 微信支付公钥ID,如何获取请参考 https://pay.weixin.qq.com/doc/v3/partner/4013038589 37 "/path/to/wxp_pub.pem" // 微信支付公钥文件路径,本地文件路径 38 ); 39 40 TerminateContractByCodeRequest request = new TerminateContractByCodeRequest(); 41 request.outContractCode = "WxCreditRepayment20200910100000"; 42 request.contractTerminationRemark = "签约信息有误,需解约然后重新签约"; 43 try { 44 TerminateContractByCodeResponse response = client.run(request); 45 // TODO: 请求成功,继续业务逻辑 46 System.out.println(response); 47 } catch (WXPayUtility.ApiException e) { 48 // TODO: 请求失败,根据状态码执行不同的逻辑 49 e.printStackTrace(); 50 } 51 } 52 53 public TerminateContractByCodeResponse run(TerminateContractByCodeRequest request) { 54 String uri = PATH; 55 String reqBody = WXPayUtility.toJson(request); 56 57 Request.Builder reqBuilder = new Request.Builder().url(HOST + uri); 58 reqBuilder.addHeader("Accept", "application/json"); 59 reqBuilder.addHeader("Wechatpay-Serial", wechatPayPublicKeyId); 60 reqBuilder.addHeader("Authorization", WXPayUtility.buildAuthorization(mchid, certificateSerialNo,privateKey, METHOD, uri, reqBody)); 61 reqBuilder.addHeader("Content-Type", "application/json"); 62 RequestBody requestBody = RequestBody.create(MediaType.parse("application/json; charset=utf-8"), reqBody); 63 reqBuilder.method(METHOD, requestBody); 64 Request httpRequest = reqBuilder.build(); 65 66 // 发送HTTP请求 67 OkHttpClient client = new OkHttpClient.Builder().build(); 68 try (Response httpResponse = client.newCall(httpRequest).execute()) { 69 String respBody = WXPayUtility.extractBody(httpResponse); 70 if (httpResponse.code() >= 200 && httpResponse.code() < 300) { 71 // 2XX 成功,验证应答签名 72 WXPayUtility.validateResponse(this.wechatPayPublicKeyId, this.wechatPayPublicKey, 73 httpResponse.headers(), respBody); 74 75 // 从HTTP应答报文构建返回数据 76 return WXPayUtility.fromJson(respBody, TerminateContractByCodeResponse.class); 77 } else { 78 throw new WXPayUtility.ApiException(httpResponse.code(), respBody, httpResponse.headers()); 79 } 80 } catch (IOException e) { 81 throw new UncheckedIOException("Sending request to " + uri + " failed.", e); 82 } 83 } 84 85 private final String mchid; 86 private final String certificateSerialNo; 87 private final PrivateKey privateKey; 88 private final String wechatPayPublicKeyId; 89 private final PublicKey wechatPayPublicKey; 90 91 public PartnerTerminateContractByCode(String mchid, String certificateSerialNo, String privateKeyFilePath, String wechatPayPublicKeyId, String wechatPayPublicKeyFilePath) { 92 this.mchid = mchid; 93 this.certificateSerialNo = certificateSerialNo; 94 this.privateKey = WXPayUtility.loadPrivateKeyFromPath(privateKeyFilePath); 95 this.wechatPayPublicKeyId = wechatPayPublicKeyId; 96 this.wechatPayPublicKey = WXPayUtility.loadPublicKeyFromPath(wechatPayPublicKeyFilePath); 97 } 98 99 public static class TerminateContractByCodeRequest { 100 @SerializedName("out_contract_code") 101 public String outContractCode; 102 103 @SerializedName("contract_termination_remark") 104 public String contractTerminationRemark; 105 } 106 107 public static class TerminateContractByCodeResponse { 108 @SerializedName("contract_info") 109 public Contract contractInfo; 110 } 111 112 public static class Contract { 113 @SerializedName("contract_id") 114 public String contractId; 115 116 @SerializedName("plan_id") 117 public String planId; 118 119 @SerializedName("out_contract_code") 120 public String outContractCode; 121 122 @SerializedName("display_name") 123 public String displayName; 124 125 @SerializedName("contract_state") 126 public ContractState contractState; 127 128 @SerializedName("contract_signed_time") 129 public String contractSignedTime; 130 131 @SerializedName("contract_terminated_time") 132 public String contractTerminatedTime; 133 134 @SerializedName("contract_termination_mode") 135 public TerminationMode contractTerminationMode; 136 137 @SerializedName("contract_termination_remark") 138 public String contractTerminationRemark; 139 140 @SerializedName("repayment_day") 141 public Long repaymentDay; 142 } 143 144 public enum ContractState { 145 @SerializedName("CONTRACT_STATE_INVALID") 146 CONTRACT_STATE_INVALID, 147 @SerializedName("CONTRACT_STATE_EFFECTIVE") 148 CONTRACT_STATE_EFFECTIVE, 149 @SerializedName("CONTRACT_STATE_TERMINATED") 150 CONTRACT_STATE_TERMINATED 151 } 152 153 public enum TerminationMode { 154 @SerializedName("TERMINATION_MODE_INVALID") 155 TERMINATION_MODE_INVALID, 156 @SerializedName("TERMINATION_MODE_BY_USER") 157 TERMINATION_MODE_BY_USER, 158 @SerializedName("TERMINATION_MODE_BY_MERCHANT") 159 TERMINATION_MODE_BY_MERCHANT, 160 @SerializedName("TERMINATION_MODE_BY_CUSTOMER_SERVICE") 161 TERMINATION_MODE_BY_CUSTOMER_SERVICE 162 } 163 164} 165
需配合微信支付工具库 wxpay_utility 使用,请参考Go
1package main 2 3import ( 4 "bytes" 5 "demo/wxpay_utility" // 引用微信支付工具库,参考 https://pay.weixin.qq.com/doc/v3/partner/4015119446 6 "encoding/json" 7 "fmt" 8 "net/http" 9 "net/url" 10) 11 12func main() { 13 // TODO: 请准备商户开发必要参数,参考:https://pay.weixin.qq.com/doc/v3/partner/4013080340 14 config, err := wxpay_utility.CreateMchConfig( 15 "19xxxxxxxx", // 商户号,是由微信支付系统生成并分配给每个商户的唯一标识符,商户号获取方式参考 https://pay.weixin.qq.com/doc/v3/partner/4013080340 16 "1DDE55AD98Exxxxxxxxxx", // 商户API证书序列号,如何获取请参考 https://pay.weixin.qq.com/doc/v3/partner/4013058924 17 "/path/to/apiclient_key.pem", // 商户API证书私钥文件路径,本地文件路径 18 "PUB_KEY_ID_xxxxxxxxxxxxx", // 微信支付公钥ID,如何获取请参考 https://pay.weixin.qq.com/doc/v3/partner/4013038589 19 "/path/to/wxp_pub.pem", // 微信支付公钥文件路径,本地文件路径 20 ) 21 if err != nil { 22 fmt.Println(err) 23 return 24 } 25 26 request := &TerminateContractByCodeRequest{ 27 OutContractCode: wxpay_utility.String("WxCreditRepayment20200910100000"), 28 ContractTerminationRemark: wxpay_utility.String("签约信息有误,需解约然后重新签约"), 29 } 30 31 response, err := PartnerTerminateContractByCode(config, request) 32 if err != nil { 33 fmt.Printf("请求失败: %+v\n", err) 34 // TODO: 请求失败,根据状态码执行不同的处理 35 return 36 } 37 38 // TODO: 请求成功,继续业务逻辑 39 fmt.Printf("请求成功: %+v\n", response) 40} 41 42func PartnerTerminateContractByCode(config *wxpay_utility.MchConfig, request *TerminateContractByCodeRequest) (response *TerminateContractByCodeResponse, err error) { 43 const ( 44 host = "https://api.mch.weixin.qq.com" 45 method = "POST" 46 path = "/v3/credit-repayment/partner/contracts/terminate" 47 ) 48 49 reqUrl, err := url.Parse(fmt.Sprintf("%s%s", host, path)) 50 if err != nil { 51 return nil, err 52 } 53 reqBody, err := json.Marshal(request) 54 if err != nil { 55 return nil, err 56 } 57 httpRequest, err := http.NewRequest(method, reqUrl.String(), bytes.NewReader(reqBody)) 58 if err != nil { 59 return nil, err 60 } 61 httpRequest.Header.Set("Accept", "application/json") 62 httpRequest.Header.Set("Wechatpay-Serial", config.WechatPayPublicKeyId()) 63 httpRequest.Header.Set("Content-Type", "application/json") 64 authorization, err := wxpay_utility.BuildAuthorization(config.MchId(), config.CertificateSerialNo(), config.PrivateKey(), method, reqUrl.RequestURI(), reqBody) 65 if err != nil { 66 return nil, err 67 } 68 httpRequest.Header.Set("Authorization", authorization) 69 70 client := &http.Client{} 71 httpResponse, err := client.Do(httpRequest) 72 if err != nil { 73 return nil, err 74 } 75 respBody, err := wxpay_utility.ExtractResponseBody(httpResponse) 76 if err != nil { 77 return nil, err 78 } 79 if httpResponse.StatusCode >= 200 && httpResponse.StatusCode < 300 { 80 // 2XX 成功,验证应答签名 81 err = wxpay_utility.ValidateResponse( 82 config.WechatPayPublicKeyId(), 83 config.WechatPayPublicKey(), 84 &httpResponse.Header, 85 respBody, 86 ) 87 if err != nil { 88 return nil, err 89 } 90 response := &TerminateContractByCodeResponse{} 91 if err := json.Unmarshal(respBody, response); err != nil { 92 return nil, err 93 } 94 95 return response, nil 96 } else { 97 return nil, wxpay_utility.NewApiException( 98 httpResponse.StatusCode, 99 httpResponse.Header, 100 respBody, 101 ) 102 } 103} 104 105type TerminateContractByCodeRequest struct { 106 OutContractCode *string `json:"out_contract_code,omitempty"` 107 ContractTerminationRemark *string `json:"contract_termination_remark,omitempty"` 108} 109 110type TerminateContractByCodeResponse struct { 111 ContractInfo *Contract `json:"contract_info,omitempty"` 112} 113 114type Contract struct { 115 ContractId *string `json:"contract_id,omitempty"` 116 PlanId *string `json:"plan_id,omitempty"` 117 OutContractCode *string `json:"out_contract_code,omitempty"` 118 DisplayName *string `json:"display_name,omitempty"` 119 ContractState *ContractState `json:"contract_state,omitempty"` 120 ContractSignedTime *string `json:"contract_signed_time,omitempty"` 121 ContractTerminatedTime *string `json:"contract_terminated_time,omitempty"` 122 ContractTerminationMode *TerminationMode `json:"contract_termination_mode,omitempty"` 123 ContractTerminationRemark *string `json:"contract_termination_remark,omitempty"` 124 RepaymentDay *int64 `json:"repayment_day,omitempty"` 125} 126 127type ContractState string 128 129func (e ContractState) Ptr() *ContractState { 130 return &e 131} 132 133const ( 134 CONTRACTSTATE_CONTRACT_STATE_INVALID ContractState = "CONTRACT_STATE_INVALID" 135 CONTRACTSTATE_CONTRACT_STATE_EFFECTIVE ContractState = "CONTRACT_STATE_EFFECTIVE" 136 CONTRACTSTATE_CONTRACT_STATE_TERMINATED ContractState = "CONTRACT_STATE_TERMINATED" 137) 138 139type TerminationMode string 140 141func (e TerminationMode) Ptr() *TerminationMode { 142 return &e 143} 144 145const ( 146 TERMINATIONMODE_TERMINATION_MODE_INVALID TerminationMode = "TERMINATION_MODE_INVALID" 147 TERMINATIONMODE_TERMINATION_MODE_BY_USER TerminationMode = "TERMINATION_MODE_BY_USER" 148 TERMINATIONMODE_TERMINATION_MODE_BY_MERCHANT TerminationMode = "TERMINATION_MODE_BY_MERCHANT" 149 TERMINATIONMODE_TERMINATION_MODE_BY_CUSTOMER_SERVICE TerminationMode = "TERMINATION_MODE_BY_CUSTOMER_SERVICE" 150) 151
应答参数
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_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_termination_mode 选填 string 【协议解约方式】 协议解约方式;只有协议已解约才返回 可选取值
contract_termination_remark 选填 string(128) 【协议解约备注】 协议解约备注;只有协议已解约才返回 repayment_day 选填 integer 【还款日】 每月还款的日期;只有预签约时传入了还款日期才会返回 |
应答示例
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_termination_mode" : "TERMINATION_MODE_BY_USER", 11 "contract_termination_remark" : "签约信息有误,需解约然后重新签约", 12 "repayment_day" : 1 13 } 14} 15
错误码
以下是本接口返回的错误码列表。详细错误码规则,请参考微信支付接口规则-错误码和错误提示

