# 拉取充值订单信息

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

接口英文名：insurance_freight_getpayorderlist

本接口用于拉取充值订单信息

## 1. 调用方式

### HTTPS 调用

```bash
POST https://api.weixin.qq.com/wxa/business/insurance_freight/getpayorderlist?access_token=ACCESS_TOKEN
```

### 云调用

- 本接口不支持云调用。

### 第三方调用

- 本接口支持第三方平台代商家调用。

- 该接口所属的权限集 id 为：139

- 服务商获得其中之一权限集授权后，可通过使用 [authorizer_access_token](/doc/oplatform/developers/dev/AuthorizerAccessToken.md) 代商家进行调用，具体可查看 [第三方调用](/doc/oplatform/Third-party_Platforms/2.0/Before_Develop/call_interface.md) 说明文档。

## 2. 请求参数

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

```json
[
  {
    "参数名": "access_token",
    "类型": "string",
    "必填": "是",
    "示例": "ACCESS_TOKEN",
    "说明": "接口调用凭证，可使用 [access_token](/miniprogram/dev/server/API/mp-access-token/api_getaccesstoken)、[authorizer_access_token](/doc/oplatform/openApi/ticket-token/api_getauthorizeraccesstoken.md)"
  }
]
```

### 请求体 `Request Payload`

```json
[
  {
    "参数名": "status_list",
    "类型": "numarray",
    "必填": "是",
    "说明": "订单状态",
    "枚举": "枚举值"
  },
  {
    "参数名": "offset",
    "类型": "number",
    "必填": "否",
    "说明": "分页offset",
    "枚举": "-"
  },
  {
    "参数名": "limit",
    "类型": "number",
    "必填": "否",
    "说明": "分页limit",
    "枚举": "-"
  }
]
```

## 3. 返回参数

### 返回体 `Response Payload`

```json
[
  {
    "参数名": "total",
    "类型": "number",
    "说明": "总数"
  },
  {
    "参数名": "list",
    "类型": "objarray",
    "说明": "充值订单列表"
  }
]
```

">

### Res.list(Array) `Object Payload`

充值订单列表

```json
[
  {
    "参数名": "order_id",
    "类型": "number",
    "说明": "充值单号",
    "枚举": "-"
  },
  {
    "参数名": "order_status",
    "类型": "number",
    "说明": "订单状态",
    "枚举": "枚举值"
  },
  {
    "参数名": "total_price",
    "类型": "number",
    "说明": "充值金额",
    "枚举": "-"
  },
  {
    "参数名": "create_time",
    "类型": "number",
    "说明": "订单创建时间",
    "枚举": "-"
  },
  {
    "参数名": "pay_time",
    "类型": "number",
    "说明": "支付时间",
    "枚举": "-"
  },
  {
    "参数名": "can_refund",
    "类型": "number",
    "说明": "是否可以退款",
    "枚举": "-"
  },
  {
    "参数名": "refund_time",
    "类型": "number",
    "说明": "退款时间",
    "枚举": "-"
  },
  {
    "参数名": "refund_status",
    "类型": "number",
    "说明": "退款状态",
    "枚举": "枚举值"
  },
  {
    "参数名": "refund_amt",
    "类型": "number",
    "说明": "退款金额",
    "枚举": "-"
  }
]
```

## 4. 枚举信息

### Body.status_list `Enum`

订单状态

```json
[
  {
    "枚举值": "1",
    "描述": "待支付"
  },
  {
    "枚举值": "2",
    "描述": "支付成功"
  },
  {
    "枚举值": "3",
    "描述": "使用中"
  },
  {
    "枚举值": "4",
    "描述": "已用完"
  },
  {
    "枚举值": "5",
    "描述": "退款中"
  },
  {
    "枚举值": "6",
    "描述": "已退款"
  },
  {
    "枚举值": "10",
    "描述": "支付超时"
  }
]
```

__order_status">

### Res.list(Array).order_status `Enum`

订单状态

```json
[
  {
    "枚举值": "1",
    "描述": "待支付"
  },
  {
    "枚举值": "2",
    "描述": "支付成功"
  },
  {
    "枚举值": "3",
    "描述": "使用中"
  },
  {
    "枚举值": "4",
    "描述": "已用完"
  },
  {
    "枚举值": "5",
    "描述": "退款中"
  },
  {
    "枚举值": "6",
    "描述": "已退款"
  },
  {
    "枚举值": "10",
    "描述": "支付超时"
  }
]
```

__refund_status">

### Res.list(Array).refund_status `Enum`

退款状态

```json
[
  {
    "枚举值": "1",
    "描述": "未退款"
  },
  {
    "枚举值": "2",
    "描述": "退款中"
  },
  {
    "枚举值": "4",
    "描述": "退款成功"
  },
  {
    "枚举值": "5",
    "描述": "退款失败"
  }
]
```

## 5. 注意事项

本接口无特殊注意事项

## 6. 代码示例

请求示例

```json
{
    "status_list": [
        2, 3, 4, 5, 6
    ],
    "offset": 0,
    "limit": 20
}
```

返回示例

```json
{
    "errcode": 0,
    "errmsg": "ok",
    "list": [
        {
            "order_id": 2850151276313431996,
            "order_status": 5,
            "total_price": 1000,
            "create_time": 1678966793,
            "pay_time": 1678966880,
            "can_refund": true,
            "refund_time": 0,
            "refund_status": 1
        }
    ],
    "total": 1
}
```

## 7. 错误码

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

## 8. 适用范围

本接口支持「小程序」账号类型调用。其他账号类型如无特殊说明，均不可调用。