Login expired. Please log in again.

Feedback

0/300

Feedback

Submitted successfully

ok

Feedback

Network exception, please try again later

ok

关闭订单API

最新更新时间:2023.10.20 版本说明

以下情况需要调用关单接口:商户订单支付失败需要生成新单号重新发起支付,要对原订单号调用关单,避免重复支付;系统下单后,用户支付超时,系统退出不再受理,避免用户继续,请调用关单接口。

注意:

• 订单生成后不能马上调用关单接口,最短调用时间间隔为5分钟。

1. 接口说明

适用对象:直连模式机构模式

请求URL:https://apihk.mch.weixin.qq.com/v3/global/transactions/id/{transaction_id}/close
          或
          https://apihk.mch.weixin.qq.com/v3/global/transactions/out-trade-no/{out_trade_no}/close

请求方式: POST


Path指该参数为路径参数
Query指该参数为URL参数
Body指该参数需在请求JSON传参

2. 请求参数

参数名 变量 类型[长度限制] 必填 描述
微信支付订单号 transaction_id string[1,32] 二选一 Path 微信支付订单号
示例值:1217752501201407033233368018
商户订单号 out_trade_no string[1,32] Path 商户订单号
示例值:1217752501201407033233368018
商户号 mchid string[1,32] Body 微信支付分配的商户号
注意:仅适用于直连模式
示例值:1900000109
子商户号 sub_mchid string[1,32] Body 微信支付分配的子商户号
注意:仅适用于机构模式
示例值:1900000109
机构商户号 sp_mchid string[1,32] Body 微信支付分配的机构商户号
注意:仅适用于机构模式
示例值:1900000100

请求示例


{
    "sp_mchid": "10000100",
    "sub_mchid": "20000100"
}
  

https://apihk.mch.weixin.qq.com/v3/global/refunds?out_trade_no=1217752501201407033233368018&count=10&offset=0&sp_mchid=1900000100&sub_mchid=1900000109
  

									{
										"stock_id": ".NET",
										"limit": 10,
									}

									{
										"stock_id": "Python",
										"stock_creator_mchid": "123456",
										"limit": 10,
									}

3. 返回参数

正常返回

无数据(HTTP状态码为204)

异常返回

参数名 变量 类型[长度限制] 必填 描述
返回状态码 code string[1, 32] 错误码,枚举值见错误码列表
示例值:INVALID_REQUEST
返回信息 message string[1, 256] 返回信息,如非空,为错误原因
示例值:参数格式校验错误
详细的错误描述 detail object 当code为PARAM_ERROR时返回,详细说明见下
参数名 变量 类型[长度限制] 必填 描述
指示错误参数的位置 field string[1, 256] 当错误参数位于请求body的JSON时,填写指向参数的JSON Pointer
当错误参数位于请求的url或者querystring时,填写参数的变量名
示例值:#/properties/payer
错误参数的值 value string[1, 256] 错误参数的值
示例值:1346177081915535577
具体错误原因 issue string[1, 256] 具体错误原因
示例值:与ALLOF schema不符
错误参数的位置 location string[1, 256] body:错误参数位于请求body的JSON中
url:错误参数位于请求url中
query:错误参数位于请求的querystring中
示例值:body

返回示例


{
	"code": "INVALID_REQUEST",
	"message": "Parameter format verification error",
	"detail": {
		"field": "#/properties/payer",
		"value": "1346177081915535577",
		"issue": "与ALLOF schema不符",
		"location": "body"
	}
}

{
	"code": "INVALID_REQUEST",
	"message": "Parameter format verification error",
	"detail": {
		"field": "#/properties/payer",
		"value": "1346177081915535577",
		"issue": "与ALLOF schema不符",
		"location": "body"
	}
}

4. 错误码

错误码 描述 解决方案
ORDERPAID 订单已支付 订单已支付,不能发起关单,请当作已支付的正常交易
SYSTEM_ERROR 系统错误 系统异常,请重新调用该API
ORDER_CLOSED 订单已关闭 订单已关闭,无需继续调用
REQUIRE_POST_METHOD 请使用post方法 请检查请求参数是否通过post方法提交


    页面导航

About  WeChat  Pay

Powered By Tencent & Tenpay Copyright©

2005-2024 Tenpay All Rights Reserved.

Contact Us
Wechat Pay Global

WeChat Pay Global

置顶