# 查询订单状态

> 接口应在服务器端调用，不可在前端（小程序、网页、APP等）直接调用，具体可参考[接口调用指南](/doc/oplatform/developers/dev/guide.md)。

接口英文名：pay_v2.queryOrder

本接口用于查看订单状态

## 1. 调用方式

### HTTPS 调用

```bash
POST https://api.weixin.qq.com/wxa/game/queryorderinfo?access_token=ACCESS_TOKEN&signature=SIGNATURE&sig_method=SIG_METHOD&pay_sig=PAY_SIG
```

### 云调用

- 本接口不支持云调用。

### 第三方调用

- 本接口不支持第三方平台调用。

## 2. 请求参数

### 查询参数 `Query String Parameters`

```json
[
  {
    "参数名": "access_token",
    "类型": "string",
    "必填": "是",
    "说明": "接口调用凭证，可使用 [access_token](/minigame/dev/api-backend/access-token/api_getaccesstoken)"
  },
  {
    "参数名": "signature",
    "类型": "string",
    "必填": "是",
    "说明": "[用户登录态签名](/minigame/dev/guide/open-ability/signature.md)"
  },
  {
    "参数名": "sig_method",
    "类型": "string",
    "必填": "是",
    "说明": "用户登录态签名的哈希方法，只支持 hmac_sha256，请传入\"hmac_sha256\""
  },
  {
    "参数名": "pay_sig",
    "类型": "string",
    "必填": "是",
    "说明": "[支付请求签名（pay_sig）算法说明](/minigame/dev/guide/open-ability/virtual-payment/signature.md)"
  }
]
```

### 请求体 `Request Payload`

```json
[
  {
    "参数名": "openid",
    "类型": "string",
    "必填": "是",
    "说明": "用户唯一标识符",
    "枚举": "-"
  },
  {
    "参数名": "offer_id",
    "类型": "string",
    "必填": "是",
    "说明": "支付应用 ID（OfferId）",
    "枚举": "-"
  },
  {
    "参数名": "ts",
    "类型": "number",
    "必填": "是",
    "说明": "当前 UNIX 时间戳（请尽可能确保时间准确），单位：秒\n如：1668136271",
    "枚举": "-"
  },
  {
    "参数名": "zone_id",
    "类型": "string",
    "必填": "是",
    "说明": "已发布的分区 ID（MP-分区配置-分区 ID） ；需要和 env 对应",
    "枚举": "-"
  },
  {
    "参数名": "env",
    "类型": "number",
    "必填": "是",
    "说明": "环境配置",
    "枚举": "枚举值"
  },
  {
    "参数名": "out_trade_no",
    "类型": "string",
    "必填": "是",
    "说明": "充值时传入的外部订单号",
    "枚举": "-"
  },
  {
    "参数名": "biz_id",
    "类型": "number",
    "必填": "是",
    "说明": "1 代币 2 道具直购",
    "枚举": "-"
  }
]
```

## 3. 返回参数

### 返回体 `Response Payload`

```json
[
  {
    "参数名": "errcode",
    "类型": "number",
    "说明": "错误码"
  },
  {
    "参数名": "errmsg",
    "类型": "string",
    "说明": "错误信息"
  },
  {
    "参数名": "product_id",
    "类型": "string",
    "说明": "道具 id"
  },
  {
    "参数名": "pay_state",
    "类型": "number",
    "说明": "支付状态（用户是否已支付）1 未支付 2 已支付"
  },
  {
    "参数名": "deliver_state",
    "类型": "number",
    "说明": "发货状态（如果是游戏币，则是余额是否增加） 1 未发货 2 已发货"
  },
  {
    "参数名": "pay_finish_time",
    "类型": "number",
    "说明": "支付完成时间"
  },
  {
    "参数名": "out_trade_no",
    "类型": "string",
    "说明": "充值时传入的外部订单号"
  },
  {
    "参数名": "mch_order_no",
    "类型": "string",
    "说明": "微信支付商户单号（仅微信支付方式存在）"
  },
  {
    "参数名": "transaction_id",
    "类型": "string",
    "说明": "交易单号（微信支付订单号，仅微信支付方式存在）"
  }
]
```

## 4. 枚举信息

### Body.env `Enum`

环境配置

```json
[
  {
    "枚举值": "0",
    "描述": "现网环境（也叫正式环境）"
  },
  {
    "枚举值": "1",
    "描述": "沙箱环境"
  }
]
```

## 5. 注意事项

本接口无特殊注意事项

## 6. 代码示例

### 6.1 请求示例

请求示例

```json
{
  "openid": "oUrsfxxxxxxxxxx",
  "ts": 1668512806,
  "env": 0,
  "out_trade_no": "test_queryorderinfo_1668512806",
  "offer_id":"xxxx",
  "biz_id":1
}
```

返回示例

```json
{
  "errcode": 0,
  "errmsg": "ok",
  "out_trade_no": "test_queryorderinfo_1668512806",
  "pay_finish_time": 1669364790,
  "product_id": "id_100001",
  "deliver_state": 1,
  "pay_state": 1,
  "mch_order_no": "1217752501201407033233368018",
  "transaction_id": "1217752501201407033233368018"
}
```

### 6.2 请求示例

请求示例

```json
{
  "openid": "oUrsfxxxxxxxxxx",
  "ts": 1668512806,
  "env": 0,
  "out_trade_no": "test_queryorderinfo_1668512806",
  "offer_id":"xxxx",
  "biz_id":1
}
```

返回示例

```json
{
  "errcode": 90018,
  "errmsg": "[openid] openid is invalid"
}
```

## 7. 错误码

以下是本接口的错误码列表，其他错误码可参考 [通用错误码](/doc/oplatform/developers/errCode/README.md)；调用接口遇到报错，可使用官方提供的 [API 诊断工具](https://developers.weixin.qq.com/console/devtools/debug?utm_source=api_errcode) 辅助定位和分析问题。

```json
[
  {
    "错误码": "-1",
    "错误描述": "系统繁忙，此时请开发者稍候再试"
  },
  {
    "错误码": "0",
    "错误描述": "请求成功"
  },
  {
    "错误码": "90010",
    "错误描述": "signature 签名错误"
  },
  {
    "错误码": "90011",
    "错误描述": "pay_sig 签名错误"
  },
  {
    "错误码": "90016",
    "错误描述": "sessionkey fail，用户 sessionkey 过期，需要重走登录流程"
  },
  {
    "错误码": "90018",
    "错误描述": "参数错误，具体参数见 errmsg 描述"
  },
  {
    "错误码": "90019",
    "错误描述": "out_trade_no 未找到"
  }
]
```

## 8. 适用范围

本接口支持「小游戏（仅认证）」账号类型调用。其他账号类型如无特殊说明，均不可调用。