上传商户提交资料文件
更新时间:2025.05.21商户在提交资料时,可通过本接口上传所需的文件
接口说明
支持商户:【普通服务商】
请求方式:【POST】/v3/mch-manage/submission-files/sub-mchid/{sub_mchid}/upload
请求域名:【主域名】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
path 路径参数
sub_mchid 必填 string(32)
【子商户号】 由服务商为子商户进件后获取,具体请参考服务商模式开发必要参数说明。
Form 表单
submission_file 必填 file
【商户提交材料文件】 将文件进行二进制转换,得到的二进制内容,在请求body中上传此二进制内容,文件大小不能超过资料项的限制。
meta 必填 object
【媒体文件元数据】 媒体文件元信息,使用json表示,包含两个对象:filename、file_digest。
| 属性 | |
file_name 必填 string(128) 【文件名称】 商户上传的文件的名称,包含文件后缀名。 file_digest 必填 string(256) 【文件摘要】 图片文件的文件摘要,即对图片文件的二进制内容进行SHA256计算得到的值,字母全大写。 |
item_id 必填 integer
【文件对应资料项ID】 该文件对应支付的资料项ID
manage_record_id 选填 string(128)
【商户管理记录ID】 商户管理记录的主键,唯一指定一条商户管理记录
请求示例
POST
1curl -X POST \ 2 https://api.mch.weixin.qq.com/v3/mch-manage/submission-files/sub-mchid/123000110/upload \ 3 -H "Authorization: WECHATPAY2-SHA256-RSA2048 mchid=\"1900000001\",..." \ 4 -H "Accept: application/json" \ 5 -H "Content-Type: multipart/form-data" \ 6 -F submission_file=@"/path/to/file" \ 7 -F meta="{ 8 "file_name" : "filea.jpg", 9 "file_digest" : "B94D27B9934D3E08A52E52D7DA7DABFAC484EFE37A5380EE9088F7ACE2EFCDE9" 10 }" \ 11 -F item_id="56" \ 12 -F manage_record_id=""manage_record_id_example""
需配合微信支付工具库 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 CreateSubmissionFile { 27 private static String HOST = "https://api.mch.weixin.qq.com"; 28 private static String METHOD = "POST"; 29 private static String PATH = "/v3/mch-manage/submission-files/sub-mchid/{sub_mchid}/upload"; 30 31 public static void main(String[] args) { 32 // TODO: 请准备商户开发必要参数,参考:https://pay.weixin.qq.com/doc/v3/partner/4013080340 33 CreateSubmissionFile client = new CreateSubmissionFile( 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 CreateSubmissionFileRequest request = new CreateSubmissionFileRequest(); 42 request.subMchid = "123000110"; 43 request.submissionFile = "submissionFile_bytes".getBytes(); 44 request.meta = new FileMetaInfo(); 45request.meta.fileName = "filea.jpg"; 46request.meta.fileDigest = "B94D27B9934D3E08A52E52D7DA7DABFAC484EFE37A5380EE9088F7ACE2EFCDE9"; 47 request.itemId = 1L; 48 request.manageRecordId = "manageRecordId_example"; 49 try { 50 SubmissionFilesEntity response = client.run(request); 51 // TODO: 请求成功,继续业务逻辑 52 System.out.println(response); 53 } catch (WXPayUtility.ApiException e) { 54 // TODO: 请求失败,根据状态码执行不同的逻辑 55 e.printStackTrace(); 56 } 57 } 58 59 public SubmissionFilesEntity run(CreateSubmissionFileRequest request) { 60 String uri = PATH; 61 // 构建multipart/form-data请求体 62 String metaJson = WXPayUtility.toJson(request.meta); 63 RequestBody metaPart = RequestBody.create(MediaType.parse("application/json"), metaJson); 64 // todo: you_file_name替换为meta里面的文件名字段 65 String contentType = WXPayUtility.getContentTypeByFileName("your_file_name"); 66 RequestBody filePart = RequestBody.create(MediaType.parse(contentType), request.file); 67 MultipartBody requestBody = new MultipartBody.Builder() 68 .setType(MultipartBody.FORM) 69 .addFormDataPart("meta", null, metaPart) 70 .addFormDataPart("file", "your_file_name", filePart) 71 .build(); 72 73 Request.Builder reqBuilder = new Request.Builder().url(HOST + uri); 74 reqBuilder.addHeader("Accept", "application/json"); 75 reqBuilder.addHeader("Wechatpay-Serial", wechatPayPublicKeyId); 76 reqBuilder.addHeader("Authorization", WXPayUtility.buildAuthorization(mchid, certificateSerialNo, privateKey, METHOD, uri, metaJson)); 77 reqBuilder.method(METHOD, requestBody); 78 Request httpRequest = reqBuilder.build(); 79 80 // 发送HTTP请求 81 OkHttpClient client = new OkHttpClient.Builder().build(); 82 try (Response httpResponse = client.newCall(httpRequest).execute()) { 83 String respBody = WXPayUtility.extractBody(httpResponse); 84 if (httpResponse.code() >= 200 && httpResponse.code() < 300) { 85 // 2XX 成功,验证应答签名 86 WXPayUtility.validateResponse(this.wechatPayPublicKeyId, this.wechatPayPublicKey, 87 httpResponse.headers(), respBody); 88 89 // 从HTTP应答报文构建返回数据 90 return WXPayUtility.fromJson(respBody, SubmissionFilesEntity.class); 91 } else { 92 throw new WXPayUtility.ApiException(httpResponse.code(), respBody, httpResponse.headers()); 93 } 94 } catch (IOException e) { 95 throw new UncheckedIOException("Sending request to " + uri + " failed.", e); 96 } 97 } 98 99 private final String mchid; 100 private final String certificateSerialNo; 101 private final PrivateKey privateKey; 102 private final String wechatPayPublicKeyId; 103 private final PublicKey wechatPayPublicKey; 104 105 public CreateSubmissionFile(String mchid, String certificateSerialNo, String privateKeyFilePath, String wechatPayPublicKeyId, String wechatPayPublicKeyFilePath) { 106 this.mchid = mchid; 107 this.certificateSerialNo = certificateSerialNo; 108 this.privateKey = WXPayUtility.loadPrivateKeyFromPath(privateKeyFilePath); 109 this.wechatPayPublicKeyId = wechatPayPublicKeyId; 110 this.wechatPayPublicKey = WXPayUtility.loadPublicKeyFromPath(wechatPayPublicKeyFilePath); 111 } 112 113 public static class CreateSubmissionFileRequest { 114 @SerializedName("sub_mchid") 115 @Expose(serialize = false) 116 public String subMchid; 117 118 @SerializedName("submission_file") 119 public byte[] submissionFile; 120 121 @SerializedName("meta") 122 public FileMetaInfo meta; 123 124 @SerializedName("item_id") 125 public Long itemId; 126 127 @SerializedName("manage_record_id") 128 public String manageRecordId; 129 } 130 131 public static class SubmissionFilesEntity { 132 @SerializedName("file_id") 133 public String fileId; 134 } 135 136 public static class FileMetaInfo { 137 @SerializedName("file_name") 138 public String fileName; 139 140 @SerializedName("file_digest") 141 public String fileDigest; 142 } 143 144} 145
需配合微信支付工具库 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 "strings" 15) 16 17func main() { 18 // TODO: 请准备商户开发必要参数,参考:https://pay.weixin.qq.com/doc/v3/partner/4013080340 19 config, err := wxpay_utility.CreateMchConfig( 20 "19xxxxxxxx", // 商户号,是由微信支付系统生成并分配给每个商户的唯一标识符,商户号获取方式参考 https://pay.weixin.qq.com/doc/v3/partner/4013080340 21 "1DDE55AD98Exxxxxxxxxx", // 商户API证书序列号,如何获取请参考 https://pay.weixin.qq.com/doc/v3/partner/4013058924 22 "/path/to/apiclient_key.pem", // 商户API证书私钥文件路径,本地文件路径 23 "PUB_KEY_ID_xxxxxxxxxxxxx", // 微信支付公钥ID,如何获取请参考 https://pay.weixin.qq.com/doc/v3/partner/4013038589 24 "/path/to/wxp_pub.pem", // 微信支付公钥文件路径,本地文件路径 25 ) 26 if err != nil { 27 fmt.Println(err) 28 return 29 } 30 31 request := &CreateSubmissionFileRequest{ 32 SubMchid: wxpay_utility.String("123000110"), 33 SubmissionFile: wxpay_utility.Bytes([]byte("file data")), 34 Meta: &FileMetaInfo{ 35 FileName: wxpay_utility.String("filea.jpg"), 36 FileDigest: wxpay_utility.String("B94D27B9934D3E08A52E52D7DA7DABFAC484EFE37A5380EE9088F7ACE2EFCDE9"), 37 }, 38 ItemId: wxpay_utility.Int64(56), 39 ManageRecordId: wxpay_utility.String("ManageRecordId_example"), 40 } 41 42 response, err := CreateSubmissionFile(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 CreateSubmissionFile(config *wxpay_utility.MchConfig, request *CreateSubmissionFileRequest) (response *SubmissionFilesEntity, err error) { 54 const ( 55 host = "https://api.mch.weixin.qq.com" 56 method = "POST" 57 path = "/v3/mch-manage/submission-files/sub-mchid/{sub_mchid}/upload" 58 ) 59 60 reqUrl, err := url.Parse(fmt.Sprintf("%s%s", host, path)) 61 if err != nil { 62 return nil, err 63 } 64 reqUrl.Path = strings.Replace(reqUrl.Path, "{sub_mchid}", url.PathEscape(*request.SubMchid), -1) 65 // 构造 multipart/form-data 请求体 66 body := &bytes.Buffer{} 67 writer := multipart.NewWriter(body) 68 69 // todo: your_file_name替换为meta里面的文件名字段 70 fileHeader := make(textproto.MIMEHeader) 71 fileHeader.Set("Content-Disposition", fmt.Sprintf(`form-data; name="file"; filename="%s"`, "your_file_name")) 72 ext := filepath.Ext("your_file_name") 73 contentType := mime.TypeByExtension(ext) 74 if contentType == "" { 75 contentType = "application/octet-stream" 76 } 77 fileHeader.Set("Content-Type", contentType) 78 fileWriter, err := writer.CreatePart(fileHeader) 79 if err != nil { 80 return nil, err 81 } 82 _, err = fileWriter.Write(*request.File) 83 if err != nil { 84 return nil, err 85 } 86 87 // meta 字段 88 metaJSON, err := json.Marshal(request.Meta) 89 if err != nil { 90 return nil, err 91 } 92 metaWriter, err := writer.CreateFormField("meta") 93 if err != nil { 94 return nil, err 95 } 96 _, err = metaWriter.Write(metaJSON) 97 if err != nil { 98 return nil, err 99 } 100 101 err = writer.Close() 102 if err != nil { 103 return nil, err 104 } 105 httpRequest, err := http.NewRequest(method, reqUrl.String(), body) 106 if err != nil { 107 return nil, err 108 } 109 httpRequest.Header.Set("Accept", "application/json") 110 httpRequest.Header.Set("Wechatpay-Serial", config.WechatPayPublicKeyId()) 111 httpRequest.Header.Set("Content-Type", writer.FormDataContentType()) 112 // 签名时使用 meta JSON 113 metaJson, err := json.Marshal(request.Meta) 114 if err != nil { 115 return nil, err 116 } 117 authorization, err := wxpay_utility.BuildAuthorization(config.MchId(), config.CertificateSerialNo(), config.PrivateKey(), method, reqUrl.RequestURI(), metaJson) 118 if err != nil { 119 return nil, err 120 } 121 httpRequest.Header.Set("Authorization", authorization) 122 123 client := &http.Client{} 124 httpResponse, err := client.Do(httpRequest) 125 if err != nil { 126 return nil, err 127 } 128 respBody, err := wxpay_utility.ExtractResponseBody(httpResponse) 129 if err != nil { 130 return nil, err 131 } 132 if httpResponse.StatusCode >= 200 && httpResponse.StatusCode < 300 { 133 // 2XX 成功,验证应答签名 134 err = wxpay_utility.ValidateResponse( 135 config.WechatPayPublicKeyId(), 136 config.WechatPayPublicKey(), 137 &httpResponse.Header, 138 respBody, 139 ) 140 if err != nil { 141 return nil, err 142 } 143 response := &SubmissionFilesEntity{} 144 if err := json.Unmarshal(respBody, response); err != nil { 145 return nil, err 146 } 147 148 return response, nil 149 } else { 150 return nil, wxpay_utility.NewApiException( 151 httpResponse.StatusCode, 152 httpResponse.Header, 153 respBody, 154 ) 155 } 156} 157 158type CreateSubmissionFileRequest struct { 159 SubMchid *string `json:"sub_mchid,omitempty"` 160 SubmissionFile *[]byte `json:"submission_file,omitempty"` 161 Meta *FileMetaInfo `json:"meta,omitempty"` 162 ItemId *int64 `json:"item_id,omitempty"` 163 ManageRecordId *string `json:"manage_record_id,omitempty"` 164} 165 166func (o *CreateSubmissionFileRequest) MarshalJSON() ([]byte, error) { 167 type Alias CreateSubmissionFileRequest 168 a := &struct { 169 SubMchid *string `json:"sub_mchid,omitempty"` 170 *Alias 171 }{ 172 // 序列化时移除非 Body 字段 173 SubMchid: nil, 174 Alias: (*Alias)(o), 175 } 176 return json.Marshal(a) 177} 178 179type SubmissionFilesEntity struct { 180 FileId *string `json:"file_id,omitempty"` 181} 182 183type FileMetaInfo struct { 184 FileName *string `json:"file_name,omitempty"` 185 FileDigest *string `json:"file_digest,omitempty"` 186} 187
应答参数
200 OK
file_id 选填 string(512)
【文件标识ID】 上传成功后返回,上传资料文件的主键,唯一定义此资源的标识
应答示例
200 OK
1{ 2 "file_id" : "dklfjaljdflakjfkljasdf.jpg" 3} 4
错误码
以下是本接口返回的错误码列表。详细错误码规则,请参考微信支付接口规则-错误码和错误提示

