查询订单

更新时间：2024.11.14

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

注意：

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

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

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

调用付款码支付API，返回USERPAYING的状态；

调用关单或撤销接口API之前，需确认支付状态；

接口说明

适用对象：服务商

请求URL： https://api.mch.weixin.qq.com/pay/orderquery

URL地址： https://api2.mch.weixin.qq.com/pay/orderquery(备用域名)见跨城冗灾方案

请求方式： POST

数据格式： XML

是否需要证书：否

请求参数

参数名	变量	类型[长度限制]	必填	描述
应用ID	appid	string[1,32]	是	由微信生成的应用ID，全局唯一。请求查单接口时请注意APPID的应用属性，例如公众号场景下，需使用应用属性为公众号的APPID。示例值：wxcbda96de0b165486
商户号	mch_id	string[1,32]	是	商户号是商户在微信申请微信支付成功后分配的账号ID，登录平台为pay.weixin.qq.com 示例值：1200009811
子商户应用ID	sub_appid	string[1,32]	否	子商户号绑定的appid(非必填，如需操作，需要服务商在商户平台为子商户绑定) 示例值：wxcbda96de0b165489
子商户号	sub_mch_id	string[1,32]	是	微信支付分配的子商户号示例值：1900000109
微信订单号	transaction_id	string[1,32]	二选一	微信生成的订单号，在支付通知中有返回示例值：1217752501201407033233368018
商户订单号	out_trade_no	string[1,32]	二选一	商户系统内部订单号，要求32个字符内，只能是数字、大小写字母_-\|*@ ，且在同一个商户号下唯一。 transaction_id、out_trade_no二选一，如果同时存在优先级：transaction_id> out_trade_no 示例值：1217752501201407033233368018
随机字符串	nonce_str	string[1,32]	是	随机字符串，不长于32位。推荐随机数生成算法示例值：5K8264ILTKCH16CQ2502SI8ZNMTM67VS
签名	sign	string[1,32]	是	签名，详见签名生成算法示例值：C380BEC2BFD727A4B6845133519F3AD6

请求示例：

XML

1
2<xml>
3   <appid>wx2421b1c4370ec43b</appid>
4   <sub_appid>wx2421b1c4370ec43b</sub_appid>
5   <mch_id>10000100</mch_id>
6   <sub_mch_id>1900000109</sub_mch_id>
7   <nonce_str>ec2316275641faa3aacf3cc599e8730f</nonce_str>
8   <transaction_id>1008450740201411110005820873</transaction_id>
9   <sign>FDD167FAA73459FD921B144BAF4F4CA2</sign>
10</xml>
11

返回参数

参数名	变量	类型[长度限制]	必填	描述
返回状态码	return_code	string[1,16]	是	SUCCESS/FAIL 此字段是通信标识，非交易标识，交易是否成功需要查看result_code来判断示例值：SUCCESS
返回信息	return_msg	string[1,128]	否	返回信息，如非空，为错误原因如：签名失败等。示例值：签名失败

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

参数名	变量	类型	必填	描述
应用ID	appid	string[1,32]	是	由微信生成的应用ID，全局唯一。请求查单接口时请注意APPID的应用属性，例如公众号场景下，需使用应用属性为公众号的APPID 示例值：wx8888888888888888
商户号	mch_id	string[1,32]	是	微信支付分配的商户号示例值：1900000109
子商户应用ID	sub_appid	string[1,32]	否	微信分配的子商户应用ID，如需在支付完成后获取sub_openid则此参数必传。示例值：wx8888888888888888
子商户号	sub_mch_id	string[1,32]	是	微信支付分配的子商户号示例值：1900000109
随机字符串	nonce_str	string[1,32]	是	随机字符串，不长于32位。推荐随机数生成算法示例值：5K8264ILTKCH16CQ2502SI8ZNMTM67VS
签名	sign	string[1,64]	是	签名，详见签名生成算法示例值：C380BEC2BFD727A4B6845133519F3AD6
业务结果	result_code	string[1,16]	是	SUCCESS/FAIL 示例值：SUCCESS
错误代码	err_code	string[1,32]	否	详细参见错误列表示例值：SYSTEMERROR
错误代码描述	err_code_des	string[1,128]	否	结果信息描述示例值：系统错误

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

