查询结算账号
更新时间:2025.01.21服务商/电商平台(不包括支付机构、银行),可使用本接口,查询其进件且已签约特约商户/二级商户当前的结算账户信息(敏感信息掩码)和验证结果。
|
接口说明
支持商户:【普通服务商】 【平台商户】
请求方式:【GET】/v3/apply4sub/sub_merchants/{sub_mchid}/settlement
请求域名:【主域名】https://api.mch.weixin.qq.com 使用该域名将访问就近的接入点
【备域名】https://api2.mch.weixin.qq.com 使用该域名将访问异地的接入点 ,指引点击查看
请求参数
Header HTTP头参数
Authorization 必填 string
请参考签名认证生成认证信息
Accept 必填 string
请设置为application/json
path 路径参数
sub_mchid 必填 string(10)
【特约商户/二级商户号】 请输入本服务商进件、已签约的特约商户/二级商户号。
请求示例
GET
1curl -X GET \ 2 https://api.mch.weixin.qq.com/v3/apply4sub/sub_merchants/1900006491/settlement \ 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 GetSettlement { 26 private static String HOST = "https://api.mch.weixin.qq.com"; 27 private static String METHOD = "GET"; 28 private static String PATH = "/v3/apply4sub/sub_merchants/{sub_mchid}/settlement"; 29 30 public static void main(String[] args) { 31 // TODO: 请准备商户开发必要参数,参考:https://pay.weixin.qq.com/doc/v3/partner/4013080340 32 GetSettlement client = new GetSettlement( 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 GetSettlementRequest request = new GetSettlementRequest(); 41 request.subMchid = "1900006491"; 42 try { 43 Settlement 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 Settlement run(GetSettlementRequest request) { 53 String uri = PATH; 54 uri = uri.replace("{sub_mchid}", WXPayUtility.urlEncode(request.subMchid)); 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, Settlement.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 GetSettlement(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 GetSettlementRequest { 97 @SerializedName("sub_mchid") 98 @Expose(serialize = false) 99 public String subMchid; 100 } 101 102 public static class Settlement { 103 @SerializedName("account_type") 104 public BankAccountType accountType; 105 106 @SerializedName("account_bank") 107 public String accountBank; 108 109 @SerializedName("bank_name") 110 public String bankName; 111 112 @SerializedName("bank_branch_id") 113 public String bankBranchId; 114 115 @SerializedName("account_number") 116 public String accountNumber; 117 118 @SerializedName("verify_result") 119 public VerifyResult verifyResult; 120 121 @SerializedName("verify_fail_reason") 122 public String verifyFailReason; 123 } 124 125 public enum BankAccountType { 126 @SerializedName("ACCOUNT_TYPE_BUSINESS") 127 ACCOUNT_TYPE_BUSINESS, 128 @SerializedName("ACCOUNT_TYPE_PRIVATE") 129 ACCOUNT_TYPE_PRIVATE 130 } 131 132 public enum VerifyResult { 133 @SerializedName("VERIFY_SUCCESS") 134 VERIFY_SUCCESS, 135 @SerializedName("VERIFY_FAIL") 136 VERIFY_FAIL, 137 @SerializedName("VERIFYING") 138 VERIFYING 139 } 140 141} 142
需配合微信支付工具库 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 := &GetSettlementRequest{ 27 SubMchid: wxpay_utility.String("1900006491"), 28 } 29 30 response, err := GetSettlement(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 GetSettlement(config *wxpay_utility.MchConfig, request *GetSettlementRequest) (response *Settlement, err error) { 42 const ( 43 host = "https://api.mch.weixin.qq.com" 44 method = "GET" 45 path = "/v3/apply4sub/sub_merchants/{sub_mchid}/settlement" 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, "{sub_mchid}", url.PathEscape(*request.SubMchid), -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 := &Settlement{} 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 GetSettlementRequest struct { 101 SubMchid *string `json:"sub_mchid,omitempty"` 102} 103 104func (o *GetSettlementRequest) MarshalJSON() ([]byte, error) { 105 type Alias GetSettlementRequest 106 a := &struct { 107 SubMchid *string `json:"sub_mchid,omitempty"` 108 *Alias 109 }{ 110 // 序列化时移除非 Body 字段 111 SubMchid: nil, 112 Alias: (*Alias)(o), 113 } 114 return json.Marshal(a) 115} 116 117type Settlement struct { 118 AccountType *BankAccountType `json:"account_type,omitempty"` 119 AccountBank *string `json:"account_bank,omitempty"` 120 BankName *string `json:"bank_name,omitempty"` 121 BankBranchId *string `json:"bank_branch_id,omitempty"` 122 AccountNumber *string `json:"account_number,omitempty"` 123 VerifyResult *VerifyResult `json:"verify_result,omitempty"` 124 VerifyFailReason *string `json:"verify_fail_reason,omitempty"` 125} 126 127type BankAccountType string 128 129func (e BankAccountType) Ptr() *BankAccountType { 130 return &e 131} 132 133const ( 134 BANKACCOUNTTYPE_ACCOUNT_TYPE_BUSINESS BankAccountType = "ACCOUNT_TYPE_BUSINESS" 135 BANKACCOUNTTYPE_ACCOUNT_TYPE_PRIVATE BankAccountType = "ACCOUNT_TYPE_PRIVATE" 136) 137 138type VerifyResult string 139 140func (e VerifyResult) Ptr() *VerifyResult { 141 return &e 142} 143 144const ( 145 VERIFYRESULT_VERIFY_SUCCESS VerifyResult = "VERIFY_SUCCESS" 146 VERIFYRESULT_VERIFY_FAIL VerifyResult = "VERIFY_FAIL" 147 VERIFYRESULT_VERIFYING VerifyResult = "VERIFYING" 148) 149
应答参数
200 OK
account_type 必填 string
【账户类型】 返回特约商户的结算账户类型。
可选取值
ACCOUNT_TYPE_BUSINESS
: 对公银行账户ACCOUNT_TYPE_PRIVATE
: 经营者个人银行卡
account_bank 必填 string(128)
【开户银行】 返回特约商户的结算账户-开户银行全称。
bank_name 选填 string(128)
【开户银行全称(含支行)】 返回特约商户的结算账户-开户银行全称(含支行)。
bank_branch_id 选填 string(128)
【开户银行联行号】 返回特约商户的结算账户-联行号。
account_number 必填 string(128)
【银行账号】 返回特约商户的结算账户-银行账号,掩码显示。
verify_result 必填 string
【验证结果】 返回特约商户的结算账户-验证结果。
可选取值
VERIFY_SUCCESS
: 验证成功,该账户可正常发起提现。VERIFY_FAIL
: 验证失败,该账户无法发起提现,请检查修改。VERIFYING
: 验证中,商户可发起提现尝试。
verify_fail_reason 选填 string(1024)
【验证失败原因】 如果验证成功则为空,验证失败则为具体原因。
应答示例
200 OK
1{ 2 "account_type" : "ACCOUNT_TYPE_BUSINESS", 3 "account_bank" : "工商银行", 4 "bank_name" : "施秉县农村信用合作联社城关信用社", 5 "bank_branch_id" : "402713354941", 6 "account_number" : "62*************78", 7 "verify_result" : "VERIFY_SUCCESS", 8 "verify_fail_reason" : "用户姓名/证件/手机不匹配,请核对后重试" 9} 10
错误码
公共错误码
状态码 | 错误码 | 描述 | 解决方案 |
---|---|---|---|
400 | PARAM_ERROR | 参数错误 | 请根据错误提示正确传入参数 |
400 | INVALID_REQUEST | HTTP 请求不符合微信支付 APIv3 接口规则 | 请参阅 接口规则 |
401 | SIGN_ERROR | 验证不通过 | 请参阅 签名常见问题 |
500 | SYSTEM_ERROR | 系统异常,请稍后重试 | 请稍后重试 |
业务错误码
状态码 | 错误码 | 描述 | 解决方案 |
---|---|---|---|
403 | NO_AUTH | 商户权限异常 | 该商户不是本服务商进件的子商户,无权限操作 |