关闭支付订单

关闭订单

接口描述：商户通过该接口关闭订单，支付网关会对订单完成关闭处理。
接口说明
适用对象：普通商户 特约商户
请求URL：https://pay.yintongzaixian.com/api/pay/close
请求方式：POST
请求类型：application/json 或 application/x-www-form-urlencoded
请求参数

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

请求示例数据JSON

{
  "payOrderId": "P202106181104177050002",
  "appId": "60cc09bce4b0f1c0b83761c9",
  "sign": "46940C58B2F3AE426B77A297ABF4D31E",
  "signType": "MD5",
  "reqTime": "1624006009",
  "mchNo": "M1623984572",
  "version": "1.0"
}

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

data数据格式

字段名	变量名	必填	类型	示例值	描述
渠道错误码	errCode	否	String	1002	渠道关单返回错误码
渠道错误描述	errMsg	否	String	关闭异常	渠道关单返回错误描述

返回示例数据JSON

{
  "code": 0,
  "data": {
    "errCode": '',
    "errMsg": ''
  },
  "msg": "SUCCESS",
  "sign": "9548145EA12D0CD8C1628BCF44E19E0D"
}

SDK调用示例（Java）：

JeepayClient jeepayClient = JeepayClient.getInstance(Jeepay.appId, Jeepay.apiKey, Jeepay.getApiBase());
PayOrderCloseRequest request = new PayOrderCloseRequest();
PayOrderCloseReqModel model = new PayOrderCloseReqModel();
model.setMchNo(Jeepay.mchNo);                           // 商户号
model.setAppId(jeepayClient.getAppId());                 // 应用ID
model.setPayOrderId("P1526477317539262465");             // 支付订单号

request.setBizModel(model);
try {
    PayOrderCloseResponse 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());
}