企业商户为员工下发企业支付额度卡

更新时间:2025.05.09

企业商户为员工下发企业支付额度卡。该接口允许服务商为已授权的员工下发企业支付额度卡,设置卡片名称、额度、备注等信息,员工可使用该额度卡进行企业支付。企业可根据不同业务场景(如差旅报销、日常办公等)为员工发放不同类型的额度卡,便于费用管理和控制。

接口说明

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

请求方式:【POST】/v3/webizpay/employees/{employee_id}/quota-cards

请求域名:【主域名】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


path  路径参数

 employee_id  必填   string(64)

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


body  包体参数

 sp_mchid  必填   string(32)

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


 sub_mchid  必填   string(32)

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


 card_template_id  必填   string(64)

【额度卡模板 ID】 额度卡模板ID,指定使用的额度卡模板,决定额度卡的使用规则、退款规则等,请联系微信支付侧申请卡模板ID。


 amount  必填   integer

【卡可用金额】 卡可用金额,单位为分,整型。
示例:1元应填写 100


 card_name  必填   string(20)

【卡片名称】 卡片名称,企业自定义的额度卡名称,用于标识额度卡用途,如'报销额度卡'、'差旅费用卡'等。
长度不超过20个字符


 out_card_no  必填   string(32)

【商户卡号】 商户卡号,由商户系统生成的唯一标识额度卡的编号,用于后续查询、作废等操作。
要求6-32个字符内,只能是数字、大小写字母_-|* 且在同一个商户号下唯一。


 effective_end_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秒。


 card_remark  选填   string(50)

【卡片备注】 卡片备注,额度卡的补充说明信息,如'2023年1月差旅报销'、'项目经费'等
长度不超过50个字符

