订单退款

功能概述

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

接口地址

https://apis.geoswift.com/cp/refund

参数名称 参数中文名称 类型& 长度 参数说明 是否必填
merchantId 商户编号 varchar(9) 商户编号 M
partnerId 服务商ID varchar(9) 服务商编号 C
requestId 订单号 varchar(50) 提交的订单号必须在自身账户交易中唯一;不能重复提交，商户自行拟定 M
refundAmount 金额 varchar(18) 当退款币种为JPY、KRW、VND时,退款金额以元为单位,其他币种以分单位,1元=100分 M
orderId 原订单流水号 varchar(32) 商户订单号在汇元通所对应的订单流水标识(支付完成后的serialNumber) M
notifyUrl 通知地址 varchar(200) 服务器通知：退款成功后会向该地址发送成功通知，该地址可以带参数，如: “https://www.geoswift.com/callback.action?test=test”. 注意：如不填 notifyUrl 的参数值退款成功后您的服务器将得不到退款成功的通知。 M
remark 备注 varchar(300) 商户在汇元通为订单进行备注，通过支付结果返回商户 O
hmac 参数签名 varchar(500) 商户生成的参数签名结果，获取hmac的方法请参考请求加密流程 M

以上参数值中不能包含以下特殊字符’”&<>()

参数示例

{ "requestId": "1624330715201", "refundAmount": "3", "remark": "1", "orderId": "2c9980727a2c6c68017a2dcb60c90082", "notifyUrl": "https://dev-sdk.ehking.com/onlinepay/notify_V3", "merchantId": "G90008005", "hmac": "QyhAtQMiAN7OaYAOnDW/9UsomenrLu8y/uT/a47MPqMxy7BfCS2JmgrnwoX7lqO3DDhHuhCHs5McN 9g5AS5wQiV0MCRdFk7cYRLyU8ljoSbnqUSQkgW9oDK94r9jrYpzd554ViZ2Ggy2VLGrJSGvbSosLBbThQ1xpJX b/v+KSwRUJPPsEFaeYyhkIz+bGZQovl53keZkeg4nTKm2rI3vUl9Rb2CIjgDMqm+/m862faPtWMvd5tDtb+zH2 l0LyGUuFwiSWVw5GymLMWaQKpKltscuOuR6zCXKpvK8fRkD6jsvmvUhElZC++gFNkylLb6BuQaP7OYZ9G1ycCy 2fOZ5zw==" }

退款请求同步返回参数列表

参数名称 参数中文名称 参数说明
merchantId 商户编号 商户编号
partnerId 服务商ID 服务商编号
requestId 退款订单号 退款订单号
serialNumber 退款流水号 汇元通系统退款流水号
bankRequestNumber 真实银行流水号 请求银行流水号
amount 退款金额 退款金额,当退款币种为JPY、KRW、VND时,退款金额以元为单位,其他币种以分单位，1元=100分
currency 退款币种 见货币列表
status 状态 成功SUCCESS(此成功状态为提交请求至汇元通成功而不是退款成功)
失败FAILED
错误ERROR
remark 备注 备注
errorMessage 错误信息 错误信息
hmac 参数签名 汇元通生成的参数签名结果，验签过程请参考解密流程

参数示例

{ "amount": "1", "currency": "CNY", "merchantId": "G90008005", "remark": "", "requestId": "1624272050465", "serialNumber": "2c9980727a2e129e017a2e2919500007", "status": "SUCCESS", "hmac": "aWXYpj+00QH3hWq4G6nw1s1DcqHU68leHgEMNX5pWqaervKNwvFepp//+qA1X5yJj9wkZGIzPBPZ3M 6RHEBk4ZeV74bdY4TeRz/7FZ+q25YiQuHPqHTHHDfVPV/vofilmkkA1ypg4KqDan/0qo0d9j9QTVGSEvlblBrC1 8iKGYOi9Qg1BUNeUvqvQi2cwAVFpsqFBr9PDuFniiYfIQdvhJUInMkOP2fXnUqsT6v+w0dF4ZxzIjGHB9dzwp1Z TWtec1ZDxETNhfNHhiiwX6YC0/QKnHZn0YQzWLArsN0zPpWLrxI7Q9ghyJYoAkXeJT9TDqwgT4wWaex0BOs3IZh xsw==" }

退款请求异步返回参数列表

参数名称 参数中文名称 参数说明
merchantId 商户编号 商户编号
requestId 退款订单号 退款订单号
serialNumber 退款流水号 汇元通系统退款流水号
bankRequestNumber 真实银行流水号 请求银行流水号
status 退款状态 SUCCESS 成功
FAILED 失败
amount 退款金额 当退款币种为JPY、KRW、VND时,退款金额以元为单位,其他币种以分单位,1元=100分
currency 退款币种 见货币列表
completeDateTime 完成时间 完成时间
remark 备注 备注
actualRefundAmount 退款结算金额 退款结算金额,当退款结算币种为JPY、KRW、VND时,退款结算金额以元为单位,其他币种以分单位,1元=100分
actualRefundCurrency 退款结算币种 退款结算币种,见货币列表
refundFeeAmount 返还手续费金额 返还手续费金额,当返还手续费币种为JPY、KRW、VND时,返还手续费金额以元为单位,其他币种以分单位,1元=100分
refundFeeCurrency 返还手续费币种 返还手续费币种,见货币列表
errorMessage 错误信息 错误信息
hmac 参数签名 汇元通生成的参数签名结果，验签过程请参考解密流程

参数示例

{ "actualRefundAmount":"101", "actualRefundCurrency":"USD", "amount":"101", "completeDateTime":"2021-06-22 14:10:33", "currency":"USD", "merchantId":"G90008005", "remark":"核查拒绝自动退款", "requestId":"2c9980727a31dfd6017a32560ccd0009", "serialNumber":"1624342134096", "status":"SUCCESS", "hmac":"juhgRm/EpquYBqPwW+nMx+Frjxeyi1SZNwOsDkGGb7ytPI2owTHprugBrG5OiJjld8bSHnMHpb+Ml nlXyxXZ1JYUxxwdWfSk9PTNbkdG5cp7DcM0V/Q+vj198+pHSzcd+sisuUzzFs/pK3zXZ3KY4nj5rP8UvqAPnHA sUa5XOxwjF1LabwL8FsPcclnsnop15K11ZGSWfaG0VMKZ6+CjZvIYI/EOqJhS/wgcDVCjFnSscieQb4y8Qbmxz ZBvOWFWbnHpua6GKxl19DAi08Qcr1n87sX9rfWRkJgKxOD6ZXsJi0+Fmsk8S+mgxUhhe0LXZR9XvxzOnCOyvjU RCBu+tA==" }