微信支付-开发者文档

返回上一层文档首页 / 查询订单API

查询订单API

最新更新时间：2021.12.16 版本说明

商户可以通过查询订单接口主动查询订单状态，完成下一步的业务逻辑。查询订单状态可通过微信支付订单号或商户订单号两种方式查询

注意：

查询订单可通过微信支付订单号和商户订单号两种方式查询，两种查询方式返回结果相同

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

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

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

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

• 调用关单接口API之前，需确认支付状态。

1、微信支付订单号查询

接口说明

适用对象： 服务商

请求URL： https://api.mch.weixin.qq.com/v3/pay/partner/transactions/id/{transaction_id}

请求方式：GET

path指该参数为路径参数

query指该参数需在请求URL传参

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

请求参数

参数名	变量	类型[长度限制]	必填	描述
服务商户号	sp_mchid	string[1,32]	是	query 服务商户号，由微信支付生成并下发示例值：1230000109
子商户号	sub_mchid	string[1,32]	是	query 子商户的商户号，由微信支付生成并下发。示例值：1900000109
微信支付订单号	transaction_id	string[1,32]	是	path 微信支付系统生成的订单号示例值：1217752501201407033233368018

请求示例


https://api.mch.weixin.qq.com/v3/pay/partner/transactions/id/4200000985202103031441826014?sp_mchid=1900007XXX&sub_mchid=1900008XXX

    
｛
JAVA示例代码
｝

2、商户订单号查询

接口说明

适用对象： 服务商

请求URL： https://api.mch.weixin.qq.com/v3/pay/partner/transactions/out-trade-no/{out_trade_no}

请求方式：GET

path指该参数为路径参数

query指该参数需在请求URL传参

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

请求参数

参数名	变量	类型[长度限制]	必填	描述
服务商户号	sp_mchid	string[1,32]	是	query 服务商户号，由微信支付生成并下发示例值：1230000109
子商户号	sub_mchid	string[1,32]	是	query 子商户的商户号，由微信支付生成并下发。示例值：1900000109
商户订单号	out_trade_no	string[6,32]	是	path 商户系统内部订单号，只能是数字、大小写字母_-*且在同一个商户号下唯一。特殊规则：最小字符长度为6 示例值：1217752501201407033233368018

请求示例


https://api.mch.weixin.qq.com/v3/pay/partner/transactions/out-trade-no/1217752501201407033233368XXX?sp_mchid=1230000109&sub_mchid=1900008XXX

    
｛
JAVA示例代码
｝

返回参数

参数名

变量

类型[长度限制]

必填

描述

服务商应用ID

sp_appid

string[1,32]

是

服务商申请的公众号或移动应用appid。
示例值：wx8888888888888888

服务商户号

sp_mchid

string[1,32]

是

服务商户号，由微信支付生成并下发
示例值：1230000109

子商户应用ID

sub_appid

string[1,32]

否

子商户申请的公众号或移动应用appid。
示例值：wxd678efh567hg6999

子商户号

sub_mchid

string[1,32]

是

子商户的商户号，由微信支付生成并下发。
示例值：1900000109

商户订单号

out_trade_no

string[6,32]

是

商户系统内部订单号，只能是数字、大小写字母_-*且在同一个商户号下唯一，详见【商户订单号】。
特殊规则：最小字符长度为6
示例值：1217752501201407033233368018

微信支付订单号

transaction_id

string[1,32]

否

微信支付系统生成的订单号。
示例值：1217752501201407033233368018

交易类型

trade_type

string[1,16]

否

交易类型，枚举值：
JSAPI：公众号支付
NATIVE：扫码支付
APP：APP支付
MICROPAY：付款码支付
MWEB：H5支付
FACEPAY：刷脸支付
示例值：MICROPAY

交易状态

trade_state

string[1,32]

是

交易状态，枚举值：
SUCCESS：支付成功
REFUND：转入退款
NOTPAY：未支付
CLOSED：已关闭
REVOKED：已撤销（仅付款码支付会返回）
USERPAYING：用户支付中（仅付款码支付会返回）
PAYERROR：支付失败（仅付款码支付会返回）
示例值：SUCCESS

交易状态描述

trade_state_desc

string[1,256]

是

交易状态描述
示例值：支付成功

付款银行

bank_type

string[1,32]

否

银行类型，采用字符串类型的银行标识。银行标识请参考《银行类型对照表》
示例值：CMC

附加数据

attach

string[1,128]

否

附加数据，在查询API和支付通知中原样返回，可作为自定义参数使用，实际情况下只有支付完成状态才会返回该字段。
示例值：自定义数据

支付完成时间

success_time

string[1,64]

否

支付完成时间，遵循rfc3339标准格式，格式为yyyy-MM-DDTHH:mm:ss+TIMEZONE，yyyy-MM-DD表示年月日，T出现在字符串中，表示time元素的开头，HH:mm:ss表示时分秒，TIMEZONE表示时区（+08:00表示东八区时间，领先UTC 8小时，即北京时间）。例如：2015-05-20T13:29:35+08:00表示，北京时间2015年5月20日 13点29分35秒。
示例值：2018-06-08T10:34:56+08:00

+ 支付者

payer

object

是

支付者信息

参数名	变量	类型[长度限制]	必填	描述
用户服务标识	sp_openid	string[1,128]	是	用户在服务商appid下的唯一标识。示例值：oUpF8uMuAJO_M2pxb1Q9zNjWeS6o
用户子标识	sub_openid	string[1,128]	否	用户在子商户appid下的唯一标识。如果返回sub_appid，那么sub_openid一定会返回示例值：oUpF8uMuAJO_M2pxb1Q9zNjWeS6o

