查询订单
更新时间:2025.01.07该接口提供所有微信支付订单的查询,商户可以通过查询订单接口主动查询订单状态,完成下一步的业务逻辑。
需要调用查询接口的情况:
当商户后台、网络、服务器等出现异常,商户系统最终未接收到支付通知;
调用扣款接口后,返回系统错误或未知交易状态情况
|
1. 接口说明
适用对象: 直连模式 机构模式
请求URL:https://apihk.mch.weixin.qq.com/v3/global/papay/transactions/{transaction_id}
或
https://apihk.mch.weixin.qq.com/v3/global/papay/transactions/out-trade-no/{out_trade_no}
请求方式:GET
Path 指该参数为路径参数
Query 指该参数为URL参数
Body 指该参数需在请求JSON传参
2. 请求参数
参数名 | 变量 | 类型[长度限制] | 必填 | 描述 |
---|---|---|---|---|
子商户号 | sub_mchid | string[1,32] | 否 | Query 服务商模式必填,微信支付分配的子商户号 |
微信订单号 | transaction_id | string[1,32] | 二选一 | Path 支付完成后,微信返回的微信支付订单号 |
商户订单号 | out_trade_no | string[1,32] | Path 商户系统内部的订单号,可包含字母;更换授权码必须要换新的商户订单号 其他说明见商户订单号 |
请求示例
场景一:直连模式
场景二:服务商模式/机构模式
3. 返回参数
参数名 | 变量 | 类型[长度限制] | 必填 | 描述 | |||
---|---|---|---|---|---|---|---|
商户号 | mchid | string[1,32] | 是 | 微信支付分配的商户号 | |||
应用ID | appid | string[1,32] | 是 | 商户号绑定的appid | |||
服务商商户号 | sp_mchid | string[1,32] | 是 | 微信支付分配的机构商户号 | |||
子商户号 | sub_mchid | string[1,32] | 是 | 微信支付分配的子商户号 | |||
服务商应用ID | sp_appid | string[1,32] | 是 | 服务商绑定的appid | |||
子商户应用ID | sub_appid | string[1,32] | 否 | 发起签约的子商户号绑定的appid | |||
商户订单号 | out_trade_no | string[1,32] | 是 | 返回的商户订单号 | |||
微信支付订单号 | transaction_id | string[1,32] | 是 | 微信支付订单号 | |||
商户数据 | attach | string[1,127] | 否 | 附加数据,在查询API和支付通知中原样返回,该字段主要用于商户携带订单的自定义数据 | |||
交易类型 | trade_type | string[1,16] | 是 | 代扣支付 | |||
付款银行 | 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,16] | 是 | 枚举值: | |||
交易状态描述 | trade_state_desc | string[1,256] | 是 | 对当前订单状态的描述和下一步操作的指引 | |||
MCC码 | merchant_category_code | string[1,16] | 是 | 商户行业编码 | |||
支付者 | payer | object | 否 | 成功时才返回。支付者信息,详细说明见下文 | |||
| |||||||
订单金额 | amount | object | 否 | 成功时才返回。订单金额信息,详细说明见下文 | |||
| |||||||
场景信息 | scene_info | object | 否 | 成功时才返回。场景信息对象,详细说明见下文 | |||
| |||||||
优惠功能 | promotion_detail | array | 否 | 成功时才返回。优惠功能信息,详细说明见下文 | |||
|
4. 错误码
状态码 | 错误码 | 描述 | 解决方案 |
---|---|---|---|
403 | CONTRACT_NOT_EXIST | Result Empty | 查询的签约协议不存在,或者传入正确查询参数重试 |
400 | PARAM_ERROR | 参数错误 | 传入正确查询参数 |
500 | SYSTEM_ERROR | 系统错误 | 请稍等重试 |