微信支付 API
  1. API列表
微信支付 API
  • 文档说明
    • 阅读对象
    • 版本说明
  • 术语
    • 支付模式
    • 名词解释
  • 支付账户
    • 支付账户
  • 接口规则
    • 协议规则
    • 参数规定
    • 安全规范
    • 获取openid
  • JSAPI支付
    • 场景介绍
    • 案例介绍
    • 接入前准备
    • 开发指引
    • 获取微信版本号
    • JSAPI调起支付
    • 支付常见问题
  • API列表
    • 统一下单
      POST
    • 查询订单
      POST
    • 关闭订单
      POST
    • 申请退款
      POST
    • 查询退款
      POST
    • 下载交易账单
      POST
    • 下载资金账单
      POST
    • 支付结果通知
      POST
    • 交易保障
      POST
    • 退款结果通知
      POST
  • 最佳实践
    • 支付回调和查单实现指引
    • 支付验收指引
    • 网络排查指引
    • 最佳安全实践
    • 跨城冗灾方案
    • 回调通知注意事项
    • 专线商户Notify升级指引
    • 商户收银台H5大字号规范
    • 微信支付二维码规范
  • 运营规范
    • 运营规范
  • SDK与DEMO下载
    • SDK与DEMO下载
  1. API列表

关闭订单

POST
/pay/closeorder

应用场景#

以下情况需要调用关单接口:商户订单支付失败需要生成新单号重新发起支付,要对原订单号调用关单,避免重复支付;系统下单后,用户支付超时,系统退出不再受理,避免用户继续,请调用关单接口。
注意:订单生成后不能马上调用关单接口,最短调用时间间隔为5分钟。

错误码#

名称描述原因解决方案
ORDERPAID订单已支付订单已支付,不能发起关单订单已支付,不能发起关单,请当作已支付的正常交易
SYSTEMERROR系统错误系统错误系统异常,请重新调用该API
ORDERCLOSED订单已关闭订单已关闭,无法重复关闭订单已关闭,无需继续调用
SIGNERROR签名错误参数签名结果不正确请检查签名参数和方法是否都符合签名算法要求
REQUIRE_POST_METHOD请使用post方法未使用post传递参数请检查请求参数是否通过post方法提交
XML_FORMAT_ERRORXML格式错误XML格式错误请检查XML参数格式是否正确
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST '/pay/closeorder' \
--header 'Content-Type: application/xml' \
--data-raw '<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>'
响应示例响应示例
<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> 

请求参数

Body 参数application/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
示例

返回响应

🟢200成功
application/json
Body
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时返回错误描述,详细参见下文错误列表
上一页
查询订单
下一页
申请退款
Built with