单笔订单退款结果查询

最新更新时间：2021.11.25

查询某笔退款请求的结果

---

接口说明

请求URL： https://{domain}/os-base/query/refund/v1/open

请求方式： POST

公共请求参数

参数名	必填	类型	说明
access_id	是	string	开发者唯一标识
sign_type	是	string	固定传RSA2
time_stamp	是	long	请求时间，Linux时间戳，单位毫秒
sign	是	string	签名结果
data	是	string	将业务参数转为JSON字符串，然后使用BASE64编码的数据

详细签名方法请阅读接口加密方案

业务请求参数

名称	必填	类型	说明
osRefundNo	是	string	开放平台退款单号
ownerRefundNo	否	string	商户自传的退款单号，若没有可不传

公共响应参数

名称	必传	类型	说明
code	是	int	请求结果code,详细请参考错误码说明)
msg	是	string	请求结果描述，失败时会返回错误原因
data	否	object	请求结果返回的业务响应参数，若无业务参数则返回空

业务响应参数

名称	必传	类型	说明
refundStatus	是	string	退款状态 WAIT:退款申请创建, SUCCESS:退款成功, FAILURE:退款失败, CLOSE:已关闭(例如超出退款期限)
osTradeNo	是	string	开放平台给商户的交易订单号
osRefundNo	是	string	本次退款的退款单号，开放平台内唯一
refundFee	是	int	本次退款金额
orderFee	是	int	交易订单的总金额，单位分
paymentFee	是	int	交易订单的用户实付金额 单位为分
refundTime	是	long	支付平台返回的退款时间，时间戳 ，标准北京时间
createdTime	是	long	退款申请时间，时间戳 ，标准北京时间
refundReason	否	string	退款原因，若请求退款时有值则返回
ownerBusinessNo	否	string	商户维护:商户创建的订单业务号，商户自传，支付回调原封返回
ownerPayTerminal	否	string	商户支付终端，商户自传，支付回调原封返回

SDK方法

// 创建上传数据client
TyhPaymentClient client = TyhPaymentClient.create(TyhOptions.builder()
                .accessId(ACCESS_ID)
                .secretKey(SECRET_KEY)
                .allowUpload(Boolean.TRUE)
                .build());

// 构建查询交易订单的请求参数
TradeRefundQuery query = TradeRefundQuery.builder()
                .osRefundNo("os_refund_20211126")        // 必填
                .ownerRefundNo("owner_refund_20211126")  //选填
                .build();

// 开始发起请求
try {
    Results<TradeRefundResultDto> results = client.tradeRefundQuery(query);
    // 获取合并支付查询结果
    TradeRefundResultDto dto = results != null && results.ifSuccess() ? results.getData() : null;
} catch (Exception e) {
    e.printStackTrace();
}
     

入参格式

{
    "osRefundNo" : "os_refund_20211126",
    "ownerRefundNo" : "owner_refund_20211126"
}

出参格式：

{
  "code": 8888,
  "msg": "处理成功",
  "data": {
    "refundStatus":"SUCCESS",
    "osTradeNo": "os_trade_20211126",
    "osRefundNo": "os_refund_20211126",
    "refundFee": 400,
    "orderFee": 700,
    "paymentFee": 600,
    "refundTime": 1638003826072,
    "createdTime": 1638003819071,
    "refundReason": "退款原因"
  }
}

code 为 8888 表示操作成功，其它值则为失败，具体内容参见错误码说明)。