查询订单

更新时间：2024.11.18

应用场景

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

押金消费时，押金金额解冻，部分金额退还给用户，部分金额结算给商户。通过该接口可以查询押金消费的目前的具体押金消费单状态：包含退款和结算状态信息.

需要调用查询接口的情况：

当商户后台、网络、服务器等出现异常，商户系统最终未接收到支付通知；
调用支付接口后，返回系统错误或未知交易状态情况；
调用被扫支付API，返回USERPAYING的状态；
调用关单或撤销接口API之前，需确认支付状态；
查询押金消费状态。

接口规则

请求Url	https://api.mch.weixin.qq.com/deposit/orderquery
是否需要证书	否
请求方式	post
签名方式	HMAC-SHA256

请求参数

名称	变量名	必填	类型	示例值	描述
服务商应用ID	appid	是	String(32)	wx8888888888888888	服务商商户的APPID
商户号	mch_id	是	String(32)	1900000109	服务商商户的商户号
子商户应用ID	sub_appid	否	String(32)	wx8888888888888888	微信分配的子商户APPID，如需在支付完成后获取sub_openid则此参数必传。
子商户号	sub_mch_id	是	String(32)	1900000109	服务商通过进件后获得的特约商户号
微信订单号	transaction_id	二选一	String(32)	013467007045764	微信的订单号，优先使用
商户订单号	out_trade_no	二选一	String(32)	1217752501201407033233368018	商户系统内部订单号，要求32个字符内，只能是数字、大小写字母_-\|*@ ，且在同一个商户号下唯一。
随机字符串	nonce_str	是	String(32)	C380BEC2BFD727A4B6845133519F3AD6	随机字符串，不长于32位。推荐随机数生成算法
签名	sign	是	String(64)	C380BEC2BFD727A4B6845133519F3AD6C380BEC2BFD727A4B6845133519F3AD6	签名，详见签名生成算法
签名类型	sign_type	是	String(32)	HMAC-SHA256	签名类型，仅支持HMAC-SHA256

举例如下：

1<xml>
2  <appid>wx2421b1c4370ec43b</appid>
3  <mch_id>10000100</mch_id>
4  <nonce_str>ec2316275641faa3aacf3cc599e8730f</nonce_str>
5  <transaction_id>1008450740201411110005820873</transaction_id>
6  <sign_type> HMAC-SHA256</sign_type>
7  <sign>FDD167FAA73459FD921B144BAF4F4CA2</sign>
8</xml>

返回结果

名称	变量名	必填	类型	示例值	描述
返回状态码	return_code	是	String(16)	SUCCESS	SUCCESS/FAIL 此字段是通信标识，非交易标识，交易是否成功需要查看trade_state来判断
返回信息	return_msg	否	String(128)	签名失败	返回信息，如非空，为错误原因签名失败参数格式校验错误

以下字段在return_code为SUCCESS的时候有返回

名称	变量名	必填	类型	示例值	描述
服务商应用ID	appid	是	String(32)	wx8888888888888888	服务商商户的APPID
商户号	mch_id	是	String(32)	1900000109	服务商商户的商户号
子商户应用ID	sub_appid	否	String(32)	wx8888888888888888	微信分配的子商户APPID，如需在支付完成后获取sub_openid则此参数必传。
子商户号	sub_mch_id	是	String(32)	1900000109	服务商通过进件后获得的特约商户号
随机字符串	nonce_str	是	String(32)	5K8264ILTKCH16CQ2502SI8ZNMTM67VS	随机字符串，不长于32位。推荐随机数生成算法
签名	sign	是	String(64)	C380BEC2BFD727A4B6845133519F3AD6C380BEC2BFD727A4B6845133519F3AD6	签名，详见签名生成算法
业务结果	result_code	是	String(16)	SUCCESS	SUCCESS/FAIL
错误代码	err_code	否	String(32)	SYSTEMERROR	详细参见错误列表
错误代码描述	err_code_des	否	String(128)	系统错误	结果信息描述

以下字段在return_code 、result_code、trade_state都为SUCCESS时有返回，如trade_state不为 SUCCESS，则只返回out_trade_no（必传）和attach（选传）。