+订单金额

amount

object

否

订单金额信息，当支付成功时返回该字段。

参数名	变量	类型[长度限制]	必填	描述
总金额	total	int	否	订单总金额，单位为分。示例值：100
用户支付金额	payer_total	int	否	用户支付金额，单位为分。（指使用优惠券的情况下，这里等于总金额-优惠券金额）示例值：100
货币类型	currency	string[1,16]	否	CNY：人民币，境内商户号仅支持人民币。示例值：CNY
用户支付币种	payer_currency	string[1,16]	否	用户支付币种示例值：CNY

+场景信息

scene_info

object

否

支付场景描述

参数名	变量	类型[长度限制]	必填	描述
商户端设备号	device_id	string[1,32]	否	商户端设备号（发起扣款请求的商户服务器设备号）。示例值：013467007045764

+优惠功能

promotion_detail

array

否

优惠功能，享受优惠时返回该字段。

参数名

变量

类型[长度限制]

必填

描述

券ID

coupon_id

string[1,32]

是

券ID
示例值：109519

优惠名称

name

string[1,64]

否

优惠名称
示例值：单品惠-6

优惠范围

scope

string[1,32]

否

GLOBAL：全场代金券
SINGLE：单品优惠
示例值：GLOBAL

优惠类型

type

string[1,32]

否

CASH：充值型代金券
NOCASH：免充值型代金券
示例值：CASH

优惠券面额

amount

int

是

优惠券面额
示例值：100

活动ID

stock_id

string[1,32]

否

活动ID
示例值：931386

微信出资

wechatpay_contribute

int

否

微信出资，单位为分
示例值：0

商户出资

merchant_contribute

int

否

商户出资，单位为分
示例值：0

其他出资

other_contribute

int

否

其他出资，单位为分
示例值：0

优惠币种

currency

string[1,16]

否

CNY：人民币，境内商户号仅支持人民币。
示例值：CNY

+单品列表

goods_detail

array

否

单品列表信息

参数名	变量	类型[长度限制]	必填	描述
商品编码	goods_id	string[1,32]	是	商品编码示例值：M1006
商品数量	quantity	int	是	用户购买的数量示例值：1
商品单价	unit_price	int	是	商品单价，单位为分示例值：100
商品优惠金额	discount_amount	int	是	商品优惠金额示例值：0
商品备注	goods_remark	string[1,128]	否	商品备注信息示例值：商品备注信息

返回示例

正常示例


{
	"amount": {
		"currency": "CNY",
		"payer_currency": "CNY",
		"payer_total": 2,
		"total": 2
	},
	"attach": "",
	"bank_type": "CMB_DEBIT",
	"out_trade_no": "b3682ea011c547a49e8d7cc93107b71c",
	"payer": {
		"sp_openid": "o4GgauMQHaUO8ujCGIXNKATQlXXX",
		"sub_openid": "o4GgauMQHaUO8ujCGIXNKATQlXXX"
	},
	"promotion_detail": [],
	"sp_appid": "wxdace645e0bc2cXXX",
	"sp_mchid": "1900007XXX",
	"sub_appid": "wxdace645e0bc2cXXX",
	"sub_mchid": "1900008XXX",
	"success_time": "2021-03-03T15:27:14+08:00",
	"trade_state": "SUCCESS",
	"trade_state_desc": "支付成功",
	"trade_type": "JSAPI",
	"transaction_id": "4200000985202103031441826014"
}


    http://2323weixin.qq.com

错误码公共错误码

状态码	错误码	描述	解决方案
400	INVALID_REQUEST	无效请求	请根据接口返回的详细信息检查
	APPID_MCHID_NOT_MATCH	appid和mch_id不匹配	请确认appid和mch_id是否匹配
	PARAM_ERROR	参数错误	请根据接口返回的详细信息检查请求参数
	ORDER_CLOSED	订单已关闭	当前订单已关闭，请重新下单
	MCH_NOT_EXISTS	商户号不存在	请检查商户号是否正确
401	SIGN_ERROR	签名错误	请检查签名参数和方法是否都符合签名算法要求
403	ACCOUNT_ERROR	账号异常	用户账号异常，无需更多操作
	OUT_TRADE_NO_USED	商户订单号重复	请核实商户订单号是否重复提交
	TRADE_ERROR	交易错误	因业务原因交易失败，请查看接口返回的详细信息
	RULE_LIMIT	业务规则限制	因业务规则限制请求频率，请查看接口返回的详细信息
	NOT_ENOUGH	余额不足	用户账号余额不足，请用户充值或更换支付卡后再支付
	NO_AUTH	商户无权限	请商户前往申请此接口相关权限
404	ORDER_NOT_EXIST	订单不存在	请检查订单是否发起过交易
404	ORDER_NOT_EXIST	订单不存在	请检查订单是否发起过交易
429	FREQUENCY_LIMITED	频率超限	请降低请求接口频率
500	SYSTEM_ERROR	系统错误	系统异常，请用相同参数重新调用
	OPENID_MISMATCH	openid和appid不匹配	请确认openid和appid是否匹配
	INVALID_TRANSACTIONID	订单号非法	请检查微信支付订单号是否正确
	BANK_ERROR	银行系统异常	银行系统异常，请用相同参数重新调用

微信支付合作伙伴平台

查询订单API

注意：

1、微信支付订单号查询

接口说明

请求参数

请求示例

2、商户订单号查询

接口说明

请求参数

请求示例

返回参数

返回示例

错误码公共错误码