发票产品状态查询
1、修订记录
| 修订记录 | 日期 | 说明 |
|---|---|---|
| 1.0 | 2026.06.18 | 发票产品状态查询 |
2、业务说明
(1)接口说明
发票产品状态查询
请求主体类型:application/json
请求方式:POST
3、请求地址
| 环境 | HTTPS请求地址 |
|---|---|
| 测试环境 | https://appdev.ysepay-test.com/openapi/invoice/productStatusQuery |
| 正式环境 | https://ysgate.ysepay.com/openapi/invoice/productStatusQuery |
4、请求参数说明
4.1、公共请求参数
| 参数 | 类型(长度) | 必填 | 参数说明 |
|---|---|---|---|
| timeStamp | String | Y | 发送请求的时间,格式"yyyy-MM-dd HH:mm:ss" |
| method | String(128) | Y | 接口名称,固定值:invoice.productStatusQuery |
| charset | String(10) | Y | 请求使用的编码格式,如utf-8,gbk,gb2312等,固定为utf-8 |
| sign | String | Y | 商户请求参数的签名串(签名算法默认为国密),详见demo,注意:请用商户私钥进行签名 |
| check | String | Y | 银盛公钥加密随机生成的字符串(key)得到的加密值,详见demo |
| bizContent | String | Y | 业务参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递。注意:需要通过AES以及随机生成的字符串(key)加密业务参数集合,得到bizContent |
| reqId | String | Y | 请求唯一流水号,商户系统唯一,要求32个字符内(最少14个字符),只能是数字、大小写字母_-且在同一个商户号下唯一。最后12位要求格式为"yyMMddHHmmss" 示例值:xy1415220315145602 |
| certId | String | Y | 发起方商户号,服务商在银盛给自己开设的商户号,即可当作发起方商户号,由银盛生成并下发。 注意:不同于子商户号,服务商发展的商户即为子商户号 |
| version | String | Y | 调用的接口版本,固定为:1.0 |
4.2、业务请求参数
(bizContent加密前的json数据明文字符串)
| 参数 | 类型(长度) | 必填 | 参数说明 |
|---|---|---|---|
| partnerId | String(32) | Y | 服务商编号,801开头的代理商编号 |
| merchantId | String(50) | Y | 系统内商户号,系统内商户号(必填) |
| channel | String(20) | N | 渠道类型,WECHAT-微信,ALIPAY-支付宝,为空查询全部 |
5、响应参数说明
请注意:银盛后期会对返回参数保留扩展的权力,扩展方式为新增参数但不会删除参数,请商户在解析银盛返回参数时要支持银盛可能扩展参数这种情况。5.1、公共响应参数
| 参数 | 类型(长度) | 必填 | 参数说明 |
|---|---|---|---|
| code | String(5) | Y | 网关响应码,示例值:00000 ,详见网关公共响应码 |
| msg | String(50) | Y | 网关响应码描述 |
| subCode | String | Y | 业务响应码,参见具体的API接口文档 |
| subMsg | String | Y | 业务响应描述 |
| timeStamp | String | Y | 响应时间,格式"yyyy-MM-dd HH:mm:ss" |
| norce | String(128) | Y | 随机参数 |
| sign | String | Y | 响应参数的签名串,详见demo, 注意:请用银盛公钥进行验签 |
| businessData | String | Y | 业务响应参数集合, 注意:银盛网关通过AES加密业务响应参数集合,得到businessData,商户需要对其进行解密,详情请见demo |
5.2、业务响应参数
响应业务参数businessData(json数据)
| 参数 | 类型(长度) | 必填 | 参数说明 |
|---|---|---|---|
| statusCode | String(10) | Y | 业务状态码,业务状态码,成功为SUCCESS,失败返回对应错误码 |
| errorMsg | String(500) | N | 错误信息,成功为空,失败返回具体错误描述 |
| merchantId | String(50) | N | 系统内商户号,系统内商户号 |
| creditCode | String(50) | N | 商户税号,统一社会信用代码 |
| items | Object | N | 产品状态列表,按渠道维度的产品状态明细 |
5.2.1.1 items具体参数
| 参数 | 类型(长度) | 必填 | 参数说明 |
|---|---|---|---|
| channel | String(20) | N | 渠道类型,WECHAT-微信,ALIPAY-支付宝 |
| invoiceProductAbility | String(50) | N | 发票产品能力,BASIC-基础开票,REAL_ESTATE_LEASE-不动产租赁,REFINED_OIL-成品油 |
| productAccessStatusCode | String(20) | N | 产品接入状态码,产品接入状态码 |
| authStatusCode | String(20) | N | 授权状态码,发票能力授权状态码 |
| billingPersons | Object | N | 开票人列表,开票人信息列表 |
| accessFailReason | String(500) | N | 接入失败原因,产品接入失败原因 |
| authStartDate | String(50) | N | 授权开始日期,授权开始日期 |
| authEndDate | String(50) | N | 授权截止日期,授权截止日期 |
| paymentStatus | String(20) | N | 缴费状态,WAIT_PAY-待缴费,PAY_SUCCESS-缴费成功,PAY_FAIL-缴费失败,PAYING-缴费中,REFUNDED-已退费 |
5.2.1.1.1 billingPersons具体参数
| 参数 | 类型(长度) | 必填 | 参数说明 |
|---|---|---|---|
| personId | String(50) | N | 开票人ID,开票人ID |
| personName | String(100) | N | 开票人姓名,开票人姓名 |
6、业务响应码 网关公共响应码
| 响应码 | 响应码描述 | 解决方案 |
|---|---|---|
| 00000 | 成功 | 请求处理成功 |
| 40000 | 参数错误 | 请求参数缺失或格式不正确 |
| 40001 | 签名验证不通过 | 请求签名验证失败,请检查签名参数 |
| 40002 | 商户号有误 | 请检查商户号是否真实存在 |
| 40010 | 网关非法参数 | 检查请求参数,修改后重新发起请求 |
| 40011 | 前置系统参数验证错误 | 检查请求参数,修改后重新发起请求 |
| 50000 | 系统异常 | 系统内部异常,请稍后重试 |
| 50001 | 失败 | 请求处理失败 |
| 50002 | 交易超时 | 请求处理超时,请稍后查询确认结果 |
| 50003 | 业务失败 | 参看具体错误描述 |
| 50004 | 商户无权限 | 商户未开通该功能或无操作权限 |
| 50005 | 资源不存在 | 请求的资源不存在 |
| 50300 | 商户未入网 | 商户尚未完成入网,请先调用入网接口 |
| 50301 | 渠道类型不合法 | 渠道类型仅支持WECHAT或ALIPAY |
| 50302 | 查询结果为空 | 未找到符合条件的产品记录 |