名称	变量名	必填	类型	示例值	描述
设备号	device_info	否	String(32)	013467007045764	微信支付分配的终端设备号，
用户标识	openid	是	String(128)	wxd930ea5d5a258f4f	用户在商户appid下的唯一标识
是否关注公众账号	is_subscribe	否	String(1)	Y	用户是否关注公众账号，Y-关注，N-未关注，仅在公众账号类型支付有效
用户子标识	sub_openid	否	String(128)	wxd930ea5d5a258f4f	用户在子商户appid下的唯一标识
是否关注子公众账号	sub_is_subscribe	是	String(1)	Y	用户是否关注子公众账号，Y-关注，N-未关注，仅在公众账号类型支付有效
交易类型	trade_type	是	String(16)	DEPOSITPAY	调用接口提交的交易类型，取值如下：MICROPAY，DEPOSITPAY
交易状态	trade_state	是	String(32)	SUCCESS	刷卡支付交易状态： SUCCESS—支付成功 REFUND—转入退款 NOTPAY—未支付 CLOSED—已关闭 REVOKED—已撤销(刷卡支付) USERPAYING--用户支付中 PAYERROR--支付失败(其他原因，如银行返回失败) 押金支付交易状态： NOTPAY—未支付 USERPAYING--用户支付中 PAYERROR--支付失败 SUCCESS?支付成功，资金冻结中 REVOKED—已撤销 SETTLING—押金消费已受理 SETTLEMENTFAIL ?押金解除冻结失败 CONSUMED—押金消费成功
付款银行	bank_type	是	String(32)	CMC	银行类型，采用字符串类型的银行标识
标价金额	total_fee	是	int	100	订单总金额，单位为分
标价币种	fee_type	否	String(8)	CNY	货币类型，符合ISO 4217标准的三位字母代码，默认人民币：CNY，其他值列表详见货币类型
应结订单金额	settlement_total_fee	否	int	100	当订单使用了免充值型优惠券后返回该参数，应结订单金额=订单金额-免充值优惠券金额。
现金支付金额	cash_fee	是	int	100	现金支付金额订单现金支付金额，详见支付金额
现金支付货币类型	cash_fee_type	否	String(16)	CNY	货币类型，符合ISO 4217标准的三位字母代码，默认人民币：CNY，其他值列表详见货币类型
微信支付订单号	transaction_id	是	String(32)	1217752501201407033233368018	微信支付订单号
商户订单号	out_trade_no	是	String(32)	1217752501201407033233368018	商户系统内部订单号，要求32个字符内，只能是数字、大小写字母_-\|*@ ，且在同一个商户号下唯一。
商家数据包	attach	否	String(128)	123456	商家数据包，原样返回
支付完成时间	time_end	是	String(14)	20141030133525	订单支付时间，格式为yyyyMMddHHmmss，如2009年12月25日9点10分10秒表示为20091225091010。其他详见时间规则
交易状态描述	trade_state_desc	是	String(256)	支付失败，请重新下单支付	对当前查询订单状态的描述和下一步操作的指引
押金消费金额	consume_fee	否	int	888	押金消费金额，用户消费后结算给商户的金额

举例如下：

1<xml>
2  <return_code><![CDATA[SUCCESS]]></return_code>
3  <return_msg><![CDATA[OK]]></return_msg>
4  <appid><![CDATA[wx2421b1c4370ec43b]]></appid>
5  <mch_id><![CDATA[10000100]]></mch_id>
6  <device_info><![CDATA[1000]]></device_info>
7  <nonce_str><![CDATA[TN55wO9Pba5yENl8]]></nonce_str>
8  <sign><![CDATA[BDF0099C15FF7BC6B1585FBB110AB635]]></sign>
9  <result_code><![CDATA[SUCCESS]]></result_code>
10  <openid><![CDATA[oUpF8uN95-Ptaags6E_roPHg7AG0]]></openid>
11  <is_subscribe><![CDATA[Y]]></is_subscribe>
12  <trade_type><![CDATA[MICROPAY]]></trade_type>
13  <bank_type><![CDATA[CCB_DEBIT]]></bank_type>
14  <total_fee>1</total_fee>
15  <fee_type><![CDATA[CNY]]></fee_type>
16  <transaction_id><![CDATA[1008450740201411110005820873]]></transaction_id>
17  <out_trade_no><![CDATA[1415757673]]></out_trade_no>
18  <attach><![CDATA[订单额外描述]]></attach>
19  <time_end><![CDATA[20141111170043]]></time_end>
20  <trade_state><![CDATA[SUCCESS]]></trade_state>
21</xml>

错误码列表

名称	描述	原因	解决方案
ORDERNOTEXIST	此交易订单号不存在	查询系统中不存在此交易订单号	该API只能查提交支付交易返回成功的订单，请商户检查需要查询的订单号是否正确
SYSTEMERROR	系统错误	后台系统返回错误	系统异常，请再调用发起查询

文档是否有帮助

更多支持

开发文档(商户)开发文档(V2版)开发者社区微信开放平台微信公众平台腾讯客服