支付接口 - 查询退款订单

查询退款订单

接口描述：商户通过该接口查询退款订单，支付网关会返回订单最新的数据
接口说明
适用对象：普通商户 特约商户
请求URL：https://pay.yintongzaixian.com/api/refund/query
请求方式：POST
请求类型：application/json 或 application/x-www-form-urlencoded

请求参数

字段名	变量名	必填	类型	示例值	描述
商户号	mchNo	是	String(64)	M1621873433953	商户号
应用ID	appId	是	String(64)	60cc09bce4b0f1c0b83761c9	应用ID
退款订单号	refundOrderId	是	String(30)	R20160427210604000490	支付中心生成的退款单号，与mchRefundNo二者传一即可
商户退款单号	mchRefundNo	是	String(64)	20160427210604000490	商户生成的退款单号，与refundOrderId二者传一即可
请求时间	reqTime	是	long	1622016572190	请求接口时间,13位时间戳
接口版本	version	是	String(3)	1.0	接口版本号，固定：1.0
签名	sign	是	String(32)	C380BEC2BFD727A4B6845133519F3AD6	签名值，详见签名算法
签名类型	signType	是	String(32)	MD5	签名类型，目前只支持MD5或RSA2方式

请求示例数据JSON

{
  "refundOrderId": "P202106181105527690009",
  "appId": "60cc09bce4b0f1c0b83761c9",
  "sign": "1484293FCAEAFE11DEC8949DB6B525A9",
  "signType": "MD5",
  "reqTime": "1624008199",
  "mchNo": "M1623984572",
  "version": "1.0"
}

返回参数

字段名	变量名	必填	类型	示例值	描述
返回状态	code	是	int	0	0-处理成功，其他-处理有误，详见错误码
返回信息	msg	否	String(128)	签名失败	具体错误原因，例如：签名失败、参数格式校验错误
签名信息	sign	否	String(32)	CCD9083A6DAD9A2DA9F668C3D4517A84	对data内数据签名,如data为空则不返回
返回数据	data	否	String(512)	{}	返回下单数据,json格式数据

data数据格式

字段名	变量名	必填	类型	示例值	描述
退款订单号	refundOrderId	是	String(30)	R20160427210604000490	支付中心生成的退款单号
支付订单号	payOrderId	是	String(30)	P12021022311124442600	返回支付系统订单号
商户号	mchNo	是	String(30)	M1621873433953	商户号
应用ID	appId	是	String(24)	60cc09bce4b0f1c0b83761c9	应用ID
商户退款单号	mchRefundNo	是	String(30)	20160427210604000490	商户生成的退款单号
支付金额	payAmount	是	int	100	支付金额,单位分
退款金额	refundAmount	是	int	100	退款金额,单位分
货币代码	currency	是	String(3)	cny	三位货币代码,人民币:cny
退款状态	state	是	int	2	退款状态 0-订单生成 1-退款中 2-退款成功 3-退款失败 4-退款关闭
渠道订单号	channelOrderNo	否	String	20160427210604000490	对应渠道的订单号
渠道错误码	errCode	否	String	1002	渠道返回错误码
渠道错误描述	errMsg	否	String	134586944573118714	渠道返回错误描述
扩展参数	extraParam	否	String(512)	134586944573118714	商户扩展参数,回调时会原样返回
创建时间	createdAt	是	long	1622016572190	订单创建时间,13位时间戳
成功时间	successTime	否	long	1622016572190	订单支付成功时间,13位时间戳

返回示例数据JSON

{
  "code": 0,
  "data": {
    "appId": "60cc09bce4b0f1c0b83761c9",
    "channelOrderNo": "2021061822001423031419593035",
    "createdAt": 1623985552769,
    "currency": "cny",
    "extParam": "",
    "mchNo": "M1623984572",
    "mchRefundNo": "mho1623985552430",
    "payAmount": 58,
    "payOrderId": "P202106181104177050002",
    "refundAmount": 4,
    "refundOrderId": "P202106181105527690009",
    "state": 2,
    "successTime": 1623985554000
  },
  "msg": "SUCCESS",
  "sign": "E3F9F008FC5EF84BD782CCC7BE69DC5E"
}

SDK调用示例（Java）：

JeepayClient jeepayClient = JeepayClient.getInstance(Jeepay.appId, Jeepay.apiKey, Jeepay.getApiBase());
RefundOrderQueryRequest request = new RefundOrderQueryRequest();
RefundOrderQueryReqModel model = new RefundOrderQueryReqModel();
model.setMchNo(Jeepay.mchNo);                           // 商户号
model.setAppId(jeepayClient.getAppId());                 // 应用ID
model.setRefundOrderId("R1526477317539262465");           // 退款订单号

request.setBizModel(model);
try {
    RefundOrderQueryResponse response = jeepayClient.execute(request);
    _log.info("验签结果：{}", response.checkSign(Jeepay.apiKey));
    if (response.isSuccess(Jeepay.apiKey)) {
        _log.info("data：{}", response.getData());
    } else {
        _log.info("请求失败：mchNo={}, msg={}", Jeepay.mchNo, response.getMsg());
    }
} catch (JeepayException e) {
    _log.error(e.getMessage());
}

搜索结果

查询退款订单

请求参数

返回参数