查询订单

更新时间:2024.12.18

应用场景

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

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

◆ 当商户后台、网络、服务器等出现异常,商户系统最终未接收到支付通知(查单实现可参考:支付回调和查单实现指引);

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

◆ 调用被扫支付API,返回USERPAYING的状态;

◆ 调用关单或撤销接口API之前,需确认支付状态;

接口链接

https://api.mch.weixin.qq.com/pay/orderquery

是否需要证书

不需要

请求参数

字段名

变量名

必填

类型

示例值

描述

服务商的APPID

appid

String(32)

wx8888888888888888

服务商商户的APPID

子商户公众账号ID

sub_appid

String(32)

wx8888888888888888

微信分配的子商户公众账号ID

商户号

mch_id

String(32)

1900000109

微信支付分配的商户号

子商户号

sub_mch_id

String(32)

1900000109

微信支付分配的子商户号

微信订单号

transaction_id

二选一

String(32)

013467007045764

微信的订单号,优先使用

商户订单号

out_trade_no

String(32)

1217752501201407033233368018

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

随机字符串

nonce_str

String(32)

C380BEC2BFD727A4B6845133519F3AD6

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

签名

sign

String(32)

5K8264ILTKCH16CQ2502SI8ZNMTM67VS

签名,详见签名生成算法

举例如下:

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

返回结果

字段名

变量名

必填

类型

示例值

描述

返回状态码

return_code

String(16)

SUCCESS

SUCCESS/FAIL

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

返回信息

return_msg

String(128)

签名失败

返回信息,如非空,为错误原因,例如:签名失败、参数格式校验错误

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

字段名

变量名

必填

类型

示例值

描述

服务商的APPID

appid

String(32)

wx8888888888888888

服务商商户的APPID

商户号

mch_id

String(32)

1900000109

微信支付分配的商户号

子商户公众账号ID

sub_appid

String(32)

wx8888888888888888

微信分配的子商户公众账号ID

子商户号

sub_mch_id

String(32)

1900000109

微信支付分配的子商户号

随机字符串

nonce_str

String(32)

5K8264ILTKCH16CQ2502SI8ZNMTM67VS

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

签名

sign

String(32)

C380BEC2BFD727A4B6845133519F3AD6

签名,详见签名生成算法

业务结果

result_code

String(16)

SUCCESS

SUCCESS/FAIL

错误代码

err_code

String(32)

SYSTEMERROR

详细参见第6节错误列表

错误代码描述

err_code_des

String(128)

系统错误

结果信息描述

以下字段在return_code 、result_code、trade_state都为SUCCESS时有返回 。

交易成功判断条件: return_code、result_code和trade_state都为SUCCESS

字段名

变量名

必填

类型

示例值

描述

设备号

device_info

String(32)

013467007045764

微信支付分配的终端设备号,

用户标识

openid

String(128)

wxd930ea5d5a258f4f

用户在商户appid下的唯一标识

是否关注公众账号

is_subscribe

String(1)

N

已废弃,默认统一返回N

用户子标识

sub_openid

String(128)

wxd930ea5d5a258f4f

用户在子商户appid下的唯一标识

是否关注子公众账号

sub_is_subscribe

String(1)

N

已废弃,默认统一返回N

交易类型

trade_type

String(16)

JSAPI

调用接口提交的交易类型,取值如下:JSAPI,NATIVE,APP,MICROPAY,详细说明见参数规定

交易状态

trade_state

String(32)

SUCCESS

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

付款银行

bank_type

String(32)

CMC

银行类型,采用字符串类型的银行标识

商品详情

detail

String(8192)

{
"discount_detail":[
{
"goods_id":"iphone6s_16G",
"goods_name":"iPhone6s 16G",
"coupon_batch_id":888,
"coupon_id":666888,
"coupon_fee":1000
},
{
"goods_id":"iphone6s_32G",
"goods_name":"iPhone6s 32G",
"coupon_batch_id":999,
"coupon_id":666999,
"coupon_fee":1500
}
]
}

商品详细列表,使用Json格式,传输签名前请务必使用CDATA标签将JSON文本串保护起来。如果使用了单品优惠,会有单品优惠信息返回

discount_detail []:
└ goods_id String 必填 32 商品的编号
└ goods_name String 必填 256 商品名称
└ coupon_batch_id String 必填 代金券批次ID
└ coupon_id String 必填 代金卷ID
└ coupon_fee int 必填 代金券支付金额,单位为分

标价金额

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,其他值列表详见货币类型

代金券金额

coupon_fee

int

100

“代金券或立减优惠”金额<=订单总金额,订单总金额-“代金券或立减优惠”金额=现金支付金额,详见支付金额

代金券使用数量

coupon_count

int

1

代金券或立减优惠使用数量

代金券ID

coupon_id_$n

String(20)

10000 

代金券或立减优惠ID, $n为下标,从0开始编号

代金券类型

coupon_type_$n

String

CASH

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

单个代金券金额

coupon_fee_$n

int

100

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

微信支付订单号

transaction_id

String(32)

1217752501201407033233368018

微信支付订单号

商户订单号

out_trade_no

String(32)

1217752501201407033233368018

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

商家数据包

attach

String(128)

123456

商家数据包,原样返回

支付完成时间

time_end

String(14)

20141030133525

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

交易状态描述

trade_state_desc

String(256)

支付失败,请重新下单支付

对当前查询订单状态的描述和下一步操作的指引

举例如下:

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   <sub_mch_id><![CDATA[1900000109]]></sub_mch_id>
7   <device_info><![CDATA[1000]]></device_info>
8   <nonce_str><![CDATA[TN55wO9Pba5yENl8]]></nonce_str>
9   <sign><![CDATA[BDF0099C15FF7BC6B1585FBB110AB635]]></sign>
10   <result_code><![CDATA[SUCCESS]]></result_code>
11   <openid><![CDATA[oUpF8uN95-Ptaags6E_roPHg7AG0]]></openid>
12   <is_subscribe><![CDATA[N]]></is_subscribe>
13   <trade_type><![CDATA[MICROPAY]]></trade_type>
14   <bank_type><![CDATA[CCB_DEBIT]]></bank_type>
15   <total_fee>1</total_fee>
16   <fee_type><![CDATA[CNY]]></fee_type>
17   <transaction_id><![CDATA[1008450740201411110005820873]]></transaction_id>
18   <out_trade_no><![CDATA[1415757673]]></out_trade_no>
19   <attach><![CDATA[订单额外描述]]></attach>
20   <time_end><![CDATA[20141111170043]]></time_end>
21   <trade_state><![CDATA[SUCCESS]]></trade_state>
22</xml>

错误码

名称

描述

原因

解决方案

ORDERNOTEXIST

此交易订单号不存在

查询系统中不存在此交易订单号

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

SYSTEMERROR

系统错误

后台系统返回错误

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

 

 

 

反馈
咨询
目录
置顶