上传电子发票文件
更新时间:2025.09.18调用【将电子发票插入微信用户卡包】接口之前,需要先调用本接口上传电子发票文件,获取文件ID。上传的发票文件会在三天后过期,因此上传后请尽快调用【将电子发票插入微信用户卡包】接口执行插入微信用户卡包的操作。
接口说明
支持商户:【普通服务商】
请求方式:【POST】/v3/new-tax-control-fapiao/fapiao-applications/upload-fapiao-file
请求域名:【主域名】https://api.mch.weixin.qq.com 使用该域名将访问就近的接入点
【备域名】https://api2.mch.weixin.qq.com 使用该域名将访问异地的接入点 ,指引点击查看
请求参数
Header HTTP头参数
Authorization 必填 string
请参考签名认证生成认证信息
Accept 必填 string
请设置为application/json
Content-Type 必填 string
请设置为multipart/form-data
Form 表单
file 必填 file
【电子发票文件】 将电子发票文件转换为二进制数据流,在请求body中通过表单提交的方式上传此二进制内容。电子发票文件只支持PDF格式,文件大小不能超过2M
meta 必填 object
【电子发票文件元信息】 电子发票文件元信息
| 属性 | |
sub_mchid 必填 string(32) 【子商户号】 微信支付分配的子商户号,具体请参考服务商模式开发必要参数说明 file_type 必填 string 【文件类型】 发票文件的类型 可选取值
digest_alogrithm 必填 string 【文件摘要算法】 文件摘要算法 可选取值
digest 必填 string(64) 【文件摘要】 根据文件摘要算法对电子发票文件二进制内容计算出的文件摘要,结果为16进制编码 |
请求示例
POST
1curl -X POST \ 2 https://api.mch.weixin.qq.com/v3/new-tax-control-fapiao/fapiao-applications/upload-fapiao-file \ 3 -H "Authorization: WECHATPAY2-SHA256-RSA2048 mchid=\"1900000001\",..." \ 4 -H "Accept: application/json" \ 5 -H "Content-Type: multipart/form-data" \ 6 -F file=@"/path/to/file" \ 7 -F meta="{ 8 "sub_mchid" : "1900000109", 9 "file_type" : "PDF", 10 "digest_alogrithm" : "SM3", 11 "digest" : "addca90a6a290b9642dbaccffdf01e8c22aa348940b2e96754169ba08c19e5db" 12 }"
需配合微信支付工具库 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 okhttp3.MultipartBody; 15import java.io.UncheckedIOException; 16import java.security.PrivateKey; 17import java.security.PublicKey; 18import java.util.ArrayList; 19import java.util.HashMap; 20import java.util.List; 21import java.util.Map; 22 23/** 24 * 上传电子发票文件 25 */ 26public class UploadFapiaoFile { 27 private static String HOST = "https://api.mch.weixin.qq.com"; 28 private static String METHOD = "POST"; 29 private static String PATH = "/v3/new-tax-control-fapiao/fapiao-applications/upload-fapiao-file"; 30 31 public static void main(String[] args) { 32 // TODO: 请准备商户开发必要参数,参考:https://pay.weixin.qq.com/doc/v3/partner/4013080340 33 UploadFapiaoFile client = new UploadFapiaoFile( 34 "19xxxxxxxx", // 商户号,是由微信支付系统生成并分配给每个商户的唯一标识符,商户号获取方式参考 https://pay.weixin.qq.com/doc/v3/partner/4013080340 35 "1DDE55AD98Exxxxxxxxxx", // 商户API证书序列号,如何获取请参考 https://pay.weixin.qq.com/doc/v3/partner/4013058924 36 "/path/to/apiclient_key.pem", // 商户API证书私钥文件路径,本地文件路径 37 "PUB_KEY_ID_xxxxxxxxxxxxx", // 微信支付公钥ID,如何获取请参考 https://pay.weixin.qq.com/doc/v3/partner/4013038589 38 "/path/to/wxp_pub.pem" // 微信支付公钥文件路径,本地文件路径 39 ); 40 41 UploadFapiaoFileRequest request = new UploadFapiaoFileRequest(); 42 request.file = "file_bytes".getBytes(); 43 request.meta = new FileMeta(); 44request.meta.subMchid = "1900000109"; 45request.meta.fileType = FapiaoFileType.PDF; 46request.meta.digestAlogrithm = DigestType.SM3; 47request.meta.digest = "addca90a6a290b9642dbaccffdf01e8c22aa348940b2e96754169ba08c19e5db"; 48 try { 49 UploadFapiaoFileResponse response = client.run(request); 50 // TODO: 请求成功,继续业务逻辑 51 System.out.println(response); 52 } catch (WXPayUtility.ApiException e) { 53 // TODO: 请求失败,根据状态码执行不同的逻辑 54 e.printStackTrace(); 55 } 56 } 57 58 public UploadFapiaoFileResponse run(UploadFapiaoFileRequest request) { 59 String uri = PATH; 60 // 构建multipart/form-data请求体 61 String metaJson = WXPayUtility.toJson(request.meta); 62 RequestBody metaPart = RequestBody.create(MediaType.parse("application/json"), metaJson); 63 // todo: you_file_name替换为meta里面的文件名字段 64 String contentType = WXPayUtility.getContentTypeByFileName("your_file_name"); 65 RequestBody filePart = RequestBody.create(MediaType.parse(contentType), request.file); 66 MultipartBody requestBody = new MultipartBody.Builder() 67 .setType(MultipartBody.FORM) 68 .addFormDataPart("meta", null, metaPart) 69 .addFormDataPart("file", "your_file_name", filePart) 70 .build(); 71 72 Request.Builder reqBuilder = new Request.Builder().url(HOST + uri); 73 reqBuilder.addHeader("Accept", "application/json"); 74 reqBuilder.addHeader("Wechatpay-Serial", wechatPayPublicKeyId); 75 reqBuilder.addHeader("Authorization", WXPayUtility.buildAuthorization(mchid, certificateSerialNo, privateKey, METHOD, uri, metaJson)); 76 reqBuilder.method(METHOD, requestBody); 77 Request httpRequest = reqBuilder.build(); 78 79 // 发送HTTP请求 80 OkHttpClient client = new OkHttpClient.Builder().build(); 81 try (Response httpResponse = client.newCall(httpRequest).execute()) { 82 String respBody = WXPayUtility.extractBody(httpResponse); 83 if (httpResponse.code() >= 200 && httpResponse.code() < 300) { 84 // 2XX 成功,验证应答签名 85 WXPayUtility.validateResponse(this.wechatPayPublicKeyId, this.wechatPayPublicKey, 86 httpResponse.headers(), respBody); 87 88 // 从HTTP应答报文构建返回数据 89 return WXPayUtility.fromJson(respBody, UploadFapiaoFileResponse.class); 90 } else { 91 throw new WXPayUtility.ApiException(httpResponse.code(), respBody, httpResponse.headers()); 92 } 93 } catch (IOException e) { 94 throw new UncheckedIOException("Sending request to " + uri + " failed.", e); 95 } 96 } 97 98 private final String mchid; 99 private final String certificateSerialNo; 100 private final PrivateKey privateKey; 101 private final String wechatPayPublicKeyId; 102 private final PublicKey wechatPayPublicKey; 103 104 public UploadFapiaoFile(String mchid, String certificateSerialNo, String privateKeyFilePath, String wechatPayPublicKeyId, String wechatPayPublicKeyFilePath) { 105 this.mchid = mchid; 106 this.certificateSerialNo = certificateSerialNo; 107 this.privateKey = WXPayUtility.loadPrivateKeyFromPath(privateKeyFilePath); 108 this.wechatPayPublicKeyId = wechatPayPublicKeyId; 109 this.wechatPayPublicKey = WXPayUtility.loadPublicKeyFromPath(wechatPayPublicKeyFilePath); 110 } 111 112 public static class UploadFapiaoFileRequest { 113 @SerializedName("file") 114 public byte[] file; 115 116 @SerializedName("meta") 117 public FileMeta meta; 118 } 119 120 public static class UploadFapiaoFileResponse { 121 @SerializedName("fapiao_media_id") 122 public String fapiaoMediaId; 123 } 124 125 public static class FileMeta { 126 @SerializedName("sub_mchid") 127 public String subMchid; 128 129 @SerializedName("file_type") 130 public FapiaoFileType fileType; 131 132 @SerializedName("digest_alogrithm") 133 public DigestType digestAlogrithm; 134 135 @SerializedName("digest") 136 public String digest; 137 } 138 139 public enum FapiaoFileType { 140 @SerializedName("PDF") 141 PDF 142 } 143 144 public enum DigestType { 145 @SerializedName("SM3") 146 SM3 147 } 148 149} 150
需配合微信支付工具库 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 "mime" 9 "mime/multipart" 10 "net/http" 11 "net/textproto" 12 "net/url" 13 "path/filepath" 14) 15 16func main() { 17 // TODO: 请准备商户开发必要参数,参考:https://pay.weixin.qq.com/doc/v3/partner/4013080340 18 config, err := wxpay_utility.CreateMchConfig( 19 "19xxxxxxxx", // 商户号,是由微信支付系统生成并分配给每个商户的唯一标识符,商户号获取方式参考 https://pay.weixin.qq.com/doc/v3/partner/4013080340 20 "1DDE55AD98Exxxxxxxxxx", // 商户API证书序列号,如何获取请参考 https://pay.weixin.qq.com/doc/v3/partner/4013058924 21 "/path/to/apiclient_key.pem", // 商户API证书私钥文件路径,本地文件路径 22 "PUB_KEY_ID_xxxxxxxxxxxxx", // 微信支付公钥ID,如何获取请参考 https://pay.weixin.qq.com/doc/v3/partner/4013038589 23 "/path/to/wxp_pub.pem", // 微信支付公钥文件路径,本地文件路径 24 ) 25 if err != nil { 26 fmt.Println(err) 27 return 28 } 29 30 request := &UploadFapiaoFileRequest{ 31 File: wxpay_utility.Bytes([]byte("file data")), 32 Meta: &FileMeta{ 33 SubMchid: wxpay_utility.String("1900000109"), 34 FileType: FAPIAOFILETYPE_PDF.Ptr(), 35 DigestAlogrithm: DIGESTTYPE_SM3.Ptr(), 36 Digest: wxpay_utility.String("addca90a6a290b9642dbaccffdf01e8c22aa348940b2e96754169ba08c19e5db"), 37 }, 38 } 39 40 response, err := UploadFapiaoFile(config, request) 41 if err != nil { 42 fmt.Printf("请求失败: %+v\n", err) 43 // TODO: 请求失败,根据状态码执行不同的处理 44 return 45 } 46 47 // TODO: 请求成功,继续业务逻辑 48 fmt.Printf("请求成功: %+v\n", response) 49} 50 51func UploadFapiaoFile(config *wxpay_utility.MchConfig, request *UploadFapiaoFileRequest) (response *UploadFapiaoFileResponse, err error) { 52 const ( 53 host = "https://api.mch.weixin.qq.com" 54 method = "POST" 55 path = "/v3/new-tax-control-fapiao/fapiao-applications/upload-fapiao-file" 56 ) 57 58 reqUrl, err := url.Parse(fmt.Sprintf("%s%s", host, path)) 59 if err != nil { 60 return nil, err 61 } 62 // 构造 multipart/form-data 请求体 63 body := &bytes.Buffer{} 64 writer := multipart.NewWriter(body) 65 66 // todo: your_file_name替换为meta里面的文件名字段 67 fileHeader := make(textproto.MIMEHeader) 68 fileHeader.Set("Content-Disposition", fmt.Sprintf(`form-data; name="file"; filename="%s"`, "your_file_name")) 69 ext := filepath.Ext("your_file_name") 70 contentType := mime.TypeByExtension(ext) 71 if contentType == "" { 72 contentType = "application/octet-stream" 73 } 74 fileHeader.Set("Content-Type", contentType) 75 fileWriter, err := writer.CreatePart(fileHeader) 76 if err != nil { 77 return nil, err 78 } 79 _, err = fileWriter.Write(*request.File) 80 if err != nil { 81 return nil, err 82 } 83 84 // meta 字段 85 metaJSON, err := json.Marshal(request.Meta) 86 if err != nil { 87 return nil, err 88 } 89 metaWriter, err := writer.CreateFormField("meta") 90 if err != nil { 91 return nil, err 92 } 93 _, err = metaWriter.Write(metaJSON) 94 if err != nil { 95 return nil, err 96 } 97 98 err = writer.Close() 99 if err != nil { 100 return nil, err 101 } 102 httpRequest, err := http.NewRequest(method, reqUrl.String(), body) 103 if err != nil { 104 return nil, err 105 } 106 httpRequest.Header.Set("Accept", "application/json") 107 httpRequest.Header.Set("Wechatpay-Serial", config.WechatPayPublicKeyId()) 108 httpRequest.Header.Set("Content-Type", writer.FormDataContentType()) 109 // 签名时使用 meta JSON 110 metaJson, err := json.Marshal(request.Meta) 111 if err != nil { 112 return nil, err 113 } 114 authorization, err := wxpay_utility.BuildAuthorization(config.MchId(), config.CertificateSerialNo(), config.PrivateKey(), method, reqUrl.RequestURI(), metaJson) 115 if err != nil { 116 return nil, err 117 } 118 httpRequest.Header.Set("Authorization", authorization) 119 120 client := &http.Client{} 121 httpResponse, err := client.Do(httpRequest) 122 if err != nil { 123 return nil, err 124 } 125 respBody, err := wxpay_utility.ExtractResponseBody(httpResponse) 126 if err != nil { 127 return nil, err 128 } 129 if httpResponse.StatusCode >= 200 && httpResponse.StatusCode < 300 { 130 // 2XX 成功,验证应答签名 131 err = wxpay_utility.ValidateResponse( 132 config.WechatPayPublicKeyId(), 133 config.WechatPayPublicKey(), 134 &httpResponse.Header, 135 respBody, 136 ) 137 if err != nil { 138 return nil, err 139 } 140 response := &UploadFapiaoFileResponse{} 141 if err := json.Unmarshal(respBody, response); err != nil { 142 return nil, err 143 } 144 145 return response, nil 146 } else { 147 return nil, wxpay_utility.NewApiException( 148 httpResponse.StatusCode, 149 httpResponse.Header, 150 respBody, 151 ) 152 } 153} 154 155type UploadFapiaoFileRequest struct { 156 File *[]byte `json:"file,omitempty"` 157 Meta *FileMeta `json:"meta,omitempty"` 158} 159 160type UploadFapiaoFileResponse struct { 161 FapiaoMediaId *string `json:"fapiao_media_id,omitempty"` 162} 163 164type FileMeta struct { 165 SubMchid *string `json:"sub_mchid,omitempty"` 166 FileType *FapiaoFileType `json:"file_type,omitempty"` 167 DigestAlogrithm *DigestType `json:"digest_alogrithm,omitempty"` 168 Digest *string `json:"digest,omitempty"` 169} 170 171type FapiaoFileType string 172 173func (e FapiaoFileType) Ptr() *FapiaoFileType { 174 return &e 175} 176 177const ( 178 FAPIAOFILETYPE_PDF FapiaoFileType = "PDF" 179) 180 181type DigestType string 182 183func (e DigestType) Ptr() *DigestType { 184 return &e 185} 186 187const ( 188 DIGESTTYPE_SM3 DigestType = "SM3" 189) 190
应答参数
200 OK
fapiao_media_id 必填 string(128)
【电子发票文件ID】 上传的电子发票文件对应的ID,三天内有效,用于【将电子发票插入微信用户卡包】接口
应答示例
200 OK
1{ 2 "fapiao_media_id" : "ASNFZ4mrze/+3LqYdlQyEA==" 3} 4
文件上传步骤
1.创建一个POST的方法请求/upload URI:
例如: POST https://api.mch.weixin.qq.com/new-tax-control-fapiao/fapiao-applications/upload-fapiao-file HTTP/1.1
2.将文件的数据添加到请求主体:
2.1 文本文件file参数的获取方式说明:
文本文件二进制内容,放在请求HTTP的body中。
2.2 电子发票文件元信息meta参数的获取方式说明: 电子发票文件元信息,使用json表示,包含四个对象:sub_mchid、file_type、digest_alogrithm、digest。
sub_mchid参数获取方式说明: 微信支付分配的子商户号,服务商模式下必传
file_type参数获取方式说明: 发票文件的类型为PDF - PDF文件类型,PDF文件类型
digest_alogrithm参数获取方式说明: 文件摘要算法,SM3 - 国密SM3算法,国密SM3摘要算法
digest参数获取方式说明: 根据文件摘要算法对电子发票文件二进制内容计算出的文件摘要,结果为16进制编码
2.3 签名计算说明:
参与签名计算的请求主体为meta的json串:
1{ "file_type": "PDF","digest": "addca90a6a290b9642dbaccffdf01e8c22aa348940b2e96754169ba08c19e5db", "digest_alogrithm": "SM3" }待签名串示例:
1POST 2/v3/new-tax-control-fapiao/fapiao-applications/upload-fapiao-file 31566987169 //时间戳 412ced2db6f0193dda91ba86224ea1cd8 //随机数 5{ "file_type": "PDF","digest": "addca90a6a290b9642dbaccffdf01e8c22aa348940b2e96754169ba08c19e5db", "digest_alogrithm": "SM3" }
添加HTTP头:
1Content-Type:multipart/form-data.设置为要上载的对象的MIME媒体类型。 2Authorization: WECHATPAY2-SHA256-RSA2048 mchid="1900231671", 3nonce_str="PCHK6HSOEDTACETP6P3AL7DWPHTBKIAT",timestamp="1567067659", 4serial_no="1FB89742D19F2BD30B69948D16DECA0FCB4481EB", 5signature="PB6M7+3JL7TSCl5zqD1sdWVypOIEQsD4dgOU+vPiVM6GMRo2qYSWKf8u46i9ZJFhyZTBdZ7SFR+BjDZh6 689hFgN8LZL+QWTvq3cse/FEUFYyOLN7L/2IZX4GA4cWInuJ2MpOhZRMpm+emrcn42gTMKAPNQ7dBLO7ux6MoSuQp69 7PW+p1ogmkER68exTVUXYqA5P3vITlWNr++RDy2+ExvB7qVISOKW0vBkxUxN9e7hwUbDwGln170ZXomoO1KpQSbw3f1u 8WUCx/IlWJhJIun7rUMtVT+kfijNUqcILtSfE4hWKKVaZn9j5CX8M7aKbbDOFy3SvbSJ3WQgRnRbgog5w==" 9Content-Type: multipart/form-data;boundary=boundary
添加body:
1// 以下为body的内容 2--boundary // boundary为商户自定义的一个字符串 3Content-Disposition: form-data; name="meta"; 4Content-Type: application/json 5//此处必须有一个空行 6{ "file_type": "PDF","digest": "addca90a6a290b9642dbaccffdf01e8c22aa348940b2e96754169ba08c19e5db", "digest_alogrithm": "SM3" } 7--boundary 8Content-Disposition: form-data; name="file"; 9Content-Type: pdf/plain 10//此处必须有一个空行 11--boundary--
说明:请求包体每行结尾都需要包含\r\n(空行也需要)。
发送请求:
1POST /v3/new-tax-control-fapiao/fapiao-applications/upload-fapiao-file HTTP/1.1 2Host: api.mch.weixin.qq.com 3Authorization: WECHATPAY2-SHA256-RSA2048 4mchid="1900231671",nonce_str="PCHK6HSOEDTACETP6P3AL7DWPHTBKIAT", 5timestamp="1567067659", 6serial_no="1FB89742D19F2BD30B69948D16DECA0FCB4481EB", 7signature="PB6M7+3JL7TSCl5zqD1sdWVypOIEQsD4dgOU+vPiVM6GMRo2qYSWKf8u46i9ZJFhyZTBdZ7 8SFR+BjDZh689hFgN8LZL+QWTvq3cse/FEUFYyOLN7L/2IZX4GA4cWInuJ2MpOhZRMpm+emrcn42gTMKAPN 9Q7dBLO7ux6MoSuQp69PW+p1ogmkER68exTVUXYqA5P3vITlWNr++RDy2+ExvB7qVISOKW0vBkxUxN9e 107hwUbDwGln170ZXomoO1KpQSbw3f1uWUCx/IlWJhJIun7rUMtVT+kfijNUqcILtSfE4hWKKVaZn9j5CX8M 117aKbbDOFy3SvbSJ3WQgRnRbgog5w==" 12Content-Type: multipart/form-data;boundary=boundary 13 14--boundary 15Content-Disposition: form-data; name="meta"; 16Content-Type: application/json 17 18{ "file_type": "PDF","digest": "addca90a6a290b9642dbaccffdf01e8c22aa348940b2e96754169ba08c19e5db", "digest_alogrithm": "SM3" } 19--boundary 20Content-Disposition: form-data; name="file"; 21Content-Type: pdf/plain 22 23--boundary--
错误码
公共错误码
状态码 | 错误码 | 描述 | 解决方案 |
|---|---|---|---|
400 | PARAM_ERROR | 参数错误 | 请根据错误提示正确传入参数 |
400 | INVALID_REQUEST | HTTP 请求不符合微信支付 APIv3 接口规则 | 请参阅 接口规则 |
401 | SIGN_ERROR | 验证不通过 | 请参阅 签名常见问题 |
500 | SYSTEM_ERROR | 系统异常,请稍后重试 | 请稍后重试 |
业务错误码
状态码 | 错误码 | 描述 | 解决方案 |
|---|---|---|---|
400 | PARAM_ERROR | 电子发票文件超过尺寸限制 | 请上传2M以内的电子发票文件 |
400 | INVALID_REQUEST | 请求参数符合参数格式,但不符合业务规则 | 请使用正确的参数重新调用 |
400 | INVALID_REQUEST | 电子发票文件与元信息中的摘要不匹配 | 请使用匹配的电子发票文件和摘要 |
403 | NO_AUTH | 商户无权限 | 请检查是否已经开通电子发票产品相关功能权限,并检查子商户是否接受了服务商的邀请 |
429 | FREQUENCY_LIMITED | 频率超限 | 请降低请求接口频率 |

