企业商户获取指定额度卡支付链接

更新时间:2025.05.29

企业商户获取指定额度卡支付链接。该接口允许服务商获取指定额度卡的支付链接,员工可通过该链接使用额度卡进行支付,链接有效期较短,请在有效期内使用。企业可通过此接口为员工生成便捷的支付入口,简化支付流程。

接口说明

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

请求方式:【GET】/v3/webizpay/employees/{employee_id}/quota-cards/{card_no}/payment-url

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

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

请求参数

Header  HTTP头参数

 Authorization  必填 string

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


 Accept  必填 string

请设置为application/json


path  路径参数

 card_no  必填   string(64)

【企业支付额度卡卡号】 企业支付额度卡卡号,微信支付平台生成的唯一标识额度卡的编号。通过创建卡和查询卡返回。
示例:1068019671702503425


 employee_id  必填   string(64)

【微信授权关系 ID】 微信授权关系ID,微信支付平台生成的唯一标识授权关系的ID,用户注册时会回调商户获取微信授权关系ID或者商户通过企业下唯一的员工ID查询企业支付员工接口获得。
示例:WeBizPay_a968402a-73bb-43e2-9e1a-8371b0ca3d7c


query  查询参数

 sp_mchid  必填   string(32)

【服务商商户号】 是由微信支付系统生成并分配给每个服务商的唯一标识符,具体请参考服务商模式开发必要参数说明


 sub_mchid  必填   string(32)

【出资子商户号】 由服务商为子商户进件后获取,具体请参考服务商模式开发必要参数说明


 application_type  必填   string

【拉起付款码页面的企业应用类型】 用户从企业应用跳转至微信付款码,需传入拉起付款码页面的企业应用类型

可选取值

  • H5:  表示从商户的应用是外部H5,跳转微信拉起企业支付相关能力

  • MINIPROGRAM:  表示从商户的应用是微信小程序,跳转微信拉起企业支付相关能力

请求示例

Java
Go
curl