参数名

变量

类型[长度限制]

必填

描述

设备号

device_info

string[1,32]

否

微信支付分配的终端设备号，
示例值：013467007045764

用户标识

openid

string[1,128]

是

用户在商户appid下的唯一标识
示例值：oUpF8uMuAJO_M2pxb1Q9zNjWeS6o

是否关注公众账号

is_subscribe

string[1,1]

否

用户是否关注公众账号，枚举值：
Y：关注，
N：未关注，
仅在公众账号类型支付有效
示例值：Y

用户子标识

sub_openid

string[1,128]

否

用户在子商户appid下的唯一标识
示例值：oUpF8uMuAJO_M2pxb1Q9zNjWeS6o

是否关注子公众账号

sub_is_subscribe

string[1,1]

否

用户是否关注子公众账号，枚举值：
Y：关注
N：未关注
（机构商户不返回）
示例值：Y

交易类型

trade_type

string[1,16]

是

调用接口提交的交易类型，取值如下：
JSAPI：JSAPI支付（或小程序支付）
NATIVE：Native支付
APP：APP支付
MWEB：H5支付
PAP：委托代扣
示例值：PAP

交易状态

trade_state

string[1,32]

是

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

付款银行

bank_type

string[1,32]

是

银行类型，采用字符串类型的银行标识
示例值：CMC

商品详情

detail

string[1,8192]

否

商品详细列表，使用Json格式。如果使用了单品优惠，会有单品优惠信息返回

商品详情

总金额

total_fee

int

是

订单总金额，单位为分
示例值：100

货币种类

fee_type

string[1,8]

否

货币类型，符合ISO 4217标准的三位字母代码，默认人民币：CNY，其他值列表详见货币类型
示例值：CNY

应结订单金额

settlement_total_fee

int

否

当订单使用了免充值型优惠券后返回该参数，应结订单金额=订单金额-免充值优惠券金额。
示例值：100

现金支付金额

cash_fee

int

是

现金支付金额订单现金支付金额，详见支付金额
示例值：100

现金支付货币类型

cash_fee_type

string[1,16]

否

货币类型，符合ISO 4217标准的三位字母代码，默认人民币：CNY，其他值列表详见货币类型
示例值：CNY

代金券金额

coupon_fee

int

否

“代金券或立减优惠”金额<=订单总金额，订单总金额-“代金券或立减优惠”金额=现金支付金额，详见支付金额
示例值：100

代金券使用数量

coupon_count

int

否

代金券或立减优惠使用数量
示例值：1

代金券ID

coupon_id_$n

string[1,20]

否

代金券或立减优惠ID, $n为下标，从0开始编号
示例值：10000

代金券类型

coupon_type_$n

String

否

CASH：充值代金券
NO_CASH：非充值优惠券
开通免充值券功能，并且订单使用了优惠券后有返回（取值：CASH、NO_CASH）。$n为下标,从0开始编号，举例：coupon_type_$0
示例值：CASH

单个代金券金额

coupon_fee_$n

int

否

单个代金券或立减优惠支付金额, $n为下标，从0开始编号
示例值：100

微信支付订单号

transaction_id

string[1,32]

是

微信支付订单号
示例值：1009660380201506130728806387

商户订单号

out_trade_no

string[1,32]

是

商户系统的订单号，与请求一致。
示例值：20150806125346

附加数据

attach

string[1,128]

否

附加数据，原样返回
示例值：深圳分店

支付完成时间

time_end

string[1,14]

是

订单支付时间，格式为yyyyMMddHHmmss，如2009年12月25日9点10分10秒表示为20091225091010。其他详见时间规则
示例值：20141030133525

交易状态描述

trade_state_desc

string[1,256]

是

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

返回示例：

正常示例

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

错误码

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

文档是否有帮助

更多支持

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