# 查询创建的订单

接口应在服务器端调用,不可在前端(小程序、网页、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_tokenstringACCESS_TOKEN接口调用凭证,可使用 access_tokenauthorizer_access_token
pay_sigstring-支付签名

# 请求体 Request Payload

参数名类型必填说明
openidstring用户的openid
envnumber0-正式环境 1-沙箱环境
order_idstring创建的订单号
wx_order_idstring微信内部单号(与order_id二选一)

# 3. 返回参数

# 返回体 Response Payload

参数名类型说明
errcodenumber错误码
errmsgstring错误信息
orderobject订单信息

# Res.order Object Payload

订单信息

参数名类型说明枚举
order_idstring订单号-
create_timenumber创建时间-
update_timenumber更新时间-
statusnumber当前状态枚举值
biz_typenumber业务类型0-短剧-
order_feenumber订单金额,单位分-
coupon_feenumber订单优惠金额,单位分(暂无此字段)-
paid_feenumber用户支付金额-
order_typenumber订单类型 枚举值
refund_feenumber当类型为退款单时表示退款金额,单位分-
paid_timenumber支付/退款时间,unix秒级时间戳-
provide_timenumber发货时间-
biz_metastring订单创建时传的信息-
env_typenumber环境类型1-现网 2-沙箱-
tokenstring下单时米大师返回的token-
left_feenumber支付单类型时表示此单经过退款还剩余的金额,单位分-
wx_order_idstring微信内部单号-
channel_order_idstring渠道单号,为用户微信支付详情页面上的商户单号-
wxpay_order_idstring微信支付交易单号,为用户微信支付详情页面上的交易单号-
sett_timenumber结算时间的秒级时间戳,大于0表示结算成功-
sett_statenumber结算状态0-未开始结算 1-结算中 2-结算成功 3-待结算(与0相同)-
platform_fee_fennumber虚拟支付技术服务费,单位为分;sett_state = 2时返回-
cps_fee_fennumber公众号、视频号平台的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系统错误
268490001openid错误
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. 适用范围

本接口暂未明确可调用账号类型,或在业务中根据调用传参自行确定是否可调用,请以实际调用情况为准。