免密冻结

退款

1. 接口介绍

功能简述:

本接口用于商户对收款成功的交易进行部分退款或全额退款。

约束条件:

1、 原收款交易必须是成功的。
2、 累计退款金额不能大于原收款金额。
3、 交易时间超过一年的订单无法提交退款。

正常流程:

1、 报文合性校验。
2、 报文参数校验。
3、 原交易校验。
4、 执行退款。
5、 同步返回退款结果
6、 异步发送退款结果回调通知

异常流程:

1、 请求源IP不在IP白单中。
2、 报文验签失败。
3、 报文参数非法。
4、 原交易不存在。
5、 累计退款金额大于原收款金额。

2. 请求地址

测试环境URL:

http://mobiletest.cmburl.cn/CmbBank_B2B/UI/NetPay/DoBusiness.ashx

生产环境URL:

https://b2b.cmbchina.com/CmbBank_B2B/UI/NetPay/DoBusiness.ashx

3. 请求报文

请求报文参数类型(长度)必填描述示例
charsetString(8)M编码格式,固定为UTF-8UTF-8
jsonRequestDataStringMjson格式的请求参数,详见jsonRequestData定义

jsonRequestData参数定义

参数名类型(长度)必填描述示例
versionString(3)M固定为1.01.0
signStringM使用商户支付密钥对reqData内的数据进行签名
signTypeStringM固定为SHA-256SHA-256
reqData请求数据


dateTimeString(14)M请求时间,商户发起该请求的时间,精确到秒。
格式:yyyyMMddHHmmss
20160623101430
txCodeStringM交易码,固定为CMTKACMTKA
branchNoString(4)M商户分行号,4位数字0755
merchantNoString(6)M商户号,6位数字002346
merchantSerialNoString(20)M商户退款请求流水号,全局唯一2016062310143088
agrNoString(32)M客户签约的协议号201606238888888
origDateString(8)M原商户冻结交易日期YYYYMMDD20160623
origMerchantSerialNoString(32)M原商户冻结交易订单号2016062310143011
origAmountString(20)M原冻结交易订单金额,以分为单位,如2000表示20.00元1000
amountString(20)M退款金额,以分为单位,如2000表示20.00元100
trnAbsString(50)M简要描述退款原因周年庆优惠
noticeUrlString(100)M结果异步通知URL (地址仅支持http 80端口和https 443端口),用于银行异步发送交易结果http://notice.xxabc.com

请求示例:

json报文组织:

{
    "version":"1.0",
    "sign":"见签名处理章节",
    "signType":"SHA-256",
    "reqData":{
        "dateTime":"20160623101430",
        "txCode":"CMTKA",
        "branchNo":"0755",
        "merchantNo":"002346",
        "merchantSerialNo":"2016062310143088",
        "agrNo":"201606238888888",
        "origDate":"20160623",
        "origMerchantSerialNo":"2016062310143011",
        "origAmount":"1000",
        "amount":"100",
        "trnAbs":"周年庆优惠",
        "noticeUrl":"http://notice.xxabc.com"
    }
}

表单组织:

<form action="请求地址" method="post" >
      <input type="hidden" name="jsonRequestData" value='以上json字符串' /> 
      <input type="hidden" name="charset"  value='UTF-8' />
</form>

待签名字符串(未包含支付密钥):

agrNo=201606238888888&amount=100&branchNo=0755&dateTime=20160623101430&merchantNo=002346&merchantSerialNo=2016062310143088&noticeUrl=http://notice.xxabc.com&orig Amount=1000&origDate=20160623&origMerchantSerialNo=2016062310143011&trnAbs=周年庆优惠&txCode=CMTK

4. 响应报文

参数名类型(长度)必填描述示例
versionString(3)M固定为1.01.0
charsetString(8)M参数编码,固定为UTF-8UTF-8
signStringM报文签名,使用商户支付密钥
对rspData内的数据进行验签

signTypeStringM签名算法,固定为SHA-256SHA-256
rspData应答数据


rspCodeStringM处理结果返回码
SUC0000:退款成功
CMBMB05:业务处理超时,请等待回调通知或稍后查询交易结果
其他:请求处理失败
SUC0000
rspMsgStringM处理结果返回码的描述信息退款成功
dateTimeString(14)M银行响应该请求的时间,格式yyyyMMddHHmmss20160623101430
merchantSerialNoString(32)M商户交易请求流水号,全局唯一2016062310143088
bankSerialNoString(30)M银行处理该请求的流水号(请以异步通知接口或查询接口的返回值为准)2016062310143099
agrNoString(32)M客户签约的协议号201606238888888
CMBMB05业务处理超时不返回以下字段:



amountString(20)M退款金额,以元为单位,如10.01表示10元零1分10.01
settleAmountString(20)M实退金额,以元为单位,如9.99表示9元零99分9.99
discountAmountString(4)M优惠金额,以元为单位,如1.11表示1元零11分1.11
sttl_modeString(1)M

原交易清算类型
A 按订单金额清算
M 按实扣金额清算

