支付关闭接口 ¶

提示

用于支付订单创建后，用户在一定时间内未进行支付，可调用该接口直接将未付款的支付订单进行关闭。除了使用接口API方式对订单关闭，也可以在管理后台使用界面进行操作。与支付关闭接口类似的接口还有撤销接口，但只能应用在部分场景中。

接口说明 ¶

参数	说明
请求URL	`/unipay/close`
请求方式	`POST`
请求类型	`application/json`

请求参数 ¶

业务参数 ¶

提示

设置参数时，不要忘了设置公共请求参数调用说明，未做特殊说明所有接口都需要传输

字段名	变量名	必填	类型	长度	示例值	描述
支付订单号	orderNo	否	String	100	不可同时为空，支付订单号 > 商户订单号 > 通道订单号	1753370980523384832
商户支付订单号	bizOrderNo	否	String	100	不可同时为空，支付订单号 > 商户订单号 > 通道订单号	P0001
通道支付订单号	outOrderNo	否	String	100	不可同时为空，支付订单号 > 商户订单号 > 通道订单号	2025110024006610001
使用撤销关闭订单	useCancel	是	Boolean		false	是否使用撤销方式进行订单关闭, 只有部分支付通道的支付方式才可以使用, 如果不支持撤销, 这个参数将不会生效

响应结果 ¶

通用响应参数 ¶

提示

业务数据在公共响应参数中的data字段，在code为0时才会有返回数据，见调用说明。

业务响应参数 ¶

无业务响应数据，如果该支付订单设置了异步通知地址或订阅了支付订单变动，会给该地址推送通知消息，数据格式参考统一支付接口回调消息通知。

HTTP请求示例 ¶

请求参数 ¶

json

{
  "bizOrderNo" : "SDK_1721807811589",
  "useCancel" : true,
  "mchNo" : "M1723635576766",
  "appId" : "M8207639754663343",
  "clientIp" : "127.0.0.1",
  "sign" : "71cb5cc7c575651ad0bef8fb3348aeb7",
  "reqTime" : "2025-04-10 17:02:14"
}

响应参数(成功) ¶

json

{
    "code": 0,
    "msg": "success",
    "sign": "41dde6c64bba81938d0b34c3b73aa280",
    "resTime": "2025-04-10 17:09:08",
    "traceId": "gV9vddq9TkQn"
}

响应参数(失败) ¶

json

{
  "code" : 20041,
  "msg" : "支付订单不存在",
  "sign" : "a96b7ce2b8706a83e8515ce1db0f8f4c",
  "resTime" : "2025-04-10 17:02:14",
  "traceId" : "ZrGiGHeZByDi"
}

SDK请求示例 ¶

提示

使用SDK可以简化接入支付的速度

java

public void cancel(){
    PayCloseParam param = new PayCloseParam();
    param.setBizOrderNo("SDK_1721807811589");
    param.setClientIp("127.0.0.1");
    param.setUseCancel(true);
    DaxPayResult<Void> execute = DaxPayKit.execute(param);
    System.out.println(JsonUtil.toJsonStr(execute));
}