订单退款
POST
http://crm.houcaller.com/ysPayController/ysRefund
请求头
参数名
类型
描述
必填
strParams
String
加密后的参数 参考加密方法 参考请求DEMO
必填
请求参数
参数名
类型
描述
必填
posId
String
机构ID
必填
merOrderId
String
商户订单号
必填
targetOrderId
String
银联订单号
必填
instMid
String
默认 QRPAYDEFAULT
可选
refundAmount
BigDecimal
下单接口中上送了分账标记字段divisionFlag，则该字段refundAmount=subOrders中totalAmount之和+platformAmount
必填
refundOrderId
String
多次退款必传，每次退款上送的refundOrderId值需不同，若多次退货，且后续退货上送的merOrderId和refundOrderId字段与之前退货上送的值一致，将不会走退货逻辑，而是返回已有退货订单的退货信息，遵循商户订单号生成规范
可选
platformAmount
BigDecimal
平台商户退款分账金额 若原交易是分账交易，则分账金额必传，且退款接口platformAmount小于下单接口中上送的platformAmount
可选
subOrders
List
子订单信息 若原交易有分账，退款时必填。且退款接口totalAmount小于下单接口中上送的subOrders中对应mid下的totalAmount。（一次只能对一个子商户进行退款）
可选
posId
String
机构ID
必填
totalAmount
BigDecimal
子商户分账金额
必填
refundDesc
String
退货说明
可选
type
String
0 or Null 整单退 1:分账退
必填
请求示例
响应数据
参数名
类型
注释
描述
payTime
string
支付时间 格式yyyy-MM-ddHH:mm:ss
示例：2022-08-31 11:10:13
connectSys
string
链接系统
示例：UNIONPAY
merName
string
商户名称
示例：厦门宅小牛科技服务有限公司
mid
string
商户号
示例：89835065812APRE
refundStatus
string
退款状态 UNKNOWN 不明确的交易状态 SUCCESS 退款成功 退款失败 PROCESSING
示例：SUCCESS
settleDate
string
结算日期 格式yyyy-MM-dd
示例：2022-08-31
sendBackAmount
int
商户实退金额
示例：1
tid
string
终端号
示例：UEN7NT67
refundTargetOrderId
string
目标系统退货订单号
示例：50101903112022083124374504714
refundFundsDesc
string
退款渠道描述
示例：现金退款0.01元。
refundFunds
string
退款渠道列表
示例：现金:1
targetMid
string
支付渠道商户号
示例：527237510
cardAttr
string
卡属性
示例：DEBIT_CARD
targetStatus
string
目标平台的状态
示例：SUCCESS|SUCCESS
seqId
string
平台流水号
示例：29340781957N
merOrderId
string
商户订单号
示例：146AEU2208311107222MXX93CY
targetSys
string
目标平台代码
示例：WXPay
bankInfo
string
银行信息
示例：建设银行(借记卡)
delegatedFlag
string
标识
示例：N
settleRefId
string
清分ID 如果来源方传了bankRefId就等于bankRefId，否则等于seqId
示例：29341582210N
refundOrderId
string
退款订单号
示例：10002208315421013113235393
totalAmount
string
总金额
示例：1
refundInvoiceAmount
string
实付部分退款金额
示例：1
chnlCost
string
渠道成本
示例：758
responseTimestamp
string
请求系统时间
示例：2022-08-31 11:10:14
errCode
string
错误编码
示例：SUCCESS
status
string
交易状态
示例：TRADE_SUCCESS
返回示例
退款状态码
参数名
描述
UNKNOWN
不明确的交易状态
SUCCESS
退款成功
FAIL
退款失败
PROCESSING
退款失败
订单状态码
参数名
描述
NEW_ORDER
新订单
UNKNOWN
不明确的交易状态
TRADE_CLOSED
在指定时间段内未支付时关闭的交易；在交易完成全额退款成功时关闭的交易；支付失败的交易。 TRADE_CLOSED的交易不允许进行任何操作。
WAIT_BUYER_PAY
交易创建，等待买家付款。
TRADE_SUCCESS
支付成功
TRADE_REFUND
订单转入退货流程