跳转至

退款接口

请求方式 body 编码 接口地址
POST application/json UTF-8 集测：https://mchapitest.shengpay.com/refund/orderRefund
生产：https://mchapi.shengpay.com/refund/orderRefund

请求参数

变量名 类型 必填 示例值 描述
mchId String(16) Y 93751497 商户号
outTradeNo String(64) Y 20210987612312 商户订单号(支付时商户单号)
outRefundNo String(64) Y r20210987612312 退款订单号
refundFee int Y 2 退款金额 单位 分
refundDesc String(64) N 退款原因
notifyUrl String(128) Y 退款通知地址
returnAttach Boolean N false 是否返回退款备注，默认 false,当isReturnAttach=true时，返回退款备注
attach String（512） 附加信息
isComplement String(16) N true 退款无需要补退结算，同步返回结果(JSON字符串) true:需要补，false:不需要，默认true
mktAmt long N true 商户营销活动中退贴手续费金额（与交易中类似）
nonceStr String(32) Y 随机字符串
signType String Y RSA 签名类型目前只支持RSA
sign String Y 签名 (见签名介绍)

请求示例

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
{
    "mchId": "93751497",
    "nonceStr": "ikg7Oro4YgebbaKAhwbf57JkihA5PArZ",
    "notifyUrl": "http://10.241.80.32:8082/refundNotify",
    "outRefundNo": "1602834549305",
    "outTradeNo": "8a8zg8sbw28hifn3hd5o",
    "refundDesc": "用户要求",
    "refundFee": 2,
    "sign": "YERldf7EczR/WQuLv/qun9wBr0pk6tYveKvSm70KTPhusyBwfUBmAD6ULx3u0swoD1k0JutK824oStcfap0B/dHcAaXq3nw9/eZIwSNjO7/3FXPsgy/wrn4759c6+F2RV5yhI2/6FNKKpDM9Z6aUEqrZTulPpo8y/fkK0x61iSLcsy8vO45VHgXnvqoKJm69Xrt4G6luPVwznKioRPXKzb7a7+2NDc8txAeENBXv67UwEJo3tZBlTYoh2x+/oyrSxim4mN2wotNvDl/Z/jYLjVQUm71bz83MWmUTHsUmlPs/0qzOJEkC0GqNsB0QI4TR8xNulKpfiFQef4I4hNhhzw==",
    "signType": "RSA"
}

响应参数

变量名 类型 必填 示例值 描述
returnCode String Y SUCCESS 返回码(SUCCESS/FAIL)
returnMsg String N 返回消息(当returnCode为FAIL时使用)
resultCode String Y SUCCESS 业务结果(SUCCESS/FAIL)
errorCode String N 错误代码(当resultCode为FAIL时使用) 枚举类：(见错误码枚举类)
errorCodeDes String N 错误描述(当resultCode为FAIL时使用)
mchId String Y 93751497 商户号
outTradeNo String Y 20210987612312 商户订单号
transactionId String Y M20210987612312 盛付通产品订单号
outRefundNo String Y r20210987612312 商户退款订单号
refundId String Y 盛付通退款订单号
refundFee int Y 10 退款金额 单位 分
totalFee int Y 20 订单总金额单位 分
refundStatus String Y 退款订单状态(见订单状态说明)
attach String（512） N 附加信息
refundAccount String（512） N 退结算资金来源
nonceStr String Y 随机字符串
signType String Y RSA 签名类型
sign String Y 签名 (见签名介绍)

响应示例

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
{
    "refundFee": 2,
    "mchId": "93751497",
    "outRefundNo": "1602834549305",
    "resultCode": "SUCCESS",
    "sign": "BhOYbmM7ypi6DZCFQ9wmJfIYynKkh3CkdHFU5jKZaJ2xTvfjg69cRBsd/Cl7qqWFaEbkJxS4Y9pVz/NmRXTPXkzsVN4YpC2QlQLTyDG6iskJFJdgW8eBJlcMdvhFPZClcSI0uKB27qQuZDsV4Z2Wm/Uv16gdjoTwkSMF1H5AhMI=",
    "refundStatus": "REFUND_ING",
    "transactionId": "M20201015348067758698831872",
    "nonceStr": "eiySfAJwdYSkjgCAaYSvKTSxgmxoZpqU",
    "returnCode": "SUCCESS",
    "totalFee": 2,
    "outTradeNo": "8a8zg8sbw28hifn3hd5o",
    "signType": "RSA",
    "refundId": "MR20201016348520544091688960"
}

退款订单状态

枚举值 枚举描述
REFUND_INIT 创建
REFUND_ING 退款中
REFUND_SUCCESS 退款成功
REFUND_FAIL 退款失败
Back to top