查询订单
更新时间: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 | 签名,详见签名生成算法 |
举例如下:
返回结果
字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
---|---|---|---|---|---|
返回状态码 | 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--支付成功 |
付款银行 | bank_type | 是 | String(32) | CMC | 银行类型,采用字符串类型的银行标识 |
商品详情 | detail | 否 | String(8192) | { | 商品详细列表,使用Json格式,传输签名前请务必使用CDATA标签将JSON文本串保护起来。如果使用了单品优惠,会有单品优惠信息返回 discount_detail []: |
标价金额 | 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--充值代金券 |
单个代金券金额 | 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) | 支付失败,请重新下单支付 | 对当前查询订单状态的描述和下一步操作的指引 |
举例如下:
错误码
名称 | 描述 | 原因 | 解决方案 |
---|---|---|---|
ORDERNOTEXIST | 此交易订单号不存在 | 查询系统中不存在此交易订单号 | 该API只能查提交支付交易返回成功的订单,请商户检查需要查询的订单号是否正确 |
SYSTEMERROR | 系统错误 | 后台系统返回错误 | 系统异常,请再调用发起查询 |