实名认证查询接口
1.修订记录
修订 | 日期 | 说明 | 作者 |
---|---|---|---|
V0.1 | 2016/11/29 | 新接口参数定义 | 莫尚校 |
V0.2 | 2018/05/25 | 补充shopdate参数 | 黄国强 |
V0.3 | 2020/11/11 | 修改ACQ_QUERY_NO_RECORD的说明 | 汤吉齐 |
V0.4 | 2021/01/21 | 修改ACQ_QUERY_NO_RECORD的描述 | 王晶 |
V0.5 | 2021/12/27 | 支持国密 | 王晶 |
2.接口说明
(1)场景说明
1、调用接口进行实名认证查询
(2)接口说明
1、实名认证查询接口
3.请求地址
环境 | HTTPS请求地址 |
---|---|
正式环境 | https://openapi.ysepay.com/gateway.do |
4.请求参数说明
4.1 公共请求参数
参数 | 类型(字节长度) | 必填 | 参数说明 |
---|---|---|---|
method | String(1,128) | Y | 接口名称 固定值 ysepay.authenticate.four.key.element.query |
partner_id | String(1,20) | Y | 在银盛支付开设的服务商商户号,请联系客户经理提供 |
timestamp | String(1,19) | Y | 发送请求的时间,格式"yyyy-MM-dd HH:mm:ss" 示例值:2014-07-24 03:07:50 |
charset | String(1,10) | Y | 商户网站使用的编码格式,如UTF-8、GBK、GB2312等,默认值 GBK |
sign_type | String(1,10) | Y | 报文签名算法,RSA/SM |
sign | String(1,256) | Y | 签名字符串,再用Base64编码 |
version | String(1,3) | Y | 接口版本3.0 当前版本:3.0 |
biz_content | String | Y | 业务请求参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递 |
4.2 业务请求参数
参数名biz_content,值为一个json格式对象,下面列表描述json对象的值
参数 | 类型(字节长度) | 必填 | 参数说明 |
---|---|---|---|
trade_no | String(1,30) | C | 银盛平台交易流水号(实名认证),trade_no与out_trade_no 不能同时为空, 示例值:507161129207266509 |
out_trade_no | String(1,32) | C | 商户系统生成的订单号(实名认证),生成规则前8位必须为交易日期,如20180525,范围跨度支持包含当天在内的前后一天,且只能由大小写英文字母、数字、下划线及横杠组成 示例值:201805256843192280647118 |
shopdate | String(8,8) | Y | 商户系统的交易发生日期格式yyyyMMdd 示例值:20180525 |
5.响应参数说明
银盛支付对商户的请求数据处理完成后,会将处理的结果数据同步回执给商户。
请注意:银盛后期会对返回参数保留扩展的权力,扩展方式为新增参数但不会删除参数,请商户在解析银盛返回参数时要支持银盛可能扩展参数这种情况。
5.1 公共响应参数
参数 | 类型(字节长度) | 必填 | 参数说明 |
---|---|---|---|
sign | String | Y | 签名字符串,Base64编码 |
ysepay_authenticate_four_key_element_query_response | String | Y | 业务响应参数的集合,最大长度不限 |
5.2 业务响应参数
参数 | 类型(字节长度) | 必填 | 参数说明 | |
---|---|---|---|---|
code | String | Y | 响应代码 | |
msg | String | Y | 响应代码描述 | |
trade_no | String(1,30) | Y | 银盛支付交易流水号 | |
out_trade_no | String(1,32) | Y | 商户系统生成的订单号 | |
order_status | String(32) | Y | 实名认证订单状态值:SUCCESS\ | FAILURE 示例值:附录8.2 |
order_status_description | String(256) | N | 订单状态描述,当order_status_description 为FAILURE\ | TRADE_FAILURE 时,该字段是实名认证失败原因描述或银盛已受理后处理过程中出现的异常原因描述。该参数最长为128个汉字。 |
account_date | String(1,10) | N | 会计日期:日账单格式为yyyyMMdd 示例值:20160413 | |
fee | Number(15) | N | 参考手续费,单位为:RMB Yuan。取值范围为[0.01,100000000.00],精确到小数点后两位。 |
6.样例
无
7.附录
7.1 实名认证查询错误码
错误码 | 错误描述 | 解决方案 |
---|---|---|
ACQ.INVALID_PARAMETER | 参数无效 | 检查请求参数,修改后重新发起请求 |
ACQ.PARAM_ERROR | 参数错误 | 检查请求参数,修改后重新发起请求 |
ACQ.RISK_ERROR | 风控检查异常 | 请检查风控是否有异常,然后再重新发起 |
ACQ.SYSTEM_BUSY | 系统繁忙 | 请稍后再试,如还有问题,请联系银盛 |
ACQ.QUERY_NO_RECORD | 暂未查询到交易,请检查订单号/流水号后重试 | 该状态为未知状态,请勿当成失败状态处理 检查传入的订单号是否正确,修改后重新发起请求或继续查询 |
7.2 实名认证状态
枚举名称 | 枚举说明 |
---|---|
SUCCESS | 实名认证成功 |
FAILURE | 实名认证失败 |
TRADE_FAILURE | 认证交易失败 |
HASBEEN_ACCEPTED | 实名认证银盛已受理 |