微信单号查询电子回单
更新时间:2025.03.21商户可以通过该接口查看回单申请进度
回单状态 | 含义 | 建议处理方式 |
---|---|---|
GENERATING | 表示电子回单正在生成中 | 过段时间重试查询,建议查询时间间隔不低于2分钟 |
FINISHED | 回单已成功生成,会返回回单文件的下载地址和摘要信息 | 通过返回的下载地址下载回单文件数据并比较摘要值 |
FAILED | 电子回单生成失败,会返回具体的失败原因 | 停止重试查询,查看具体的失败原因 |
请务必对比下载的回单文件的摘要值与查询接口返回的摘要值的一致性,确保得到的回单文件的真实性和完整性。
下载地址的有效期为10分钟,超过10分钟后需要重新通过该接口获取下载地址(不需要重新申请)。
接口说明
支持商户:【普通商户】
请求方式:【GET】/v3/fund-app/mch-transfer/elecsign/transfer-bill-no/{transfer_bill_no}
请求域名:【主域名】https://api.mch.weixin.qq.com 使用该域名将访问就近的接入点
【备域名】https://api2.mch.weixin.qq.com 使用该域名将访问异地的接入点 ,指引点击查看
请求参数
Header HTTP头参数
Authorization 必填 string
请参考签名认证生成认证信息
Accept 必填 string
请设置为application/json
path 路径参数
transfer_bill_no 必填 string(64)
【微信转账单号】 转账单据对应的微信支付单号
请求示例
GET
1curl -X GET \ 2 https://api.mch.weixin.qq.com/v3/fund-app/mch-transfer/elecsign/transfer-bill-no/1330000071100999991182020050700019480001 \ 3 -H "Authorization: WECHATPAY2-SHA256-RSA2048 mchid=\"1900000001\",..." \ 4 -H "Accept: application/json" 5
需配合微信支付工具库 WXPayUtility 使用,请参考Java
1package com.java.demo; 2 3import com.java.utils.WXPayUtility; // 引用微信支付工具库,参考:https://pay.weixin.qq.com/doc/v3/merchant/4014931831 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 QueryElecsignByNo { 26 private static String HOST = "https://api.mch.weixin.qq.com"; 27 private static String METHOD = "GET"; 28 private static String PATH = "/v3/fund-app/mch-transfer/elecsign/transfer-bill-no/{transfer_bill_no}"; 29 30 public static void main(String[] args) { 31 // TODO: 请准备商户开发必要参数,参考:https://pay.weixin.qq.com/doc/v3/merchant/4013070756 32 QueryElecsignByNo client = new QueryElecsignByNo( 33 "19xxxxxxxx", // 商户号,是由微信支付系统生成并分配给每个商户的唯一标识符,商户号获取方式参考 https://pay.weixin.qq.com/doc/v3/merchant/4013070756 34 "1DDE55AD98Exxxxxxxxxx", // 商户API证书序列号,如何获取请参考 https://pay.weixin.qq.com/doc/v3/merchant/4013053053 35 "/path/to/apiclient_key.pem", // 商户API证书私钥文件路径,本地文件路径 36 "PUB_KEY_ID_xxxxxxxxxxxxx", // 微信支付公钥ID,如何获取请参考 https://pay.weixin.qq.com/doc/v3/merchant/4013038816 37 "/path/to/wxp_pub.pem" // 微信支付公钥文件路径,本地文件路径 38 ); 39 40 QueryElecsignByNoRequest request = new QueryElecsignByNoRequest(); 41 request.transferBillNo = "1330000071100999991182020050700019480001"; 42 try { 43 QueryElecsignResponse response = client.run(request); 44 // TODO: 请求成功,继续业务逻辑 45 System.out.println(response); 46 } catch (WXPayUtility.ApiException e) { 47 // TODO: 请求失败,根据状态码执行不同的逻辑 48 e.printStackTrace(); 49 } 50 } 51 52 public QueryElecsignResponse run(QueryElecsignByNoRequest request) { 53 String uri = PATH; 54 uri = uri.replace("{transfer_bill_no}", WXPayUtility.urlEncode(request.transferBillNo)); 55 56 Request.Builder reqBuilder = new Request.Builder().url(HOST + uri); 57 reqBuilder.addHeader("Accept", "application/json"); 58 reqBuilder.addHeader("Wechatpay-Serial", wechatPayPublicKeyId); 59 reqBuilder.addHeader("Authorization", WXPayUtility.buildAuthorization(mchid, certificateSerialNo, privateKey, METHOD, uri, null)); 60 reqBuilder.method(METHOD, null); 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, QueryElecsignResponse.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 QueryElecsignByNo(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 QueryElecsignByNoRequest { 97 @SerializedName("transfer_bill_no") 98 @Expose(serialize = false) 99 public String transferBillNo; 100 } 101 102 public static class QueryElecsignResponse { 103 @SerializedName("state") 104 public ElecsignStatus state; 105 106 @SerializedName("create_time") 107 public String createTime; 108 109 @SerializedName("update_time") 110 public String updateTime; 111 112 @SerializedName("hash_type") 113 public ElecsignHashType hashType; 114 115 @SerializedName("hash_value") 116 public String hashValue; 117 118 @SerializedName("download_url") 119 public String downloadUrl; 120 } 121 122 public enum ElecsignStatus { 123 @SerializedName("GENERATING") 124 GENERATING, 125 @SerializedName("FINISHED") 126 FINISHED, 127 @SerializedName("FAILED") 128 FAILED 129 } 130 131 public enum ElecsignHashType { 132 @SerializedName("SHA256") 133 SHA256, 134 @SerializedName("SM3") 135 SM3 136 } 137 138} 139
需配合微信支付工具库 wxpay_utility 使用,请参考Go
1package main 2 3import ( 4 "demo/wxpay_utility" // 引用微信支付工具库,参考 https://pay.weixin.qq.com/doc/v3/merchant/4015119334 5 "encoding/json" 6 "fmt" 7 "net/http" 8 "net/url" 9 "strings" 10) 11 12func main() { 13 // TODO: 请准备商户开发必要参数,参考:https://pay.weixin.qq.com/doc/v3/merchant/4013070756 14 config, err := wxpay_utility.CreateMchConfig( 15 "19xxxxxxxx", // 商户号,是由微信支付系统生成并分配给每个商户的唯一标识符,商户号获取方式参考 https://pay.weixin.qq.com/doc/v3/merchant/4013070756 16 "1DDE55AD98Exxxxxxxxxx", // 商户API证书序列号,如何获取请参考 https://pay.weixin.qq.com/doc/v3/merchant/4013053053 17 "/path/to/apiclient_key.pem", // 商户API证书私钥文件路径,本地文件路径 18 "PUB_KEY_ID_xxxxxxxxxxxxx", // 微信支付公钥ID,如何获取请参考 https://pay.weixin.qq.com/doc/v3/merchant/4013038816 19 "/path/to/wxp_pub.pem", // 微信支付公钥文件路径,本地文件路径 20 ) 21 if err != nil { 22 fmt.Println(err) 23 return 24 } 25 26 request := &QueryElecsignByNoRequest{ 27 TransferBillNo: wxpay_utility.String("1330000071100999991182020050700019480001"), 28 } 29 30 response, err := QueryElecsignByNo(config, request) 31 if err != nil { 32 fmt.Printf("请求失败: %+v\n", err) 33 // TODO: 请求失败,根据状态码执行不同的处理 34 return 35 } 36 37 // TODO: 请求成功,继续业务逻辑 38 fmt.Printf("请求成功: %+v\n", response) 39} 40 41func QueryElecsignByNo(config *wxpay_utility.MchConfig, request *QueryElecsignByNoRequest) (response *QueryElecsignResponse, err error) { 42 const ( 43 host = "https://api.mch.weixin.qq.com" 44 method = "GET" 45 path = "/v3/fund-app/mch-transfer/elecsign/transfer-bill-no/{transfer_bill_no}" 46 ) 47 48 reqUrl, err := url.Parse(fmt.Sprintf("%s%s", host, path)) 49 if err != nil { 50 return nil, err 51 } 52 reqUrl.Path = strings.Replace(reqUrl.Path, "{transfer_bill_no}", url.PathEscape(*request.TransferBillNo), -1) 53 httpRequest, err := http.NewRequest(method, reqUrl.String(), nil) 54 if err != nil { 55 return nil, err 56 } 57 httpRequest.Header.Set("Accept", "application/json") 58 httpRequest.Header.Set("Wechatpay-Serial", config.WechatPayPublicKeyId()) 59 authorization, err := wxpay_utility.BuildAuthorization(config.MchId(), config.CertificateSerialNo(), config.PrivateKey(), method, reqUrl.RequestURI(), nil) 60 if err != nil { 61 return nil, err 62 } 63 httpRequest.Header.Set("Authorization", authorization) 64 65 client := &http.Client{} 66 httpResponse, err := client.Do(httpRequest) 67 if err != nil { 68 return nil, err 69 } 70 respBody, err := wxpay_utility.ExtractResponseBody(httpResponse) 71 if err != nil { 72 return nil, err 73 } 74 if httpResponse.StatusCode >= 200 && httpResponse.StatusCode < 300 { 75 // 2XX 成功,验证应答签名 76 err = wxpay_utility.ValidateResponse( 77 config.WechatPayPublicKeyId(), 78 config.WechatPayPublicKey(), 79 &httpResponse.Header, 80 respBody, 81 ) 82 if err != nil { 83 return nil, err 84 } 85 response := &QueryElecsignResponse{} 86 if err := json.Unmarshal(respBody, response); err != nil { 87 return nil, err 88 } 89 90 return response, nil 91 } else { 92 return nil, wxpay_utility.NewApiException( 93 httpResponse.StatusCode, 94 httpResponse.Header, 95 respBody, 96 ) 97 } 98} 99 100type QueryElecsignByNoRequest struct { 101 TransferBillNo *string `json:"transfer_bill_no,omitempty"` 102} 103 104func (o *QueryElecsignByNoRequest) MarshalJSON() ([]byte, error) { 105 type Alias QueryElecsignByNoRequest 106 a := &struct { 107 TransferBillNo *string `json:"transfer_bill_no,omitempty"` 108 *Alias 109 }{ 110 // 序列化时移除非 Body 字段 111 TransferBillNo: nil, 112 Alias: (*Alias)(o), 113 } 114 return json.Marshal(a) 115} 116 117type QueryElecsignResponse struct { 118 State *ElecsignStatus `json:"state,omitempty"` 119 CreateTime *string `json:"create_time,omitempty"` 120 UpdateTime *string `json:"update_time,omitempty"` 121 HashType *ElecsignHashType `json:"hash_type,omitempty"` 122 HashValue *string `json:"hash_value,omitempty"` 123 DownloadUrl *string `json:"download_url,omitempty"` 124} 125 126type ElecsignStatus string 127 128func (e ElecsignStatus) Ptr() *ElecsignStatus { 129 return &e 130} 131 132const ( 133 ELECSIGNSTATUS_GENERATING ElecsignStatus = "GENERATING" 134 ELECSIGNSTATUS_FINISHED ElecsignStatus = "FINISHED" 135 ELECSIGNSTATUS_FAILED ElecsignStatus = "FAILED" 136) 137 138type ElecsignHashType string 139 140func (e ElecsignHashType) Ptr() *ElecsignHashType { 141 return &e 142} 143 144const ( 145 ELECSIGNHASHTYPE_SHA256 ElecsignHashType = "SHA256" 146 ELECSIGNHASHTYPE_SM3 ElecsignHashType = "SM3" 147) 148
应答参数
200 OK
state 必填 string
【申请单状态】 GENERATING:生成中,FINISHED: 已完成,FAILED:已失败
可选取值
GENERATING
: 表示当前电子回单已受理成功并在处理中FINISHED
: 表示当前电子回单已处理完成FAILED
: 表示当前电子回单生成失败,失败原因字段会返回具体的失败原因
create_time 必填 string(32)
【申请单创建时间】 申请单的创建时间,按照使用rfc3339所定义的格式,格式为yyyy-MM-DDThh:mm:ss+TIMEZONE
update_time 必填 string(32)
【申请单更新时间】 申请单最近的更新时间,按照使用rfc3339所定义的格式,格式为yyyy-MM-DDThh:mm:ss+TIMEZONE
hash_type 选填 string
【回单文件摘要类型】 申请单状态为已完成时返回
可选取值
SHA256
: SHA256摘要算法SM3
: 国密SM3摘要算法
hash_value 选填 string(512)
【回单文件摘要值】 申请单状态为已完成时返回,请务必将下载的回单文件摘要值与该值进行对比,以保证回单文件的完整性和真实性
download_url 选填 string(3000)
【回单文件下载地址】 申请单状态为已完成时返回,有效期10分钟,过期后可以重新通过该接口获取;下载地址的域名,路径,参数都可能变化,请不要自行拼接
应答示例
200 OK
1{ 2 "state" : "FINISHED", 3 "create_time" : "2015-05-20T13:29:35.120+08:00", 4 "update_time" : "2015-05-20T13:29:35.120+08:00", 5 "hash_type" : "SHA256", 6 "hash_value" : "DE731F35146A0BEFADE5DB9D1E468D96C01CA8898119C674FEE9F11F4DBE5529", 7 "download_url" : "https://api.mch.weixin.qq.com/v3/transferbilldownload/file?token=xxx" 8} 9
错误码
公共错误码
状态码 | 错误码 | 描述 | 解决方案 |
---|---|---|---|
400 | PARAM_ERROR | 参数错误 | 请根据错误提示正确传入参数 |
400 | INVALID_REQUEST | HTTP 请求不符合微信支付 APIv3 接口规则 | 请参阅 接口规则 |
401 | SIGN_ERROR | 验证不通过 | 请参阅 签名常见问题 |
500 | SYSTEM_ERROR | 系统异常,请稍后重试 | 请稍后重试 |
业务错误码
状态码 | 错误码 | 描述 | 解决方案 |
---|---|---|---|
429 | FREQUENCY_LIMIT_EXCEED | 频率超限 | 接口请求频率超限,当前请求结果不明确,请降低请求接口频率后,使用相同参数重试 |
429 | RATELIMIT_EXCEEDED | 频率超限 | 接口或同一单号请求频率超限,当前请求结果不明确,请降低请求接口频率,使用相同参数重试 |