发票邀请查询
1、修订记录
| 修订记录 | 日期 | 说明 |
|---|---|---|
| 1.0 | 2026.07.01 | 初版 |
2、业务说明
(1)接口说明
发票邀请查询修改
请求主体类型:application/json
请求方式:POST
3、请求地址
| 环境 | HTTPS请求地址 |
|---|---|
| 测试环境 | https://appdev.ysepay-test.com/openapi/invoice/inviteStatusQuery |
| 正式环境 | https://ysgate.ysepay.com/openapi/invoice/inviteStatusQuery |
4、请求参数说明
4.1、公共请求参数
| 参数 | 类型(长度) | 必填 | 参数说明 |
|---|---|---|---|
| timeStamp | String | Y | 发送请求的时间,格式"yyyy-MM-dd HH:mm:ss" |
| method | String(128) | Y | 接口名称,固定值:invoice.inviteStatusQuery |
| 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 | 错误信息,成功为空,失败返回具体错误描述 |
| items | Object | N | 邀请状态列表,邀请状态明细列表 |
5.2.1.1 items具体参数
| 参数 | 类型(长度) | 必填 | 参数说明 |
|---|---|---|---|
| applyId | String(64) | N | 申请编号,申请编号 |
| merchantId | String(50) | N | 系统内商户号,系统内商户号 |
| merchantName | String(200) | N | 商户名称,商户名称 |
| channelMerchantId | String(50) | N | 子商户号,渠道子商户号 |
| creditCode | String(50) | N | 统一社会信用代码,统一社会信用代码 |
| channel | String(20) | N | 渠道类型,WECHAT-微信,ALIPAY-支付宝 |
| invoiceCapability | Object | N | 开票能力列表,开票能力列表 |
| inviteStatus | String(20) | N | 邀请状态,PENDING-待处理,INVITING-邀请中,ACCEPTED-已接受,FAILED-失败 |
| inviteUrl | String(500) | N | 邀请链接,商户入网邀请链接 |
| failCode | String(50) | N | 失败码,邀请失败时返回错误码 |
| failReason | String(500) | N | 失败原因,邀请失败时返回错误描述 |
| createTime | String(50) | N | 创建时间,创建时间 |
| updateTime | String(50) | N | 更新时间,更新时间 |
5.2.1.1.1 invoiceCapability具体参数
| 参数 | 类型(长度) | 必填 | 参数说明 |
|---|---|---|---|
| ability | String(50) | N | 开票能力,BASIC-基础行业,HOUSING_RENTAL-不动产租赁,FUEL-成品油 |
6、业务响应码 网关公共响应码
| 响应码 | 响应码描述 | 解决方案 |
|---|---|---|
| 00000 | 成功 | 请求处理成功 |
| 40000 | 参数错误 | 请求参数缺失或格式不正确 |
| 40001 | 签名验证不通过 | 请求签名验证失败,请检查签名参数 |
| 40002 | 商户号有误 | 请检查商户号是否真实存在 |
| 40010 | 网关非法参数 | 检查请求参数,修改后重新发起请求 |
| 40011 | 前置系统参数验证错误 | 检查请求参数,修改后重新发起请求 |
| 50000 | 系统异常 | 系统内部异常,请稍后重试 |
| 50001 | 失败 | 请求处理失败 |
| 50002 | 交易超时 | 请求处理超时,请稍后查询确认结果 |
| 50003 | 业务失败 | 参看具体错误描述 |
| 50004 | 商户无权限 | 商户未开通该功能或无操作权限 |
| 50005 | 资源不存在 | 请求的资源不存在 |
| 50700 | 商户号与申请编号不能同时为空 | merchantId和applyId至少传入一个 |
| 50701 | 查询结果为空 | 未找到符合条件的邀请记录 |
| 50702 | 申请编号有误 | 请检查申请编号是否正确 |