# 查询广告金回收记录
接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南。
接口英文名:query_recover_bill
本接口用于查询广告金回收记录
# 1. 调用方式
# HTTPS 调用
POST https://api.weixin.qq.com/xpay/query_recover_bill?access_token=ACCESS_TOKEN
# 云调用
- 本接口不支持云调用。
# 第三方调用
本接口支持第三方平台代商家调用。
该接口所属的权限集 id 为:157
服务商获得其中之一权限集授权后,可通过使用 authorizer_access_token 代商家进行调用,具体可查看 第三方调用 说明文档。
# 2. 请求参数
# 查询参数 Query String Parameters
| 参数名 | 类型 | 必填 | 示例 | 说明 |
|---|---|---|---|---|
| access_token | string | 是 | ACCESS_TOKEN | 接口调用凭证,可使用 access_token、authorizer_access_token |
# 请求体 Request Payload
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| page | number | 是 | 查询页码,不小于 1 |
| page_size | number | 是 | 每页记录数量 |
| filter | object | 是 | 查询过滤条件 |
| env | number | 是 | 0-正式环境 1-沙箱环境(仅作为签名校验,查询的结果都是正式环境的) |
# Body.filter Object Payload
查询过滤条件
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| recover_time_begin | number | 是 | 查询回收开始时间,unix秒级时间戳 |
| recover_time_end | number | 是 | 查询回收结束时间,unix秒级时间戳 |
| bill_id | string | 是 | (可选)广告金回收单 ID |
# 3. 返回参数
# 返回体 Response Payload
| 参数名 | 类型 | 说明 |
|---|---|---|
| bill_list | objarray | 广告金回收记录列表 |
| total_page | number | 查询命中总的页数 |
| errcode | number | 错误码 |
| errmsg | string | 错误信息 |
# Res.bill_list(Array) Object Payload
广告金回收记录列表
| 参数名 | 类型 | 说明 |
|---|---|---|
| bill_id | string | 回收单 ID |
| recover_time | number | 回收时间,unix秒级时间戳 |
| settle_begin | number | 结算周期开始时间,unix秒级时间戳 |
| settle_end | number | 结算周期结束时间,unix秒级时间戳 |
| fund_id | string | 对应的发放广告金ID |
| recover_account_name | string | 回收广告金账户 |
| recover_amount | number | 回收金额,单位:分 |
| refund_order_list | array | 对应的退款订单 id |
# 4. 注意事项
本接口无特殊注意事项
# 5. 代码示例
本接口无代码示例
# 6. 错误码
以下是本接口的错误码列表,其他错误码可参考 通用错误码;调用接口遇到报错,可使用官方提供的 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 |
# 7. 适用范围
本接口暂未明确可调用账号类型,或在业务中根据调用传参自行确定是否可调用,请以实际调用情况为准。