查询还款单
更新时间:2025.12.05商户可调用该接口来获取还款单的详细信息
接口说明
支持商户:【普通服务商】
请求方式:【GET】/v3/credit-repayment/partner/deduct-orders/{out_trade_no}
请求域名:【主域名】https://api.mch.weixin.qq.com 使用该域名将访问就近的接入点
【备域名】https://api2.mch.weixin.qq.com 使用该域名将访问异地的接入点 ,指引点击查看
请求参数
Header HTTP头参数
Authorization 必填 string
请参考签名认证生成认证信息
Accept 必填 string
请设置为application/json
path 路径参数
out_trade_no 必填 string(32)
【商户侧交易单号】 在发起还款时商户传入的商户侧交易单号
请求示例
GET
1curl -X GET \ 2 https://api.mch.weixin.qq.com/v3/credit-repayment/partner/deduct-orders/DeductOrder123456 \ 3 -H "Authorization: WECHATPAY2-SHA256-RSA2048 mchid=\"1900000001\",..." \ 4 -H "Accept: application/json" 5
需配合微信支付工具库 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 PartnerQueryDeductOrder { 26 private static String HOST = "https://api.mch.weixin.qq.com"; 27 private static String METHOD = "GET"; 28 private static String PATH = "/v3/credit-repayment/partner/deduct-orders/{out_trade_no}"; 29 30 public static void main(String[] args) { 31 // TODO: 请准备商户开发必要参数,参考:https://pay.weixin.qq.com/doc/v3/partner/4013080340 32 PartnerQueryDeductOrder client = new PartnerQueryDeductOrder( 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 PartnerQueryDeductOrderRequest request = new PartnerQueryDeductOrderRequest(); 41 request.outTradeNo = "DeductOrder123456"; 42 try { 43 DeductOrder response = client.run(request); 44 // TODO: 请求成功,继续业务逻辑 45 System.out.println(response); 46 } catch (WXPayUtility.ApiException e) { 47 // TODO: 请求失败,根据状态码执行不同的逻辑 48 e.printStackTrace(); 49 } 50 } 51 52 public DeductOrder run(PartnerQueryDeductOrderRequest request) { 53 String uri = PATH; 54 uri = uri.replace("{out_trade_no}", WXPayUtility.urlEncode(request.outTradeNo)); 55 56 Request.Builder reqBuilder = new Request.Builder().url(HOST + uri); 57 reqBuilder.addHeader("Accept", "application/json"); 58 reqBuilder.addHeader("Wechatpay-Serial", wechatPayPublicKeyId); 59 reqBuilder.addHeader("Authorization", WXPayUtility.buildAuthorization(mchid, certificateSerialNo, privateKey, METHOD, uri, null)); 60 reqBuilder.method(METHOD, null); 61 Request httpRequest = reqBuilder.build(); 62 63 // 发送HTTP请求 64 OkHttpClient client = new OkHttpClient.Builder().build(); 65 try (Response httpResponse = client.newCall(httpRequest).execute()) { 66 String respBody = WXPayUtility.extractBody(httpResponse); 67 if (httpResponse.code() >= 200 && httpResponse.code() < 300) { 68 // 2XX 成功,验证应答签名 69 WXPayUtility.validateResponse(this.wechatPayPublicKeyId, this.wechatPayPublicKey, 70 httpResponse.headers(), respBody); 71 72 // 从HTTP应答报文构建返回数据 73 return WXPayUtility.fromJson(respBody, DeductOrder.class); 74 } else { 75 throw new WXPayUtility.ApiException(httpResponse.code(), respBody, httpResponse.headers()); 76 } 77 } catch (IOException e) { 78 throw new UncheckedIOException("Sending request to " + uri + " failed.", e); 79 } 80 } 81 82 private final String mchid; 83 private final String certificateSerialNo; 84 private final PrivateKey privateKey; 85 private final String wechatPayPublicKeyId; 86 private final PublicKey wechatPayPublicKey; 87 88 public PartnerQueryDeductOrder(String mchid, String certificateSerialNo, String privateKeyFilePath, String wechatPayPublicKeyId, String wechatPayPublicKeyFilePath) { 89 this.mchid = mchid; 90 this.certificateSerialNo = certificateSerialNo; 91 this.privateKey = WXPayUtility.loadPrivateKeyFromPath(privateKeyFilePath); 92 this.wechatPayPublicKeyId = wechatPayPublicKeyId; 93 this.wechatPayPublicKey = WXPayUtility.loadPublicKeyFromPath(wechatPayPublicKeyFilePath); 94 } 95 96 public static class PartnerQueryDeductOrderRequest { 97 @SerializedName("out_trade_no") 98 @Expose(serialize = false) 99 public String outTradeNo; 100 } 101 102 public static class DeductOrder { 103 @SerializedName("out_trade_no") 104 public String outTradeNo; 105 106 @SerializedName("out_record_id") 107 public String outRecordId; 108 109 @SerializedName("appid") 110 public String appid; 111 112 @SerializedName("sub_appid") 113 public String subAppid; 114 115 @SerializedName("openid") 116 public String openid; 117 118 @SerializedName("contract_id") 119 public String contractId; 120 121 @SerializedName("order_state") 122 public DeductOrderState orderState; 123 124 @SerializedName("deduct_amount") 125 public String deductAmount; 126 127 @SerializedName("pay_success_amount") 128 public String paySuccessAmount; 129 130 @SerializedName("description") 131 public String description; 132 133 @SerializedName("attach") 134 public String attach; 135 136 @SerializedName("transaction_id") 137 public String transactionId; 138 } 139 140 public enum DeductOrderState { 141 @SerializedName("DEDUCT_ORDER_STATE_PENDING") 142 DEDUCT_ORDER_STATE_PENDING, 143 @SerializedName("DEDUCT_ORDER_STATE_NOT_PAY") 144 DEDUCT_ORDER_STATE_NOT_PAY, 145 @SerializedName("DEDUCT_ORDER_STATE_PAY_SUCCESS") 146 DEDUCT_ORDER_STATE_PAY_SUCCESS, 147 @SerializedName("DEDUCT_ORDER_STATE_PAY_FAIL") 148 DEDUCT_ORDER_STATE_PAY_FAIL 149 } 150 151} 152
需配合微信支付工具库 wxpay_utility 使用,请参考Go
1package main 2 3import ( 4 "demo/wxpay_utility" // 引用微信支付工具库,参考 https://pay.weixin.qq.com/doc/v3/partner/4015119446 5 "encoding/json" 6 "fmt" 7 "net/http" 8 "net/url" 9 "strings" 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 := &PartnerQueryDeductOrderRequest{ 27 OutTradeNo: wxpay_utility.String("DeductOrder123456"), 28 } 29 30 response, err := PartnerQueryDeductOrder(config, request) 31 if err != nil { 32 fmt.Printf("请求失败: %+v\n", err) 33 // TODO: 请求失败,根据状态码执行不同的处理 34 return 35 } 36 37 // TODO: 请求成功,继续业务逻辑 38 fmt.Printf("请求成功: %+v\n", response) 39} 40 41func PartnerQueryDeductOrder(config *wxpay_utility.MchConfig, request *PartnerQueryDeductOrderRequest) (response *DeductOrder, err error) { 42 const ( 43 host = "https://api.mch.weixin.qq.com" 44 method = "GET" 45 path = "/v3/credit-repayment/partner/deduct-orders/{out_trade_no}" 46 ) 47 48 reqUrl, err := url.Parse(fmt.Sprintf("%s%s", host, path)) 49 if err != nil { 50 return nil, err 51 } 52 reqUrl.Path = strings.Replace(reqUrl.Path, "{out_trade_no}", url.PathEscape(*request.OutTradeNo), -1) 53 httpRequest, err := http.NewRequest(method, reqUrl.String(), nil) 54 if err != nil { 55 return nil, err 56 } 57 httpRequest.Header.Set("Accept", "application/json") 58 httpRequest.Header.Set("Wechatpay-Serial", config.WechatPayPublicKeyId()) 59 authorization, err := wxpay_utility.BuildAuthorization(config.MchId(), config.CertificateSerialNo(), config.PrivateKey(), method, reqUrl.RequestURI(), nil) 60 if err != nil { 61 return nil, err 62 } 63 httpRequest.Header.Set("Authorization", authorization) 64 65 client := &http.Client{} 66 httpResponse, err := client.Do(httpRequest) 67 if err != nil { 68 return nil, err 69 } 70 respBody, err := wxpay_utility.ExtractResponseBody(httpResponse) 71 if err != nil { 72 return nil, err 73 } 74 if httpResponse.StatusCode >= 200 && httpResponse.StatusCode < 300 { 75 // 2XX 成功,验证应答签名 76 err = wxpay_utility.ValidateResponse( 77 config.WechatPayPublicKeyId(), 78 config.WechatPayPublicKey(), 79 &httpResponse.Header, 80 respBody, 81 ) 82 if err != nil { 83 return nil, err 84 } 85 response := &DeductOrder{} 86 if err := json.Unmarshal(respBody, response); err != nil { 87 return nil, err 88 } 89 90 return response, nil 91 } else { 92 return nil, wxpay_utility.NewApiException( 93 httpResponse.StatusCode, 94 httpResponse.Header, 95 respBody, 96 ) 97 } 98} 99 100type PartnerQueryDeductOrderRequest struct { 101 OutTradeNo *string `json:"out_trade_no,omitempty"` 102} 103 104func (o *PartnerQueryDeductOrderRequest) MarshalJSON() ([]byte, error) { 105 type Alias PartnerQueryDeductOrderRequest 106 a := &struct { 107 OutTradeNo *string `json:"out_trade_no,omitempty"` 108 *Alias 109 }{ 110 // 序列化时移除非 Body 字段 111 OutTradeNo: nil, 112 Alias: (*Alias)(o), 113 } 114 return json.Marshal(a) 115} 116 117type DeductOrder struct { 118 OutTradeNo *string `json:"out_trade_no,omitempty"` 119 OutRecordId *string `json:"out_record_id,omitempty"` 120 Appid *string `json:"appid,omitempty"` 121 SubAppid *string `json:"sub_appid,omitempty"` 122 Openid *string `json:"openid,omitempty"` 123 ContractId *string `json:"contract_id,omitempty"` 124 OrderState *DeductOrderState `json:"order_state,omitempty"` 125 DeductAmount *string `json:"deduct_amount,omitempty"` 126 PaySuccessAmount *string `json:"pay_success_amount,omitempty"` 127 Description *string `json:"description,omitempty"` 128 Attach *string `json:"attach,omitempty"` 129 TransactionId *string `json:"transaction_id,omitempty"` 130} 131 132type DeductOrderState string 133 134func (e DeductOrderState) Ptr() *DeductOrderState { 135 return &e 136} 137 138const ( 139 DEDUCTORDERSTATE_DEDUCT_ORDER_STATE_PENDING DeductOrderState = "DEDUCT_ORDER_STATE_PENDING" 140 DEDUCTORDERSTATE_DEDUCT_ORDER_STATE_NOT_PAY DeductOrderState = "DEDUCT_ORDER_STATE_NOT_PAY" 141 DEDUCTORDERSTATE_DEDUCT_ORDER_STATE_PAY_SUCCESS DeductOrderState = "DEDUCT_ORDER_STATE_PAY_SUCCESS" 142 DEDUCTORDERSTATE_DEDUCT_ORDER_STATE_PAY_FAIL DeductOrderState = "DEDUCT_ORDER_STATE_PAY_FAIL" 143) 144
应答参数
200 OK
out_trade_no 必填 string(32)
【商户侧交易单号】 发起还款时商户传入的商户侧交易单号
out_record_id 选填 string(32)
【商户侧预约还款记录ID】 预约还款成功的商户侧预约还款记录ID
appid 必填 string(32)
【商户AppID】 商户在微信申请的公众号或移动应用AppID,与服务商商户号绑定。可参考服务商模式开发必要参数说明
sub_appid 选填 string(32)
【子商户AppID】 与子商户号绑定的AppID。可参考服务商模式开发必要参数说明
openid 必填 string(128)
【用户标识】 用户在商户AppID下的唯一标识
contract_id 必填 string(64)
【还款协议ID】 商户与用户签约的还款协议ID
order_state 必填 string
【还款单状态】 还款单的状态
可选取值
DEDUCT_ORDER_STATE_PENDING: 待处理DEDUCT_ORDER_STATE_NOT_PAY: 待处理还款DEDUCT_ORDER_STATE_PAY_SUCCESS: 还款成功DEDUCT_ORDER_STATE_PAY_FAIL: 还款失败
deduct_amount 必填 string
【还款金额】 单位分
pay_success_amount 选填 string
【实际还款金额】 单位分;只有还款成功才会返回
description 必填 string(127)
【产品描述】 对产品信息的描述。服务商需传递能真实代表产品信息的描述
attach 选填 string(128)
【商户数据包】 服务商可传入自定义数据包,该数据对用户不可见,用于存储订单相关的服务商自定义信息。查询API和支付通知中原样返回
transaction_id 选填 string(32)
【微信支付的支付单号】 只有还款成功才返回
应答示例
200 OK
1{ 2 "out_trade_no" : "1217752501201407033233368018", 3 "out_record_id" : "123456abcde", 4 "appid" : "wxcbda96de0b165486", 5 "sub_appid" : "wxcbda96de0b165489", 6 "openid" : "oUpF8uMuAJO_M2pxb1Q9zNjWeS6o", 7 "contract_id" : "20251105000000123456789", 8 "order_state" : "DEDUCT_ORDER_STATE_PENDING", 9 "deduct_amount" : "10000", 10 "pay_success_amount" : "10000", 11 "description" : "信贷还款", 12 "attach" : "备注", 13 "transaction_id" : "1009660380201506130728806387" 14} 15
错误码
以下是本接口返回的错误码列表。详细错误码规则,请参考微信支付接口规则-错误码和错误提示

