退款API(旧)
请求地址
生产环境
https://merchserv.netpay.cmbchina.com/merchserv/BaseHttp.dll?DoRefund
测试环境
http://121.15.180.66:801//netpayment_directlink_nosession/BaseHttp.dll?DoRefund
请求报文
报文的参数名:jsonRequestData,参数值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 |
date | String(8) | M | 商户订单日期,支付时的订单日期 格式:yyyyMMdd | 20160624 |
orderNo | String(32) | M | 商户订单号,支付时的订单号 | 9999000001 |
refundSerialNo | String(20) | O | 退款流水号,商户生成,同一笔订单内,同一退款流水号只能退款一次。可用于防重复退款。 | |
amount | String(14) | M | 退款金额,格式xxxx.xx | 0.01 |
desc | String(100) | O | 退款描述 | |
operatorNo | String | O | 商户结账系统的操作员号,选填,若填了则会对操作员号和密码进行校验,若不填则不校验。 | 9999 |
encrypType | String | O | 操作员密码加密算法,RC4:使用RC4算法对操作员密码进行加密,加密密钥为支付密钥。DES:使用DES算法对操作员密码进行加密,加密密钥为商户支付密钥的前8位,不足8位则右补0。空:默认不加密; | |
pwd | String | O | 操作员登录密码。使用encrypType算法加密后的密码 注意:加密后的密文必须转换为16进制字符串表示 | BF6DC5D23519 |
注意:
1. 交易时间超过一年的订单无法提交退款。
2. 支付退款支持单笔交易分多次退款,多次退款需要提交原支付订单的商户订单号,并设置不同的退款流水号。申请退款总金额不能超过订单金额。 一笔退款失败后重新提交,请不要更换退款流水号,请使用原商户退款流水号。
请求示例
1.json报文组织:
{ "version":"1.0", "charset":"UTF-8", "sign":"见签名处理章节", "signType":"SHA-256", "reqData": { "dateTime":"20160806150213", "branchNo":"0755", "merchantNo":"000054", "date":"20160629", "orderNo":"9999000042", "amount":"0.01", "desc":"", "refundSerialNo":"201606250000001", "operatorNo":"9999", "encrypType":"RC4", "pwd":"BF6DC5D23519" } }
2.表单组织:
<form action="请求地址" method="post"> <input type="hidden" name="jsonRequestData" value='以上json字符串' /> <input type="hidden" name="charset" value=’utf-8’ /> </form>
3.待签名字符串示例(未包含支付密钥):
amount=0.01&branchNo=0755&date=20160629&dateTime=20160806150213&desc=&encrypType=RC4&merchantNo=000054&operatorNo=9999&orderNo=9999000042&pwd=BF6DC5D23519&refundSerialNo=201606250000001
响应报文
参数 | 类型(长度) | 必填 | 描述 | 示例 |
version | String(3) | M | 接口版本号,固定为“1.0” | 1.0 |
charset | String(8) | M | 参数编码,固定为“UTF-8” | UTF-8 |
rspData | 请求数据 | |||
rspCode | String | M | 处理结果,SUC0000:请求处理成功 其他:请求处理失败 | SUC0000 |
rspMsg | String | M | 详细信息,请求处理失败时返回错误描述 | |
dateTime | String(14) | M | 响应时间,银行返回该数据的时间 格式:yyyyMMddHHmmss | 20160624121212 |
bankSerialNo | String(20) | M | 银行的退款流水号 | 16280672300000000010 |
currency | String(2) | M | 退款币种,固定为:“10” | 10 |
amount | String | M | 退款金额,格式:xxxx.xx | 0.01 |
refundRefNo | String | O | 银行的退款参考号 | 608061000002 |
bankDate | String(8) | M | 退款受理日期 格式:yyyyMMdd | 20160624 |
bankTime | String(6) | M | 退款受理时间 格式:HHmmss | 121201 |
refundSerialNo | String | M | 商户上送流水号 | 123456789 |
settleAmount | String | M | 实际退款金额,格式:xxxx.xx | 0.01 |
discountAmount | String | M | 退回优惠金额,格式:xxxx.xx | 0.01 |
注意:
1. 如果因为异常原因没有收到同步响应报文,请调用退款查询API确认退款状态。
响应示例
1.正常json报文组织:
{ "version":"1.0", "charset":"UTF-8", "rspData":{ "rspCode":"SUC0000", "rspMsg":"", "dateTime":"20160806150217", "bankSerialNo":"16280672300000000010", "currency":"10", "amount":"0.01", "refundRefNo":"608061000002", "bankDate":"20160806", "bankTime":"150052" “refundSerialNo”:”123456789” “settleAmount”:”0.01” “discountAmount”:”0.01” } }
错误码
错误码 | 描述 | 解决方案 |
MSS3111 | 密码格式错误(空密码或超长) | 明文密码或者密文密码解密后,密码长度不超过16位 |
MSS3112 | 解密失败 | 服务器解密失败,请检查密文密码是否正确 |
MSS3113 | 无效加密类型 | 只支持RC4/DES加密 |
MSS3804 | 直连退款异常 | 直连系统连接主机失败,请调用查询接口确认退款结果 |
MSS3414 | 描述内容超长 | 长度不超过100位 |
MSS3202 | 重复的直连退款请求,拒绝处理 | 请勿重复提交 |
MSS1016 | 分行号格式错误 | 分行号格式应为4位数字 |
MSS1017 | 商户号格式错误 | 商户号格式应为6位数字 |
MSS1019 | 操作员格式错误 | 操作员格式应为4位数字 |
MSS1020 | 金额格式错误 | 金额格式应xxxx.xx |
MSS1021 | 订单号格式错误 | 订单号格式应为6位/10位数字 |
MSS1022 | 订单日期或者时间格式错误 | 日期应为yyyyMMdd格式, 时间应为yyyyMMddHHmmss格式 |
MSS8011 | 主机无此商户定义 | 检查商户号、分行号是否正确 |