查询订单

更新时间:2025.01.07

该接口提供所有微信支付订单的查询,商户可以通过查询订单接口主动查询订单状态,完成下一步的业务逻辑。

注意:

需要调用查询接口的情况

  • 当商户后台、网络、服务器等出现异常,商户系统最终未接收到支付通知;

  • 调用支付接口后,返回系统错误或未知交易状态情况;

  • 调用刷卡支付API,返回USERPAYING的状态;


1. 接口说明

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

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

请求方式: GET

 

Path 指该参数为路径参数

Query 指该参数为URL参数

Body 指该参数需在请求JSON传参

2. 请求参数

参数名

变量

类型[长度限制]

必填

描述

商户号

mchid

string[1, 32]

query 微信支付分配的商户号
注意:仅适用于直连模式
示例值:1900000109

子商户号

sub_mchid

string[1, 32]

query 微信支付分配的子商户号
注意:仅适用于机构模式
示例值:1900000109

机构商户号

sp_mchid

string[1, 32]

query 微信支付分配的机构商户号
注意:仅适用于机构模式
示例值:1900000109

商户订单号

out_trade_no

string[1, 32]

二选一

Path 返回的商户订单号
示例值:1217752501201407033233368018

微信支付订单号

id

string[1, 32]

Path 微信支付订单号
示例值:4200000000002104083200000488

请求示例

微信支付订单号查

1https://apihk.mch.weixin.qq.com/v3/global/transactions/id/4200000000002104083200000488?mchid=1900000109

商户订单号查单

1https://apihk.mch.weixin.qq.com/v3/global/transactions/out-trade-no/1217752501201407033233368018?sub_mchid =1900000109&sp_mchid =1900000100  

 

3. 返回参数

正常返回

参数名

变量

类型[长度限制]

必填

描述

商户号

mchid

string[1, 32]

微信支付分配的商户号
注意:仅适用于直连模式
示例值:1900000109

APPID

appid

string[1, 32]

商户在微信公众平台申请服务号对应的APPID
注意:仅适用于直连模式
示例值:wx8888888888888888

机构商户号

sp_mchid

string[1, 32]

微信支付分配的机构商户号
注意:仅适用于机构模式
示例值:1900000100

子商户号

sub_mchid

string[1, 32]

微信支付分配的子商户号
注意:仅适用于机构模式
示例值:1900000109

机构APPID

sp_appid

string[1, 32]

机构在微信公众平台申请服务号对应的APPID
注意:仅适用于机构模式
示例值:wx8888888888888888

子商户APPID

sub_appid

string[1, 32]

子商户在微信开放平台申请移动应用对应的APPID
注意:仅适用于机构模式
示例值:wx8888888888888888

商户订单号

out_trade_no

string[1, 32]

返回的商户订单号
示例值:1217752501201407033233368018

微信支付订单号

id

string[1, 32]

微信支付订单号
示例值:4200000000002104083200000488

商户数据

attach

string[1, 127]

附加数据,在查询API和支付通知中原样返回,该字段主要用于商户携带订单的自定义数据
示例值:自定义数据

交易类型

trade_type

string[1, 16]

APP支付
示例值:APP

付款银行

bank_type

string[1, 32]

银行类型,采用字符串类型的银行标识,值列表详见银行类型
示例值:CMC

支付完成时间

success_time

string[1, 64]

订单支付成功时间,格式为rfc3339格式,如2018-06-08T10:34:56+08:00 代表北京时间2018年06月08日10时34分56秒
示例值:2018-06-08T10:34:56+08:00

交易状态

trade_state

string[1, 32]

SUCCESS:支付成功
REFUND:转入退款
NOTPAY:未支付
CLOSED:已关闭
REVOKED:已撤销(刷卡支付)
USERPAYING:用户支付中
PAYERROR:支付失败(其他原因,如银行返回失败)
示例值:SUCCESS

交易状态描述

trade_state_desc

string[1, 256]

对当前订单状态的描述和下一步操作的指引
示例值:支付失败,请重新下单支付

支付者

payer

object

支付者信息,详细说明见下文

支付者

订单金额

amount

object

订单金额信息,详细说明见下文

订单金额

优惠详情

promotion_detail

array

优惠详情信息,详细说明见下文

优惠详情

注意:goods_remark为备注字段,按照配置原样返回,goods_tag是订单优惠标记,用于区分订单是否可以享受优惠,两个字段内容都在微信后台配置券时进行设置。

 

异常返回

参数名

变量

类型[长度限制]

必填

描述

返回状态码

code

string[1, 32]

错误码,枚举值见错误码列表
示例值:INVALID_REQUEST

返回信息

message

string[1, 256]

返回信息,如非空,为错误原因
示例值:参数格式校验错误

详细的错误描述

detail

object

当code为PARAM_ERROR时返回,详细说明见下

详细的错误描述

返回示例

正常示例

1{
2	"id": "4200000000002104083200000488",
3	"sp_appid": "wx2421b1c4370ec43b",
4	"sp_mchid": "10000100",
5	"sub_mchid": "20000100",
6	"out_trade_no": "20150806125346",
7	"payer": {
8		"sp_openid": "oUpF8uN95-Ptaags6E_roPHg7AG0"
9	},
10	"amount": {
11		"total": 528800,
12		"currency": "HKD",
13		"payer_total": 518799,
14		"payer_currency": "CNY",
15
16		"exchange_rate": {
17			"type": "SETTLEMENT_RATE",
18			"rate": 8000000
19		}
20	},
21	"trade_type": "APP",
22	"trade_state": "SUCCESS",
23	"trade_state_desc": "支付成功",
24	"bank_type": "CCB_DEBIT",
25	"attach": "支付测试",
26	"success_time": "2018-06-08T10:34:56+08:00",
27	"promotion_detail": [{
28		"promotion_id": "109519",
29		"name": "单品惠-6",
30		"scope": "SINGLE",
31		"type": "DISCOUNT",
32		"amount": 1,
33		"currency": "HKD",
34		"activity_id": "931386",
35		"wechatpay_contribute_amount": 1,
36		"merchant_contribute_amount": 0,
37		"other_contribute_amount": 0,
38		"goods_detail": [{
39			"goods_id": "iphone6s_16G",
40			"goods_remark": "商品备注",
41			"quantity": 1,
42			"price": 528800
43		}]
44	}]
45}

异常示例

1{
2	"code": "INVALID_REQUEST",
3	"message": "Parameter format verification error",
4	"detail": {
5		"field": "#/properties/payer",
6		"value": "1346177081915535577",
7		"issue": "与ALLOF schema不符",
8		"location": "body"
9	}
10}

 

4. 错误码

错误码

描述

解决方案

ORDER_NOT_EXIST

此交易订单号不存在

该API只能查提交支付交易返回成功的订单,请商户检查需要查询的订单号是否正确

SYSTEM_ERROR

系统错误

系统异常,请再调用发起查询

 

 

About  WeChat  Pay

Powered By Tencent & Tenpay Copyright©

2005-2025 Tenpay All Rights Reserved.

Contact Us
Wechat Pay Global

WeChat Pay Global

Contact Us

Customer Service Tel

+86 571 95017

9:00-18:00 Monday-Friday GMT+8

Business Development

wxpayglobal@tencent.com

Developer Support

wepayTS@tencent.com

Wechat Pay Global

About Tenpay
Powered By Tencent & Tenpay Copyright© 2005-2025 Tenpay All Rights Reserved.