按退款日期查询退款API
请求地址
生产环境
https://merchserv.netpay.cmbchina.com/merchserv/BaseHttp.dll?QueryRefundByDate
测试环境
http://paytest.cmburl.cn:801/netpayment_directlink_nosession/BaseHttp.dll?QueryRefundByDate
请求报文
报文的参数名:jsonRequestData,参数值JSON格式见下表
参数名称 | JSON键值 | 类型(长度) | 必填 | 描述 | 示例 |
接口版本号 | version | String(3) | M | 固定为”1.0” | 1.0 |
参数编码 | charset | String(8) | M | 固定为“UTF-8” | UTF-8 |
报文签名 | sign | String | M | 对reqData内的数据进行签名 | |
签名算法 | signType | String | M | 固定为“SHA-256” | SHA-256 |
请求数据 | reqData | ||||
请求时间 | dateTime | String(14) | M | 商户发起该请求的当前时间,精确到秒 格式:yyyyMMddHHmmss | 20160623120100 |
分行号 | branchNo | String(4) | M | 商户分行号,4位数字 | 0755 |
商户号 | merchantNo | String(6) | M | 商户号,6位数字 | 000054 |
开始日期 | beginDate | String(8) | M | 格式:yyyyMMdd | 20160624 |
结束日期 | endDate | String(8) | M | 20160625 | 9999 |
操作员号 | operatorNo | String | O | 商户结账系统的操作员号 | 9999 |
续传键值 | nextKeyValue | String(40) | C | 长度只能为0或40; 首次查询填“空”; 后续查询,按应答报文中返回的nextKeyValue值原样传入。 | HH00012016050309493316250308400000000010 |
请求示例
1.json报文组织:
{ "version":"1.0", "charset":"UTF-8", "sign":"见签名处理章节", "signType":"SHA-256", "reqData":{ "dateTime":"20160806134824", "branchNo":"0755", "merchantNo":"000054", "beginDate":"20160805", "endDate":"20160805", "operatorNo":"9999", "nextKeyValue":"" } }
2.表单组织:
<form action="请求地址" method="post" > <input type="hidden" name="jsonRequestData" value='以上json字符串' /> <input type="hidden" name="charset" value='utf-8' /> </form>
3.待签名字符串示例(未包含支付密钥):
beginDate=20160805&branchNo=0755&dateTime=20160806134824&endDate=20160805&merchantNo=000054&nextKeyValue=&operatorNo=9999
响应报文
参数名称 | JSON键值 | 类型(长度) | 必填 | 描述 | 示例 |
接口版本号 | version | String(3) | M | 固定为”1.0” | 1.0 |
参数编码 | charset | String(8) | M | 固定为“UTF-8” | UTF-8 |
应答数据 | rsqData | ||||
处理结果 | rspCode | String | M | SUC0000:请求处理成功(不能仅通过该字段判断退款成功) 其他:请求处理失败 | SUC0000 |
详细信息 | rspMsg | String | C | 请求处理失败时返回错误信息 | |
响应时间 | dateTime | String(14) | M | 银行返回该数据的时间。 格式:yyyyMMddHHmmss | 20160624121212 |
续传标志 | hasNext | String(1) | M | Y:有续传(还有更多记录); N:无续传(记录已返回完毕)。 | Y |
续传键值 | nextKeyValue | String(40) | C | 当hasNext=Y时必传。 | |
返回条数 | dataCount | String | M | 本次查询返回条数。 | 200 |
记录数据 | dataList | String | 每笔记录一行,每行以\r\n 结束。第一行为表头;从第二行起为数据记录;各参数以逗号和`符号分隔(`为标准键盘1 左边键的字符),字段顺序与表头一致。数据记录定义如下: | "branchNo,`merchantNo,`date\r\n 0755,`000054,`20160624" | |
分行号 | branchNo | String(4) | M | 商户分行号,4位数字 | 0755 |
商户号 | merchantNo | String(6) | M | 商户号,6位数字 | 000054 |
订单日期 | date | String(8) | M | 商户的订单日期,格式:yyyyMMdd | 20160624 |
订单号 | orderNo | String(32) | M | 商户的订单号 | 9999000001 |
银行订单流水号 | bankSerialNo | String(20) | M | 银行的订单流水号 | 16250327200000000020 |
订单参考号 | orderRefNo | String(32) | O | 订单参考号 | |
银行退款流水号 | refundSerialNo | String(20) | M | 银行退款流水号 | 16280587500000000020 |
退款状态 | orderStatus | String(3) | M | 210:已直接退款 219:直接退款已受理 240:已授权退款 249:授权退款已受理 999:退款失败 | 210 |
币种 | currency | String(2) | M | 固定为:“10” | 10 |
退款金额 | amount | String | M | 格式:xxxx.xx | 0.01 |
费用金额 | fee | String | M | 格式:xxxx.xx | 0.01 |
退款说明 | refundDesc | String | O | ||
银行受理日期 | bankDate | String(8) | M | 格式:yyyyMMdd | 20160624 |
银行受理时间 | bankTime | String(6) | M | 格式:HHmmss | 121201 |
实际退款金额 | settleAmount | String | M | 格式:xxxx.xx | 0.01 |
退回优惠金额 | discountAmount | String | M | 格式:xxxx.xx | 0.01 |
提示:
1)对于通过调用接口发起的退款,收到报文中rspCode=‘SUC0000’且orderStatus=‘210’,代表该笔退款处理成功且已经到账。
响应示例
1.正常json报文组织:
{ "version":"1.0", "charset":"gbk", "rsqData":{ "rspCode":"SUC0000", "rspMsg":"", "dateTime":"20160825144658", "hasNext":"N", "nextKeyValue":"HH00012016080508381016280587500000000010", "dataCount":"2", "dataList":"branchNo,`merchantNo,`date,`orderNo,`bankSerialNo,`orderRefNo,`refundSerialNo,`orderStatus,`currency,`amount,`fee,`refundDesc,`bankDate,`bankTime\r\n0755,`000054,`20160804,`9999000003,`16280481900000000010,`,`16280535600000000010,`210,`10,`30.00,`3.00,`,`20160805,`083849\r\n0755,`000054,`20160804,`9999000005,`16280418800000000010,`,`16280587500000000010,`210,`10,`61.00,`6.10,`,`20160805,`083810" } }
2.异常jason报文组织
{ "version":"1.0", "charset":"UTF-8", "rsqData":{ "rspCode":"MSS1068", "rspMsg":"NP1068.结束日期格式错误" } }
错误码
错误码 | 描述 | 解决方案 |
MSS9900 | 请求数据Json转换异常 | 校验并修改请求报文数据 |
MSS3411 | 签名错误 | 验证签名是否正确,请参考签名示例 |
MSS3107 | 无效续传键值 | 续传键值长度不超过40位,初始不用填,续传填上一返回报文续传键值 |
MSS9901 | 编码格式错误 | 请校验编码是否为UTF-8 |
MSS3809 | 查询失败 | 直连系统连接主机失败,稍后再试 |
MSS0008 | 超过最大并行请求处理数限制 | 直连系统业务繁忙,稍后再试 |
MSS1016 | 分行号格式错误 | 分行号格式应为4位数字 |
MSS1017 | 商户号格式错误 | 操作员格式应为6位数字 |
MSS1019 | 操作员格式错误 | 操作员格式应为4位数字 |
MSS1022 | 订单日期或者时间格式错误 | 日期应为yyyyMMdd格式,时间应为yyyyMMddHHmmss格式 |
MSS1025 | 日期对格式错误 | 起始日期应小于结束日期 |
MSS8011 | 主机无此商户定义 | 检查商户号、分行号是否正确 |