请求示例

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 ApplyQuotaCard {
26  private static String HOST = "https://api.mch.weixin.qq.com";
27  private static String METHOD = "POST";
28  private static String PATH = "/v3/webizpay/employees/{employee_id}/quota-cards";
29
30  public static void main(String[] args) {
31    // TODO: 请准备商户开发必要参数,参考:https://pay.weixin.qq.com/doc/v3/partner/4013080340
32    ApplyQuotaCard client = new ApplyQuotaCard(
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    ApplyQuotaCardRequest request = new ApplyQuotaCardRequest();
41    request.employeeId = "WeBizPay_a968402a-73bb-43e2-9e1a-8371b0ca3d7c";
42    request.spMchid = "12341234";
43    request.subMchid = "43214321";
44    request.cardTemplateId = "template_123";
45    request.amount = 10000L;
46    request.cardName = "报销额度卡";
47    request.outCardNo = "out_card_123456";
48    request.effectiveEndTime = "2023-12-31T23:59:59+08:00";
49    request.cardRemark = "2023年1月差旅报销";
50    try {
51      CardsApplyQuotaCardResponse response = client.run(request);
52
53      // TODO: 请求成功,继续业务逻辑
54      System.out.println(response);
55    } catch (WXPayUtility.ApiException e) {
56      // TODO: 请求失败,根据状态码执行不同的逻辑
57      e.printStackTrace();
58    }
59  }
60
61  public CardsApplyQuotaCardResponse run(ApplyQuotaCardRequest request) {
62    String uri = PATH;
63    uri = uri.replace("{employee_id}", WXPayUtility.urlEncode(request.employeeId));
64    String reqBody = WXPayUtility.toJson(request);
65
66    Request.Builder reqBuilder = new Request.Builder().url(HOST + uri);
67    reqBuilder.addHeader("Accept", "application/json");
68    reqBuilder.addHeader("Wechatpay-Serial", wechatPayPublicKeyId);
69    reqBuilder.addHeader("Authorization", WXPayUtility.buildAuthorization(mchid, certificateSerialNo,privateKey, METHOD, uri, reqBody));
70    reqBuilder.addHeader("Content-Type", "application/json");
71    RequestBody requestBody = RequestBody.create(MediaType.parse("application/json; charset=utf-8"), reqBody);
72    reqBuilder.method(METHOD, requestBody);
73    Request httpRequest = reqBuilder.build();
74
75    // 发送HTTP请求
76    OkHttpClient client = new OkHttpClient.Builder().build();
77    try (Response httpResponse = client.newCall(httpRequest).execute()) {
78      String respBody = WXPayUtility.extractBody(httpResponse);
79      if (httpResponse.code() >= 200 && httpResponse.code() < 300) {
80        // 2XX 成功,验证应答签名
81        WXPayUtility.validateResponse(this.wechatPayPublicKeyId, this.wechatPayPublicKey,
82            httpResponse.headers(), respBody);
83
84        // 从HTTP应答报文构建返回数据
85        return WXPayUtility.fromJson(respBody, CardsApplyQuotaCardResponse.class);
86      } else {
87        throw new WXPayUtility.ApiException(httpResponse.code(), respBody, httpResponse.headers());
88      }
89    } catch (IOException e) {
90      throw new UncheckedIOException("Sending request to " + uri + " failed.", e);
91    }
92  }
93
94  private final String mchid;
95  private final String certificateSerialNo;
96  private final PrivateKey privateKey;
97  private final String wechatPayPublicKeyId;
98  private final PublicKey wechatPayPublicKey;
99
100  public ApplyQuotaCard(String mchid, String certificateSerialNo, String privateKeyFilePath, String wechatPayPublicKeyId, String wechatPayPublicKeyFilePath) {
101    this.mchid = mchid;
102    this.certificateSerialNo = certificateSerialNo;
103    this.privateKey = WXPayUtility.loadPrivateKeyFromPath(privateKeyFilePath);
104    this.wechatPayPublicKeyId = wechatPayPublicKeyId;
105    this.wechatPayPublicKey = WXPayUtility.loadPublicKeyFromPath(wechatPayPublicKeyFilePath);
106  }
107
108  public static class ApplyQuotaCardRequest {
109    @SerializedName("sp_mchid")
110    public String spMchid;
111  
112    @SerializedName("sub_mchid")
113    public String subMchid;
114  
115    @SerializedName("employee_id")
116    @Expose(serialize = false)
117    public String employeeId;
118  
119    @SerializedName("card_template_id")
120    public String cardTemplateId;
121  
122    @SerializedName("amount")
123    public Long amount;
124  
125    @SerializedName("card_name")
126    public String cardName;
127  
128    @SerializedName("out_card_no")
129    public String outCardNo;
130  
131    @SerializedName("effective_end_time")
132    public String effectiveEndTime;
133  
134    @SerializedName("card_remark")
135    public String cardRemark;
136  }
137  
138  public static class CardsApplyQuotaCardResponse {
139    @SerializedName("sp_mchid")
140    public String spMchid;
141  
142    @SerializedName("sub_mchid")
143    public String subMchid;
144  
145    @SerializedName("out_card_no")
146    public String outCardNo;
147  
148    @SerializedName("employee_id")
149    public String employeeId;
150  
151    @SerializedName("card_no")
152    public String cardNo;
153  
154    @SerializedName("effective_begin_time")
155    public String effectiveBeginTime;
156  
157    @SerializedName("effective_end_time")
158    public String effectiveEndTime;
159  }
160  
161}
162

应答参数

200 OK

 sp_mchid  必填   string(32)

【服务商商户号】 服务商商户号,具有企业支付服务商资质的微信支付商户号,由商户请求时传入


 sub_mchid  必填   string(32)

【出资子商户号】 出资子商户号,企业支付的出资方商户号,指定额度卡资金来源,由商户请求时传入


 out_card_no  必填   string(32)

【商户卡号】 商户卡号,由商户系统生成的唯一标识额度卡的编号,由商户下发额度卡时传入。


 employee_id  必填   string(64)

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


 card_no  必填   string(64)

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


 effective_begin_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秒。


 effective_end_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秒。

应答示例

200 OK

1{
2  "sp_mchid" : "12341234",
3  "sub_mchid" : "43214321",
4  "out_card_no" : "mch_card_123456",
5  "employee_id" : "WeBizPay_a968402a-73bb-43e2-9e1a-8371b0ca3d7c",
6  "card_no" : "1068019671702503425",
7  "effective_begin_time" : "2023-01-01T00:00+08:00",
8  "effective_end_time" : "2023-12-31T23:59:59+08:00"
9}
10

 

错误码

公共错误码

状态码

错误码

描述

解决方案

400

PARAM_ERROR

参数错误

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

400

INVALID_REQUEST

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

请参阅 接口规则

401

SIGN_ERROR

验证不通过

请参阅 签名常见问题

500

SYSTEM_ERROR

系统异常,请稍后重试

请稍后重试

 

 

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