查询订单
更新时间:2025.01.07该接口提供所有微信支付订单的查询,商户可以通过查询订单接口主动查询订单状态,完成下一步的业务逻辑。
|
1. 接口说明
适用对象: 直连模式 机构模式
请求URL:https://apihk.mch.weixin.qq.com/v3/global/transactions/id/{id}
或
https://apihk.mch.weixin.qq.com/v3/global/transactions/out-trade-no/{out_trade_no}
请求方式: GET
Path 指该参数为路径参数
Query 指该参数为URL参数
Body 指该参数需在请求JSON传参
2. 请求参数
参数名 | 变量 | 类型[长度限制] | 必填 | 描述 |
---|---|---|---|---|
商户号 | mchid | string[1, 32] | 是 | query 微信支付分配的商户号 |
子商户号 | sub_mchid | string[1, 32] | 是 | query 微信支付分配的子商户号 |
机构商户号 | sp_mchid | string[1, 32] | 是 | query 微信支付分配的机构商户号 |
商户订单号 | out_trade_no | string[1, 32] | 二选一 | Path 返回的商户订单号 |
微信支付订单号 | id | string[1, 32] | Path 微信支付订单号 |
请求示例
微信支付订单号查
商户订单号查单
3. 返回参数
正常返回
参数名 | 变量 | 类型[长度限制] | 必填 | 描述 | |||
---|---|---|---|---|---|---|---|
商户号 | mchid | string[1, 32] | 是 | 微信支付分配的商户号 | |||
APPID | appid | string[1, 32] | 是 | 商户在微信公众平台申请服务号对应的APPID | |||
机构商户号 | sp_mchid | string[1, 32] | 是 | 微信支付分配的机构商户号 | |||
子商户号 | sub_mchid | string[1, 32] | 是 | 微信支付分配的子商户号 | |||
机构APPID | sp_appid | string[1, 32] | 是 | 机构在微信公众平台申请服务号对应的APPID | |||
子商户APPID | sub_appid | string[1, 32] | 否 | 子商户在微信开放平台申请移动应用对应的APPID | |||
商户订单号 | out_trade_no | string[1, 32] | 是 | 返回的商户订单号 | |||
微信支付订单号 | id | string[1, 32] | 是 | 微信支付订单号 | |||
商户数据 | attach | string[1, 127] | 否 | 附加数据,在查询API和支付通知中原样返回,该字段主要用于商户携带订单的自定义数据 | |||
交易类型 | trade_type | string[1, 16] | 是 | APP支付 | |||
付款银行 | bank_type | string[1, 32] | 是 | 银行类型,采用字符串类型的银行标识,值列表详见银行类型 | |||
支付完成时间 | success_time | string[1, 64] | 是 | 订单支付成功时间,格式为rfc3339格式,如2018-06-08T10:34:56+08:00 代表北京时间2018年06月08日10时34分56秒 | |||
交易状态 | trade_state | string[1, 32] | 是 | SUCCESS:支付成功 | |||
交易状态描述 | trade_state_desc | string[1, 256] | 是 | 对当前订单状态的描述和下一步操作的指引 | |||
支付者 | payer | object | 是 | 支付者信息,详细说明见下文 | |||
| |||||||
订单金额 | amount | object | 是 | 订单金额信息,详细说明见下文 | |||
| |||||||
优惠详情 | promotion_detail | array | 否 | 优惠详情信息,详细说明见下文 | |||
|
注意:goods_remark为备注字段,按照配置原样返回,goods_tag是订单优惠标记,用于区分订单是否可以享受优惠,两个字段内容都在微信后台配置券时进行设置。
异常返回
参数名 | 变量 | 类型[长度限制] | 必填 | 描述 | |||
---|---|---|---|---|---|---|---|
返回状态码 | code | string[1, 32] | 是 | 错误码,枚举值见错误码列表 | |||
返回信息 | message | string[1, 256] | 是 | 返回信息,如非空,为错误原因 | |||
详细的错误描述 | detail | object | 否 | 当code为PARAM_ERROR时返回,详细说明见下 | |||
|
返回示例
正常示例
异常示例
4. 错误码
错误码 | 描述 | 解决方案 |
---|---|---|
ORDER_NOT_EXIST | 此交易订单号不存在 | 该API只能查提交支付交易返回成功的订单,请商户检查需要查询的订单号是否正确 |
SYSTEM_ERROR | 系统错误 | 系统异常,请再调用发起查询 |