订单退款接口

功能概述

提交退款申请接口用于商户端通过应用接口程序，实现提交退款申请的业务处理，首信易支付平台通过 JSON 格式方式返回退款申请提交的结果响应。其操作功能与现有首信易支付商户后台输入退款申请功能相同。

接口地址

https://apis.5upay.com/icc/refund

参数名称 参数中文名称 类型& 长度 参数说明 是否必填
merchantId 商户编号 varchar(9) 商户在首信易系统的唯一身份标识，商户完成首信易系统注册后可登录商户后台商户服务查看。 M
orderRequestId 订单号 varchar(80) 该参数格式为：订单生成日期-商户编号-商户流水号。例如：20170101-888-12345。商户流水号为数字，每日内不可重复，并且不能包括除数字、英文字母和“-”外以其它字符。流水号可为一组也可以用“-”间隔成几组 M
requestId 退款请求号 varchar(50) 商户自定义退款请求号，不能重复 M
amount 退款金额 decimal(18) 以元为单位，保留 2 位小数,例如10.00 M
notifyUrl 通知地址 varchar(200) 服务器通知：退款请求发送成功后会向该地址发送五次成功通知，该地址可以带参数，如:“https://www.5upay.com/callback.action?test=test”.注意：如不填 notifyUrl 的参数值退款成功后您的服务器将得不到退款成功的通知。 M
remark 备注 varchar(300) 备注 O
hmac 参数签名 varchar(500) 商户生成的参数签名结果，获取hmac的方法请参考请求加密流程 M

参数示例

{ "merchantId": "888", "orderRequestId": "20190813-888-12345", "requestId ": "12345", "amount": "1.00", "remark": "备注", "notifyUrl": "http://qa.ehking.com/sdk/onlinepay/refundNotify", "hmac":' af291df5d288690d2b7d7bcff7dc5a74447ce1502c1edcc9293051bb6a517d68 6fbb31de72bfd14938d474fa6dd0afb82a2c222a6a345e41683d456a142e3376 c5c8f07dc5bc92dd5b09af316fa478a003189ed4d4c956d33162de11a8aec8ab 6abcf66b19833302780cffaa25c7e40bb9b2ccc59adc44e3fcb4632bce5d9cf9" }

响应参数列表

注意：当响应处理正常即 status 参数值为 SUCCESS 的情况下，报文才包括商户编号、订单编号等信息。

参数名称 参数中文名称 参数说明
status 响应状态 响应正常 SUCCESS
响应异常 ERROR
merchantId 商户编号 商户在首信易系统的唯一身份标识，商户完成首信易系统注册后可登录商户后台商户服务查看。
orderRequestId 订单号 同请求参数
requestId 退款请求号 同请求参数
bankNumber 退款银行订单号 退款银行订单号
refundId 退款流水 首信易退款流水号
amount 退款金额 退款金额
currency 退款币种 CNY 为人民币，USD 为美元，EUR 为欧元，GBP 为英镑，JPY 为日元，KRW 为韩元， RUB 为卢布，CHF 为瑞士法郎，HKD 为港币，SGD 为新加坡元，MOP 为澳门元，CAD 为加元，NZD 为新西兰元，TWD 为新台币，AUD 为澳大利亚元
refundSubmissionTime 退款提交时间 退款提交时间,格式：yyyy-MM-dd HH:mm:ss
remark 备注 同请求参数
hmac 参数签名 商户生成的参数签名结果，获取hmac的方法请参考请求加密流程

参数示例

{ "status": " SUCCESS ", "merchantId": "888", " orderRequestId ": "20190813-888-12345", "requestId": "12345", "bankNumber": "1234567", "refundId": "34565", "amount": "1.00", "currency": "CNY", "refundSubmissionTime": "2019-08-13 21:30:02", "remark": "test", "hmac": " af291df5d288690d2b7d7bcff7dc5a74447ce1502c1edcc9293051bb6a517d68 6fbb31de72bfd14938d474fa6dd0afb82a2c222a6a345e41683d456a142e3376 c5c8f07dc5bc92dd5b09af316fa478a003189ed4d4c956d33162de11a8aec8ab 6abcf66b19833302780cffaa25c7e40bb9b2ccc59adc44e3fcb4632bce5d9cf9" }

异步通知参数列表

注意：此表格的参数为 NotifyUrl 的服务器返回参数

参数名称 参数中文名称 参数说明
merchantId 商户编号 商户在首信易系统的唯一身份标识，商户完成首信易系统注册后可登录商户后台商户服务查看。
orderRequestId 订单号 同请求参数
requestId 退款请求号 同请求参数
refundId 退款流水 首信易退款流水号
bankNumber 退款银行订单号 退款银行订单号
refundStatus 退款状态 成功 SUCCESS
失败 FAILED
amount 退款金额 商户提交的退款金额
currency 退款币种 CNY 为人民币，USD 为美元，EUR 为欧元，GBP 为英镑，JPY 为日元，KRW 为韩元， RUB 为卢布，CHF 为瑞士法郎，HKD 为港币，SGD 为新加坡元，MOP 为澳门元，CAD 为加元，NZD 为新西兰元，TWD 为新台币，AUD 为澳大利亚元
refundSubmissionTime 退款提交时间 格式：yyyy-MM-dd HH:mm:ss
refundCompleteTime 退款完成时间 格式：yyyy-MM-dd HH:mm:ss
remark 备注 同请求参数
hmac 参数签名 商户生成的参数签名结果，获取hmac的方法请参考请求加密流程

参数示例

{ "merchantId": "888", "orderRequestId": "20190813-888-123456", "requestId": "12345", "refundId": "816290053119947", "bankNumber": "3456789098", "refundStatus": "SUCCESS", "amount": "1.00", "currency": "CNY", "refundSubmissionTime": "2019-08-13 01:12:30", "refundCompleteTime": "2019-08-13 01:12:31", "remark": "test", "hmac": " af291df5d288690d2b7d7bcff7dc5a74447ce1502c1edcc9293051bb6a517d68 6fbb31de72bfd14938d474fa6dd0afb82a2c222a6a345e41683d456a142e3376 c5c8f07dc5bc92dd5b09af316fa478a003189ed4d4c956d33162de11a8aec8ab 6abcf66b19833302780cffaa25c7e40bb9b2ccc59adc44e3fcb4632bce5d9cf9" }