上传电子发票文件
更新时间:2025.09.03调用【将电子发票插入微信用户卡包】接口之前,需要先调用本接口上传电子发票文件,获取文件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 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 UploadFapiaoFile { 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/fapiao-applications/upload-fapiao-file"; 29 30 public static void main(String[] args) { 31 // TODO: 请准备商户开发必要参数,参考:https://pay.weixin.qq.com/doc/v3/partner/4013080340 32 UploadFapiaoFile client = new UploadFapiaoFile( 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 request = new (); 41 try { 42 UploadFapiaoFileResponse response = client.run(request); 43 // TODO: 请求成功,继续业务逻辑 44 System.out.println(response); 45 } catch (WXPayUtility.ApiException e) { 46 // TODO: 请求失败,根据状态码执行不同的逻辑 47 e.printStackTrace(); 48 } 49 } 50 51 public UploadFapiaoFileResponse run( request) { 52 String uri = PATH; 53 54 Request.Builder reqBuilder = new Request.Builder().url(HOST + uri); 55 reqBuilder.addHeader("Accept", "application/json"); 56 reqBuilder.addHeader("Wechatpay-Serial", wechatPayPublicKeyId); 57 reqBuilder.addHeader("Authorization", WXPayUtility.buildAuthorization(mchid, certificateSerialNo, privateKey, METHOD, uri, null)); 58 reqBuilder.addHeader("Content-Type", "application/json"); 59 RequestBody emptyBody = RequestBody.create(null, ""); 60 reqBuilder.method(METHOD, emptyBody); 61 Request httpRequest = reqBuilder.build(); 62 63 // 发送HTTP请求 64 OkHttpClient client = new OkHttpClient.Builder().build(); 65 try (Response httpResponse = client.newCall(httpRequest).execute()) { 66 String respBody = WXPayUtility.extractBody(httpResponse); 67 if (httpResponse.code() >= 200 && httpResponse.code() < 300) { 68 // 2XX 成功,验证应答签名 69 WXPayUtility.validateResponse(this.wechatPayPublicKeyId, this.wechatPayPublicKey, 70 httpResponse.headers(), respBody); 71 72 // 从HTTP应答报文构建返回数据 73 return WXPayUtility.fromJson(respBody, UploadFapiaoFileResponse.class); 74 } else { 75 throw new WXPayUtility.ApiException(httpResponse.code(), respBody, httpResponse.headers()); 76 } 77 } catch (IOException e) { 78 throw new UncheckedIOException("Sending request to " + uri + " failed.", e); 79 } 80 } 81 82 private final String mchid; 83 private final String certificateSerialNo; 84 private final PrivateKey privateKey; 85 private final String wechatPayPublicKeyId; 86 private final PublicKey wechatPayPublicKey; 87 88 public UploadFapiaoFile(String mchid, String certificateSerialNo, String privateKeyFilePath, String wechatPayPublicKeyId, String wechatPayPublicKeyFilePath) { 89 this.mchid = mchid; 90 this.certificateSerialNo = certificateSerialNo; 91 this.privateKey = WXPayUtility.loadPrivateKeyFromPath(privateKeyFilePath); 92 this.wechatPayPublicKeyId = wechatPayPublicKeyId; 93 this.wechatPayPublicKey = WXPayUtility.loadPublicKeyFromPath(wechatPayPublicKeyFilePath); 94 } 95 96 public static class UploadFapiaoFileResponse { 97 @SerializedName("fapiao_media_id") 98 public String fapiaoMediaId; 99 } 100 101} 102
需配合微信支付工具库 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 "strings" 11) 12 13 14func main() { 15 // TODO: 请准备商户开发必要参数,参考:https://pay.weixin.qq.com/doc/v3/partner/4013080340 16 config, err := wxpay_utility.CreateMchConfig( 17 "19xxxxxxxx", // 商户号,是由微信支付系统生成并分配给每个商户的唯一标识符,商户号获取方式参考 https://pay.weixin.qq.com/doc/v3/partner/4013080340 18 "1DDE55AD98Exxxxxxxxxx", // 商户API证书序列号,如何获取请参考 https://pay.weixin.qq.com/doc/v3/partner/4013058924 19 "/path/to/apiclient_key.pem", // 商户API证书私钥文件路径,本地文件路径 20 "PUB_KEY_ID_xxxxxxxxxxxxx", // 微信支付公钥ID,如何获取请参考 https://pay.weixin.qq.com/doc/v3/partner/4013038589 21 "/path/to/wxp_pub.pem", // 微信支付公钥文件路径,本地文件路径 22 ) 23 if err != nil { 24 fmt.Println(err) 25 return 26 } 27 28 request := &{ 29 File: wxpay_utility.String("BINARY_DATA_HERE"), 30 Meta: &FileMeta{ 31 SubMchid: wxpay_utility.String("1900000109"), 32 FileType: FAPIAOFILETYPE_PDF.Ptr(), 33 DigestAlogrithm: DIGESTTYPE_SM3.Ptr(), 34 Digest: wxpay_utility.String("addca90a6a290b9642dbaccffdf01e8c22aa348940b2e96754169ba08c19e5db"), 35}, 36 } 37 38 response, err := UploadFapiaoFile(config, request) 39 if err != nil { 40 fmt.Printf("请求失败: %+v\n", err) 41 // TODO: 请求失败,根据状态码执行不同的处理 42 return 43 } 44 45 // TODO: 请求成功,继续业务逻辑 46 fmt.Printf("请求成功: %+v\n", response) 47} 48 49func UploadFapiaoFile(config *wxpay_utility.MchConfig, request *) (response *UploadFapiaoFileResponse, err error) { 50 const ( 51 host = "https://api.mch.weixin.qq.com" 52 method = "POST" 53 path = "/v3/new-tax-control-fapiao/fapiao-applications/upload-fapiao-file" 54 ) 55 56 reqUrl, err := url.Parse(fmt.Sprintf("%s%s", host, path)) 57 if err != nil { 58 return nil, err 59 } 60 httpRequest, err := http.NewRequest(method, reqUrl.String(), nil) 61 if err != nil { 62 return nil, err 63 } 64 httpRequest.Header.Set("Accept", "application/json") 65 httpRequest.Header.Set("Wechatpay-Serial", config.WechatPayPublicKeyId()) 66 httpRequest.Header.Set("Content-Type", "application/json") 67 authorization, err := wxpay_utility.BuildAuthorization(config.MchId(), config.CertificateSerialNo(), config.PrivateKey(), method, reqUrl.RequestURI(), nil) 68 if err != nil { 69 return nil, err 70 } 71 httpRequest.Header.Set("Authorization", authorization) 72 73 client := &http.Client{} 74 httpResponse, err := client.Do(httpRequest) 75 if err != nil { 76 return nil, err 77 } 78 respBody, err := wxpay_utility.ExtractResponseBody(httpResponse) 79 if err != nil { 80 return nil, err 81 } 82 if httpResponse.StatusCode >= 200 && httpResponse.StatusCode < 300 { 83 // 2XX 成功,验证应答签名 84 err = wxpay_utility.ValidateResponse( 85 config.WechatPayPublicKeyId(), 86 config.WechatPayPublicKey(), 87 &httpResponse.Header, 88 respBody, 89 ) 90 if err != nil { 91 return nil, err 92 } 93 response := &UploadFapiaoFileResponse{} 94 if err := json.Unmarshal(respBody, response); err != nil { 95 return nil, err 96 } 97 98 return response, nil 99 } else { 100 return nil, wxpay_utility.NewApiException( 101 httpResponse.StatusCode, 102 httpResponse.Header, 103 respBody, 104 ) 105 } 106} 107 108type UploadFapiaoFileResponse struct { 109 FapiaoMediaId *string `json:"fapiao_media_id,omitempty"` 110 } 111 112 113
应答参数
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 | 频率超限 | 请降低请求接口频率 |