终端交易流水查询
1、修订记录
| 修订记录 | 日期 | 说明 |
|---|---|---|
| 1.0 | 2023.03.03 | 初版 |
2、业务说明
(1)接口说明
支持根据商户号、交易参考号、交易日期查询pos终端发起的交易信息。每笔交易限制查询间隔时间为3秒。
请求主体类型:application/json
请求方式:POST
3、请求地址
| 环境 | HTTPS请求地址 |
|---|---|
| 测试环境 | https://appdev.ysepay.com/openapi/posTrade/queryHpstjnl |
| 正式环境 | https://ysgate.ysepay.com/openapi/posTrade/queryHpstjnl |
4、请求参数说明
4.1、公共请求参数
| 参数 | 类型(长度) | 必填 | 参数说明 |
|---|---|---|---|
| timeStamp | String | Y | 发送请求的时间,格式"yyyy-MM-dd HH:mm:ss" |
| method | String(128) | Y | 接口名称,固定值:posTrade.queryHpstjnl |
| 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数据明文字符串)
| 参数 | 类型(长度) | 必填 | 参数说明 |
|---|---|---|---|
| t42MercId | String(20) | Y | 商户号,由银盛支付生成并下发 |
| logNo | String(12) | Y | 交易参考号 |
| acDt | String(8) | Y | 会计日期,格式yyyyMMdd |
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数据)
| 参数 | 类型(长度) | 必填 | 参数说明 |
|---|---|---|---|
| state | String | N | 交易状态 错误码成功时响应,00:查询成功 02:未查询到交易信息 99 |ZA|ZB|ZC|ZD|ZZ 失败#具体的交易状态见订单详情中的txnSts |
| reqMsgId | String | N | 请求流水号 |
| tradeInfo | Object | N | 订单详细信息,code为0000时返回 |
5.2.1 tradeInfo具体参数
| 参数 | 类型(长度) | 必填 | 参数说明 |
|---|---|---|---|
| orderId | String | N | 商户订单号 |
| logNo | String | N | 流水号,交易的唯⼀标识码 |
| txnTyp | String | N | 交易类型,N:正常交易 C:被冲正交易 D:被撤销交易 |
| txnCd | String | N | 交易码,2010020:消费 1300001:聚合支付 |
| txnTm | String | N | 交易时间,格式yyyyMMddHHmms |
| msgCd | String | N | 响应码 |
| ologNo | String | N | 原交易流水号,原交易流水号 |
| refAmt | String | N | 已退货金额,单位:分 |
| orgNo | String | N | 机构号 |
| crdFlg | String | N | 卡类型,00: 借记卡 01:贷记卡 02:准贷记卡 |
| t2CrdNo | String | N | 卡号,卡号 |
| t42MercId | String | N | 商户号 |
| t4TxnAmt | String | N | 交易金额,单位:分 |
| t49Ccy | String | N | 币种,示例值:156(人名币) |
| t41TrmNo | String | N | 终端号 |
| t37SrefNo | String | N | 系统参考号 |
| mercFeeAmt | String | N | 手续费,单位:分 |
| mercFeeAmtFlg | String | N | 手续费计算标志,0:未计算 1:正在计算 2:计算完成 3:计算完成不收取 |
| txnSts | String | N | 交易状态,S:成功 F:失败 T: 发送超时 |
| t11CseqNo | String | N | 终端流水号 |
| t602TbatNo | String | N | 批次号 |
| z37CorgSrefNo | String | N | 上游交易流水号,上游交易流水号 |
| payType | String | N | 支付方式,支付方式,01 银联云闪付 02 微信 03 支付宝 |
| walletStatus | String | N | ⼊账状态,0-初始、1-进行中、 2-⼊账成功、3-⼊账失败、4-超时 为了解决手续费后面 再次变化加的⼊账状态,以此状态判断 |
| t4DiscountDesc | String | N | 银联营销详情 |
| t4DiscountAmt | String | N | 银联本金营销 |
| remark31 | String | N | 银盛营销备注 |
6、业务响应码 网关公共响应码
| 响应码 | 响应码描述 | 解决方案 |
|---|---|---|
| 0000 | 成功 | |
| 9999 | 失败 | 系统异常,请稍后使用相同的参数继续调用 |
| 5000 | 交易超时 | 业务系统超时,请稍后使用相同的参数继续调用 |
| A029998 | 网关非法参数 | 请根据接口返回的详细信息检查请求参数 |