商户单号申请电子回单
更新时间:2025.03.21商户可以 指定商户转账单号通过该接口申请 商家转账用户确认模式转账单据 对应的电子回单。
微信支付会在校验满足回单申请条件后受理回单的申请,商户后续可以通过电子回单查询接口查询回单处理进度。
申请回单前,请先确认是否满足回单申请的条件,不满足回单申请条件时,多次重试申请无意义:
1. 仅支持付款成功的转账单据申请电子回单.
2. 仅支持传入姓名的转账单据申请电子回单.
3. 仅支持六个月内的转账单据申请电子回单.
回单申请完成后的有效期为90天,过期后需要重新申请。受理成功不表示回单一定能成功生成,以查单结果返回为准。
接口说明
支持商户:【普通商户】
请求方式:【POST】/v3/fund-app/mch-transfer/elecsign/out-bill-no
请求域名:【主域名】https://api.mch.weixin.qq.com 使用该域名将访问就近的接入点
【备域名】https://api2.mch.weixin.qq.com 使用该域名将访问异地的接入点 ,指引点击查看
请求参数
Header HTTP头参数
Authorization 必填 string
请参考签名认证生成认证信息
Accept 必填 string
请设置为application/json
Content-Type 必填 string
请设置为application/json
body 包体参数
out_bill_no 必填 string(32)
【商户转账单号】 商户创建转账单据使用的单号
请求示例
需配合微信支付工具库 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 AcceptElecsignByOutNo { 26 private static String HOST = "https://api.mch.weixin.qq.com"; 27 private static String METHOD = "POST"; 28 private static String PATH = "/v3/fund-app/mch-transfer/elecsign/out-bill-no"; 29 30 public static void main(String[] args) { 31 // TODO: 请准备商户开发必要参数,参考:https://pay.weixin.qq.com/doc/v3/merchant/4013070756 32 AcceptElecsignByOutNo client = new AcceptElecsignByOutNo( 33 "填入 商户号", // 商户号,是由微信支付系统生成并分配给每个商户的唯一标识符,商户号获取方式参考 https://pay.weixin.qq.com/doc/v3/merchant/4013070756 34 "填入 商户API证书序列号", // 商户API证书序列号,如何获取请参考 https://pay.weixin.qq.com/doc/v3/merchant/4013053053 35 "填入 商户API证书私钥文件路径", // 商户API证书私钥文件路径,本地文件路径 36 "填入 微信支付公钥ID", // 微信支付公钥ID,如何获取请参考 https://pay.weixin.qq.com/doc/v3/merchant/4013038816 37 "填入 微信支付公钥文件路径" // 微信支付公钥文件路径,本地文件路径 38 ); 39 40 AcceptElecsignByOutNoRequest request = new AcceptElecsignByOutNoRequest(); 41 request.outBillNo = "plfk2020042013"; 42 try { 43 AcceptElecsignResponse response = client.run(request); 44 45 // TODO: 请求成功,继续业务逻辑 46 System.out.println(response); 47 } catch (WXPayUtility.ApiException e) { 48 // TODO: 请求失败,根据状态码执行不同的逻辑 49 e.printStackTrace(); 50 } 51 } 52 53 public AcceptElecsignResponse run(AcceptElecsignByOutNoRequest request) { 54 String uri = PATH; 55 String reqBody = WXPayUtility.toJson(request); 56 57 Request.Builder reqBuilder = new Request.Builder().url(HOST + uri); 58 reqBuilder.addHeader("Accept", "application/json"); 59 reqBuilder.addHeader("Wechatpay-Serial", wechatPayPublicKeyId); 60 reqBuilder.addHeader("Authorization", WXPayUtility.buildAuthorization(mchid, certificateSerialNo,privateKey, METHOD, uri, reqBody)); 61 reqBuilder.addHeader("Content-Type", "application/json"); 62 RequestBody requestBody = RequestBody.create(MediaType.parse("application/json; charset=utf-8"), reqBody); 63 reqBuilder.method(METHOD, requestBody); 64 Request httpRequest = reqBuilder.build(); 65 66 // 发送HTTP请求 67 OkHttpClient client = new OkHttpClient.Builder().build(); 68 try (Response httpResponse = client.newCall(httpRequest).execute()) { 69 String respBody = WXPayUtility.extractBody(httpResponse); 70 if (httpResponse.code() >= 200 && httpResponse.code() < 300) { 71 // 2XX 成功,验证应答签名 72 WXPayUtility.validateResponse(this.wechatPayPublicKeyId, this.wechatPayPublicKey, 73 httpResponse.headers(), respBody); 74 75 // 从HTTP应答报文构建返回数据 76 return WXPayUtility.fromJson(respBody, AcceptElecsignResponse.class); 77 } else { 78 throw new WXPayUtility.ApiException(httpResponse.code(), respBody, httpResponse.headers()); 79 } 80 } catch (IOException e) { 81 throw new UncheckedIOException("Sending request to " + uri + " failed.", e); 82 } 83 } 84 85 private final String mchid; 86 private final String certificateSerialNo; 87 private final PrivateKey privateKey; 88 private final String wechatPayPublicKeyId; 89 private final PublicKey wechatPayPublicKey; 90 91 public AcceptElecsignByOutNo(String mchid, String certificateSerialNo, String privateKeyFilePath, String wechatPayPublicKeyId, String wechatPayPublicKeyFilePath) { 92 this.mchid = mchid; 93 this.certificateSerialNo = certificateSerialNo; 94 this.privateKey = WXPayUtility.loadPrivateKeyFromPath(privateKeyFilePath); 95 this.wechatPayPublicKeyId = wechatPayPublicKeyId; 96 this.wechatPayPublicKey = WXPayUtility.loadPublicKeyFromPath(wechatPayPublicKeyFilePath); 97 } 98 99 public static class AcceptElecsignByOutNoRequest { 100 @SerializedName("out_bill_no") 101 public String outBillNo; 102 } 103 104 public static class AcceptElecsignResponse { 105 @SerializedName("state") 106 public ElecsignStatus state; 107 108 @SerializedName("create_time") 109 public String createTime; 110 } 111 112 public enum ElecsignStatus { 113 @SerializedName("GENERATING") 114 GENERATING, 115 @SerializedName("FINISHED") 116 FINISHED, 117 @SerializedName("FAILED") 118 FAILED 119 } 120 121} 122
需配合微信支付工具库 wxpay_utility 使用,请参考 Go
1package main 2 3import ( 4 "bytes" 5 "demo/wxpay_utility"// 引用微信支付工具库 参考:https://pay.weixin.qq.com/doc/v3/merchant/4015119334 6 "encoding/json" 7 "fmt" 8 "net/http" 9 "net/url" 10) 11 12func main() { 13 // TODO: 请准备商户开发必要参数,参考:https://pay.weixin.qq.com/doc/v3/merchant/4013070756 14 config, err := wxpay_utility.CreateMchConfig( 15 "填入 商户号", // 商户号,是由微信支付系统生成并分配给每个商户的唯一标识符,商户号获取方式参考https://pay.weixin.qq.com/doc/v3/merchant/4013070756 16 "填入 商户API证书序列号", // 商户API证书序列号,如何获取请参考https://pay.weixin.qq.com/doc/v3/merchant/4013053053 17 "填入 商户API证书私钥文件路径", // 商户API证书私钥文件路径,本地文件路径 18 "填入 微信支付公钥ID", // 微信支付公钥ID,如何获取请参考https://pay.weixin.qq.com/doc/v3/merchant/4013038816 19 "填入 微信支付公钥文件路径", // 微信支付公钥文件路径,本地文件路径 20 ) 21 if err != nil { 22 fmt.Println(err) 23 return 24 } 25 26 request := &AcceptElecsignByOutNoRequest{ 27 OutBillNo: wxpay_utility.String("plfk2020042013"), 28 } 29 30 response, err := AcceptElecsignByOutNo(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 AcceptElecsignByOutNo(config *wxpay_utility.MchConfig, request *AcceptElecsignByOutNoRequest) (response *AcceptElecsignResponse, err error) { 42 const ( 43 host = "https://api.mch.weixin.qq.com" 44 method = "POST" 45 path = "/v3/fund-app/mch-transfer/elecsign/out-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 reqBody, err := json.Marshal(request) 53 if err != nil { 54 return nil, err 55 } 56 httpRequest, err := http.NewRequest(method, reqUrl.String(), bytes.NewReader(reqBody)) 57 if err != nil { 58 return nil, err 59 } 60 httpRequest.Header.Set("Accept", "application/json") 61 httpRequest.Header.Set("Wechatpay-Serial", config.WechatPayPublicKeyId()) 62 httpRequest.Header.Set("Content-Type", "application/json") 63 authorization, err := wxpay_utility.BuildAuthorization(config.MchId(), config.CertificateSerialNo(), config.PrivateKey(), method, reqUrl.Path, reqBody) 64 if err != nil { 65 return nil, err 66 } 67 httpRequest.Header.Set("Authorization", authorization) 68 69 client := &http.Client{} 70 httpResponse, err := client.Do(httpRequest) 71 if err != nil { 72 return nil, err 73 } 74 75 respBody, err := wxpay_utility.ExtractResponseBody(httpResponse) 76 if err != nil { 77 return nil, err 78 } 79 80 if httpResponse.StatusCode >= 200 && httpResponse.StatusCode < 300 { 81 // 2XX 成功,验证应答签名 82 err = wxpay_utility.ValidateResponse( 83 config.WechatPayPublicKeyId(), 84 config.WechatPayPublicKey(), 85 &httpResponse.Header, 86 respBody, 87 ) 88 if err != nil { 89 return nil, err 90 } 91 92 if err := json.Unmarshal(respBody, response); err != nil { 93 return nil, err 94 } 95 96 return response, nil 97 } else { 98 return nil, &wxpay_utility.ApiException{ 99 StatusCode: httpResponse.StatusCode, 100 Header: httpResponse.Header, 101 Body: respBody, 102 } 103 } 104} 105 106type AcceptElecsignByOutNoRequest struct { 107 OutBillNo *string `json:"out_bill_no,omitempty"` 108} 109 110type AcceptElecsignResponse struct { 111 State *ElecsignStatus `json:"state,omitempty"` 112 CreateTime *string `json:"create_time,omitempty"` 113} 114 115type ElecsignStatus string 116 117func (e ElecsignStatus) Ptr() *ElecsignStatus { 118 return &e 119} 120 121const ( 122 ELECSIGNSTATUS_GENERATING ElecsignStatus = "GENERATING" 123 ELECSIGNSTATUS_FINISHED ElecsignStatus = "FINISHED" 124 ELECSIGNSTATUS_FAILED ElecsignStatus = "FAILED" 125)
POST
1curl -X POST \ 2 https://api.mch.weixin.qq.com/v3/fund-app/mch-transfer/elecsign/out-bill-no \ 3 -H "Authorization: WECHATPAY2-SHA256-RSA2048 mchid=\"1900000001\",..." \ 4 -H "Accept: application/json" \ 5 -H "Content-Type: application/json" \ 6 -d '{ 7 "out_bill_no" : "plfk2020042013" 8 }' 9
应答参数
200 OK
state 必填 string
【申请单状态】 GENERATING:生成中,FINISHED: 已完成,FAILED: 已失败
可选取值
GENERATING
: 表示当前电子回单已受理成功并在处理中FINISHED
: 表示当前电子回单已处理完成FAILED
: 表示当前电子回单生成失败,失败原因字段会返回具体的失败原因
create_time 必填 string(32)
【申请单创建时间】 申请单的创建时间,按照使用rfc3339所定义的格式,格式为yyyy-MM-DDThh:mm:ss+TIMEZONE
应答示例
200 OK
1{ 2 "state" : "FINISHED", 3 "create_time" : "2015-05-20T13:29:35.120+08:00" 4} 5
错误码
公共错误码
状态码 | 错误码 | 描述 | 解决方案 |
---|---|---|---|
400 | PARAM_ERROR | 参数错误 | 请根据错误提示正确传入参数 |
400 | INVALID_REQUEST | HTTP 请求不符合微信支付 APIv3 接口规则 | 请参阅 接口规则 |
401 | SIGN_ERROR | 验证不通过 | 请参阅 签名常见问题 |
500 | SYSTEM_ERROR | 系统异常,请稍后重试 | 请稍后重试 |
业务错误码
状态码 | 错误码 | 描述 | 解决方案 |
---|---|---|---|
429 | FREQUENCY_LIMIT_EXCEED | 频率超限 | 接口请求频率超限,当前请求结果不明确,请降低请求接口频率后,使用相同参数重试 |
429 | RATELIMIT_EXCEEDED | 频率超限 | 接口或同一单号请求频率超限,当前请求结果不明确,请降低请求接口频率,使用相同参数重试 |