功能说明

对已经完成的交易订单发起退款申请

 

 

接口HOST地址

取决于您原力支付服务部署所在的主机网络地址.
请注意确保防火墙设置已经允许通过该网络地址端口进行访问.
如果要修改此接口地址请通过<原力支付控制台>-<系统设置>进行设置

接口Action路径: /refund

请求方法: GET方法

请求参数

MerchantID	必填,最大长度12,字符串格式,大小写敏感. 商户的标识,标识了该交易订单的所属商家. 更多商户标识可以在控制台<获得产品支付入口>中查看.
TradeNo	必填,最大长度18,字符串格式,大小写敏感 要进行退款的交易唯一标识,此唯一标识是通过交易成功回调返回的,也可以在控制台查找到
TradeToken	必填,最大长度32,字符串格式. 要进行退款的交易的凭据,此凭据是通过交易成功回调返回的,也可以再控制台查找到 此凭据即支付宝微信的交易流水单号
RefundNo	必填,最大长度18,字符串格式,大小写敏感 退款的标识,可根据时间戳规则生成此标识并且保证此标识的唯一性. 例如:R20190429161256258
RefundAmount	必填,浮点型,精确保留2位小数 退款的资金额度,人民币元为单位,如1.00元,最小退款额度为0.10
RefundReason	必填,最大长度60,字符串格式, 退款的原因描述
RefundTimestamp	必填,最大长度18,字符串格式,大小写敏感 退款请求的时间戳,应通过当前时间进行生成,格式为YYYYMMDDHHMMSS 例如:20190429161256,支付系统会验证这个时间戳误差不能超出10分钟
RefundCustomParam	必填,最大长度500,字符串格式. 交易的自定义数据,您可以在这个参数中保存您的业务参数. 如果您设置了退款完成时使用HTTP联动通知,则此参数会在 HTTP联动通知回调中进行回传,请用URLENCODE对此参数编码, 否则可能会造成此参数的意外截断.
RefundSignMode	必填,字符串格式 此退款请求的签名模式,支持的签名模式有如下: MD5 --使用MD5进行简单签名 RSA_SHA256 --使用基于RSA非对称加密的SHA256签名算法,非常安全
RefundSignature	必填,字符串格式 此退款请求的数据安全签名,请根据安全签名格式说明进行计算设置

应答参数

通过JSON格式返回请求结果参数:
Result --指示了此次操作结果是否成功
ResultDesc--指示了此次操作结果详细说明

以下是请求成功返回的参数:
MerchantID--返回了退款操作对应的商户标识
RefundNo --返回了退款唯一标识
TTradeNo --返回了退款对应的交易唯一标识

应答状态

成功返回200,失败返回对应错误码与错误描述

备注

为了保证资金安全,请求交易退款API接口需要对请求数据进行安全签名,安全签名可分为MD5,RSA_SHA256两种方式.
安全签名实现方法请参阅<安全签名算法说明>.您也可以直接使用ForcePaySDK来生成安全签名.

原力支付系统控制台可以开启或关闭交易退款API接口,可以指定该接口的验签算法以及限制调用的来源IP地址.
在使用RSA_SHA256进行安全签名时,会用到商户私钥数据,此私钥数据需要先从控制台进行导出.