微信单号查询电子回单

更新时间: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)

【微信转账单号】 转账单据对应的微信支付单号

请求示例

Java
Go
curl

需配合微信支付工具库 WXPayUtility 使用,请参考 Java 

1package com.java.demo;
2
3import com.google.gson.annotations.Expose;
4import com.google.gson.annotations.SerializedName;
5import com.java.utils.WXPayUtility; // 引用微信支付工具库 参考:https://pay.weixin.qq.com/doc/v3/merchant/4014931831
6import java.io.IOException;
7import java.io.UncheckedIOException;
8import java.security.PrivateKey;
9import java.security.PublicKey;
10import java.util.ArrayList;
11import java.util.HashMap;
12import java.util.List;
13import java.util.Map;
14import okhttp3.MediaType;
15import okhttp3.OkHttpClient;
16import okhttp3.Request;
17import okhttp3.RequestBody;
18import okhttp3.Response;
19
20/**
21 * 微信单号查询电子回单
22 */
23public class QueryElecsignByNo {
24  private static String HOST = "https://api.mch.weixin.qq.com";
25  private static String METHOD = "GET";
26  private static String PATH = "/v3/fund-app/mch-transfer/elecsign/transfer-bill-no/{transfer_bill_no}";
27
28  public static void main(String[] args) {
29    // TODO: 请准备商户开发必要参数,参考:https://pay.weixin.qq.com/doc/v3/merchant/4013070756
30    QueryElecsignByNo client = new QueryElecsignByNo(
31        "填入 商户号",                  // 商户号,是由微信支付系统生成并分配给每个商户的唯一标识符,商户号获取方式参考https://pay.weixin.qq.com/doc/v3/merchant/4013070756
32        "填入 商户API证书序列号",       // 商户API证书序列号,如何获取请参考https://pay.weixin.qq.com/doc/v3/merchant/4013053053
33        "填入 商户API证书私钥文件路径", // 商户API证书私钥文件路径,本地文件路径
34        "填入 微信支付公钥ID",          // 微信支付公钥ID,如何获取请参考https://pay.weixin.qq.com/doc/v3/merchant/4013038816
35        "填入 微信支付公钥文件路径"     // 微信支付公钥文件路径,本地文件路径
36    );
37
38    QueryElecsignByNoRequest request = new QueryElecsignByNoRequest();
39    request.transferBillNo = "1330000071100999991182020050700019480001";
40    try {
41      QueryElecsignResponse response = client.run(request);
42
43      // TODO: 请求成功,继续业务逻辑
44      System.out.println(response);
45    } catch (WXPayUtility.ApiException e) {
46      // TODO: 请求失败,根据状态码执行不同的逻辑
47      e.printStackTrace();
48    }
49  }
50
51  public QueryElecsignResponse run(QueryElecsignByNoRequest request) {
52    String uri = PATH;
53    uri = uri.replace("{transfer_bill_no}", WXPayUtility.urlEncode(request.transferBillNo));
54
55    Request.Builder reqBuilder = new Request.Builder().url(HOST + uri);
56    reqBuilder.addHeader("Accept", "application/json");
57    reqBuilder.addHeader("Wechatpay-Serial", wechatPayPublicKeyId);
58    reqBuilder.addHeader("Authorization", WXPayUtility.buildAuthorization(mchid, certificateSerialNo, privateKey, METHOD, uri, null));
59    reqBuilder.method(METHOD, null);
60    Request httpRequest = reqBuilder.build();
61
62    // 发送HTTP请求
63    OkHttpClient client = new OkHttpClient.Builder().build();
64    try (Response httpResponse = client.newCall(httpRequest).execute()) {
65      String respBody = WXPayUtility.extractBody(httpResponse);
66      if (httpResponse.code() >= 200 && httpResponse.code() < 300) {
67        // 2XX 成功,验证应答签名
68        WXPayUtility.validateResponse(this.wechatPayPublicKeyId, this.wechatPayPublicKey,
69                                      httpResponse.headers(), respBody);
70
71        // 从HTTP应答报文构建返回数据
72        return WXPayUtility.fromJson(respBody, QueryElecsignResponse.class);
73      } else {
74        throw new WXPayUtility.ApiException(httpResponse.code(), respBody, httpResponse.headers());
75      }
76    } catch (IOException e) {
77      throw new UncheckedIOException("Sending request to " + uri + " failed.", e);
78    }
79  }
80
81  private final String mchid;
82  private final String certificateSerialNo;
83  private final PrivateKey privateKey;
84  private final String wechatPayPublicKeyId;
85  private final PublicKey wechatPayPublicKey;
86
87  public QueryElecsignByNo(String mchid, String certificateSerialNo, String privateKeyFilePath, String wechatPayPublicKeyId, String wechatPayPublicKeyFilePath) {
88    this.mchid = mchid;
89    this.certificateSerialNo = certificateSerialNo;
90    this.privateKey = WXPayUtility.loadPrivateKeyFromPath(privateKeyFilePath);
91    this.wechatPayPublicKeyId = wechatPayPublicKeyId;
92    this.wechatPayPublicKey = WXPayUtility.loadPublicKeyFromPath(wechatPayPublicKeyFilePath);
93  }
94
95  public enum ElecsignHashType {
96    @SerializedName("SHA256")
97    SHA256,
98    @SerializedName("SM3")
99    SM3
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 static class QueryElecsignByNoRequest {
132    @SerializedName("transfer_bill_no")
133    @Expose(serialize = false)
134    public String transferBillNo;
135  }
136}

应答参数

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

频率超限

接口或同一单号请求频率超限,当前请求结果不明确,请降低请求接口频率,使用相同参数重试

 

 

反馈
咨询
目录
置顶