接口地址:https://dms-api.shopoint.cn/shopoint-openapis-web/szyx/apiweb/tranx/refund
测试地址:https://dms-api-test.shopoint.cn/shopoint-openapis-web/szyx/apiweb/tranx/refund
ISV接口地址:https://dms-api.shopoint.cn/shopoint-openapis-web/szyx/apiweb/isv/refund
ISV测试地址:https://dms-api-test.shopoint.cn/shopoint-openapis-web/szyx/apiweb/isv/refund
使用场景:支持部分金额退款,隔天交易退款。(建议在交易完成后间隔几分钟(最短5分钟)再调用退款接口,避免出现订单状态同步不及时导致退款失败。)
注:1、含商户/银行优惠抵扣、积分、余额的非分账交易,只能整单退款,不支持部分退款;
2、含商户/银行优惠抵扣、积分、余额的分账交易,收款店铺分账部分只能全部退款,不支持部分退款
请求参数
参数 |
参数名称 |
取值 |
可空 |
最大长度 |
备注 |
appid |
应用ID |
平台分配的APPID |
否 |
20 |
|
orgid |
机构ID |
实际交易的机构ID |
是 |
11 |
服务商appid调用时必填 |
cusid |
商户号 |
实际交易的店铺ID |
否 |
11 |
|
version |
版本号 |
接口版本号 |
是 |
2 |
默认填11 |
trxamt |
退款金额 |
必须小于等于原订单实际支付金额,单位为分 |
否 |
16 |
|
reqsn |
商户退款订单号 |
商户的退款交易订单号 |
否 |
64(isv:25) |
商户平台唯一 |
oldreqsn |
原交易订单号 |
原交易的商户订单号 |
是 |
64(isv:25) |
|
oldtrxid |
原交易流水 |
原交易的收银宝平台流水 |
是 |
20 |
oldreqsn和oldtrxid必填其一 |
remark |
备注 |
备注信息 |
是 |
50 |
最大50个字节(25个中文字符) |
benefitdetail |
优惠信息 |
|
是 |
- |
只适用于银联单品优惠交易的退货 |
randomstr |
随机字符串 |
随机生成的字符串 |
否 |
32 |
|
signtype |
签名方式 |
|
是 |
8 |
支持MD5、RSA、SM2,不填默认MD5 |
sign |
签名 |
|
否 |
32 |
详见交易返回码说明 |
splitList |
分账退款列表 |
|
是 |
1024 |
相见附录4.7asinfo字段说明。 分账订单退款使用,整单退不传。部分退时,若不传,则按退款金额与总金额的比例挨个从分账中退款。 |
nosplitamount |
退款未分账金额 |
|
是 |
16 |
预留字段,暂不可用 |
响应参数
字段ID |
字段名称 |
取值 |
可空 |
最大长度 |
备注 |
retcode |
返回码 |
SUCCESS/FAIL |
否 |
8 |
此字段是通信标识,非交易结果,交易是否成功需要查看trxstatus来判断 |
retmsg |
返回码说明 |
|
是 |
100 |
|
以下信息只有当retcode为SUCCESS时有返回 |
|||||
cusid |
商户号 |
实际交易的店铺ID |
否 |
11 |
|
appid |
应用ID |
平台分配的APPID |
否 |
20 |
|
orgid |
机构ID |
实际交易的机构ID |
否 |
11 |
|
trxid |
交易单号 |
收银宝平台的退款交易流水号 |
是 |
20 |
|
reqsn |
商户订单号 |
商户的退款交易订单号 |
否 |
64(isv:25) |
|
trxstatus |
交易状态 |
交易的状态 |
否 |
4 |
见附录交易返回码说明 |
fintime |
交易完成时间 |
yyyyMMddHHmmss |
是 |
14 |
|
errmsg |
错误原因 |
失败的原因说明 |
是 |
100 |
|
fee |
手续费 |
|
是 |
15 |
|
trxcode |
交易类型 |
|
是 |
8 |
见附录交易类型说明 |
randomstr |
随机字符串 |
随机生成的字符串 |
否 |
32 |
|
chnltrxid |
渠道流水号 |
如支付宝,微信平台订单号 |
是 |
64 |
|
sign |
签名 |
|
否 |
32 |
详见安全规范 |
splitlist |
分账信息 |
|
是 |
|
分账结果信息,详见附录4.9 |