# 查询创建的订单
接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南。
接口英文名:query_order
本接口用于查询创建的订单(现金单,非代币单)
# 1. 调用方式
# HTTPS 调用
POST https://api.weixin.qq.com/xpay/query_order?access_token=ACCESS_TOKEN&pay_sig=PAY_SIG
# 云调用
- 本接口不支持云调用。
# 第三方调用
本接口支持第三方平台代商家调用。
该接口所属的权限集 id 为:157
服务商获得其中之一权限集授权后,可通过使用 authorizer_access_token 代商家进行调用,具体可查看 第三方调用 说明文档。
# 2. 请求参数
# 查询参数 Query String Parameters
| 参数名 | 类型 | 必填 | 示例 | 说明 |
|---|---|---|---|---|
| access_token | string | 是 | ACCESS_TOKEN | 接口调用凭证,可使用 access_token、authorizer_access_token |
| pay_sig | string | 是 | - | 支付签名 |
# 请求体 Request Payload
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| openid | string | 是 | 用户的openid |
| env | number | 是 | 0-正式环境 1-沙箱环境 |
| order_id | string | 否 | 创建的订单号 |
| wx_order_id | string | 否 | 微信内部单号(与order_id二选一) |
# 3. 返回参数
# 返回体 Response Payload
| 参数名 | 类型 | 说明 |
|---|---|---|
| errcode | number | 错误码 |
| errmsg | string | 错误信息 |
| order | object | 订单信息 |
# Res.order Object Payload
订单信息
| 参数名 | 类型 | 说明 | 枚举 |
|---|---|---|---|
| order_id | string | 订单号 | - |
| create_time | number | 创建时间 | - |
| update_time | number | 更新时间 | - |
| status | number | 当前状态 | 枚举值 |
| biz_type | number | 业务类型0-短剧 | - |
| order_fee | number | 订单金额,单位分 | - |
| coupon_fee | number | 订单优惠金额,单位分(暂无此字段) | - |
| paid_fee | number | 用户支付金额 | - |
| order_type | number | 订单类型 | 枚举值 |
| refund_fee | number | 当类型为退款单时表示退款金额,单位分 | - |
| paid_time | number | 支付/退款时间,unix秒级时间戳 | - |
| provide_time | number | 发货时间 | - |
| biz_meta | string | 订单创建时传的信息 | - |
| env_type | number | 环境类型1-现网 2-沙箱 | - |
| token | string | 下单时米大师返回的token | - |
| left_fee | number | 支付单类型时表示此单经过退款还剩余的金额,单位分 | - |
| wx_order_id | string | 微信内部单号 | - |
| channel_order_id | string | 渠道单号,为用户微信支付详情页面上的商户单号 | - |
| wxpay_order_id | string | 微信支付交易单号,为用户微信支付详情页面上的交易单号 | - |
| sett_time | number | 结算时间的秒级时间戳,大于0表示结算成功 | - |
| sett_state | number | 结算状态0-未开始结算 1-结算中 2-结算成功 3-待结算(与0相同) | - |
| platform_fee_fen | number | 虚拟支付技术服务费,单位为分;sett_state = 2时返回 | - |
| cps_fee_fen | number | 公众号、视频号平台的cps服务费,单位为分;sett_state = 2时返回 | - |
# 4. 枚举信息
# Res.order.status Enum
当前状态
| 枚举值 | 描述 |
|---|---|
| 0 | 订单初始化(未创建成功,不可用于支付) |
| 1 | 订单创建成功 |
| 2 | 订单已经支付,待发货 |
| 3 | 订单发货中 |
| 4 | 订单已发货 |
| 5 | 订单已经退款 |
| 6 | 订单已经关闭(不可再使用) |
| 7 | 订单退款失败 |
| 8 | 用户退款完成 |
| 9 | 回收广告金完成 |
| 10 | 分账回退完成 |
# Res.order.order_type Enum
订单类型
| 枚举值 | 描述 |
|---|---|
| 0 | 普通虚拟支付 |
| 1 | 普通退款 |
| 7 | 苹果iOS支付 |
| 8 | 苹果iOS退款 |
# 5. 注意事项
使用支付签名
# 支付签名
签名参数为 pay_sig,加在 query 后面
例如接口地址是:https://api.weixin.qq.com/xpay/query_user_balance?access_token=xxxx
加上签名后则需要传 https://api.weixin.qq.com/xpay/query_user_balance?access_token=xxxx&pay_sig=xxx
# 6. 代码示例
请求示例
{
"openid": "",
"env": 0,
"order_id": "",
"wx_order_id": ""
}
返回示例
{
"errcode": 0,
"errmsg": "",
"order": {
"order_id": "",
"create_time": 0,
"update_time": 0,
"status": 0,
"biz_type": 0,
"order_fee": 0,
"coupon_fee": 0,
"paid_fee": 0,
"order_type": 0,
"refund_fee": 0,
"paid_time": 0,
"provide_time": 0,
"biz_meta": "",
"env_type": 0,
"token": "",
"left_fee": 0,
"wx_order_id": "",
"channel_order_id": "",
"wxpay_order_id": "",
"sett_time": 0,
"sett_state": 0,
"platform_fee_fen": 0,
"cps_fee_fen": 0
}
}
# 7. 错误码
以下是本接口的错误码列表,其他错误码可参考 通用错误码;调用接口遇到报错,可使用官方提供的 API 诊断工具 辅助定位和分析问题。
| 错误码 | 错误描述 |
|---|---|
| -1 | 系统错误 |
| 268490001 | openid错误 |
| 268490002 | 请求参数字段错误,具体看errmsg |
| 268490003 | 签名错误 |
| 268490004 | 重复操作(赠送和代币支付和充值广告金相关接口会返回,表示之前的操作已经成功) |
| 268490005 | 订单已经通过cancel_currency_pay接口退款,不支持再退款 |
| 268490006 | 代币的退款/支付操作金额不足 |
| 268490007 | 图片或文字存在敏感内容,禁止使用 |
| 268490008 | 代币未发布,不允许进行代币操作 |
| 268490009 | 用户session_key不存在或已过期,请重新登录 |
| 268490011 | 数据生成中,请稍后调用本接口获取 |
| 268490012 | 批量任务运行中,请等待完成后才能再次运行 |
| 268490013 | 禁止对核销状态的单进行退款 |
| 268490014 | 退款操作进行中,稍后可以使用相同参数重试 |
| 268490015 | 频率限制 |
| 268490016 | 退款的left_fee字段与实际不符,请通过query_order接口查询确认 |
| 268490018 | 广告金充值帐户行业 id 不匹配 |
| 268490019 | 广告金充值帐户 id已绑定其他 appid |
| 268490020 | 广告金充值帐户主体名称错误 |
| 268490021 | 账户未完成进件 |
| 268490022 | 广告金充值账户无效 |
| 268490023 | 广告金余额不足 |
| 268490024 | 广告金充值金额必须大于 0 |
# 8. 适用范围
本接口暂未明确可调用账号类型,或在业务中根据调用传参自行确定是否可调用,请以实际调用情况为准。