创建电子发票卡券模板
更新时间:2025.09.03为商户创建电子发票的卡券模板,该卡券模板在开具的电子发票插入微信用户卡包时使用。调用该接口将覆盖商户之前配置的电子发票卡券模板。
注意:商户必须先调用本接口创建卡券模版之后才能调用开票相关接口。
接口说明
支持商户:【普通服务商】
请求方式:【POST】/v3/new-tax-control-fapiao/card-template
请求域名:【主域名】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 包体参数
sub_mchid 必填 string(32)
【子商户号】 微信支付分配的子商户号,具体请参考服务商模式开发必要参数说明
card_appid 必填 string(32)
【插卡服务号AppID】 插卡服务号AppID。AppID需要与服务商或子商户商户号绑定,具体请参考服务商模式开发必要参数说明
card_template_information 必填 object
【卡券模板信息】 卡券模板信息
属性 | |||||
payee_name 选填 string(32) 【收款方名称】 收款方名称。显示在电子发票卡券信息中,若不传则默认取商户名称 logo_url 必填 string(1024) 【卡券logo地址】 卡券logo地址。使用插卡服务号身份调用【上传永久素材】接口上传logo图片,得到的图片素材url地址 custom_cell 选填 object 【卡券自定义cell位配置】 卡券自定义cell位配置。需要在卡券详情中增加
|
请求示例
POST
1curl -X POST \ 2 https://api.mch.weixin.qq.com/v3/new-tax-control-fapiao/card-template \ 3 -H "Authorization: WECHATPAY2-SHA256-RSA2048 mchid=\"1900000001\",..." \ 4 -H "Accept: application/json" \ 5 -H "Content-Type: application/json" \ 6 -d '{ 7 "sub_mchid" : "1900000109", 8 "card_appid" : "wxb1170446a4c0a5a2", 9 "card_template_information" : { 10 "payee_name" : "某公司", 11 "logo_url" : "http://mmbiz.qpic.cn/mmbiz/iaL1LJM1mF9aRKPZJkmG8xXhiaHqkKSVMMWeN3hLut7X7hicFNjakmxibMLGWpXrEXB33367o7zHN0CwngnQY7zb7g/0", 12 "custom_cell" : { 13 "words" : "电子发票", 14 "description" : "查看发票", 15 "jump_url" : "http://www.qq.com", 16 "miniprogram_user_name" : "gh_86a091e50ad4@app", 17 "miniprogram_path" : "pages/xxxPage" 18 } 19 } 20 }' 21
需配合微信支付工具库 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 CreateFapiaoCardTemplate { 26 private static String HOST = "https://api.mch.weixin.qq.com"; 27 private static String METHOD = "POST"; 28 private static String PATH = "/v3/new-tax-control-fapiao/card-template"; 29 30 public static void main(String[] args) { 31 // TODO: 请准备商户开发必要参数,参考:https://pay.weixin.qq.com/doc/v3/partner/4013080340 32 CreateFapiaoCardTemplate client = new CreateFapiaoCardTemplate( 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 CreateFapiaoCardTemplateRequest request = new CreateFapiaoCardTemplateRequest(); 41 request.subMchid = "1900000109"; 42 request.cardAppid = "wxb1170446a4c0a5a2"; 43 request.cardTemplateInformation = new CardTemplateInfo(); 44 request.cardTemplateInformation.payeeName = "某公司"; 45 request.cardTemplateInformation.logoUrl = "http://mmbiz.qpic.cn/mmbiz/iaL1LJM1mF9aRKPZJkmG8xXhiaHqkKSVMMWeN3hLut7X7hicFNjakmxibMLGWpXrEXB33367o7zHN0CwngnQY7zb7g/0"; 46 request.cardTemplateInformation.customCell = new CustomCell(); 47 request.cardTemplateInformation.customCell.words = "电子发票"; 48 request.cardTemplateInformation.customCell.description = "查看发票"; 49 request.cardTemplateInformation.customCell.jumpUrl = "http://www.qq.com"; 50 request.cardTemplateInformation.customCell.miniprogramUserName = "gh_86a091e50ad4@app"; 51 request.cardTemplateInformation.customCell.miniprogramPath = "pages/xxxPage"; 52 try { 53 FapiaoCardTemplateEntity response = client.run(request); 54 // TODO: 请求成功,继续业务逻辑 55 System.out.println(response); 56 } catch (WXPayUtility.ApiException e) { 57 // TODO: 请求失败,根据状态码执行不同的逻辑 58 e.printStackTrace(); 59 } 60 } 61 62 public FapiaoCardTemplateEntity run(CreateFapiaoCardTemplateRequest request) { 63 String uri = PATH; 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, FapiaoCardTemplateEntity.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 CreateFapiaoCardTemplate(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 CreateFapiaoCardTemplateRequest { 109 @SerializedName("sub_mchid") 110 public String subMchid; 111 112 @SerializedName("card_appid") 113 public String cardAppid; 114 115 @SerializedName("card_template_information") 116 public CardTemplateInfo cardTemplateInformation; 117 } 118 119 public static class FapiaoCardTemplateEntity { 120 @SerializedName("card_appid") 121 public String cardAppid; 122 123 @SerializedName("card_id") 124 public String cardId; 125 } 126 127 public static class CardTemplateInfo { 128 @SerializedName("payee_name") 129 public String payeeName; 130 131 @SerializedName("logo_url") 132 public String logoUrl; 133 134 @SerializedName("custom_cell") 135 public CustomCell customCell; 136 } 137 138 public static class CustomCell { 139 @SerializedName("words") 140 public String words; 141 142 @SerializedName("description") 143 public String description; 144 145 @SerializedName("jump_url") 146 public String jumpUrl; 147 148 @SerializedName("miniprogram_user_name") 149 public String miniprogramUserName; 150 151 @SerializedName("miniprogram_path") 152 public String miniprogramPath; 153 } 154 155} 156
需配合微信支付工具库 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 := &CreateFapiaoCardTemplateRequest{ 27 SubMchid: wxpay_utility.String("1900000109"), 28 CardAppid: wxpay_utility.String("wxb1170446a4c0a5a2"), 29 CardTemplateInformation: &CardTemplateInfo{ 30 PayeeName: wxpay_utility.String("某公司"), 31 LogoUrl: wxpay_utility.String("http://mmbiz.qpic.cn/mmbiz/iaL1LJM1mF9aRKPZJkmG8xXhiaHqkKSVMMWeN3hLut7X7hicFNjakmxibMLGWpXrEXB33367o7zHN0CwngnQY7zb7g/0"), 32 CustomCell: &CustomCell{ 33 Words: wxpay_utility.String("电子发票"), 34 Description: wxpay_utility.String("查看发票"), 35 JumpUrl: wxpay_utility.String("http://www.qq.com"), 36 MiniprogramUserName: wxpay_utility.String("gh_86a091e50ad4@app"), 37 MiniprogramPath: wxpay_utility.String("pages/xxxPage"), 38 }, 39 }, 40 } 41 42 response, err := CreateFapiaoCardTemplate(config, request) 43 if err != nil { 44 fmt.Printf("请求失败: %+v\n", err) 45 // TODO: 请求失败,根据状态码执行不同的处理 46 return 47 } 48 49 // TODO: 请求成功,继续业务逻辑 50 fmt.Printf("请求成功: %+v\n", response) 51} 52 53func CreateFapiaoCardTemplate(config *wxpay_utility.MchConfig, request *CreateFapiaoCardTemplateRequest) (response *FapiaoCardTemplateEntity, err error) { 54 const ( 55 host = "https://api.mch.weixin.qq.com" 56 method = "POST" 57 path = "/v3/new-tax-control-fapiao/card-template" 58 ) 59 60 reqUrl, err := url.Parse(fmt.Sprintf("%s%s", host, path)) 61 if err != nil { 62 return nil, err 63 } 64 reqBody, err := json.Marshal(request) 65 if err != nil { 66 return nil, err 67 } 68 httpRequest, err := http.NewRequest(method, reqUrl.String(), bytes.NewReader(reqBody)) 69 if err != nil { 70 return nil, err 71 } 72 httpRequest.Header.Set("Accept", "application/json") 73 httpRequest.Header.Set("Wechatpay-Serial", config.WechatPayPublicKeyId()) 74 httpRequest.Header.Set("Content-Type", "application/json") 75 authorization, err := wxpay_utility.BuildAuthorization(config.MchId(), config.CertificateSerialNo(), config.PrivateKey(), method, reqUrl.RequestURI(), reqBody) 76 if err != nil { 77 return nil, err 78 } 79 httpRequest.Header.Set("Authorization", authorization) 80 81 client := &http.Client{} 82 httpResponse, err := client.Do(httpRequest) 83 if err != nil { 84 return nil, err 85 } 86 respBody, err := wxpay_utility.ExtractResponseBody(httpResponse) 87 if err != nil { 88 return nil, err 89 } 90 if httpResponse.StatusCode >= 200 && httpResponse.StatusCode < 300 { 91 // 2XX 成功,验证应答签名 92 err = wxpay_utility.ValidateResponse( 93 config.WechatPayPublicKeyId(), 94 config.WechatPayPublicKey(), 95 &httpResponse.Header, 96 respBody, 97 ) 98 if err != nil { 99 return nil, err 100 } 101 response := &FapiaoCardTemplateEntity{} 102 if err := json.Unmarshal(respBody, response); err != nil { 103 return nil, err 104 } 105 106 return response, nil 107 } else { 108 return nil, wxpay_utility.NewApiException( 109 httpResponse.StatusCode, 110 httpResponse.Header, 111 respBody, 112 ) 113 } 114} 115 116type CreateFapiaoCardTemplateRequest struct { 117 SubMchid *string `json:"sub_mchid,omitempty"` 118 CardAppid *string `json:"card_appid,omitempty"` 119 CardTemplateInformation *CardTemplateInfo `json:"card_template_information,omitempty"` 120} 121 122type FapiaoCardTemplateEntity struct { 123 CardAppid *string `json:"card_appid,omitempty"` 124 CardId *string `json:"card_id,omitempty"` 125} 126 127type CardTemplateInfo struct { 128 PayeeName *string `json:"payee_name,omitempty"` 129 LogoUrl *string `json:"logo_url,omitempty"` 130 CustomCell *CustomCell `json:"custom_cell,omitempty"` 131} 132 133type CustomCell struct { 134 Words *string `json:"words,omitempty"` 135 Description *string `json:"description,omitempty"` 136 JumpUrl *string `json:"jump_url,omitempty"` 137 MiniprogramUserName *string `json:"miniprogram_user_name,omitempty"` 138 MiniprogramPath *string `json:"miniprogram_path,omitempty"` 139} 140
应答参数
200 OK
card_appid 必填 string(32)
【插卡服务号AppID】 卡券模板所属的服务号AppID
card_id 必填 string(32)
【卡券模板ID】 卡券模板ID
应答示例
200 OK
1{ 2 "card_appid" : "wxb1170446a4c0a5a2", 3 "card_id" : "p4gLgvn_cxVCQez17kaBJnZHPcXs" 4} 5
错误码
公共错误码
状态码 | 错误码 | 描述 | 解决方案 |
---|---|---|---|
400 | PARAM_ERROR | 参数错误 | 请根据错误提示正确传入参数 |
400 | INVALID_REQUEST | HTTP 请求不符合微信支付 APIv3 接口规则 | 请参阅 接口规则 |
401 | SIGN_ERROR | 验证不通过 | 请参阅 签名常见问题 |
500 | SYSTEM_ERROR | 系统异常,请稍后重试 | 请稍后重试 |
业务错误码
状态码 | 错误码 | 描述 | 解决方案 |
---|---|---|---|
400 | APPID_MCHID_NOT_MATCH | appid与mchid不匹配 | 请检查公众号appid是否已被服务商或子商户绑定 |
400 | INVALID_REQUEST | 请求参数符合参数格式,但不符合业务规则 | 请使用正确的参数重新调用 |
403 | NO_AUTH | 商户无权限 | 请检查是否已经开通电子发票产品相关功能权限,并检查子商户是否接受了服务商的邀请 |
429 | FREQUENCY_LIMITED | 频率超限 | 请降低请求接口频率 |