接口地址:https://vsp.allinpay.com/apiweb/tranx/refund
测试地址:https://syb-test.allinpay.com/apiweb/tranx/refund
使用场景:支持部分金额退款,隔天交易退款。(建议在交易完成后间隔几分钟(最短5分钟)再调用退款接口,避免出现订单状态同步不及时导致退款失败。)
注:云闪付(银联扫码)含单品优惠交易只能整单退款,不支持部分退款
请求参数:
参数 | 参数名称 | 取值 | 可空 | 长度 | 备注 |
---|---|---|---|---|---|
orgid | 集团/代理商商户号 | 15 | 共享集团号/代理商参数时必填 | ||
cusid | 商户号 | 实际交易商户号 | 否 | 15 | |
appid | 应用ID | 平台分配的APPID | 否 | 8 | |
version | 版本号 | 接口版本号 | 是 | 2 | 默认填11 |
trxamt | 退款金额 | 单位为分 | 否 | 16 | |
reqsn | 商户退款订单号 | 商户的退款交易订单号 | 否 | 50 | 商户平台唯一 |
oldreqsn | 原交易订单号 | 原交易的商户订单号 | 是 | 50 | |
oldtrxid | 原交易流水 | 原交易的收银宝平台流水 | 是 | 20 |
oldreqsn和oldtrxid必填其一 建议:商户如果同时拥有oldtrxid和oldreqsn 优先使用oldtrxid |
remark | 备注 | 备注信息 | 是 | 50 | 最大50个字节(25个中文字符) |
benefitdetail | 优惠信息 | 是 | - | 只适用于银联单品优惠交易的退货 | |
randomstr | 随机字符串 | 随机生成的字符串 | 否 | 32 | |
notify_url | 交易结果通知地址 |
接收交易结果的通知回调地址, 通知url必须为直接可访问的url, 不能携带参数。 https只支持默认端口 |
是 | 256 | 若使用https,需使用默认443端口 |
signtype | 签名方式 | 否 | 8 |
RSA SM2 |
|
sign | 签名 | 否 | 32 | 详见交易返回码说明 |
响应参数:
字段ID | 字段名称 | 取值 | 可空 | 长度 | 备注 |
---|---|---|---|---|---|
retcode | 返回码 | SUCCESS/FAIL | 否 | 8 |
此字段是通信标识,非交易结果 交易是否成功需要查看trxstatus来判断 |
retmsg | 返回码说明 | 是 | 100 | ||
以下信息只有当retcode为SUCCESS时有返回 | |||||
cusid | 商户号 | 平台分配的商户号 | 否 | 15 | |
appid | 应用ID | 平台分配的APPID | 否 | 8 | |
trxid | 交易单号 | 收银宝平台的退款交易流水号 | 否 | 20 | |
reqsn | 商户订单号 | 商户的退款交易订单号 | 否 | 32 | |
trxstatus | 交易状态 | 交易的状态 | 否 | 4 | 见附录交易返回码说明 |
fintime | 交易完成时间 | yyyyMMddHHmmss | 是 | 14 | |
errmsg | 错误原因 | 失败的原因说明 | 是 | 100 | |
fee | 手续费 | 是 | 15 | ||
trxcode | 交易类型 | 是 | 8 | 见附录交易类型说明 | |
randomstr | 随机字符串 | 随机生成的字符串 | 否 | 32 | |
chnltrxid | 渠道流水号 | 如支付宝,微信平台订单号 | 是 | 64 | |
chnldata | 渠道信息 | 是 | - | ||
bankcode | 所属银行 | 是 | |||
sign | 签名 | 否 | 32 | 详见安全规范 |