通过商家批次单号查询批次单

更新时间:2024.03.22

商家明细单号查单接口。商户可以通过该接口查询转账批次单以及指定状态的转账明细单。返回消息中包含微信批次单号、批次状态、批次类型、转账总金额、转账总笔数、成功金额、失败金额等信息。

# 接口说明

支持商户:
【普通商户】
请求方式:
【GET】/v3/transfer/batches/out-batch-no/{out_batch_no}
请求域名:
【主域名】
https://api.mch.weixin.qq.com
使用该域名将访问就近的接入点
【备域名】
https://api2.mch.weixin.qq.com
使用该域名将访问异地的接入点 ,指引点击查看

# 请求参数

    Header HTTP头参数
  • Authorization 必填 string
    请参考 签名认证 生成认证信息
  • Accept 必填 string
    请设置为 application/json
    Path 路径参数
  • out_batch_no 必填 string(32)
    【商家批次单号】 商户系统内部的商家批次单号,在商户系统内部唯一
    Query 查询参数
  • need_query_detail 必填 boolean
    【是否查询转账明细单】 true-是;false-否,默认否。商户可选择是否查询指定状态的转账明细单,当转账批次单状态为“FINISHED”(已完成)时,才会返回满足条件的转账明细单
  • offset 选填 integer
    【请求资源起始位置】 该次请求资源(转账明细单)的起始位置,从0开始,默认值为0
  • limit 选填 integer
    【最大资源条数】 该次请求可返回的最大资源(转账明细单)条数,最小20条,最大100条,不传则默认20条。不足20条按实际条数返回
  • detail_status 选填 string(32)
    【明细状态】 WAIT_PAY: 待确认。待商户确认, 符合免密条件时, 系统会自动扭转为转账中
    ALL:全部。需要同时查询转账成功、失败和待确认的明细单
    SUCCESS:转账成功
    FAIL:转账失败。需要确认失败原因后,再决定是否重新发起对该笔明细单的转账(并非整个转账批次单)
    当need_query_detail为true时该字段必填

请求示例

GET

# 应答参数

    200OK
  • transfer_batch 必填 TransferBatchGet
    【转账批次单】 转账批次单基本信息
    • 属性
  • transfer_detail_list 选填 array[TransferDetailCompact]
    【转账明细单列表】 当批次状态为“FINISHED”(已完成),且成功查询到转账明细单时返回。包括微信明细单号、明细状态信息
    • 属性

应答示例

200 OK

# 错误码

# 公共错误码

状态码 错误码 描述 解决方案
400 PARAM_ERROR 参数错误 请根据错误提示正确传入参数
400 INVALID_REQUEST HTTP 请求不符合微信支付 APIv3 接口规则 请参阅 接口规则
401 SIGN_ERROR 验证不通过 请参阅 签名常见问题
500 SYSTEM_ERROR 系统异常,请稍后重试 请稍后重试

# 业务错误码

状态码 错误码 描述 解决方案
400 INVALID_REQUEST 请求参数符合参数格式,但不符合业务规则 查询单据超过限定时间(30天),可以尝试通过商户平台预约下载
404 NOT_FOUND 记录不存在 查询的转账批次单不存在
429 FREQUENCY_LIMITED 频率超限 请求量不要超过接口调用频率限制
500 SYSTEM_ERROR 系统错误 5开头的状态码都为系统问题,请使用相同参数稍后重新调用
反馈
咨询
目录