A
fee_amtString(20)C手续费金额,以元为单位,如0.01表示零元1分0.01
card_typeString(2)M交易卡类型
02 本行借记卡
03 本行信用卡
08 他行借记卡
09 他行信用卡
02
settleDateString(8)M银行账务日期(YYYYMMDD),用于商户与银行对账20161212

相应示例:

正常json报文组织:

{
    "version":"1.0",
    "charset":"UTF-8",
    "sign":"见签名处理章节",
    "signType":"SHA-256",
    "rspData":{
        "rspCode":"SUC0000",
        "rspMsg":"退款成功",
        "dateTime":"20160623101430",
        "merchantSerialNo":"2016062310143088",
        "bankSerialNo":"2016062310143099",
        "agrNo":"1234567891234568789",
        "amount":"10.01",
        "settleAmount":"9.99",
        "discountAmount":"1.11",
        "settleDate":"20161212",
        "sttl_mode":"A",
        "fee_amt":"0.01",
        "card_type":"02"
        }
}

待验签字符串(未包含支付密钥):

agrNo=1234567891234568789&amount=10.01&bankSerialNo=2016062310143099&card_type=02&dateTime=20160623101430&discountAmount=1.11&fee_amt=0.01&merchantSerialNo=2016062310143088&rspCode=SUC0000&rspMsg=退款成功&settleAmount=9.99&settleDate=20161212&sttl_mode=A

异常json报文组织:

{
    "version":"1.0",
    "charset":"UTF-8",
    "sign":"见签名处理章节",
    "signType":"SHA-256",
    "rspData":{
        "rspCode":"DCB0003",
        "rspMsg":"DCB0003 请求报文JSON格式错误!",
        "txCode":"",
        "dateTime":"20160817141216"
    }
}

待验签字符串(未包含支付密钥):

dateTime=20160817141537&rspCode=DCB0003&rspMsg=DCB0003 请求报文JSON格式错误!&txCode=

5. 错误码

错误码错误描述解决方案
CMBMB82交易金额不能小于或等于0请检查交易金额,最低退款0.01元。
CMBMB97请求参数错误根据提示信息中括号里的内容,修改请求参数。
如:请求参数错误(商户交易日期),
检查”商户交易日期”字段的内容是否正确
DCB0001DCB0001 贵方发送错误报文数
太多,已被限制访问!

异常操作错误太多,请根据之前的错误反馈
进行更改,限制将在一定时间后自动解除
DCB0002DCB0002 请求报文数据不能为空!输入参数jsonRequestData拼写正确,并且值非空
DCB0003DCB0003 请求报文JSON格式错误!输入参数jsonRequestData为合法的JSON格式
DCB0004DCB0004 请求报文数据有误;
请求报文长度过长
缩短输入参数jsonRequestData内容
DCB0004DCB0004 请求报文数据有误:……错误消息有以下这些情况,请根据对应提示修改。
接口版本号version值不正确
参数编码charset值不正确
签名sign不能为空
签名算法signType值不正确
请求数据reqData不能为空
时间戳dateTime位数超长或者为0
时间戳dateTime不能为空
交易功能码txCode位数超长或者为0
交易功能码txCode不能为空
商户号merchantNo位数超长或者为0
商户号merchantNo不能为空
分行号branchNo位数超长或者为0
分行号branchNo不能为空
商户流水号merchantSerialNo位数超长或者为0
商户流水号merchantSerialNo不能为空
客户协议号agrNo位数超长或者为0
客户协议号agrNo不能为空
DCB0005DCB0005 商户未开通接入平台功能;
商户号:……
商户号需要开通接入平台功能
DCB0006DCB0006 源IP地址不在商户IP白名单中;
商户号:…;IP地址:…
商户需要提供IP添加到白名单中
DCB0007DCB0007 调用功能不可用;
调用功能代码:……
调用的功能不支持,请输入支持的功能代码
DCB0008DCB0008 签名验证失败:……错误消息有以下情况,请根据对应提示修改。
签名时间戳格式不正确!
签名时间错误,签名已经失效。
验签异常:……
DCB0010DCB0010 获取商户密钥失败;商户号:……商户未正确开通接入平台功能,请按正规流程进行登记开通
DCB0017DCB0017 与业务系统的通讯失败:……错误消息有以下情况,请稍后再试
[MIDServerComNP]业务系统繁忙
[MIDServerComNP]连接业务服务器失败:…
[MIDServerComNP]接收业务系统通讯报文头失败
[MIDServerComNP]接收业务系统通讯报文头非法
[MIDServerComNP]接收业务系统通讯报文包体长度不正确.[…]
[MIDServerComNP]与业务系统通讯异常:…
DCB0018DCB0018 与业务系统的通讯异常:……错误消息有以下情况,请联系招行相关技术支持人员。
解析中间业务平台返回报文失败
DCB0019DCB0019 企业网银签名异常:……请联系招行相关技术支持人员
DCB0020DCB0020 服务器繁忙,请稍后再试。当前服务器负载达到上限,请稍后再试。
DCB0021DCB0021 解析返回报文失败请联系招行相关技术支持人员

6. FAQ