创建电子发票卡券模板

更新时间：2024.12.09

为商户创建电子发票的卡券模板，该卡券模板在开具的电子发票插入微信用户卡包时使用。调用该接口将覆盖商户之前配置的电子发票卡券模板。
注意：商户必须先调用本接口创建卡券模版之后才能调用开票相关接口。

接口说明

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

请求方式：【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，也可以是子商户申请的AppId；若是直连模式，则是直连商户申请的AppId

card_template_information 　必填 object

【卡券模板信息】卡券模板信息

属性

payee_name 　选填 string(32)

【收款方名称】收款方名称，显示在电子发票卡券信息中，若不传则默认取商户名称

logo_url 　必填 string(1024)

【卡券logo地址】卡券logo地址，请点击参考此文档

custom_cell 　选填 object

【卡券自定义cell位配置】卡券自定义cell位配置，需要在卡券详情中增加

属性

words 　必填 string(5)

【cell位文字】展示在卡券详情页自定义cell位上的文字

description 　必填 string(6)

【cell位描述】展示在卡券详情页自定义cell位右侧的描述

jump_url 　选填 string(1024)

【点击cell位跳转的地址】点击卡券详情页自定义cell位后跳转的页面链接，用户跳转时会自动在链接后加上参数encrypt_code与card_id，商户需要调用code解码接口解码encrypt_code得到真实的code

miniprogram_user_name 　选填 string(32)

【点击cell位跳转的小程序的用户名】用于指定点击卡券详情页自定义cell位后跳转的小程序，该小程序必须与商户插卡的AppID绑定

miniprogram_path 　选填 string(1024)

【点击cell位跳转的小程序的页面路径】用于指定点击卡券详情页自定义cell位后跳转的小程序页面路径，跳转小程序后，开发者可以通过页面onShow方法的query中获取到发起跳转的card_id、encrypt_code和用户的公众号OpenID，商户需要调用code解码接口解码encrypt_code得到真实的code

请求示例

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

应答参数

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和mch_id不匹配	请检查AppID和mchid是否匹配，或者AppID与sub_mchid是否匹配
400	INVALID_REQUEST	请求参数符合参数格式，但不符合业务规则	请使用正确的参数重新调用
401	SIGN_ERROR	签名错误或签名信息不完整	请检查签名参数和方法是否都符合签名算法要求
403	NO_AUTH	商户无权限	请检查是否已经开通电子发票产品相关功能权限，若是服务商模式，还需确认子商户是否接受了服务商的邀请
429	FREQUENCY_LIMITED	频率超限	请降低请求接口频率

文档是否有帮助

更多支持

开发文档(商户)开发文档(V2版)开发者社区微信开放平台微信公众平台腾讯客服