# 下载支付订单

接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南

接口英文名:start_download_order

发起下载订单任务,成功后用 query_download_order 接口查询结果

# 1. 调用方式

# HTTPS 调用

POST https://api.weixin.qq.com/xpay/start_download_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

参数名类型必填示例说明
begin_dsnumber20260420开始日期,格式 YYYYMMDD
end_dsnumber20260420结束日期,格式 YYYYMMDD,与 begin_ds 间隔不超过 31 天
order_typenumber1订单类型:1=代币交易订单 /2=道具直购交易订单 /3=会员订阅订单 /4=退款订单
order_infostring订单信息搜索关键字,支持按交易单号/商户单号/用户ID 模糊匹配
is_providedbooleantrue发货状态,order_type 为 2(道具) 或 3(会员订阅) 时必须传入;true=已发货 /false=未发货;不传默认 true
refund_statusnumber0退款状态筛选,仅 order_type=4(退款订单) 时有效;0=全部 /2=已退款 /4=退款中 /5=退款失败;不传默认 0(全部)
envnumber0环境标识:0=现网 /1=沙箱(用于基类签名校验)
pay_channelnumber1支付渠道:1=普通虚拟支付 /2=苹果IAP

# 3. 返回参数

# 返回体 Response Payload

参数名类型示例说明
errcodenumber0错误码,0 表示成功
errmsgstring错误信息
task_idstring下载任务 ID,用于后续查询下载结果

# 4. 注意事项

本接口无特殊注意事项

# 5. 代码示例

请求示例

{
    "begin_ds": 20260420,
    "end_ds": 20260420,
    "order_type": 1,
    "order_info": "",
    "is_provided": "true",
    "refund_status": 0,
    "env": 0,
    "pay_channel": 1
}

返回示例

{
    "errcode": 0,
    "errmsg": "",
    "task_id": ""
}

# 6. 错误码

此接口没有特殊错误码,可参考 通用错误码;调用接口遇到报错,可使用官方提供的 API 诊断工具 辅助定位和分析问题。

# 7. 适用范围

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