上传图片API
部分微信支付业务指定商户需要使用图片上传 API来上报图片信息,从而获得必传参数的值:图片MediaID 。
适用对象:直连模式 机构模式
请求URL:https://apihk.mch.weixin.qq.com/v3/merchant/media/upload
请求主体类型:multipart/form-data
请求方式:POST
参数名 | 变量 | 类型[长度限制] | 必填 | 描述 |
---|---|---|---|---|
图片文件 | file | object | 是 | Body将媒体图片进行二进制转换,得到的媒体图片二进制内容,在请求body中上传此二进制内容。媒体图片只支持JPG、BMP、PNG格式,文件大小不能超过2M。 示例值:pic1 |
媒体文件元信息 | meta | object | 是 | Body媒体文件元信息,使用json表示,包含两个对象:filename、sha256。 |
String filePath = "/your/home/hellokitty.png";
URI uri = new URI("https://apihk.mch.weixin.qq.com/v3/merchant/media/upload");
File file = new File(filePath);
try (FileInputStream ins1 = new FileInputStream(file)) {
String sha256 = DigestUtils.sha256Hex(ins1);
try (InputStream ins2 = new FileInputStream(file)) {
HttpPost request = new WechatPayUploadHttpPost.Builder(uri)
.withImage(file.getName(), sha256, ins2)
.build();
CloseableHttpResponse response1 = httpClient.execute(request);
}
}
JAVA详细请求示例详见:wechatpay-apache-httpclient
PHP详细请求示例详见:wechatpay-guzzle-middleware
参数名 | 变量 | 类型[长度限制] | 必填 | 描述 |
---|---|---|---|---|
媒体文件标识 Id | media_id | string[1, 512] | 是 | 微信返回的媒体文件标识Id。 示例值:b6a17e2a-1dc4-4376-8630-e73d06490c0d |
{
"media_id": "H1ihR9JUtVj-J7CJqBUY5ZOrG_Je75H-rKhTG7FUmg9sxNTbRN54dFiUHnhgrBQ6EKeHoGcHTJMHn5TAuLVjHUQDBInSWXcIHYXOeRa2OHA"
}
例如:
POST https://apihk.mch.weixin.qq.com/v3/merchant/media/upload HTTP/1.1
5.2.1 图片文件file参数的获取方式说明:
媒体图片二进制内容,放在请求http的body中。
5.2.2 媒体文件元信息meta参数的获取方式说明:
媒体文件元信息,使用json表示,包含两个对象:filename、sha256。
● filename参数获取方式说明:
商户上传的媒体图片的名称,商户自定义,必须以JPG、BMP、PNG为后缀。
● digest参数获取方式说明:
图片文件的文件摘要,即对图片文件的二进制内容进行sha256计算得到的值。
5.2.3 签名计算说明:
签名生成
参与签名计算的请求主体为meta的json串:
{"filename": "file1.jpg", "sha256": "hjkahkjsjkfsjk78687dhjahdajhk"}
Example of a string to be signed:
POST
/v3/merchant/media/upload
1566987169 //时间戳
12ced2db6f0193dda91ba86224ea1cd8 //随机数
{"filename":" filea.jpg ","sha256":" hjkahkjsjkfsjk78687dhjahdajhk "}
Content-Type:multipart/form-data.设置为要上载的对象的MIME媒体类型。
Authorization: WECHATPAY2-SHA256-RSA2048 mchid="1900231671",
nonce_str="PCHK6HSOEDTACETP6P3AL7DWPHTBKIAT",timestamp="1567067659",
serial_no="1FB89742D19F2BD30B69948D16DECA0FCB4481EB",
signature="PB6M7+3JL7TSCl5zqD1sdWVypOIEQsD4dgOU+vPiVM6GMRo2qYSWKf8u46i9ZJFhyZTBdZ7SFR+BjDZh6
89hFgN8LZL+QWTvq3cse/FEUFYyOLN7L/2IZX4GA4cWInuJ2MpOhZRMpm+emrcn42gTMKAPNQ7dBLO7ux6MoSuQp69
PW+p1ogmkER68exTVUXYqA5P3vITlWNr++RDy2+ExvB7qVISOKW0vBkxUxN9e7hwUbDwGln170ZXomoO1KpQSbw3f1u
WUCx/IlWJhJIun7rUMtVT+kfijNUqcILtSfE4hWKKVaZn9j5CX8M7aKbbDOFy3SvbSJ3WQgRnRbgog5w=="
Content-Type: multipart/form-data;boundary="boundary"
// 以下为body的内容
--boundary // boundary为商户自定义的一个字符串
Content-Disposition: form-data; name="meta";
Content-Type: application/json
//此处必须有一个空行
{ "filename": "filea.jpg", "sha256": " hjkahkjsjkfsjk78687dhjahdajhk " }
--boundary
Content-Disposition: form-data; name="file"; filename="filea.jpg";
Content-Type: image/jpg
//此处必须有一个空行
pic1 //pic1即为媒体图片的二进制内容
--boundary--
说明:请求包体每行结尾都需要包含\r\n(空行也需要)。
POST /v3/merchant/media/upload HTTP/1.1
Host: api.mch.weixin.qq.com
Authorization: WECHATPAY2-SHA256-RSA2048
mchid="1900231671",nonce_str="PCHK6HSOEDTACETP6P3AL7DWPHTBKIAT",
timestamp="1567067659",
serial_no="1FB89742D19F2BD30B69948D16DECA0FCB4481EB",
signature="PB6M7+3JL7TSCl5zqD1sdWVypOIEQsD4dgOU+vPiVM6GMRo2qYSWKf8u46i9ZJFhyZTBdZ7
SFR+BjDZh689hFgN8LZL+QWTvq3cse/FEUFYyOLN7L/2IZX4GA4cWInuJ2MpOhZRMpm+emrcn42gTMKAPN
Q7dBLO7ux6MoSuQp69PW+p1ogmkER68exTVUXYqA5P3vITlWNr++RDy2+ExvB7qVISOKW0vBkxUxN9e
7hwUbDwGln170ZXomoO1KpQSbw3f1uWUCx/IlWJhJIun7rUMtVT+kfijNUqcILtSfE4hWKKVaZn9j5CX8M
7aKbbDOFy3SvbSJ3WQgRnRbgog5w=="
Content-Type: multipart/form-data;boundary=boundary
--boundary
Content-Disposition: form-data; name="meta";
Content-Type: application/json
{ "filename": "filea.jpg", "sha256": " hjkahkjsjkfsjk78687dhjahdajhk " }
--boundary
Content-Disposition: form-data; name="file"; filename="filea.jpg";
Content-Type: image/jpg
pic1
--boundary--
状态码 | 错误码 | 描述 | 解决方案 |
---|---|---|---|
500 | SYSTEMERROR | 系统错误 | 系统异常,请使用相同参数稍后重新调用 |
SYSTEMERROR | 文件系统错误,请稍后重试 | 文件系统异常,请使用相同参数稍后重新调用 | |
400 | PARAM_ERROR | 图片文件名称不正确,请检查后重新提交 | 图片文件名称不正确,只支持jpg,jpeg,png,bmp,请使用正确图片文件重新调用 |
PARAM_ERROR | 文件二进制内容不是图片,请检查后重新提交 | 上传文件二进制内容头部不正确,只支持jpg,jpeg,png,bmp,请使用正确图片文件重新调用 | |
PARAM_ERROR | 图片sha256值有误,请检查后重新提交 | 图片sha256值计算有误,请检查算法,重新计算后提交 | |
PARAM_ERROR | 文件大小不能超过2M,请检查后重新提交 | 商户更换文件或者对图片进行压缩后,重新调用 | |
PARAM_ERROR | 文件为空,请检查后重新提交 | 商户更换文件后,重新调用 | |
429 | FREQUENCY_LIMIT_EXCEED | 操作过快,请稍后重试 | 请商户降低每秒调用频率 |
FREQUENCY_LIMIT_EXCEED | 当天上传文件数已达上限 | 请商户降低每天调用频率 | |
403 | NO_AUTH | 商户权限异常 | 请确认是否已经开通相关权限 |
Customer Service Tel
Business Development
9:00-18:00
Monday-Friday GMT+8
Technical Support
WeChat Pay Global
ICP证