# 拉取充值订单信息
接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南。
接口英文名:insurance_freight_getpayorderlist
本接口用于拉取充值订单信息
# 1. 调用方式
# HTTPS 调用
POST https://api.weixin.qq.com/wxa/business/insurance_freight/getpayorderlist?access_token=ACCESS_TOKEN
# 云调用
- 本接口不支持云调用。
# 第三方调用
本接口支持第三方平台代商家调用。
该接口所属的权限集 id 为:139
服务商获得其中之一权限集授权后,可通过使用 authorizer_access_token 代商家进行调用,具体可查看 第三方调用 说明文档。
# 2. 请求参数
# 查询参数 Query String Parameters
| 参数名 | 类型 | 必填 | 示例 | 说明 |
|---|---|---|---|---|
| access_token | string | 是 | ACCESS_TOKEN | 接口调用凭证,可使用 access_token、authorizer_access_token |
# 请求体 Request Payload
| 参数名 | 类型 | 必填 | 说明 | 枚举 |
|---|---|---|---|---|
| status_list | numarray | 是 | 订单状态 | 枚举值 |
| offset | number | 否 | 分页offset | - |
| limit | number | 否 | 分页limit | - |
# 3. 返回参数
# 返回体 Response Payload
| 参数名 | 类型 | 说明 |
|---|---|---|
| total | number | 总数 |
| list | objarray | 充值订单列表 |
# Res.list(Array) Object Payload
充值订单列表
| 参数名 | 类型 | 说明 | 枚举 |
|---|---|---|---|
| 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
订单状态
| 枚举值 | 描述 |
|---|---|
| 1 | 待支付 |
| 2 | 支付成功 |
| 3 | 使用中 |
| 4 | 已用完 |
| 5 | 退款中 |
| 6 | 已退款 |
| 10 | 支付超时 |
# Res.list(Array).order_status Enum
订单状态
| 枚举值 | 描述 |
|---|---|
| 1 | 待支付 |
| 2 | 支付成功 |
| 3 | 使用中 |
| 4 | 已用完 |
| 5 | 退款中 |
| 6 | 已退款 |
| 10 | 支付超时 |
# Res.list(Array).refund_status Enum
退款状态
| 枚举值 | 描述 |
|---|---|
| 1 | 未退款 |
| 2 | 退款中 |
| 4 | 退款成功 |
| 5 | 退款失败 |
# 5. 注意事项
本接口无特殊注意事项
# 6. 代码示例
请求示例
{
"status_list": [
2, 3, 4, 5, 6
],
"offset": 0,
"limit": 20
}
返回示例
{
"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. 错误码
此接口没有特殊错误码,可参考 通用错误码;调用接口遇到报错,可使用官方提供的 API 诊断工具 辅助定位和分析问题。
# 8. 适用范围
本接口支持「小程序」账号类型调用。其他账号类型如无特殊说明,均不可调用。