申请退款

请求方式 body 编码 接口地址
POST application/json UTF-8 /api/v1/payment/refund

请求参数

字段名 变量名 必填 类型 示例值 描述
appId 商户应用ID Y String(32) djgeiq978y933
mchId 商户号 Y String(20) 93745641 商户号
outTradeNo 商户订单号 N String(32) hiuhei09023j12j40206 outTradeNo和transactionId二选一必填
transactionId 商户订单号 N String(32) outTradeNo和transactionId二选一必填
outRefundNo 商户退款订单号 Y String(32)
totalFee 总金额 Y Int 100 单位:分
refundFee 退款金额 Y Int 100 单位:分
refundDesc 退款原因 N String(128)
refundAccount 退款资金来源 N String(32) RECHARGE:余额退款 UNSETTLED:当日未结算营业额退款
notifyUrl 商户通知回调地址 Y String(300) https://notify.shengpay.com/notify 接收连尚支付退款异步通知回调地址,通知url必须为直接可访问的url,不能携带参数。
applyMchId 发起方商户号 N String(20)
applyType 申请方式 N String(20) PROXY
nonceStr 随机字符串 Y String(32) pWUVWVYWNQhnTXpQzhIzMGCwqBkZclzg
signType 签名类型 Y String(10) RSA 目前只支持RSA
sign 签名 Y String(500)
{
    "appId":"appid_huawei",
    "mchId":"93745648",
    "nonceStr":"adwafwaf3432523523523",
    "sign":"32532523d23235235",
    "signType":"RSA",
    "transactionId":"",
    "outTradeNo":"huaweitest_0jhiuhi_31",
    "outRefundNo":"huaweitest_0jhiuhi_31_re1",
    "totalFee":"100",
    "refundFee":"100",
    "refundDesc":"测试退款",
    "refundAccount":"",
    "notifyUrl":"http://wifi.notify.com"
}

响应参数

字段名 变量名 必填 类型 示例值 描述
returnCode 返回码 Y String(32) SUCCESS SUCCESS/FAIL 此字段为业务交互通信标志
returnMsg 返回消息 Y String(32) OK 当returnCode为FAIL时,返回错误信息
resultCode 业务结果 Y String(32) SUCCESS SUCCESS/FAIL
errorCode 错误代码 N String(32) 当resultCode为FAIL时,errorCode必填
errorCodeDes 错误描述 N String(64) 当resultCode为FAIL时,errorCodeDes必填
appId appId N String(32) 当resultCode为SUCCESS时,appId必填
mchId 商户号 N String(32) 当resultCode为SUCCESS时,mchId必填
transactionId 连尚支付订单号 Y String(32) 当returnCode和resultCode为SUCCESS时,transactionId必填
outTradeNo 商户订单号 Y String(32) 当returnCode和resultCode为SUCCESS时,outTradeNo必填
outRefundNo 商户退款订单号 N String(32) 当returnCode和resultCode为SUCCESS时,outRefundNo必填
refundId 连尚退款订单号 N String(32) 当returnCode和resultCode为SUCCESS时,refundId必填
refundFee 退款金额 N Int 当returnCode和resultCode为SUCCESS时,refundFee必填
settlementRefundFee 实际退款金额 N Int 当returnCode和resultCode为SUCCESS时,settlementRefundFee必填
totalFee 支付订单金额 N Int 当returnCode和resultCode为SUCCESS时,totalFee必填
settlementTotalFee 实际结算金额 N Int 当returnCode和resultCode为SUCCESS时,settlementTotalFee必填
couponRefundCount 退款代金券使用数量 N Int 当returnCode和resultCode为SUCCESS时,并且有优惠减免时,couponRefundFee必填
couponRefundFee 代金券退款总金额 N Int 当returnCode和resultCode为SUCCESS时,并且有优惠减免时,couponRefundFee必填
couponRefundId$n 退款代金券ID N String(32) 当returnCode和resultCode为SUCCESS时,并且有优惠减免时,couponRefundId必填,$n从0开始计数
couponType$n 代金券类型 N String(32) 当returnCode和resultCode为SUCCESS时,并且有优惠减免时,couponType必填,$n从0开始计数
couponRefundFee$n 单个代金券退款金额 N Int 当returnCode和resultCode为SUCCESS时,并且有优惠减免时,couponRefundFee必填,$n从0开始计数
nonceStr 随机字符串 Y String(32)
signType 加签方式 Y String(10) RSA 目前只支持RSA
sign 签名 Y String(500)

错误码描述

返回码 返回文案 解决方案
NO_AUTH 商户无此接口权限 请商户前往申请此接口权限
ORDER_PAID 商户订单已支付 商户订单已支付,无需更多操作
ORDER_CLOSED 订单已关闭 当前订单已关闭,请重新下单
SYSTEM_ERROR 系统错误 系统异常,请用相同请求参数重新发起请求
APP_ID_NOT_EXIST appId不存在 请检查appId是否正确
MCH_ID_NOT_EXIST mchId不存在 请检查mchId是否正确
APP_ID_AND_MCH_ID_NOT_MATCH appId和mchId不匹配 请确认appId和mchId是否匹配
LACK_PARAMS 缺少参数 请检查参数是否齐全
PARAMS_ERROR 参数问题 请检查参数值是否符合
OUT_TRADE_NO_USED 商户订单号重复 请核实商户订单号是否重复提交
SIGN_ERROR 签名错误 请检查签名参数和方法是否都符合签名算法要求