小程序场景预签约(需要实名验证)
更新时间:2026.04.24商户可调用本接口预先指定签约,生成预签约会话及对应的预签约ID,再携带预签约ID(pre_entrustweb_id)参数,通过微信SDK拉起微信支付客户端的签约页面。
通过本接口预签约时,商户需具备实名验证产品权限,要求用户在签约时完成实名验证授权,仅当用户的微信支付实名信息与商户预留一致时才能完成签约。
接口说明
支持商户:【平台商户】
请求方式:【POST】/v3/ecommerce/individual-contracts/pre-entrust-sign-with-real-name-identity/mini-program
请求域名:【主域名】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
Wechatpay-Serial 必填 string
【微信支付公钥ID】或【微信支付平台证书序列号】 请求参数中的敏感字段,需要使用微信支付公钥加密(推荐),请参考获取微信支付公钥ID说明以及微信支付公钥加密敏感信息指引;也可以使用微信支付平台证书公钥加密,参考获取平台证书序列号、平台证书加密敏感信息指引
body 包体参数
appid 必填 string(32)
【签约和付款的AppID】 调用方的AppID,获取方式详见:服务商模式开发必要参数说明
out_contract_code 必填 string(128)
【业务申请单号】 自定义的商户唯一编号,需保证服务商下唯一,仅允许包含英文半角的数字、字母、连接线-和下划线_。
openid 必填 string(64)
【个人收款方的OpenID】 个人收款方在平台appid下的唯一标识。
real_name 必填 string(512)
【真实姓名】 必须加密传输,参考 HEADER 参数 Wechatpay-Serial 文档描述中的加密敏感信息指引。加密前的明文使用 UTF-8 编码,长度限制 1-64 字符。
cred_type 必填 string
【证件类型】 目前仅支持身份证
可选取值
ID_CARD: 身份证
cred_id 必填 string(512)
【证件号码】 必须加密传输,参考 HEADER 参数 Wechatpay-Serial 文档描述中的加密敏感信息指引。加密前的明文使用 UTF-8 编码,长度限制 1-64 字符。
请求示例
POST
1curl -X POST \ 2 https://api.mch.weixin.qq.com/v3/ecommerce/individual-contracts/pre-entrust-sign-with-real-name-identity/mini-program \ 3 -H "Authorization: WECHATPAY2-SHA256-RSA2048 mchid=\"1900000001\",..." \ 4 -H "Accept: application/json" \ 5 -H "Wechatpay-Serial: 5157F09EFDC096DE15EBE81A47057A7232F1B8E1" \ 6 -H "Content-Type: application/json" \ 7 -d '{ 8 "appid" : "wxd678efh567h23787", 9 "out_contract_code" : "APPLYMENT_00000000001", 10 "openid" : "oUpF8uMuAJO_M2pxb1Q9zNjWeS6o", 11 "real_name" : "刘某某", 12 "cred_type" : "ID_CARD", 13 "cred_id" : "440000000000000000" 14 }' 15
需配合微信支付工具库 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 * 小程序场景C2C预签约(需要实名验证) 24 */ 25public class PreEntrustSignWithRealNameIdentityMp { 26 private static String HOST = "https://api.mch.weixin.qq.com"; 27 private static String METHOD = "POST"; 28 private static String PATH = "/v3/ecommerce/individual-contracts/pre-entrust-sign-with-real-name-identity/mini-program"; 29 30 public static void main(String[] args) { 31 // TODO: 请准备商户开发必要参数,参考:https://pay.weixin.qq.com/doc/v3/partner/4013080340 32 PreEntrustSignWithRealNameIdentityMp client = new PreEntrustSignWithRealNameIdentityMp( 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 PreEntrustSignWithRealNameIdentityRequest request = new PreEntrustSignWithRealNameIdentityRequest(); 41 request.appid = "wxd678efh567h23787"; 42 request.outContractCode = "APPLYMENT_00000000001"; 43 request.openid = "oUpF8uMuAJO_M2pxb1Q9zNjWeS6o"; 44 request.realName = client.encrypt("real_name"); 45 request.credType = CredType.ID_CARD; 46 request.credId = client.encrypt("cred_id"); 47 try { 48 PreEntrustSignResponse response = client.run(request); 49 // TODO: 请求成功,继续业务逻辑 50 System.out.println(response); 51 } catch (WXPayUtility.ApiException e) { 52 // TODO: 请求失败,根据状态码执行不同的逻辑 53 e.printStackTrace(); 54 } 55 } 56 57 public PreEntrustSignResponse run(PreEntrustSignWithRealNameIdentityRequest request) { 58 String uri = PATH; 59 String reqBody = WXPayUtility.toJson(request); 60 61 Request.Builder reqBuilder = new Request.Builder().url(HOST + uri); 62 reqBuilder.addHeader("Accept", "application/json"); 63 reqBuilder.addHeader("Wechatpay-Serial", wechatPayPublicKeyId); 64 reqBuilder.addHeader("Authorization", WXPayUtility.buildAuthorization(mchid, certificateSerialNo,privateKey, METHOD, uri, reqBody)); 65 reqBuilder.addHeader("Content-Type", "application/json"); 66 RequestBody requestBody = RequestBody.create(MediaType.parse("application/json; charset=utf-8"), reqBody); 67 reqBuilder.method(METHOD, requestBody); 68 Request httpRequest = reqBuilder.build(); 69 70 // 发送HTTP请求 71 OkHttpClient client = new OkHttpClient.Builder().build(); 72 try (Response httpResponse = client.newCall(httpRequest).execute()) { 73 String respBody = WXPayUtility.extractBody(httpResponse); 74 if (httpResponse.code() >= 200 && httpResponse.code() < 300) { 75 // 2XX 成功,验证应答签名 76 WXPayUtility.validateResponse(this.wechatPayPublicKeyId, this.wechatPayPublicKey, 77 httpResponse.headers(), respBody); 78 79 // 从HTTP应答报文构建返回数据 80 return WXPayUtility.fromJson(respBody, PreEntrustSignResponse.class); 81 } else { 82 throw new WXPayUtility.ApiException(httpResponse.code(), respBody, httpResponse.headers()); 83 } 84 } catch (IOException e) { 85 throw new UncheckedIOException("Sending request to " + uri + " failed.", e); 86 } 87 } 88 89 private final String mchid; 90 private final String certificateSerialNo; 91 private final PrivateKey privateKey; 92 private final String wechatPayPublicKeyId; 93 private final PublicKey wechatPayPublicKey; 94 95 public PreEntrustSignWithRealNameIdentityMp(String mchid, String certificateSerialNo, String privateKeyFilePath, String wechatPayPublicKeyId, String wechatPayPublicKeyFilePath) { 96 this.mchid = mchid; 97 this.certificateSerialNo = certificateSerialNo; 98 this.privateKey = WXPayUtility.loadPrivateKeyFromPath(privateKeyFilePath); 99 this.wechatPayPublicKeyId = wechatPayPublicKeyId; 100 this.wechatPayPublicKey = WXPayUtility.loadPublicKeyFromPath(wechatPayPublicKeyFilePath); 101 } 102 103 public String encrypt(String plainText) { 104 return WXPayUtility.encrypt(this.wechatPayPublicKey, plainText); 105 } 106 107 public static class PreEntrustSignWithRealNameIdentityRequest { 108 @SerializedName("appid") 109 public String appid; 110 111 @SerializedName("out_contract_code") 112 public String outContractCode; 113 114 @SerializedName("openid") 115 public String openid; 116 117 @SerializedName("real_name") 118 public String realName; 119 120 @SerializedName("cred_type") 121 public CredType credType; 122 123 @SerializedName("cred_id") 124 public String credId; 125 } 126 127 public static class PreEntrustSignResponse { 128 @SerializedName("pre_entrustweb_id") 129 public String preEntrustwebId; 130 } 131 132 public enum CredType { 133 @SerializedName("ID_CARD") 134 ID_CARD 135 } 136 137} 138
需配合微信支付工具库 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 := &PreEntrustSignWithRealNameIdentityRequest{ 27 Appid: wxpay_utility.String("wxd678efh567h23787"), 28 OutContractCode: wxpay_utility.String("APPLYMENT_00000000001"), 29 Openid: wxpay_utility.String("oUpF8uMuAJO_M2pxb1Q9zNjWeS6o"), 30 RealName: wxpay_utility.String("刘某某"), /*请传入wxpay_utility.EncryptOAEPWithPublicKey 加密结果*/ 31 CredType: CREDTYPE_ID_CARD.Ptr(), 32 CredId: wxpay_utility.String("440000000000000000"), /*请传入wxpay_utility.EncryptOAEPWithPublicKey 加密结果*/ 33 } 34 35 response, err := PreEntrustSignWithRealNameIdentityMp(config, request) 36 if err != nil { 37 fmt.Printf("请求失败: %+v\n", err) 38 // TODO: 请求失败,根据状态码执行不同的处理 39 return 40 } 41 42 // TODO: 请求成功,继续业务逻辑 43 fmt.Printf("请求成功: %+v\n", response) 44} 45 46func PreEntrustSignWithRealNameIdentityMp(config *wxpay_utility.MchConfig, request *PreEntrustSignWithRealNameIdentityRequest) (response *PreEntrustSignResponse, err error) { 47 const ( 48 host = "https://api.mch.weixin.qq.com" 49 method = "POST" 50 path = "/v3/ecommerce/individual-contracts/pre-entrust-sign-with-real-name-identity/mini-program" 51 ) 52 53 reqUrl, err := url.Parse(fmt.Sprintf("%s%s", host, path)) 54 if err != nil { 55 return nil, err 56 } 57 reqBody, err := json.Marshal(request) 58 if err != nil { 59 return nil, err 60 } 61 httpRequest, err := http.NewRequest(method, reqUrl.String(), bytes.NewReader(reqBody)) 62 if err != nil { 63 return nil, err 64 } 65 httpRequest.Header.Set("Accept", "application/json") 66 httpRequest.Header.Set("Wechatpay-Serial", config.WechatPayPublicKeyId()) 67 httpRequest.Header.Set("Content-Type", "application/json") 68 authorization, err := wxpay_utility.BuildAuthorization(config.MchId(), config.CertificateSerialNo(), config.PrivateKey(), method, reqUrl.RequestURI(), reqBody) 69 if err != nil { 70 return nil, err 71 } 72 httpRequest.Header.Set("Authorization", authorization) 73 74 client := &http.Client{} 75 httpResponse, err := client.Do(httpRequest) 76 if err != nil { 77 return nil, err 78 } 79 respBody, err := wxpay_utility.ExtractResponseBody(httpResponse) 80 if err != nil { 81 return nil, err 82 } 83 if httpResponse.StatusCode >= 200 && httpResponse.StatusCode < 300 { 84 // 2XX 成功,验证应答签名 85 err = wxpay_utility.ValidateResponse( 86 config.WechatPayPublicKeyId(), 87 config.WechatPayPublicKey(), 88 &httpResponse.Header, 89 respBody, 90 ) 91 if err != nil { 92 return nil, err 93 } 94 response := &PreEntrustSignResponse{} 95 if err := json.Unmarshal(respBody, response); err != nil { 96 return nil, err 97 } 98 99 return response, nil 100 } else { 101 return nil, wxpay_utility.NewApiException( 102 httpResponse.StatusCode, 103 httpResponse.Header, 104 respBody, 105 ) 106 } 107} 108 109type PreEntrustSignWithRealNameIdentityRequest struct { 110 Appid *string `json:"appid,omitempty"` 111 OutContractCode *string `json:"out_contract_code,omitempty"` 112 Openid *string `json:"openid,omitempty"` 113 RealName *string `json:"real_name,omitempty"` 114 CredType *CredType `json:"cred_type,omitempty"` 115 CredId *string `json:"cred_id,omitempty"` 116} 117 118type PreEntrustSignResponse struct { 119 PreEntrustwebId *string `json:"pre_entrustweb_id,omitempty"` 120} 121 122type CredType string 123 124func (e CredType) Ptr() *CredType { 125 return &e 126} 127 128const ( 129 CREDTYPE_ID_CARD CredType = "ID_CARD" 130) 131
应答参数
200 OK
pre_entrustweb_id 必填 string(256)
【预签约ID】 生成预签约会ID,携带预签约ID(pre_entrustweb_id)参数,通过微信SDK拉起微信支付客户端的签约页面。
应答示例
200 OK
1{ 2 "pre_entrustweb_id" : "1121_9f3cec22a2d367737674d08d98e5e07b8388495fafedc0eba83c327e8ad720ed_12bfdd59b387c4bff8543de4719a886a" 3} 4
错误码
以下是本接口返回的错误码列表。详细错误码规则,请参考微信支付接口规则-错误码和错误提示

