退款交易查询
1.修订记录
| 修订 |
日期 |
说明 |
作者 |
| V0.1 |
2016/4/13 |
新接口参数定义 |
莫尚校 |
| V0.2 |
2016/4/25 |
修改请求方法名称 |
易显群 |
| V0.3 |
2016/5/20 |
增加业务参数说明，订单号优先于银盛流水号 |
易显群 |
| V0.4 |
2016/6/21 |
修改参数说明 |
莫尚校 |
| V0.5 |
2016/6/24 |
修改参数trade_no字符长度 |
莫尚校 |
| V0.6 |
2016/6/24 |
修改退款流水号字段说明 |
郭勇 |
| V0.7 |
2017/11/07 |
支持担保交易 |
邓鑫 |
| V0.8 |
2018/05/25 |
补充shopdate参数 |
黄国强 |
| V0.9 |
2018/12/29 |
退款新增异步通知 |
邓鑫 |
| V1.0 |
2020/7/22 |
退款查询返回营销退款信息 |
汤吉齐 |
| V1.1 |
2020/10/22 |
退款查询返回退款资金动态信息 |
王晶 |
| V1.2 |
2021/01/21 |
修改ACQ_QUERY_NO_RECORD的描述 |
王晶 |
| V1.3 |
2021/08/25 |
分期交易返回实际贴息利率 |
王晶 |
| V1.4 |
2021/12/27 |
支持国密 |
王晶 |
| V1.5 |
2022/10/12 |
返回字段新增(src_fee_flag、payee_fee_flag、payer_fee_flag、src_fee、payee_fee、payer_fee)预计上线时间2022.11月中旬 |
游周平 |
| V1.6 |
2022/10/12 |
返回字段新增funds_dynamics,has_refund_src_fee,has_refund_payee_fee,has_refund_payer_fee,alipay_refund_coupon_info字段的定义，删除字段refund_channelfunds_dynamics |
刘军 |
2.接口说明
退款交易查询请求
3.请求地址
4.参数说明
4.1公共请求参数
| 参数 |
类型(长度） |
Y |
参数说明 |
| method |
String(128) |
Y |
接口名称 固定值 ysepay.online.trade.refund.query |
| partner_id |
String(20) |
Y |
在银盛支付开设的服务商商户号，请联系客户经理提供 |
| timestamp |
String(19) |
Y |
发送请求的时间，格式"yyyy-MM-dd HH:mm:ss" 示例值：2014-07-24 03:07:50 |
| charset |
String(10) |
Y |
商户网站使用的编码格式，如UTF-8、GBK、GB2312等，默认值 GBK |
| sign_type |
String(10) |
Y |
报文签名算法，RSA/SM |
| sign |
String(256) |
Y |
签名字符串，再用Base64编码 |
| version |
String(3) |
Y |
接口版本3.0 当前版本 3.0 |
| biz_content |
String |
Y |
业务请求参数的集合，最大长度不限，除公共参数外所有请求参数都必须放在这个参数中传递 |
4.2 业务请求参数
参数名biz_content,值为一个json格式对象，下面列表描述json对象的值
| 参数 |
类型(字节长度） |
必填 |
参数说明 |
| out_trade_no |
String(1,32) |
Y |
订单支付时传入的商户系统内部订单号,和银盛交易号不能同时为空。 trade_no,out_trade_no如果同时存在优先取out_trade_no |
| trade_no |
String(1，30) |
N |
银盛平台交易流水号trade_no与out_trade_no 不能同时为空 示例值：311160414497667096 |
| out_request_no |
String(1，32) |
Y |
请求退款接口时，传入的退款请求订单号 示例值：RD2012061713107 |
5.响应参数说明
银盛支付对商户的请求数据处理完成后，会将处理的结果数据同步回执给商户。
请注意：银盛后期会对返回参数保留扩展的权力，扩展方式为新增参数但不会删除参数，请商户在解析银盛返回参数时要支持银盛可能扩展参数这种情况。
5.1 公共响应参数
| 参数 |
类型(字节长度） |
必填 |
参数说明 |
| sign |
String |
Y |
签名字符串，Base64编码 |
| ysepay_online_trade_refund_query_response |
String |
Y |
业务响应参数的集合，最大长度不限 |
5.2 业务响应参数
| 参数 |
类型(字节长度） |
必填 |
参数说明 |
| code |
String |
Y |
响应代码 |
| msg |
String |
Y |
响应代码描述 |
| trade_no |
String(1，30) |
Y |
银盛支付平台的订单交易流水 |
| out_trade_no |
String(1，32) |
Y |
创建交易传入的商户订单号 |
| out_request_no |
String(1，32) |
Y |
本笔退款对应的退款请求号 |
| refund_state |
String |
Y |
退款交易状态成功:success,处理中：in_process,失败：fail |
| funds_state |
String |
Y |
退款资金状态 |
| refund_reason |
String(1,50) |
N |
发起退款时，传入的退款原因 |
| total_amount |
Number |
N |
该笔退款所对应的交易的订单金额 |
| refund_amount |
Number |
N |
本次退款请求，对应的退款金额 |
| account_date |
String(10） |
N |
退款会计日期，格式"yyyy-MM-dd" |
| markting_refund_detail |
String |
N |
营销退款信息 |
| funds_dynamics |
String |
N |
退款资金动态明细列表，List 的json串，示例值：5.4 |
| real_discount_fee_rate |
Double |
N |
分期交易商户实际贴息 费率 |
| src_fee_flag |
String |
N |
发起方计费状态 |
|
| payee_fee_flag |
String |
N |
收款方计费状态 |
|
| payer_fee_flag |
String |
N |
付款方计费状态 |
|
| src_fee |
Double |
N |
发起方退还手续费 |
|
| payee_fee |
Double |
N |
收款方退还手续费 |
|
| payer_fee |
Double |
N |
付款方退还手续费 |
| has_refund_src_fee |
Double |
N |
发起方已退手续费 |
|
| has_refund_payee_fee |
Double |
N |
收款方已退手续费 |
|
| has_refund_payer_fee |
Double |
N |
付方已退手续费 |
5.3 退款资金状态
| 值 |
描述 |
| success |
退款成功 |
| in_process |
退款处理中 |
| fail_to_manual_deal |
退款失败，待人工处理，有疑问请联系商务经理 |
| fail_due_manual_close |
退款失败，人工关闭，有疑问请联系商务经理 |
| fail |
退款失败 |
5.4 RefundChannelfundsDynamicDto
| 参数 |
类型(字节长度） |
必填 |
参数说明 |
| refundsn |
String |
Y |
退款交易流水 示例值：RD2012061713107 |
| refundamount |
BigDecimal |
Y |
本次发往渠道金额 |
| state |
String |
Y |
退款资金状态 示例值：10 |
| channelSendSn |
String |
N |
发往渠道流水 示例值：1012010231551064011 |
| channelRecvSn |
String |
N |
渠道返回流水 示例值：50100003692020030514951409618 |
| sendChannelTime |
String |
N |
发往渠道时间 格式 yyyy-MM-dd HH:mm:ss |
| channelRecvTime |
String |
N |
渠道返回时间 格式 yyyy-MM-dd HH:mm:ss |
| couponInfo |
String |
N |
营销退款信息（银联） |
| marketingRefundDetail |
String |
N |
营销退款信息（微信） |
6.异步通知参数
银盛支付对商户的请求数据处理完成后，会将处理的结果数据通过服务器主动通知的方式通知给商户网站。这些处理结果数据就是服务器异步通知参数。
请注意：银盛后期会对返回参数保留扩展的权力，扩展方式为新增参数但不会删除参数，请商户在解析银盛返回参数时要支持银盛可能扩展参数这种情况。
| 参数 |
类型(字节长度） |
必填 |
参数说明 |
| sign_type |
String |
Y |
报文签名算法，交易请求时的签名类型RSA/SM |
| sign |
String |
Y |
签名字符串，Base64编码 |
| notify_type |
String |
Y |
通知类型 固定值：refund.status.sync |
| notify_time |
String(19) |
Y |
发送请求的时间，格式"yyyy-MM-dd HH:mm:ss" 示例值：2014-07-24 03:07:50 |
| out_trade_no |
String(32) |
Y |
银盛支付合作商户网站唯一订单号。 |
| total_amount |
Number |
N |
该笔退款订单的资金总额，单位为RMB-Yuan。取值范围为[0.01，100000000.00]，精确到小数点后两位。 |
| trade_no |
String(20) |
N |
该交易在银盛支付系统中的交易流水号。 |
| trade_status |
String |
Y |
交易目前所处的状态。成功状态的示例值： TRADE_SUCCESS |
| account_date |
String（10） |
N |
入账的时间，格式"yyyyMMdd" 示例址：20140724 |
| coupon_info |
String |
N |
优惠信息coupon_info优惠信息活动对象为多个时，coupon_info中就有多方优惠信息spnsrId出资方，值为1时银联出资，值为2时付款方出资，值为3时商户出资offstAmt优惠金额 |
| settlement_amount |
Number |
N |
原订单结算金额 示例值：100.00 |
7.样例
7.1 consignee_info 说明
[{
"spnsrId": "1",
"offstAmt": 1
}, {
"spnsrId": "2",
"offstAmt": 2
}]
8.附录
8.1 退款请求错误码
| 错误码 |
错误描述 |
解决方案 |
| ACQ.SYSTEM_ERROR |
系统错误 |
重新发起请求 |
| ACQ.INVALID_PARAMETER |
参数无效 |
检查请求参数，修改后重新发起请求 |
| ACQ.QUERY_NO_RECORD |
暂未查询到交易，请检查订单号/流水号后重试 |
该状态为未知状态，请勿当成失败状态处理 检查传入的订单号是否正确，修改后重新发起请求或继续查询 |