申请分账账单
更新时间:2025.01.20
|
微信支付按天提供分账账单文件,商户可以通过该接口获取账单文件的下载地址。文件内包含分账相关的金额、时间等信息,供商户核对到账等情况。
|
接口说明
支持商户:【普通服务商】
请求方式:【GET】/v3/profitsharing/bills
请求域名:【主域名】https://api.mch.weixin.qq.com 使用该域名将访问就近的接入点
【备域名】https://api2.mch.weixin.qq.com 使用该域名将访问异地的接入点 ,指引点击查看
请求参数
Header HTTP头参数
Authorization 必填 string
请参考签名认证生成认证信息
Accept 必填 string
请设置为application/json
query 查询参数
sub_mchid 选填 string(12)
【子商户号】 若商户是直连商户:
无需填写该字段
若商户是服务商:
不填则默认返回服务商下的所有分账账单。
如需下载某个子商户下的分账账单,则填指定的子商户号。
bill_date 必填 string(10)
【账单日期】 格式YYYY-MM-DD。仅支持三个月内的账单下载申请。
tar_type 选填 string
【压缩类型】 不填则以不压缩的方式返回数据流
可选取值
GZIP
: 返回格式为.gzip的压缩包账单
请求示例
GET
1curl -X GET \ 2 https://api.mch.weixin.qq.com/v3/profitsharing/bills?sub_mchid=19000000001&bill_date=2019-06-11&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 SplitBill { 26 private static String HOST = "https://api.mch.weixin.qq.com"; 27 private static String METHOD = "GET"; 28 private static String PATH = "/v3/profitsharing/bills"; 29 30 public static void main(String[] args) { 31 // TODO: 请准备商户开发必要参数,参考:https://pay.weixin.qq.com/doc/v3/partner/4013080340 32 SplitBill client = new SplitBill( 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 SplitBillRequest request = new SplitBillRequest(); 41 request.subMchid = "19000000001"; 42 request.billDate = "2019-06-11"; 43 request.tarType = SplitBillTarType.GZIP; 44 try { 45 SplitBillResponse 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 SplitBillResponse run(SplitBillRequest request) { 55 String uri = PATH; 56 Map<String, Object> args = new HashMap<>(); 57 args.put("sub_mchid", request.subMchid); 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, SplitBillResponse.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 SplitBill(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 SplitBillRequest { 106 @SerializedName("sub_mchid") 107 @Expose(serialize = false) 108 public String subMchid; 109 110 @SerializedName("bill_date") 111 @Expose(serialize = false) 112 public String billDate; 113 114 @SerializedName("tar_type") 115 @Expose(serialize = false) 116 public SplitBillTarType tarType; 117 } 118 119 public static class SplitBillResponse { 120 @SerializedName("hash_type") 121 public SplitBillHashType hashType; 122 123 @SerializedName("hash_value") 124 public String hashValue; 125 126 @SerializedName("download_url") 127 public String downloadUrl; 128 } 129 130 public enum SplitBillTarType { 131 @SerializedName("GZIP") 132 GZIP 133 } 134 135 public enum SplitBillHashType { 136 @SerializedName("SHA1") 137 SHA1 138 } 139 140} 141
需配合微信支付工具库 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) 10 11func main() { 12 // TODO: 请准备商户开发必要参数,参考:https://pay.weixin.qq.com/doc/v3/partner/4013080340 13 config, err := wxpay_utility.CreateMchConfig( 14 "19xxxxxxxx", // 商户号,是由微信支付系统生成并分配给每个商户的唯一标识符,商户号获取方式参考 https://pay.weixin.qq.com/doc/v3/partner/4013080340 15 "1DDE55AD98Exxxxxxxxxx", // 商户API证书序列号,如何获取请参考 https://pay.weixin.qq.com/doc/v3/partner/4013058924 16 "/path/to/apiclient_key.pem", // 商户API证书私钥文件路径,本地文件路径 17 "PUB_KEY_ID_xxxxxxxxxxxxx", // 微信支付公钥ID,如何获取请参考 https://pay.weixin.qq.com/doc/v3/partner/4013038589 18 "/path/to/wxp_pub.pem", // 微信支付公钥文件路径,本地文件路径 19 ) 20 if err != nil { 21 fmt.Println(err) 22 return 23 } 24 25 request := &SplitBillRequest{ 26 SubMchid: wxpay_utility.String("19000000001"), 27 BillDate: wxpay_utility.String("2019-06-11"), 28 TarType: SPLITBILLTARTYPE_GZIP.Ptr(), 29 } 30 31 response, err := SplitBill(config, request) 32 if err != nil { 33 fmt.Printf("请求失败: %+v\n", err) 34 // TODO: 请求失败,根据状态码执行不同的处理 35 return 36 } 37 38 // TODO: 请求成功,继续业务逻辑 39 fmt.Printf("请求成功: %+v\n", response) 40} 41 42func SplitBill(config *wxpay_utility.MchConfig, request *SplitBillRequest) (response *SplitBillResponse, err error) { 43 const ( 44 host = "https://api.mch.weixin.qq.com" 45 method = "GET" 46 path = "/v3/profitsharing/bills" 47 ) 48 49 reqUrl, err := url.Parse(fmt.Sprintf("%s%s", host, path)) 50 if err != nil { 51 return nil, err 52 } 53 query := reqUrl.Query() 54 if request.SubMchid != nil { 55 query.Add("sub_mchid", *request.SubMchid) 56 } 57 if request.BillDate != nil { 58 query.Add("bill_date", *request.BillDate) 59 } 60 if request.TarType != nil { 61 query.Add("tar_type", fmt.Sprintf("%v", *request.TarType)) 62 } 63 reqUrl.RawQuery = query.Encode() 64 httpRequest, err := http.NewRequest(method, reqUrl.String(), nil) 65 if err != nil { 66 return nil, err 67 } 68 httpRequest.Header.Set("Accept", "application/json") 69 httpRequest.Header.Set("Wechatpay-Serial", config.WechatPayPublicKeyId()) 70 authorization, err := wxpay_utility.BuildAuthorization(config.MchId(), config.CertificateSerialNo(), config.PrivateKey(), method, reqUrl.RequestURI(), nil) 71 if err != nil { 72 return nil, err 73 } 74 httpRequest.Header.Set("Authorization", authorization) 75 76 client := &http.Client{} 77 httpResponse, err := client.Do(httpRequest) 78 if err != nil { 79 return nil, err 80 } 81 respBody, err := wxpay_utility.ExtractResponseBody(httpResponse) 82 if err != nil { 83 return nil, err 84 } 85 if httpResponse.StatusCode >= 200 && httpResponse.StatusCode < 300 { 86 // 2XX 成功,验证应答签名 87 err = wxpay_utility.ValidateResponse( 88 config.WechatPayPublicKeyId(), 89 config.WechatPayPublicKey(), 90 &httpResponse.Header, 91 respBody, 92 ) 93 if err != nil { 94 return nil, err 95 } 96 response := &SplitBillResponse{} 97 if err := json.Unmarshal(respBody, response); err != nil { 98 return nil, err 99 } 100 101 return response, nil 102 } else { 103 return nil, wxpay_utility.NewApiException( 104 httpResponse.StatusCode, 105 httpResponse.Header, 106 respBody, 107 ) 108 } 109} 110 111type SplitBillRequest struct { 112 SubMchid *string `json:"sub_mchid,omitempty"` 113 BillDate *string `json:"bill_date,omitempty"` 114 TarType *SplitBillTarType `json:"tar_type,omitempty"` 115} 116 117func (o *SplitBillRequest) MarshalJSON() ([]byte, error) { 118 type Alias SplitBillRequest 119 a := &struct { 120 SubMchid *string `json:"sub_mchid,omitempty"` 121 BillDate *string `json:"bill_date,omitempty"` 122 TarType *SplitBillTarType `json:"tar_type,omitempty"` 123 *Alias 124 }{ 125 // 序列化时移除非 Body 字段 126 SubMchid: nil, 127 BillDate: nil, 128 TarType: nil, 129 Alias: (*Alias)(o), 130 } 131 return json.Marshal(a) 132} 133 134type SplitBillResponse struct { 135 HashType *SplitBillHashType `json:"hash_type,omitempty"` 136 HashValue *string `json:"hash_value,omitempty"` 137 DownloadUrl *string `json:"download_url,omitempty"` 138} 139 140type SplitBillTarType string 141 142func (e SplitBillTarType) Ptr() *SplitBillTarType { 143 return &e 144} 145 146const ( 147 SPLITBILLTARTYPE_GZIP SplitBillTarType = "GZIP" 148) 149 150type SplitBillHashType string 151 152func (e SplitBillHashType) Ptr() *SplitBillHashType { 153 return &e 154} 155 156const ( 157 SPLITBILLHASHTYPE_SHA1 SplitBillHashType = "SHA1" 158) 159
应答参数
200 OK
hash_type 必填 string
【哈希类型】 原始账单(gzip需要解压缩)的摘要算法,用于校验文件的完整性
可选取值
SHA1
: Secure Hash Algorithm 1
hash_value 必填 string(1024)
【哈希值】 原始账单(gzip需要解压缩)的摘要值,用于校验文件的完整性
download_url 必填 string(2048)
【下载地址】 供下一步请求账单文件的下载地址,该地址30s内有效
应答示例
200 OK
1{ 2 "hash_type" : "SHA1", 3 "hash_value" : "79bb0f45fc4c42234a918000b2668d689e2bde04", 4 "download_url" : "https://api.mch.weixin.qq.com/v3/bill/downloadurl?token=xxx" 5} 6
错误码
公共错误码
状态码 | 错误码 | 描述 | 解决方案 |
---|---|---|---|
400 | PARAM_ERROR | 参数错误 | 请根据错误提示正确传入参数 |
400 | INVALID_REQUEST | HTTP 请求不符合微信支付 APIv3 接口规则 | 请参阅 接口规则 |
401 | SIGN_ERROR | 验证不通过 | 请参阅 签名常见问题 |
500 | SYSTEM_ERROR | 系统异常,请稍后重试 | 请稍后重试 |
业务错误码
状态码 | 错误码 | 描述 | 解决方案 |
---|---|---|---|
400 | INVALID_REQUEST | 服务商和分账方无受理关系 | 请检查子商户号是否正确 |
400 | INVALID_REQUEST | 请求的账单日期已过期 | 请调整账单日期 |
400 | INVALID_REQUEST | 请求的账单正在生成中 | 请确认账单时间是否正确,当日的账单会在次日上午10点以后可供下载 |
400 | NO_STATEMENT_EXIST | 账单文件不存在 | 请确认账单时间是否正确,当日的账单会在次日上午10点以后可供下载 |
400 | PARAM_ERROR | 日期格式不正确 | 请使用正确的参数重新调用 |
429 | FREQUENCY_LIMITED | 商户发起获取账单的频率过高 | 请降低频率后重试 |
500 | SYSTEM_ERROR | 系统错误 | 系统异常,请使用相同参数稍后重新调用 |