Native合单下单
更新时间:2025.01.16用户在服务商前端选择微信支付后,服务商需调用该接口在微信支付下单,生成用于调起支付的二维码链接code_url
。
|
接口说明
支持商户:【普通服务商】
请求方式:【POST】/v3/combine-transactions/native
请求域名:【主域名】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 包体参数
combine_appid 必填 string(32)
【合单服务商APPID】服务商(合单发起方)的APPID。APPID是微信开放平台(移动应用)或微信公众平台(小程序、公众号)为开发者的应用程序提供的唯一标识。此处可以填写这三种类型中的任意一种APPID,并确保该combine_appid
与combine_mchid
有绑定关系。详见:商户号绑定APPID操作说明。
combine_out_trade_no 必填 string(32)
【合单商户订单号】服务商系统内部订单号,要求6~32个字符内,只能是数字、大小写字母_-|*,且在同一个合单服务商商户号combine_mchid
下唯一。
combine_mchid 必填 string(32)
【合单服务商商户号】 服务商(合单发起方)的商户号,是由微信支付系统生成并分配给每个商户的唯一标识符,具体请参考服务商模式开发必要参数说明。
scene_info 选填 object
【场景信息】 场景信息
属性 | |
device_id 选填 string(16) 【商户端设备号】 终端设备号(门店号或收银设备ID) payer_client_ip 必填 string(45) 【用户终端IP】 用户端实际IP,支持IPv4和IPv6两种格式的IP地址。IP获取请参考获取用户IP指引 |
sub_orders 必填 array[ReqSubOrder]
【子单信息列表】 合单支付的子单信息列表,一笔合单支付订单可支持1-50笔子单交易。
属性 | |||||||||
mchid 必填 string(32) 【服务商商户号】 此处请填写服务商(合单发起方)的商户号 attach 必填 string(128) 【商户数据包】服务商在创建订单时可传入自定义数据包,该数据对用户不可见,用于存储订单相关的服务商自定义信息,其总长度限制在128字符以内。支付成功后查询合单订单API和合单订单支付成功回调通知均会将此字段返回给服务商,并且该字段还会体现在交易账单。 amount 必填 object 【子单金额信息】 子订单收款金额信息。
out_trade_no 必填 string(32) 【子单商户订单号】 服务商系统内部订单号,要求6~32个字符内,只能是数字、大小写字母_-|*,且在同一个合单服务商商户号 sub_mchid 必填 string(32) 【子商户号(也叫特约商户号)】 子单参与方,由服务商为子商户进件后获取,具体请参考服务商模式开发必要参数说明。 description 必填 string(128) 【商品描述】商品信息描述,用户微信账单的商品字段中可见(可参考Native合单支付模式介绍-6、账单示意图),服务商需传递能真实代表商品信息的描述,不能超过127个字符。 settle_info 选填 object 【结算信息】 结算信息
sub_appid 选填 string 【子商户APPID】是子商户在微信开放平台(移动应用)或公众平台(公众号/小程序)上申请的一个唯一标识。此处可以填写这三种类型中的任意一种APPID,并确保该 goods_tag 选填 string(32) 【订单优惠标记】代金券在创建时可以配置多个订单优惠标记,标记的内容由创券商户自定义设置。详细参考:创建代金券批次API。 示例: |
time_expire 选填 string
【支付结束时间】
1、定义:支付结束时间是指用户能够完成该笔订单支付的最后时限,并非订单关闭的时间。超过此时间后,用户将无法对该笔订单进行支付。如需关闭订单,请调用关闭合单订单API接口。
2、格式要求:支付结束时间需遵循rfc3339标准格式:yyyy-MM-DDTHH:mm:ss+TIMEZONE
。yyyy-MM-DD
表示年月日;T
字符用于分隔日期和时间部分;HH:mm:ss
表示具体的时分秒;TIMEZONE
表示时区(例如,+08:00
对应东八区时间,即北京时间)。
示例:2015-05-20T13:29:35+08:00
表示北京时间2015年5月20日13点29分35秒。
3、注意事项:
time_expire
参数仅在用户首次下单时可设置,且不允许后续修改,尝试修改将导致错误。若用户实际进行支付的时间超过了订单设置的支付结束时间,服务商需使用新的商户订单号下单,生成新的订单供用户进行支付。若未超过支付结束时间,则可使用原参数重新请求下单接口,以获取当前订单最新的
code_url
进行支付。支付结束时间不能早于下单时间后1分钟,若设置的支付结束时间早于该时间,系统将自动调整为下单时间后1分钟作为支付结束时间。
notify_url 必填 string
【商户回调地址】服务商接收合单订单支付成功回调通知的地址,需按照notify_url填写注意事项规范填写。
请求示例
POST
合单支付-Native合单下单-请求示例
1curl -X POST \ 2 https://api.mch.weixin.qq.com/v3/combine-transactions/native \ 3 -H "Authorization: WECHATPAY2-SHA256-RSA2048 mchid=\"1900000001\",..." \ 4 -H "Accept: application/json" \ 5 -H "Content-Type: application/json" \ 6 -d '{ 7 "time_expire" : "2000-01-01T00:00:00+08:00", 8 "combine_appid" : "wxd678efh567hg6787", 9 "sub_orders" : [ 10 { 11 "mchid" : "1230000109", 12 "attach" : "深圳分店", 13 "amount" : { 14 "total_amount" : 10, 15 "currency" : "CNY" 16 }, 17 "out_trade_no" : "20150806125346", 18 "sub_mchid" : "1900000109", 19 "description" : "腾讯充值中心-QQ会员充值", 20 "settle_info" : { 21 "profit_sharing" : false 22 }, 23 "sub_appid" : "wxd678efh567hg6999", 24 "goods_tag" : "WXG" 25 } 26 ], 27 "combine_out_trade_no" : "20150806125346", 28 "notify_url" : "https://yourapp.com/notify", 29 "combine_mchid" : "1900000109", 30 "scene_info" : { 31 "device_id" : "POS1:1", 32 "payer_client_ip" : "14.17.22.32" 33 } 34 }' 35
需配合微信支付工具库 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 * 合单下单-NATIVE 24 */ 25public class UnionNativePrepay { 26 private static String HOST = "https://api.mch.weixin.qq.com"; 27 private static String METHOD = "POST"; 28 private static String PATH = "/v3/combine-transactions/native"; 29 30 public static void main(String[] args) { 31 // TODO: 请准备商户开发必要参数,参考:https://pay.weixin.qq.com/doc/v3/partner/4013080340 32 UnionNativePrepay client = new UnionNativePrepay( 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 UnionAPIv3NativePrepayRequest request = new UnionAPIv3NativePrepayRequest(); 41 request.combineAppid = "wxd678efh567hg6787"; 42 request.combineOutTradeNo = "20150806125346"; 43 request.combineMchid = "1900000109"; 44 request.sceneInfo = new UnionSceneInfo(); 45 request.sceneInfo.deviceId = "POS1:1"; 46 request.sceneInfo.payerClientIp = "14.17.22.32"; 47 request.subOrders = new ArrayList<>(); 48 { 49 UnionCommonSubOrder subOrdersItem0 = new UnionCommonSubOrder(); 50 subOrdersItem0.mchid = "1230000109"; 51 subOrdersItem0.subMchid = "1900000109"; 52 subOrdersItem0.subAppid = "wxd678efh567hg6999"; 53 subOrdersItem0.outTradeNo = "20150806125346"; 54 subOrdersItem0.amount = new UnionAmountInfo(); 55 subOrdersItem0.amount.totalAmount = 10L; 56 subOrdersItem0.amount.currency = "CNY"; 57 subOrdersItem0.attach = "深圳分店"; 58 subOrdersItem0.description = "腾讯充值中心-QQ会员充值"; 59 subOrdersItem0.goodsTag = "WXG"; 60 subOrdersItem0.settleInfo = new UnionSettleInfo(); 61 subOrdersItem0.settleInfo.profitSharing = false; 62 request.subOrders.add(subOrdersItem0); 63 }; 64 request.timeExpire = "2000-01-01T00:00:00+08:00"; 65 request.notifyUrl = "https://yourapp.com/notify"; 66 try { 67 UnionAPIv3NativePrepayResponse response = client.run(request); 68 // TODO: 请求成功,继续业务逻辑 69 System.out.println(response); 70 } catch (WXPayUtility.ApiException e) { 71 // TODO: 请求失败,根据状态码执行不同的逻辑 72 e.printStackTrace(); 73 } 74 } 75 76 public UnionAPIv3NativePrepayResponse run(UnionAPIv3NativePrepayRequest request) { 77 String uri = PATH; 78 String reqBody = WXPayUtility.toJson(request); 79 80 Request.Builder reqBuilder = new Request.Builder().url(HOST + uri); 81 reqBuilder.addHeader("Accept", "application/json"); 82 reqBuilder.addHeader("Wechatpay-Serial", wechatPayPublicKeyId); 83 reqBuilder.addHeader("Authorization", WXPayUtility.buildAuthorization(mchid, certificateSerialNo,privateKey, METHOD, uri, reqBody)); 84 reqBuilder.addHeader("Content-Type", "application/json"); 85 RequestBody requestBody = RequestBody.create(MediaType.parse("application/json; charset=utf-8"), reqBody); 86 reqBuilder.method(METHOD, requestBody); 87 Request httpRequest = reqBuilder.build(); 88 89 // 发送HTTP请求 90 OkHttpClient client = new OkHttpClient.Builder().build(); 91 try (Response httpResponse = client.newCall(httpRequest).execute()) { 92 String respBody = WXPayUtility.extractBody(httpResponse); 93 if (httpResponse.code() >= 200 && httpResponse.code() < 300) { 94 // 2XX 成功,验证应答签名 95 WXPayUtility.validateResponse(this.wechatPayPublicKeyId, this.wechatPayPublicKey, 96 httpResponse.headers(), respBody); 97 98 // 从HTTP应答报文构建返回数据 99 return WXPayUtility.fromJson(respBody, UnionAPIv3NativePrepayResponse.class); 100 } else { 101 throw new WXPayUtility.ApiException(httpResponse.code(), respBody, httpResponse.headers()); 102 } 103 } catch (IOException e) { 104 throw new UncheckedIOException("Sending request to " + uri + " failed.", e); 105 } 106 } 107 108 private final String mchid; 109 private final String certificateSerialNo; 110 private final PrivateKey privateKey; 111 private final String wechatPayPublicKeyId; 112 private final PublicKey wechatPayPublicKey; 113 114 public UnionNativePrepay(String mchid, String certificateSerialNo, String privateKeyFilePath, String wechatPayPublicKeyId, String wechatPayPublicKeyFilePath) { 115 this.mchid = mchid; 116 this.certificateSerialNo = certificateSerialNo; 117 this.privateKey = WXPayUtility.loadPrivateKeyFromPath(privateKeyFilePath); 118 this.wechatPayPublicKeyId = wechatPayPublicKeyId; 119 this.wechatPayPublicKey = WXPayUtility.loadPublicKeyFromPath(wechatPayPublicKeyFilePath); 120 } 121 122 public static class UnionAPIv3NativePrepayRequest { 123 @SerializedName("combine_appid") 124 public String combineAppid; 125 126 @SerializedName("combine_out_trade_no") 127 public String combineOutTradeNo; 128 129 @SerializedName("combine_mchid") 130 public String combineMchid; 131 132 @SerializedName("scene_info") 133 public UnionSceneInfo sceneInfo; 134 135 @SerializedName("sub_orders") 136 public List<UnionCommonSubOrder> subOrders = new ArrayList<UnionCommonSubOrder>(); 137 138 @SerializedName("time_expire") 139 public String timeExpire; 140 141 @SerializedName("notify_url") 142 public String notifyUrl; 143 } 144 145 public static class UnionAPIv3NativePrepayResponse { 146 @SerializedName("code_url") 147 public String codeUrl; 148 } 149 150 public static class UnionSceneInfo { 151 @SerializedName("device_id") 152 public String deviceId; 153 154 @SerializedName("payer_client_ip") 155 public String payerClientIp; 156 } 157 158 public static class UnionCommonSubOrder { 159 @SerializedName("mchid") 160 public String mchid; 161 162 @SerializedName("sub_mchid") 163 public String subMchid; 164 165 @SerializedName("sub_appid") 166 public String subAppid; 167 168 @SerializedName("out_trade_no") 169 public String outTradeNo; 170 171 @SerializedName("amount") 172 public UnionAmountInfo amount; 173 174 @SerializedName("attach") 175 public String attach; 176 177 @SerializedName("description") 178 public String description; 179 180 @SerializedName("goods_tag") 181 public String goodsTag; 182 183 @SerializedName("settle_info") 184 public UnionSettleInfo settleInfo; 185 } 186 187 public static class UnionAmountInfo { 188 @SerializedName("total_amount") 189 public Long totalAmount; 190 191 @SerializedName("currency") 192 public String currency; 193 } 194 195 public static class UnionSettleInfo { 196 @SerializedName("profit_sharing") 197 public Boolean profitSharing; 198 } 199 200} 201
需配合微信支付工具库 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 "time" 11) 12 13func main() { 14 // TODO: 请准备商户开发必要参数,参考:https://pay.weixin.qq.com/doc/v3/partner/4013080340 15 config, err := wxpay_utility.CreateMchConfig( 16 "19xxxxxxxx", // 商户号,是由微信支付系统生成并分配给每个商户的唯一标识符,商户号获取方式参考 https://pay.weixin.qq.com/doc/v3/partner/4013080340 17 "1DDE55AD98Exxxxxxxxxx", // 商户API证书序列号,如何获取请参考 https://pay.weixin.qq.com/doc/v3/partner/4013058924 18 "/path/to/apiclient_key.pem", // 商户API证书私钥文件路径,本地文件路径 19 "PUB_KEY_ID_xxxxxxxxxxxxx", // 微信支付公钥ID,如何获取请参考 https://pay.weixin.qq.com/doc/v3/partner/4013038589 20 "/path/to/wxp_pub.pem", // 微信支付公钥文件路径,本地文件路径 21 ) 22 if err != nil { 23 fmt.Println(err) 24 return 25 } 26 27 request := &UnionApiv3NativePrepayRequest{ 28 CombineAppid: wxpay_utility.String("wxd678efh567hg6787"), 29 CombineOutTradeNo: wxpay_utility.String("20150806125346"), 30 CombineMchid: wxpay_utility.String("1900000109"), 31 SceneInfo: &UnionSceneInfo{ 32 DeviceId: wxpay_utility.String("POS1:1"), 33 PayerClientIp: wxpay_utility.String("14.17.22.32"), 34 }, 35 SubOrders: []UnionCommonSubOrder{ 36 UnionCommonSubOrder{ 37 Mchid: wxpay_utility.String("1230000109"), 38 SubMchid: wxpay_utility.String("1900000109"), 39 SubAppid: wxpay_utility.String("wxd678efh567hg6999"), 40 OutTradeNo: wxpay_utility.String("20150806125346"), 41 Amount: &UnionAmountInfo{ 42 TotalAmount: wxpay_utility.Int64(10), 43 Currency: wxpay_utility.String("CNY"), 44 }, 45 Attach: wxpay_utility.String("深圳分店"), 46 Description: wxpay_utility.String("腾讯充值中心-QQ会员充值"), 47 GoodsTag: wxpay_utility.String("WXG"), 48 SettleInfo: &UnionSettleInfo{ 49 ProfitSharing: wxpay_utility.Bool(false), 50 }, 51 }, 52 }, 53 TimeExpire: wxpay_utility.Time(time.Now()), 54 NotifyUrl: wxpay_utility.String("https://yourapp.com/notify"), 55 } 56 57 response, err := UnionNativePrepay(config, request) 58 if err != nil { 59 fmt.Printf("请求失败: %+v\n", err) 60 // TODO: 请求失败,根据状态码执行不同的处理 61 return 62 } 63 64 // TODO: 请求成功,继续业务逻辑 65 fmt.Printf("请求成功: %+v\n", response) 66} 67 68func UnionNativePrepay(config *wxpay_utility.MchConfig, request *UnionApiv3NativePrepayRequest) (response *UnionApiv3NativePrepayResponse, err error) { 69 const ( 70 host = "https://api.mch.weixin.qq.com" 71 method = "POST" 72 path = "/v3/combine-transactions/native" 73 ) 74 75 reqUrl, err := url.Parse(fmt.Sprintf("%s%s", host, path)) 76 if err != nil { 77 return nil, err 78 } 79 reqBody, err := json.Marshal(request) 80 if err != nil { 81 return nil, err 82 } 83 httpRequest, err := http.NewRequest(method, reqUrl.String(), bytes.NewReader(reqBody)) 84 if err != nil { 85 return nil, err 86 } 87 httpRequest.Header.Set("Accept", "application/json") 88 httpRequest.Header.Set("Wechatpay-Serial", config.WechatPayPublicKeyId()) 89 httpRequest.Header.Set("Content-Type", "application/json") 90 authorization, err := wxpay_utility.BuildAuthorization(config.MchId(), config.CertificateSerialNo(), config.PrivateKey(), method, reqUrl.RequestURI(), reqBody) 91 if err != nil { 92 return nil, err 93 } 94 httpRequest.Header.Set("Authorization", authorization) 95 96 client := &http.Client{} 97 httpResponse, err := client.Do(httpRequest) 98 if err != nil { 99 return nil, err 100 } 101 respBody, err := wxpay_utility.ExtractResponseBody(httpResponse) 102 if err != nil { 103 return nil, err 104 } 105 if httpResponse.StatusCode >= 200 && httpResponse.StatusCode < 300 { 106 // 2XX 成功,验证应答签名 107 err = wxpay_utility.ValidateResponse( 108 config.WechatPayPublicKeyId(), 109 config.WechatPayPublicKey(), 110 &httpResponse.Header, 111 respBody, 112 ) 113 if err != nil { 114 return nil, err 115 } 116 response := &UnionApiv3NativePrepayResponse{} 117 if err := json.Unmarshal(respBody, response); err != nil { 118 return nil, err 119 } 120 121 return response, nil 122 } else { 123 return nil, wxpay_utility.NewApiException( 124 httpResponse.StatusCode, 125 httpResponse.Header, 126 respBody, 127 ) 128 } 129} 130 131type UnionApiv3NativePrepayRequest struct { 132 CombineAppid *string `json:"combine_appid,omitempty"` 133 CombineOutTradeNo *string `json:"combine_out_trade_no,omitempty"` 134 CombineMchid *string `json:"combine_mchid,omitempty"` 135 SceneInfo *UnionSceneInfo `json:"scene_info,omitempty"` 136 SubOrders []UnionCommonSubOrder `json:"sub_orders,omitempty"` 137 TimeExpire *time.Time `json:"time_expire,omitempty"` 138 NotifyUrl *string `json:"notify_url,omitempty"` 139} 140 141type UnionApiv3NativePrepayResponse struct { 142 CodeUrl *string `json:"code_url,omitempty"` 143} 144 145type UnionSceneInfo struct { 146 DeviceId *string `json:"device_id,omitempty"` 147 PayerClientIp *string `json:"payer_client_ip,omitempty"` 148} 149 150type UnionCommonSubOrder struct { 151 Mchid *string `json:"mchid,omitempty"` 152 SubMchid *string `json:"sub_mchid,omitempty"` 153 SubAppid *string `json:"sub_appid,omitempty"` 154 OutTradeNo *string `json:"out_trade_no,omitempty"` 155 Amount *UnionAmountInfo `json:"amount,omitempty"` 156 Attach *string `json:"attach,omitempty"` 157 Description *string `json:"description,omitempty"` 158 GoodsTag *string `json:"goods_tag,omitempty"` 159 SettleInfo *UnionSettleInfo `json:"settle_info,omitempty"` 160} 161 162type UnionAmountInfo struct { 163 TotalAmount *int64 `json:"total_amount,omitempty"` 164 Currency *string `json:"currency,omitempty"` 165} 166 167type UnionSettleInfo struct { 168 ProfitSharing *bool `json:"profit_sharing,omitempty"` 169} 170
应答参数
200 OK
code_url 必填 string(512)
【二维码链接】 此URL用于生成支付二维码,然后提供给用户扫码支付。Native调起支付时需要使用的参数,code_url有效期为2小时,失效后需要重新请求该接口以获取新的code_url。
注意:code_url并非固定值,使用时按照URL格式转成二维码即可。
应答示例
200 OK
1{ 2 "code_url" : "weixin://wxpay/bizpayurl/up?pr=NwY5Mz9&groupid=00" 3} 4
错误码
公共错误码
状态码 | 错误码 | 描述 | 解决方案 |
---|---|---|---|
400 | PARAM_ERROR | 参数错误 | 请根据错误提示正确传入参数 |
400 | INVALID_REQUEST | HTTP 请求不符合微信支付 APIv3 接口规则 | 请参阅接口规则检查传入的参数 |
401 | SIGN_ERROR | 验证不通过 | 请参阅签名常见问题排查 |
500 | SYSTEM_ERROR | 系统异常,请稍后重试 | 请稍后重试 |
业务错误码
状态码 | 错误码 | 描述 | 解决方案 |
---|---|---|---|
400 | APPID_MCHID_NOT_MATCH | AppID和mch_id不匹配 | 请确认AppID和mch_id是否匹配,参考:查询商户号绑定的APPID |
400 | INVALID_REQUEST | 无效请求 | 请根据接口返回的详细信息检查 |
400 | MCH_NOT_EXISTS | 商户号不存在 | 请检查商户号是否正确,商户号获取方法参考:服务商模式开发必要参数说明 |
400 | ORDER_CLOSED | 订单已关闭 | 当前订单已关闭,请重新下单 |
401 | SIGN_ERROR | 签名错误 | 请检查签名参数和方法是否都符合签名算法要求,参考:如何生成签名 |
403 | NOAUTH | 商户无权限 | 请商户联系对接运营申请此接口相关权限,参考:权限申请 |
403 | OUT_TRADE_NO_USED | 商户订单号重复 | 请核实商户订单号是否重复提交 |
403 | RULELIMIT | 业务规则限制 | 因业务规则限制请求频率,请查看接口返回的详细信息 |
429 | FREQUENCY_LIMITED | 频率超限 | 请降低请求接口频率 |
500 | SYSTEMERROR | 系统错误 | 系统异常,请用相同参数重新调用 |