检查子商户开票功能状态
更新时间:2025.09.03服务商检查子商户的电子发票功能状态是否正常,若商户已经开通API开票功能并已对服务商授权,则返回成功。
接口说明
支持商户:【普通服务商】
请求方式:【GET】/v3/new-tax-control-fapiao/merchant/{sub_mchid}/check-status
请求域名:【主域名】https://api.mch.weixin.qq.com 使用该域名将访问就近的接入点
【备域名】https://api2.mch.weixin.qq.com 使用该域名将访问异地的接入点 ,指引点击查看
请求参数
Header HTTP头参数
Authorization 必填 string
请参考签名认证生成认证信息
Accept 必填 string
请设置为application/json
path 路径参数
sub_mchid 必填 string(32)
【子商户号】 微信支付分配的子商户号,具体请参考服务商模式开发必要参数说明
请求示例
GET
1curl -X GET \ 2 https://api.mch.weixin.qq.com/v3/new-tax-control-fapiao/merchant/1900000109/check-status \ 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 CheckSubMchStatus { 26 private static String HOST = "https://api.mch.weixin.qq.com"; 27 private static String METHOD = "GET"; 28 private static String PATH = "/v3/new-tax-control-fapiao/merchant/{sub_mchid}/check-status"; 29 30 public static void main(String[] args) { 31 // TODO: 请准备商户开发必要参数,参考:https://pay.weixin.qq.com/doc/v3/partner/4013080340 32 CheckSubMchStatus client = new CheckSubMchStatus( 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 CheckSubMchStatusRequest request = new CheckSubMchStatusRequest(); 41 request.subMchid = "1900000109"; 42 try { 43 CheckSubMchStatusResponse 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 CheckSubMchStatusResponse run(CheckSubMchStatusRequest 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, CheckSubMchStatusResponse.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 CheckSubMchStatus(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 CheckSubMchStatusRequest { 97 @SerializedName("sub_mchid") 98 @Expose(serialize = false) 99 public String subMchid; 100 } 101 102 public static class CheckSubMchStatusResponse { 103 @SerializedName("sub_mchid") 104 public String subMchid; 105 106 @SerializedName("third_mode") 107 public ThirdMode thirdMode; 108 109 @SerializedName("digital_tax_mode") 110 public DigitalTaxMode digitalTaxMode; 111 } 112 113 public static class ThirdMode { 114 @SerializedName("status") 115 public ThirdModeStatus status; 116 } 117 118 public static class DigitalTaxMode { 119 @SerializedName("status") 120 public DigitalTaxApplyStatus status; 121 122 @SerializedName("billing_person_info") 123 public List<DigitalTaxBillingPersonInfo> billingPersonInfo; 124 125 @SerializedName("access_time") 126 public String accessTime; 127 128 @SerializedName("expired_time") 129 public String expiredTime; 130 131 @SerializedName("access_fail_reason") 132 public String accessFailReason; 133 134 @SerializedName("ability_info") 135 public List<DigitalTaxAbilityInfo> abilityInfo; 136 } 137 138 public enum ThirdModeStatus { 139 @SerializedName("DISABLED") 140 DISABLED, 141 @SerializedName("ENABLED") 142 ENABLED 143 } 144 145 public enum DigitalTaxApplyStatus { 146 @SerializedName("APPROVAL_PENDING") 147 APPROVAL_PENDING, 148 @SerializedName("ACCESS_CONFIRMED_PENDING") 149 ACCESS_CONFIRMED_PENDING, 150 @SerializedName("ABILITY_CONFIRMED_PENDING") 151 ABILITY_CONFIRMED_PENDING, 152 @SerializedName("BILLING_PERSON_REGISTER_PENDING") 153 BILLING_PERSON_REGISTER_PENDING, 154 @SerializedName("BILLING_PERSON_CONFIRMED_PENDING") 155 BILLING_PERSON_CONFIRMED_PENDING, 156 @SerializedName("SECURITY_SETTING_PENDING") 157 SECURITY_SETTING_PENDING, 158 @SerializedName("APPLY_FAILED") 159 APPLY_FAILED, 160 @SerializedName("DISABLED") 161 DISABLED, 162 @SerializedName("ENABLED") 163 ENABLED, 164 @SerializedName("RESOURCE_EXPIRED") 165 RESOURCE_EXPIRED 166 } 167 168 public static class DigitalTaxBillingPersonInfo { 169 @SerializedName("id") 170 public String id; 171 172 @SerializedName("name") 173 public String name; 174 } 175 176 public static class DigitalTaxAbilityInfo { 177 @SerializedName("type") 178 public FapiaoAbilityType type; 179 180 @SerializedName("status") 181 public DigitalTaxAbilityAuthorizeStatus status; 182 183 @SerializedName("authorize_fail_reason") 184 public String authorizeFailReason; 185 } 186 187 public enum FapiaoAbilityType { 188 @SerializedName("BASE_ABILITY") 189 BASE_ABILITY, 190 @SerializedName("REAL_ESTATE_ABILITY") 191 REAL_ESTATE_ABILITY 192 } 193 194 public enum DigitalTaxAbilityAuthorizeStatus { 195 @SerializedName("AUTHORIZED") 196 AUTHORIZED, 197 @SerializedName("AUTHORIZE_PENDING") 198 AUTHORIZE_PENDING, 199 @SerializedName("DEAUTHORIZED") 200 DEAUTHORIZED, 201 @SerializedName("AUTHORIZE_FAILED") 202 AUTHORIZE_FAILED 203 } 204 205} 206
需配合微信支付工具库 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 := &CheckSubMchStatusRequest{ 27 SubMchid: wxpay_utility.String("1900000109"), 28 } 29 30 response, err := CheckSubMchStatus(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 CheckSubMchStatus(config *wxpay_utility.MchConfig, request *CheckSubMchStatusRequest) (response *CheckSubMchStatusResponse, err error) { 42 const ( 43 host = "https://api.mch.weixin.qq.com" 44 method = "GET" 45 path = "/v3/new-tax-control-fapiao/merchant/{sub_mchid}/check-status" 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 := &CheckSubMchStatusResponse{} 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 CheckSubMchStatusRequest struct { 101 SubMchid *string `json:"sub_mchid,omitempty"` 102} 103 104func (o *CheckSubMchStatusRequest) MarshalJSON() ([]byte, error) { 105 type Alias CheckSubMchStatusRequest 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 CheckSubMchStatusResponse struct { 118 SubMchid *string `json:"sub_mchid,omitempty"` 119 ThirdMode *ThirdMode `json:"third_mode,omitempty"` 120 DigitalTaxMode *DigitalTaxMode `json:"digital_tax_mode,omitempty"` 121} 122 123type ThirdMode struct { 124 Status *ThirdModeStatus `json:"status,omitempty"` 125} 126 127type DigitalTaxMode struct { 128 Status *DigitalTaxApplyStatus `json:"status,omitempty"` 129 BillingPersonInfo []DigitalTaxBillingPersonInfo `json:"billing_person_info,omitempty"` 130 AccessTime *string `json:"access_time,omitempty"` 131 ExpiredTime *string `json:"expired_time,omitempty"` 132 AccessFailReason *string `json:"access_fail_reason,omitempty"` 133 AbilityInfo []DigitalTaxAbilityInfo `json:"ability_info,omitempty"` 134} 135 136type ThirdModeStatus string 137 138func (e ThirdModeStatus) Ptr() *ThirdModeStatus { 139 return &e 140} 141 142const ( 143 THIRDMODESTATUS_DISABLED ThirdModeStatus = "DISABLED" 144 THIRDMODESTATUS_ENABLED ThirdModeStatus = "ENABLED" 145) 146 147type DigitalTaxApplyStatus string 148 149func (e DigitalTaxApplyStatus) Ptr() *DigitalTaxApplyStatus { 150 return &e 151} 152 153const ( 154 DIGITALTAXAPPLYSTATUS_APPROVAL_PENDING DigitalTaxApplyStatus = "APPROVAL_PENDING" 155 DIGITALTAXAPPLYSTATUS_ACCESS_CONFIRMED_PENDING DigitalTaxApplyStatus = "ACCESS_CONFIRMED_PENDING" 156 DIGITALTAXAPPLYSTATUS_ABILITY_CONFIRMED_PENDING DigitalTaxApplyStatus = "ABILITY_CONFIRMED_PENDING" 157 DIGITALTAXAPPLYSTATUS_BILLING_PERSON_REGISTER_PENDING DigitalTaxApplyStatus = "BILLING_PERSON_REGISTER_PENDING" 158 DIGITALTAXAPPLYSTATUS_BILLING_PERSON_CONFIRMED_PENDING DigitalTaxApplyStatus = "BILLING_PERSON_CONFIRMED_PENDING" 159 DIGITALTAXAPPLYSTATUS_SECURITY_SETTING_PENDING DigitalTaxApplyStatus = "SECURITY_SETTING_PENDING" 160 DIGITALTAXAPPLYSTATUS_APPLY_FAILED DigitalTaxApplyStatus = "APPLY_FAILED" 161 DIGITALTAXAPPLYSTATUS_DISABLED DigitalTaxApplyStatus = "DISABLED" 162 DIGITALTAXAPPLYSTATUS_ENABLED DigitalTaxApplyStatus = "ENABLED" 163 DIGITALTAXAPPLYSTATUS_RESOURCE_EXPIRED DigitalTaxApplyStatus = "RESOURCE_EXPIRED" 164) 165 166type DigitalTaxBillingPersonInfo struct { 167 Id *string `json:"id,omitempty"` 168 Name *string `json:"name,omitempty"` 169} 170 171type DigitalTaxAbilityInfo struct { 172 Type *FapiaoAbilityType `json:"type,omitempty"` 173 Status *DigitalTaxAbilityAuthorizeStatus `json:"status,omitempty"` 174 AuthorizeFailReason *string `json:"authorize_fail_reason,omitempty"` 175} 176 177type FapiaoAbilityType string 178 179func (e FapiaoAbilityType) Ptr() *FapiaoAbilityType { 180 return &e 181} 182 183const ( 184 FAPIAOABILITYTYPE_BASE_ABILITY FapiaoAbilityType = "BASE_ABILITY" 185 FAPIAOABILITYTYPE_REAL_ESTATE_ABILITY FapiaoAbilityType = "REAL_ESTATE_ABILITY" 186) 187 188type DigitalTaxAbilityAuthorizeStatus string 189 190func (e DigitalTaxAbilityAuthorizeStatus) Ptr() *DigitalTaxAbilityAuthorizeStatus { 191 return &e 192} 193 194const ( 195 DIGITALTAXABILITYAUTHORIZESTATUS_AUTHORIZED DigitalTaxAbilityAuthorizeStatus = "AUTHORIZED" 196 DIGITALTAXABILITYAUTHORIZESTATUS_AUTHORIZE_PENDING DigitalTaxAbilityAuthorizeStatus = "AUTHORIZE_PENDING" 197 DIGITALTAXABILITYAUTHORIZESTATUS_DEAUTHORIZED DigitalTaxAbilityAuthorizeStatus = "DEAUTHORIZED" 198 DIGITALTAXABILITYAUTHORIZESTATUS_AUTHORIZE_FAILED DigitalTaxAbilityAuthorizeStatus = "AUTHORIZE_FAILED" 199) 200
应答参数
200 OK
sub_mchid 必填 string(32)
【子商户号】 微信支付分配的子商户号
third_mode 选填 object
【第三方开票模式】 第三方开票模式相关信息,商户开通第三方开票模式时返回
属性 | |
status 必填 string 【第三方/自建发票能力接入状态】 第三方/自建发票能力接入状态 可选取值
|
digital_tax_mode 选填 object
【数电发票模式】 数电发票模式相关信息,商户开通数电发票模式时返回
属性 | |||||||||
status 必填 string 【接入状态】 数电发票接入状态 可选取值
billing_person_info 选填 array[object] 【开票人信息】 开票人信息
access_time 选填 string 【接入时间】 数电发票接入完成的时间,遵循RFC3339标准格式:yyyy-MM-DDTHH:mm:ss+TIMEZONE expired_time 选填 string 【过期时间】 税局设置的安全校验过期时间,遵循RFC3339标准格式:yyyy-MM-DDTHH:mm:ss+TIMEZONE access_fail_reason 选填 string(1024) 【接入失败原因】 商户接入数电发票失败时,接入失败的原因展示 ability_info 选填 array[object] 【能力信息】 已申请的数电发票能力的详情信息
|
应答示例
200 OK
1{ 2 "sub_mchid" : "1900000109", 3 "third_mode" : { 4 "status" : "ENABLED" 5 }, 6 "digital_tax_mode" : { 7 "status" : "ENABLED", 8 "billing_person_info" : [ 9 { 10 "id" : "187776276864872", 11 "name" : "张伟" 12 } 13 ], 14 "access_time" : "2020-07-01T12:00:00+08:00", 15 "expired_time" : "2020-07-02T12:00:00+08:00", 16 "access_fail_reason" : "失败原因", 17 "ability_info" : [ 18 { 19 "type" : "BASE_ABILITY", 20 "status" : "AUTHORIZED", 21 "authorize_fail_reason" : "失败原因" 22 } 23 ] 24 } 25} 26
错误码
公共错误码
状态码 | 错误码 | 描述 | 解决方案 |
---|---|---|---|
400 | PARAM_ERROR | 参数错误 | 请根据错误提示正确传入参数 |
400 | INVALID_REQUEST | HTTP 请求不符合微信支付 APIv3 接口规则 | 请参阅 接口规则 |
401 | SIGN_ERROR | 验证不通过 | 请参阅 签名常见问题 |
500 | SYSTEM_ERROR | 系统异常,请稍后重试 | 请稍后重试 |
业务错误码
状态码 | 错误码 | 描述 | 解决方案 |
---|---|---|---|
400 | INVALID_REQUEST | 请求参数符合参数格式,但不符合业务规则 | 请使用正确的参数重新调用 |
403 | NO_AUTH | 商户无权限 | 请检查是否已经开通电子发票产品相关功能权限,并检查子商户是否接受了服务商的邀请 |
429 | FREQUENCY_LIMITED | 频率超限 | 请降低请求接口频率 |