关闭订单

POST/pay/closeorder

应用场景

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

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

错误码

名称	描述	原因	解决方案
ORDERPAID	订单已支付	订单已支付，不能发起关单	订单已支付，不能发起关单，请当作已支付的正常交易
SYSTEMERROR	系统错误	系统错误	系统异常，请重新调用该API
ORDERCLOSED	订单已关闭	订单已关闭，无法重复关闭	订单已关闭，无需继续调用
SIGNERROR	签名错误	参数签名结果不正确	请检查签名参数和方法是否都符合签名算法要求
REQUIRE_POST_METHOD	请使用post方法	未使用post传递参数	请检查请求参数是否通过post方法提交
XML_FORMAT_ERROR	XML格式错误	XML格式错误	请检查XML参数格式是否正确

请求参数

appid

string

公众账号ID

必需

微信分配的公众账号ID（企业号corpid即为此appid）

mch_id

string

商户号

必需

微信支付分配的商户号

nonce_str

string

随机字符串

必需

随机字符串，不长于32位。推荐随机数生成算法

out_trade_no

string

商户订单号

必需

商户系统内部订单号，要求32个字符内（最少6个字符），只能是数字、大小写字母_-|*且在同一个商户号下唯一。详见商户订单号

sign

string

签名

必需

签名，详见签名生成算法

sign_type

string

签名类型

可选

签名类型，目前支持HMAC-SHA256和MD5，默认为MD5

<xml>
   <appid>wx2421b1c4370ec43b</appid>
   <mch_id>10000100</mch_id>
   <nonce_str>4ca93f17ddf3443ceabf72f26d64fe0e</nonce_str>
   <out_trade_no>1415983244</out_trade_no>
   <sign>59FF1DF214B2D279A0EA7077C54DD95D</sign>
</xml>

示例代码

返回响应

成功(200)

HTTP 状态码: 200

内容格式: JSONapplication/json

return_code

string

返回状态码

必需

SUCCESS/FAIL 此字段是通信标识，非交易标识，交易是否成功需要查看trade_state来判断

return_msg

string

返回信息

必需

当return_code为FAIL时返回信息为错误原因，例如签名失败参数格式校验错误

appid

string

公众账号ID

必需

微信分配的公众账号ID

mch_id

string

商户号

必需

微信支付分配的商户号

nonce_str

string

随机字符串

必需

随机字符串，不长于32位。推荐随机数生成算法

sign

string

签名

必需

签名，详见签名生成算法

result_code

string

业务结果

必需

SUCCESS/FAIL

result_msg

string

业务结果描述

必需

对业务结果的补充说明

err_code

string

错误代码

可选

当result_code为FAIL时返回错误代码，详细参见下文错误列表

err_code_des

string

错误代码描述

可选

当result_code为FAIL时返回错误描述，详细参见下文错误列表

<xml>
   <return_code><![CDATA[SUCCESS]]></return_code>
   <return_msg><![CDATA[OK]]></return_msg>
   <appid><![CDATA[wx2421b1c4370ec43b]]></appid>
   <mch_id><![CDATA[10000100]]></mch_id>
   <nonce_str><![CDATA[BFK89FC6rxKCOjLX]]></nonce_str>
   <sign><![CDATA[72B321D92A7BFA0B2509F3D13C7B1631]]></sign>
   <result_code><![CDATA[SUCCESS]]></result_code>
   <result_msg><![CDATA[OK]]></result_msg>
</xml>

最后修改时间： 3 年前