订单退款

功能概述

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

接口地址

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

参数名称 参数中文名称 类型& 长度 参数说明 是否必填
merchantId 商户编号 varchar(9) 商户在首信易系统的唯一id,可在商户后台查看 M
requestId 订单号 varchar(50) 订单号为商户自行拟定,提交的订单号必须在自身平台交易中唯一。首信易支付系统已付或撤销的订单,商户平台不能以相同的订单号再次提交。 M
partnerId 服务商id varchar(9) 服务商在首信易系统的唯一id,可在商户后台查看 C
amount 订单金额 decimal(18) 单位:分,1元=100分 M
orderId 原订单流水号 varchar(32) 原订单的serialNumber M
notifyUrl 通知地址 varchar(200) 服务器通知:当退款状态为终态后首信易服务器会向该地址发送通知,该地址可以带参数,如: “www.5upay.com/callback.action?test=test” M
isCollect 是否归集 固定值 1 归集 C
0 不归集
默认不归集
refundCollectDetail 归集信息 Json(数组) 见下表 C
remark 备注 varchar(300) 备注 O
refundSubsidy 退款补贴标识 固定值 1 退款补贴 O
0 不退款补贴
默认为不退款补贴
subsidyMoney 退款补贴金额 varchar(18) 单位:分,1元=100分 O
hmac 参数签名 varchar(500) 商户生成的参数签名结果,获取hmac的方法请参考请求加密流程 M

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

请求参数(refundCollectDetail,归集信息)

参数名称 参数中文名称 类型& 长度 参数说明 是否必填
collectAccType 归集类型 固定值 SPLIT_ACC 被分账方账户 M
PLAT_ACC 平台资金账户
WAIT_ACC 待分账资金账户
collectAmount 归集金额 varchar(18) 归集金额,分为单位,1 元=100 分 M
subSplitRequestId 明细分账订单 varchar(50) 商户自行拟定的明细分账订单号,不可重复,当归集类型为 SPLIT_ACC时,此项必传,否则不传 C
remark 分账备注 varchar(300) 分账备注 O

参数示例

{ "merchantId": "890000593", "requestId": "1527756058867", "amount": "1", "orderId": "cb8d5097594e409faf0b798ddc4d88fc", "remark": "备注", "notifyUrl": "http://qa.ehking.com/sdk/onlinepay/refundNotify", "hmac": null }

退款请求返回参数列表

参数名称 参数中文名称 参数说明
merchantId 商户编号 同请求参数
requestId 订单号 同请求参数
partnerId 服务商id 同请求参数
serialNumber 交易流水号 交易流水号
status 状态 SUCCESS 成功(此成功状态为提交请求至首信易成功而不是退款成功),
FAILED 失败
ERROR 错误(此状态的返回参数见异常情况说明)
amount 退款金额 单位:分,1元=100分
currency 退款币种 默认人民币CNY
hmac 参数签名 首信易生成的参数签名结果,验签过程请参考解密流程

参数示例

{ "amount": "1", "serialNumber": "8a0be93c633eec9c0163b55bb2d42d73", "merchantId": "890000593", "requestId": "1527756058867", "hmac": "d9c980e5967cc81ccc6478392c7dfabc", "currency": "CNY", "status": "SUCCESS" }

退款异步返回参数列表

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

参数名称 参数中文名称 参数说明
merchantId 商户编号 同请求参数
requestId 订单号 同请求参数
partnerId 服务商id 同请求参数
amount 退款金额 单位:分,1元=100分
serialNumber 交易流水号 交易流水号
status 状态 SUCCESS 成功
FAILED 失败
completeDateTime 退款完成时间 退款完成时间
currency 退款币种 默认人民币CNY
errorMessage 错误信息 错误信息,退款失败返回此项
hmac 参数签名 首信易生成的参数签名结果,验签过程请参考解密流程

参数示例

{ "amount": "1", "serialNumber": "8a0be93c633eec9c0163b55bb2d42d73", "merchantId": "890000593", "requestId": "1527756058867", "hmac": "d9c980e5967cc81ccc6478392c7dfabc", "currency": "CNY", "status": "SUCCESS" }