退款交易查询
1、修订记录
修订记录 | 日期 | 说明 |
---|---|---|
1.0 | 2023.02.16 | 初版 |
2、业务说明
(1)接口说明
查询退款交易信息
请求主体类型:application/json
请求方式:POST
3、请求地址
环境 | HTTPS请求地址 |
---|---|
测试环境 | https://appdev.ysepay.com/openapi/unify/trade/refund/query |
正式环境 | https://ysgate.ysepay.com/openapi/unify/trade/refund/query |
4、请求参数说明
4.1、公共请求参数
参数 | 类型(长度) | 必填 | 参数说明 |
---|---|---|---|
timeStamp | String | Y | 发送请求的时间,格式"yyyy-MM-dd HH:mm:ss" |
method | String(128) | Y | 接口名称,固定值:unify.trade.refund.query |
charset | String(10) | Y | 请求使用的编码格式,如utf-8,gbk,gb2312等,固定为utf-8 |
sign | String | Y | 商户请求参数的签名串(签名算法默认为国密),详见demo,注意:请用商户私钥进行签名 |
check | String | Y | 银盛公钥加密随机生成的字符串(key)得到的加密值,详见demo |
bizContent | String | Y | 业务参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递。注意:需要通过AES以及随机生成的字符串(key)加密业务参数集合,得到bizContent |
reqId | String | Y | 请求唯一流水号,商户系统唯一,要求32个字符内(最少14个字符),只能是数字、大小写字母_-且在同一个商户号下唯一。最后12位要求格式为"yyMMddHHmmss" 示例值:xy1415220315145602 |
certId | String | Y | 发起方商户号,服务商在银盛给自己开设的商户号,即可当作发起方商户号,由银盛生成并下发。 注意:不同于子商户号,服务商发展的商户即为子商户号 |
version | String | Y | 调用的接口版本,固定为:1.0 |
4.2、业务请求参数
(bizContent加密前的json数据明文字符串)
参数 | 类型(长度) | 必填 | 参数说明 |
---|---|---|---|
origOrderId | String(32) | N | 商户原交易订单号,原订单号、原交易流水号不能同时为空。如果同时存在优先取原订单号。示例值:201805256843192280647118。 |
origTradeSn | String(30) | N | 原交易流水号,银盛原交易流水号,原订单号、原交易流水号不能同时为空。如果同时存在优先取原订单号。 示例值:311160414497667096。 |
refundOrderId | String(32) | Y | 商户退款订单号,请求退款接口时,传入的退款请求订单号, 示例值:RD2012061713107。 |
5、响应参数说明
请注意:银盛后期会对返回参数保留扩展的权力,扩展方式为新增参数但不会删除参数,请商户在解析银盛返回参数时要支持银盛可能扩展参数这种情况。5.1、公共响应参数
参数 | 类型(长度) | 必填 | 参数说明 |
---|---|---|---|
code | String(5) | Y | 网关响应码,示例值:00000 ,详见网关公共响应码 |
msg | String(50) | Y | 网关响应码描述 |
subCode | String | Y | 业务响应码,参见具体的API接口文档 |
subMsg | String | Y | 业务响应描述 |
timeStamp | String | Y | 响应时间,格式"yyyy-MM-dd HH:mm:ss" |
norce | String(128) | Y | 随机参数 |
sign | String | Y | 响应参数的签名串,详见demo, 注意:请用银盛公钥进行验签 |
businessData | String | Y | 业务响应参数集合, 注意:银盛网关通过AES加密业务响应参数集合,得到businessData,商户需要对其进行解密,详情请见demo |
5.2、业务响应参数
响应业务参数businessData(json数据)
参数 | 类型(长度) | 必填 | 参数说明 |
---|---|---|---|
businessData | Object | N | 响应数据 |
reqMsgId | String | N | 请求流水号 |
5.2.1 businessData具体参数
参数 | 类型(长度) | 必填 | 参数说明 |
---|---|---|---|
origOrderId | String(32) | Y | 原商户订单号,订单支付时传入的商户订单号,示例值:68431922806471166。 |
origTradeSn | String(30) | Y | 原订单交易流水,银盛支付平台的订单交易流水,示例值:311160414497667096。 |
refundOrderId | String(32) | Y | 退款订单号,本笔退款对应的退款请求号。 |
refundState | String | N | 退款状态,状态如下: 00-退款成功 10-退款申请 96-退款关闭(买家) 97-退款拒绝(商城) 98-退款拒绝(卖家) 99-退款失败 |
totalAmount | String | Y | 交易订单金额,该笔退款所对应的交易的订单金额,单位:分。 |
accountDate | String(10) | Y | 退款会计日期,格式"yyyy-MM-dd"。 |
refundTradeSn | String(32) | Y | 银盛退款流水号,示例值:01R210622215530564。 |
fundsState | String | N | 退款资金状态,状态如下: 10-初始状态 11-无退款接口需要人工处理 12-清分成功 13-退款登记 14-退款中 20-已受理 50-超时 61-资金退款失败(尚待人工处理) 62-资金退款失败(暂挂状态,尚待人工处理) 00-资金退款成功 97-审核不通过 98-人工关闭 99-资金退款失败 |
refundReason | String | N | 发起退款原因,发起退款时,传入的退款原因。 |
refundAmount | String | N | 退款金额,本次退款请求,对应的退款金额,单位:分。 |
marktingRefundDetail | String | N | 营销退款信息 |
refundChannelFundsDynamics | Array | N | 退款资金动态明细列表,List的JSON串,需要商户自己转为集合。 |
realDiscountFeeRate | String | N | 分期交易商户实际贴息费率 |
srcFeeFlag | String | N | 发起方计费状态,状态如下: 01-实时结算,未统计 11-实时结算,已统计 02-日结算,未统计 12-日结算,已统计 03-月结算,未统计 13-月结算,已统计 04-月累计-按笔,未统计 14-月累计-按笔,已统计 05-月累计-按金额,未统计 15-月累计-按金额,已统计 50-尚未计费初始值 批量业务使用,订单初始化使用 |
payeeFeeFlag | String | N | 收款方计费状态,状态如下: 01-实时结算,未统计 11-实时结算,已统计 02-日结算,未统计 12-日结算,已统计 03-月结算,未统计 13-月结算,已统计 04-月累计-按笔,未统计 14-月累计-按笔,已统计 05-月累计-按金额,未统计 15-月累计-按金额,已统计 50-尚未计费初始值 批量业务使用,订单初始化使用 |
payerFeeFlag | String | N | 付款方计费状态,状态如下: 01-实时结算,未统计 11-实时结算,已统计 02-日结算,未统计 12-日结算,已统计 03-月结算,未统计 13-月结算,已统计 04-月累计-按笔,未统计 14-月累计-按笔,已统计 05-月累计-按金额,未统计 15-月累计-按金额,已统计 50-尚未计费初始值 批量业务使用,订单初始化使用 |
srcFee | String | N | 发起方退还手续费,单位:分。 |
payeeFee | String | N | 收款方退还手续费,单位:分。 |
payerFee | String | N | 付款方退还手续费,单位:分。 |
5.2.1.1 refundChannelFundsDynamics具体参数
参数 | 类型(长度) | 必填 | 参数说明 |
---|---|---|---|
refundsn | String | N | 退款交易流水 |
refundamount | String | N | 本次发往渠道金额,单位:分。 |
state | String | N | 退款资金状态,状态如下: 10-初始状态 11-无退款接口需要人工处理 12-清分成功 13-退款登记 14-退款中 20-已受理 50-超时 61-资金退款失败(尚待人工处理) 62-资金退款失败(暂挂状态,尚待人工处理) 00-资金退款成功 97-审核不通过 98-人工关闭 99-资金退款失败 |
channelSendSn | String | N | 发往渠道流水 |
channelRecvSn | String | N | 渠道返回流水 |
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、业务响应码 网关公共响应码
响应码 | 响应码描述 | 解决方案 |
---|---|---|
0000 | 交易成功 | |
9999 | 失败 | 请根据返回提示操作或联系银盛技术人员处理 |
5000 | 交易超时 | 请检查网络或稍后重新发起请求 |
A029998 | 网关非法参数 | 检查请求参数,修改后重新发起请求。 |
B021100 | 前置系统参数验证错误 | 检查请求参数,修改后重新发起请求。 |
B043001 | 查询结果为空 | 检查发起方商户号和商户号的归属关系。 |
B043003 | 商户号有误 | 请检查发起方商户号是否真实存在。 |
B029901 | 业务失败 | 根据实际返回消息分析具体原因。 |
B049901 | 原交易订单信息不存在 | 确认是否存在改交易订单 |