需配合微信支付工具库 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 GetQuotaCardPaymentUrl {
26  private static String HOST = "https://api.mch.weixin.qq.com";
27  private static String METHOD = "GET";
28  private static String PATH = "/v3/webizpay/employees/{employee_id}/quota-cards/{card_no}/payment-url";
29
30  public static void main(String[] args) {
31    // TODO: 请准备商户开发必要参数,参考:https://pay.weixin.qq.com/doc/v3/partner/4013080340
32    GetQuotaCardPaymentUrl client = new GetQuotaCardPaymentUrl(
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    GetQuotaCardPaymentUrlRequest request = new GetQuotaCardPaymentUrlRequest();
41    request.cardNo = "1068019671702503425";
42    request.employeeId = "WeBizPay_a968402a-73bb-43e2-9e1a-8371b0ca3d7c";
43    request.spMchid = "12341234";
44    request.subMchid = "43214321";
45    request.applicationType = ApplicationType.H5;
46    try {
47      CardsGetQuotaCardPaymentUrlResponse response = client.run(request);
48
49      // TODO: 请求成功,继续业务逻辑
50      System.out.println(response);
51    } catch (WXPayUtility.ApiException e) {
52      // TODO: 请求失败,根据状态码执行不同的逻辑
53      e.printStackTrace();
54    }
55  }
56
57  public CardsGetQuotaCardPaymentUrlResponse run(GetQuotaCardPaymentUrlRequest request) {
58    String uri = PATH;
59    uri = uri.replace("{card_no}", WXPayUtility.urlEncode(request.cardNo));
60    uri = uri.replace("{employee_id}", WXPayUtility.urlEncode(request.employeeId));
61    Map<String, Object> args = new HashMap<>();
62    args.put("sp_mchid", request.spMchid);
63    args.put("sub_mchid", request.subMchid);
64    args.put("application_type", request.applicationType);
65    uri = uri + "?" + WXPayUtility.urlEncode(args);
66
67    Request.Builder reqBuilder = new Request.Builder().url(HOST + uri);
68    reqBuilder.addHeader("Accept", "application/json");
69    reqBuilder.addHeader("Wechatpay-Serial", wechatPayPublicKeyId);
70    reqBuilder.addHeader("Authorization", WXPayUtility.buildAuthorization(mchid, certificateSerialNo, privateKey, METHOD, uri, null));
71    reqBuilder.method(METHOD, null);
72    Request httpRequest = reqBuilder.build();
73
74    // 发送HTTP请求
75    OkHttpClient client = new OkHttpClient.Builder().build();
76    try (Response httpResponse = client.newCall(httpRequest).execute()) {
77      String respBody = WXPayUtility.extractBody(httpResponse);
78      if (httpResponse.code() >= 200 && httpResponse.code() < 300) {
79        // 2XX 成功,验证应答签名
80        WXPayUtility.validateResponse(this.wechatPayPublicKeyId, this.wechatPayPublicKey,
81            httpResponse.headers(), respBody);
82
83        // 从HTTP应答报文构建返回数据
84        return WXPayUtility.fromJson(respBody, CardsGetQuotaCardPaymentUrlResponse.class);
85      } else {
86        throw new WXPayUtility.ApiException(httpResponse.code(), respBody, httpResponse.headers());
87      }
88    } catch (IOException e) {
89      throw new UncheckedIOException("Sending request to " + uri + " failed.", e);
90    }
91  }
92
93  private final String mchid;
94  private final String certificateSerialNo;
95  private final PrivateKey privateKey;
96  private final String wechatPayPublicKeyId;
97  private final PublicKey wechatPayPublicKey;
98
99  public GetQuotaCardPaymentUrl(String mchid, String certificateSerialNo, String privateKeyFilePath, String wechatPayPublicKeyId, String wechatPayPublicKeyFilePath) {
100    this.mchid = mchid;
101    this.certificateSerialNo = certificateSerialNo;
102    this.privateKey = WXPayUtility.loadPrivateKeyFromPath(privateKeyFilePath);
103    this.wechatPayPublicKeyId = wechatPayPublicKeyId;
104    this.wechatPayPublicKey = WXPayUtility.loadPublicKeyFromPath(wechatPayPublicKeyFilePath);
105  }
106
107  public static class GetQuotaCardPaymentUrlRequest {
108    @SerializedName("sp_mchid")
109    @Expose(serialize = false)
110    public String spMchid;
111  
112    @SerializedName("sub_mchid")
113    @Expose(serialize = false)
114    public String subMchid;
115  
116    @SerializedName("card_no")
117    @Expose(serialize = false)
118    public String cardNo;
119  
120    @SerializedName("employee_id")
121    @Expose(serialize = false)
122    public String employeeId;
123  
124    @SerializedName("application_type")
125    @Expose(serialize = false)
126    public ApplicationType applicationType;
127  }
128  
129  public static class CardsGetQuotaCardPaymentUrlResponse {
130    @SerializedName("sp_mchid")
131    public String spMchid;
132  
133    @SerializedName("sub_mchid")
134    public String subMchid;
135  
136    @SerializedName("employee_id")
137    public String employeeId;
138  
139    @SerializedName("card_no")
140    public String cardNo;
141  
142    @SerializedName("expire_time")
143    public String expireTime;
144  
145    @SerializedName("payment_url")
146    public String paymentUrl;
147  
148    @SerializedName("application_type")
149    public ApplicationType applicationType;
150  
151    @SerializedName("mp_query")
152    public String mpQuery;
153  
154    @SerializedName("mp_business_type")
155    public String mpBusinessType;
156  }
157  
158  public enum ApplicationType {
159    @SerializedName("H5")
160    H5,
161    @SerializedName("MINIPROGRAM")
162    MINIPROGRAM
163  }
164  
165}
166

应答参数

200 OK

 sp_mchid  必填   string(32)

【服务商商户号】 服务商商户号


 sub_mchid  必填   string(32)

【出资子商户号】 出资子商户号


 employee_id  必填   string(64)

【微信授权关系 ID】 微信授权关系ID,微信支付平台生成的唯一标识授权关系的ID
示例:WeBizPay_a968402a-73bb-43e2-9e1a-8371b0ca3d7c


 card_no  必填   string(64)

【企业支付额度卡卡号】 企业支付额度卡卡号,微信支付平台生成的唯一标识额度卡的编号
示例:1068019671702503425


 expire_time  必填   string

【链接失效时间】 定义:链接失效时间,超过这个时间后,用户再通过此链接尝试拉起微信付款码支付会拦截请求,需要重新调用此接口获取新的跳转链接。
遵循rfc3339标准格式:yyyy-MM-DDTHH:mm:ss+TIMEZONEyyyy-MM-DD 表示年月日;T 字符用于分隔日期和时间部分;HH:mm:ss 表示具体的时分秒;TIMEZONE 表示时区(例如,+08:00 对应东八区时间,即北京时间)。

示例:2015-05-20T13:29:35+08:00 表示北京时间2015年5月20日13点29分35秒。


 payment_url  选填   string(256)

【跳转链接】 当跳转类型为H5,并且允许拉起微信时返回。
跳转链接,通过schema跳转到微信可以拉起付款码页面


 application_type  必填   string

【拉起付款码页面的企业应用类型】 由商户请求时传入

可选取值

  • H5:  表示从商户的应用是外部H5,跳转微信拉起企业支付相关能力

  • MINIPROGRAM:  表示从商户的应用是微信小程序,跳转微信拉起企业支付相关能力


 mp_query  选填   string(256)

【小程序查询参数】 在类型为MINIPROGRAM 时,若允许拉起付款码页面则会返回该参数(有效期35分钟),拉起企业支付页面可参考从小程序调起企业支付相关能力-wx.openBusinessView

此参数对应从小程序调起企业支付相关能力-wx.openBusinessView中的queryString


 mp_business_type  选填   string

【小程序业务类型】 在类型为MINIPROGRAM 时,若允许拉起付款码页面则会返回该参数(有效期35分钟),拉起企业支付页面可参考从小程序调起企业支付相关能力-wx.openBusinessView

此参数对应从小程序调起企业支付相关能力-wx.openBusinessView中的businessType

应答示例

200 OK

1{
2  "sp_mchid" : "12341234",
3  "sub_mchid" : "43214321",
4  "employee_id" : "WeBizPay_a968402a-73bb-43e2-9e1a-8371b0ca3d7c",
5  "card_no" : "1068019671702503425",
6  "expire_time" : "2023-06-08T11:34:56+08:00",
7  "payment_url" : "weixin://dl/liteapp?url=https%3A%2F%2Fliteapp.wxpapp.weixin.qq.com%2Fq%2FgjoM7g%3Ftoken%3D123%23wechat_pay",
8  "application_type" : "H5",
9  "mp_query" : "token=123",
10  "mp_business_type" : "liteAppWebizPayRegister"
11}
12

 

错误码

公共错误码

状态码

错误码

描述

解决方案

400

PARAM_ERROR

参数错误

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

400

INVALID_REQUEST

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

请参阅 接口规则

401

SIGN_ERROR

验证不通过

请参阅 签名常见问题

500

SYSTEM_ERROR

系统异常,请稍后重试

请稍后重试

 

 

更多技术问题
技术咨询
反馈
咨询
目录
置顶