按日下载提现异常文件
更新时间:2024.12.19收付通平台按日查询并下载提现状态为异常的提现单,提现异常包括提现失败和银行退票。
|
接口说明
支持商户:【平台商户】
请求方式:【GET】/v3/merchant/fund/withdraw/bill-type/{bill_type}
请求域名:【主域名】https://api.mch.weixin.qq.com 使用该域名将访问就近的接入点
【备域名】https://api2.mch.weixin.qq.com 使用该域名将访问异地的接入点 ,指引点击查看
请求参数
Header HTTP头参数
Authorization 必填 string
请参考签名认证生成认证信息
Accept 必填 string
请设置为application/json
path 路径参数
bill_type 必填 string
【账单类型】账单类型
可选取值:
NO_SUCC
: 包括提现失败和提现退票账单
query 查询参数
bill_date 必填 string(10)
【账单日期】表示所在日期的提现账单,格式YYYY-MM-DD。例如:2008-01-01日发起的提现,2008-01-03日银行返回提现失败,则该提现数据将出现在bill_date为2008-01-03日的账单中
tar_type 选填 string
【压缩格式】压缩格式
可选取值:
GZIP
: 返回格式为.gzip的压缩包账单
请求示例
GET
1curl -X GET \ 2 https://api.mch.weixin.qq.com/v3/merchant/fund/withdraw/bill-type/NO_SUCC?bill_date=2019-08-17&tar_type=GZIP \ 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/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 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 QueryWithdrawBill { 26 private static String HOST = "https://api.mch.weixin.qq.com"; 27 private static String METHOD = "GET"; 28 private static String PATH = "/v3/merchant/fund/withdraw/bill-type/{bill_type}"; 29 30 public static void main(String[] args) { 31 // TODO: 请准备商户开发必要参数,参考:https://pay.weixin.qq.com/doc/v3/partner/4013080340 32 QueryWithdrawBill client = new QueryWithdrawBill( 33 "19xxxxxxxx", // 商户号,是由微信支付系统生成并分配给每个商户的唯一标识符,商户号获取方式参考 https://pay.weixin.qq.com/doc/v3/partner/4013080340 34 "1DDE55AD98Exxxxxxxxxx", // 商户API证书序列号,如何获取请参考 https://pay.weixin.qq.com/doc/v3/partner/4013058924 35 "/path/to/apiclient_key.pem", // 商户API证书私钥文件路径,本地文件路径 36 "PUB_KEY_ID_xxxxxxxxxxxxx", // 微信支付公钥ID,如何获取请参考 https://pay.weixin.qq.com/doc/v3/partner/4013038589 37 "/path/to/wxp_pub.pem" // 微信支付公钥文件路径,本地文件路径 38 ); 39 40 QueryWithdrawBillRequest request = new QueryWithdrawBillRequest(); 41 request.billType = WithDrawBillType.NO_SUCC; 42 request.billDate = "2019-08-17"; 43 request.tarType = TarType.GZIP; 44 try { 45 QueryBillEntity response = client.run(request); 46 // TODO: 请求成功,继续业务逻辑 47 System.out.println(response); 48 } catch (WXPayUtility.ApiException e) { 49 // TODO: 请求失败,根据状态码执行不同的逻辑 50 e.printStackTrace(); 51 } 52 } 53 54 public QueryBillEntity run(QueryWithdrawBillRequest request) { 55 String uri = PATH; 56 uri = uri.replace("{bill_type}", WXPayUtility.urlEncode(request.billType.toString())); 57 Map<String, Object> args = new HashMap<>(); 58 args.put("bill_date", request.billDate); 59 args.put("tar_type", request.tarType); 60 String queryString = WXPayUtility.urlEncode(args); 61 if (!queryString.isEmpty()) { 62 uri = uri + "?" + queryString; 63 } 64 65 Request.Builder reqBuilder = new Request.Builder().url(HOST + uri); 66 reqBuilder.addHeader("Accept", "application/json"); 67 reqBuilder.addHeader("Wechatpay-Serial", wechatPayPublicKeyId); 68 reqBuilder.addHeader("Authorization", WXPayUtility.buildAuthorization(mchid, certificateSerialNo, privateKey, METHOD, uri, null)); 69 reqBuilder.method(METHOD, null); 70 Request httpRequest = reqBuilder.build(); 71 72 // 发送HTTP请求 73 OkHttpClient client = new OkHttpClient.Builder().build(); 74 try (Response httpResponse = client.newCall(httpRequest).execute()) { 75 String respBody = WXPayUtility.extractBody(httpResponse); 76 if (httpResponse.code() >= 200 && httpResponse.code() < 300) { 77 // 2XX 成功,验证应答签名 78 WXPayUtility.validateResponse(this.wechatPayPublicKeyId, this.wechatPayPublicKey, 79 httpResponse.headers(), respBody); 80 81 // 从HTTP应答报文构建返回数据 82 return WXPayUtility.fromJson(respBody, QueryBillEntity.class); 83 } else { 84 throw new WXPayUtility.ApiException(httpResponse.code(), respBody, httpResponse.headers()); 85 } 86 } catch (IOException e) { 87 throw new UncheckedIOException("Sending request to " + uri + " failed.", e); 88 } 89 } 90 91 private final String mchid; 92 private final String certificateSerialNo; 93 private final PrivateKey privateKey; 94 private final String wechatPayPublicKeyId; 95 private final PublicKey wechatPayPublicKey; 96 97 public QueryWithdrawBill(String mchid, String certificateSerialNo, String privateKeyFilePath, String wechatPayPublicKeyId, String wechatPayPublicKeyFilePath) { 98 this.mchid = mchid; 99 this.certificateSerialNo = certificateSerialNo; 100 this.privateKey = WXPayUtility.loadPrivateKeyFromPath(privateKeyFilePath); 101 this.wechatPayPublicKeyId = wechatPayPublicKeyId; 102 this.wechatPayPublicKey = WXPayUtility.loadPublicKeyFromPath(wechatPayPublicKeyFilePath); 103 } 104 105 public static class QueryWithdrawBillRequest { 106 @SerializedName("bill_date") 107 @Expose(serialize = false) 108 public String billDate; 109 110 @SerializedName("bill_type") 111 @Expose(serialize = false) 112 public WithDrawBillType billType; 113 114 @SerializedName("tar_type") 115 @Expose(serialize = false) 116 public TarType tarType; 117 } 118 119 public static class QueryBillEntity { 120 @SerializedName("hash_type") 121 public WithDrawBillHashType hashType; 122 123 @SerializedName("hash_value") 124 public String hashValue; 125 126 @SerializedName("download_url") 127 public String downloadUrl; 128 } 129 130 public enum WithDrawBillType { 131 @SerializedName("NO_SUCC") 132 NO_SUCC 133 } 134 135 public enum TarType { 136 @SerializedName("GZIP") 137 GZIP 138 } 139 140 public enum WithDrawBillHashType { 141 @SerializedName("SHA1") 142 SHA1 143 } 144 145} 146
需配合微信支付工具库 wxpay_utility 使用,请参考Go
1package main 2 3import ( 4 "demo/wxpay_utility" // 引用微信支付工具库,参考 https://pay.weixin.qq.com/doc/v3/partner/4015119446 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/partner/4013080340 14 config, err := wxpay_utility.CreateMchConfig( 15 "19xxxxxxxx", // 商户号,是由微信支付系统生成并分配给每个商户的唯一标识符,商户号获取方式参考 https://pay.weixin.qq.com/doc/v3/partner/4013080340 16 "1DDE55AD98Exxxxxxxxxx", // 商户API证书序列号,如何获取请参考 https://pay.weixin.qq.com/doc/v3/partner/4013058924 17 "/path/to/apiclient_key.pem", // 商户API证书私钥文件路径,本地文件路径 18 "PUB_KEY_ID_xxxxxxxxxxxxx", // 微信支付公钥ID,如何获取请参考 https://pay.weixin.qq.com/doc/v3/partner/4013038589 19 "/path/to/wxp_pub.pem", // 微信支付公钥文件路径,本地文件路径 20 ) 21 if err != nil { 22 fmt.Println(err) 23 return 24 } 25 26 request := &QueryWithdrawBillRequest{ 27 BillDate: wxpay_utility.String("2019-08-17"), 28 BillType: WITHDRAWBILLTYPE_NO_SUCC.Ptr(), 29 TarType: TARTYPE_GZIP.Ptr(), 30 } 31 32 response, err := QueryWithdrawBill(config, request) 33 if err != nil { 34 fmt.Printf("请求失败: %+v\n", err) 35 // TODO: 请求失败,根据状态码执行不同的处理 36 return 37 } 38 39 // TODO: 请求成功,继续业务逻辑 40 fmt.Printf("请求成功: %+v\n", response) 41} 42 43func QueryWithdrawBill(config *wxpay_utility.MchConfig, request *QueryWithdrawBillRequest) (response *QueryBillEntity, err error) { 44 const ( 45 host = "https://api.mch.weixin.qq.com" 46 method = "GET" 47 path = "/v3/merchant/fund/withdraw/bill-type/{bill_type}" 48 ) 49 50 reqUrl, err := url.Parse(fmt.Sprintf("%s%s", host, path)) 51 if err != nil { 52 return nil, err 53 } 54 reqUrl.Path = strings.Replace(reqUrl.Path, "{bill_type}", url.PathEscape(fmt.Sprintf("%v", *request.BillType)), -1) 55 query := reqUrl.Query() 56 if request.BillDate != nil { 57 query.Add("bill_date", *request.BillDate) 58 } 59 if request.TarType != nil { 60 query.Add("tar_type", fmt.Sprintf("%v", *request.TarType)) 61 } 62 reqUrl.RawQuery = query.Encode() 63 httpRequest, err := http.NewRequest(method, reqUrl.String(), nil) 64 if err != nil { 65 return nil, err 66 } 67 httpRequest.Header.Set("Accept", "application/json") 68 httpRequest.Header.Set("Wechatpay-Serial", config.WechatPayPublicKeyId()) 69 authorization, err := wxpay_utility.BuildAuthorization(config.MchId(), config.CertificateSerialNo(), config.PrivateKey(), method, reqUrl.RequestURI(), nil) 70 if err != nil { 71 return nil, err 72 } 73 httpRequest.Header.Set("Authorization", authorization) 74 75 client := &http.Client{} 76 httpResponse, err := client.Do(httpRequest) 77 if err != nil { 78 return nil, err 79 } 80 respBody, err := wxpay_utility.ExtractResponseBody(httpResponse) 81 if err != nil { 82 return nil, err 83 } 84 if httpResponse.StatusCode >= 200 && httpResponse.StatusCode < 300 { 85 // 2XX 成功,验证应答签名 86 err = wxpay_utility.ValidateResponse( 87 config.WechatPayPublicKeyId(), 88 config.WechatPayPublicKey(), 89 &httpResponse.Header, 90 respBody, 91 ) 92 if err != nil { 93 return nil, err 94 } 95 response := &QueryBillEntity{} 96 if err := json.Unmarshal(respBody, response); err != nil { 97 return nil, err 98 } 99 100 return response, nil 101 } else { 102 return nil, wxpay_utility.NewApiException( 103 httpResponse.StatusCode, 104 httpResponse.Header, 105 respBody, 106 ) 107 } 108} 109 110type QueryWithdrawBillRequest struct { 111 BillDate *string `json:"bill_date,omitempty"` 112 BillType *WithDrawBillType `json:"bill_type,omitempty"` 113 TarType *TarType `json:"tar_type,omitempty"` 114} 115 116func (o *QueryWithdrawBillRequest) MarshalJSON() ([]byte, error) { 117 type Alias QueryWithdrawBillRequest 118 a := &struct { 119 BillDate *string `json:"bill_date,omitempty"` 120 BillType *WithDrawBillType `json:"bill_type,omitempty"` 121 TarType *TarType `json:"tar_type,omitempty"` 122 *Alias 123 }{ 124 // 序列化时移除非 Body 字段 125 BillDate: nil, 126 BillType: nil, 127 TarType: nil, 128 Alias: (*Alias)(o), 129 } 130 return json.Marshal(a) 131} 132 133type QueryBillEntity struct { 134 HashType *WithDrawBillHashType `json:"hash_type,omitempty"` 135 HashValue *string `json:"hash_value,omitempty"` 136 DownloadUrl *string `json:"download_url,omitempty"` 137} 138 139type WithDrawBillType string 140 141func (e WithDrawBillType) Ptr() *WithDrawBillType { 142 return &e 143} 144 145const ( 146 WITHDRAWBILLTYPE_NO_SUCC WithDrawBillType = "NO_SUCC" 147) 148 149type TarType string 150 151func (e TarType) Ptr() *TarType { 152 return &e 153} 154 155const ( 156 TARTYPE_GZIP TarType = "GZIP" 157) 158 159type WithDrawBillHashType string 160 161func (e WithDrawBillHashType) Ptr() *WithDrawBillHashType { 162 return &e 163} 164 165const ( 166 WITHDRAWBILLHASHTYPE_SHA1 WithDrawBillHashType = "SHA1" 167) 168
应答参数
|
hash_type 必填 string
【哈希类型】哈希类型
可选取值:
SHA1
:
hash_value 必填 string
【哈希值】从download_url下载的文件的哈希值,用于校验文件的完整性
download_url 必填 string
【下载地址】下载地址,5分钟内有效
应答示例
200 OK
1{ 2 "hash_type" : "SHA1", 3 "hash_value" : "79bb0f45fc4c42234a918000b2668d689e2bde04", 4 "download_url" : "https://xxxx.xxx.xxx" 5} 6
错误码
公共错误码
状态码 | 错误码 | 描述 | 解决方案 |
---|---|---|---|
400 | PARAM_ERROR | 参数错误 | 请根据错误提示正确传入参数 |
400 | INVALID_REQUEST | HTTP 请求不符合微信支付 APIv3 接口规则 | 请参阅 接口规则 |
401 | SIGN_ERROR | 验证不通过 | 请参阅 签名常见问题 |
500 | SYSTEM_ERROR | 系统异常,请稍后重试 | 请稍后重试 |
业务错误码
状态码 | 错误码 | 描述 | 解决方案 |
---|---|---|---|
400 | INVALID_REQUEST | 请求的账单日期已过期 | 请检查bill_date,并重新调用 |
400 | NO_STATEMENT_EXIST | 请求的账单文件不存在 | 请检查当前商户号请求的微信支付账户在指定日期是否有资金操作 |
400 | STATEMENT_CREATING | 请求的账单正在生成中 | 请先检查当前商户号的微信支付账户在指定日期内是否有资金操作,若有,则在T+1日上午10点后再重新下载 |
403 | NO_AUTH | 当前商户号没有使用该接口的权限 | 请确认是否已经开通相关权限 |
500 | SYSTEM_ERROR | 系统错误 | 系统异常,请使用相同参数稍后重新调用 |