退款接口

功能概述

商户通过此接口提交退款申请

接口地址

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

参数名称 参数中文名称 类型& 长度 参数说明 是否必填
merchantId 商户编号 varchar(9) 商户在首信易系统的唯一id,可在商户后台查看 M
requestId 退款订单号 varchar(50) 退款订单号为商户自行拟定,提交的退款订单号必须在自身平台交易中唯一。首信易支付系统已退款成功或失败的订单,商户平台不能以相同的订单号再次提交。 M
amount 金额 varchar(18) 单位:分,1 元=100 分 M
orderId 原订单流水号 varchar(32) 商户订单号在首信易所对应的交易流水号(支付完成后的serialNumber) M
notifyUrl 通知地址 varchar(200) 服务器通知:退款终态后会向该地址发送通 知,该地址可以带参数(发送机制见1.4 ), 如 : “www.5upay.com/callback.action?t est=test” M
remark 备注 varchar(300) 商户在首信易为订单进行备注,通过退款结果返回商户 O
hmac 参数签名 varchar(500) 商户生成的参数签名结果,获取hmac的方法请参考请求加密流程 M

参数示例

{ "merchantId": "100000050", "requestId": "1528447216658", "amount": "1", "orderId": "ba3567eef3f743b2a5282c37b6250bb9", "remark": "备注", "notifyUrl": "http://qa.upay.com/sdk/foreignexchange/refundNotify", "hmac": "UZYjA/bik4TNL9aYSHajULOJxDSJkFyYfDNFxJxYCG1Zyi9s16uvSRmj07 M3ax76JG6STpWc/kyb36mWmg8X8gduvd39NupWK/zJErbgYffOmOd6YpmrvTQhbPiox LN8Ras9J9zkL7uQ3cTOaLAHOeAQh7Aps3EFJ8MMh+sY4UwIl25h3PEkbBy2sBoug+Zp gLYDXTULrBY7OQ7cLTczfe5DOxJHLGSMpinHaVFOvQaodR8yZdAygDyfDPm16mKDBBV 9NsRsGc0pNXZq+gz0hvTq1dLw+WygTVH8VPFN01bPVHQjxJd3M041kE9ABF/vAP1ExX tSNCevRrAjyyRi4Q==" }

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

参数名称 参数中文名称 参数说明
merchantId 商户编号 同请求参数
requestId 退款订单号 同请求参数
serialNumber 支付流水号 首信易系统退款流水号
status 状态 SUCCESS 成功(此成功状态为提交请求至首信易成功而不是退款成功)
FAILED 失败
amount 退款金额 单位:分,1 元=100 分
currency 退款币种 参考货币列表
completeDateTime 完成时间 退款完成时间
hmac 参数签名 商户生成的参数签名结果,获取hmac的方法请参考请求加密流程

示例

{ "merchantId": "100000050", "requestId": "1506333222530", "serialNumber": "8a7df26c5e74e383015eb87509ab3b4a", "orderId": "525b756c0800450b9286fbfd297fdb95", "amount": "10", "currency": "CNY", "completeDateTime": "2017-09-25 18:00:03", "status": "SUCCESS", "hmac": "UZYjA/bik4TNL9aYSHajULOJxDSJkFyYfDNFxJxYCG1Z yi9s16uvSRmj07M3ax76JG6STpWc/kyb36mWmg8X8gduvd39NupWK/ zJErbgYffOmOd6YpmrvTQhbPioxLN8Ras9J9zkL7uQ3cTOaLAHOeAQ h7Aps3EFJ8MMh+sY4UwIl25h3PEkbBy2sBoug+ZpgLYDXTULrBY7OQ 7cLTczfe5DOxJHLGSMpinHaVFOvQaodR8yZdAygDyfDPm16mKDBBV9 NsRsGc0pNXZq+gz0hvTq1dLw+WygTVH8VPFN01bPVHQjxJd3M041kE 9ABF/vAP1ExXtSNCevRrAjyyRi4Q==" }

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

参数名称 参数中文名称 参数说明
merchantId 商户编号 同请求参数
requestId 退款订单号 同请求参数
serialNumber 支付流水号 首信易系统退款流水号
orderId 原订单流水号 原订单支付流水号
status 退款状态 SUCCESS 成功
FAILED 失败
amount 退款金额 单位:分,1 元=100 分
currency 退款币种 参考货币列表
completeDateTime 完成时间 退款完成时间
errorCode 错误码 错误码
errorMessage 错误信息 错误信息
hmac 参数签名 商户生成的参数签名结果,获取hmac的方法请参考请求加密流程

示例

{ "merchantId": "100000050", "requestId": "1506333222530", "serialNumber": "8a7df26c5e74e383015eb87509ab3b4a", "orderId": "525b756c0800450b9286fbfd297fdb95", "amount": "10", "currency": "CNY", "completeDateTime": "2017-09-25 18:00:03", "status": "SUCCESS", "hmac": "YYSJXAyOHjV0kMzPruyuwYgebVecsJiG9/90OM1ugT5HKJh m2w5A+qQOCZzcNmk7JKz4nC398B/FrTMcAGX3ECEMpeJiNNxHNoRQkTF zI6etFI7ZuxRhFSBgYMmBNUdwq4Y/o8iOXRQnDuHxqHtNwJvrhM8OuHy zVcGBLeua8afPJlto9mQYjiq4oIfT4JmJPqnWaBZCjr+akJWXOtFG2Tk YAQg/43zdy9mTpaZHl+OjO7hU2tSL0pqZ3SBBYtZBeuIlwUFf17Wxee7 0ldY0cLLg/jhY3crw7HcJOggatH7acFqmfueLW2EqrkDkdQkHbWUmGzt eRxGlsUEMenoHrA== " }