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

更新时间：2024.08.27

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

注意

批次受理成功后，无需出资确认的明细单预计在1小时内处理完成。
需出资确认（即超过免密金额）的明细单，需先由商户员工同意出资才会执行转账。
所有明细处理完成后，批次才会处理完成。可等待回调通知批次单的处理结果，或间隔1分钟以上查询批次单状态。

接口说明

支持商户：【普通商户】

请求方式：【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时该字段必填

请求示例

1curl -X GET \
2  https://api.mch.weixin.qq.com/v3/transfer/batches/out-batch-no/plfk2020042013?need_query_detail=true&offset=0&limit=20&detail_status=FAIL \
3  -H "Authorization: WECHATPAY2-SHA256-RSA2048 mchid=\"1900000001\",..." \
4  -H "Accept: application/json" 
5

应答参数

200 OK

transfer_batch 　必填 object

【转账批次单】转账批次单基本信息

属性

mchid 　必填 string(32)

【商户号】微信支付分配的商户号

out_batch_no 　必填 string(32)

【商家批次单号】商户系统内部的商家批次单号，在商户系统内部唯一

batch_id 　必填 string(64)

【微信批次单号】微信批次单号，微信商家转账系统返回的唯一标识

appid 　必填 string(32)

【商户appid】申请商户号的appid或商户号绑定的appid（企业号corpid即为此appid）

batch_status 　必填 string(32)

【批次状态】WAIT_PAY: 待付款确认。需要付款出资商户在商家助手小程序或服务商助手小程序进行付款确认
ACCEPTED:已受理。批次已受理成功，即将进入转账中。若发起30分钟后仍处于该状态，可能原因是商户账户余额不足等。在24小时内充值充足资金将继续执行转账，请再次查单确认状态。
PROCESSING:转账中。已开始处理批次内的转账明细单
FINISHED:已完成。批次内的所有转账明细单都已处理完成
CLOSED:已关闭。可查询具体的批次关闭原因确认

batch_type 　必填 string(32)

【批次类型】API:API方式发起
WEB:页面方式发起

batch_name 　必填 string(32)

【批次名称】该笔批量转账的名称

batch_remark 　必填 string(32)

【批次备注】转账说明，UTF8编码，最多允许32个字符

close_reason 　选填 string

【批次关闭原因】如果批次单状态为“CLOSED”（已关闭），则有关闭原因

可选取值：

OVERDUE_CLOSE: 系统超时关闭，可能原因账户余额不足或其他错误

TRANSFER_SCENE_INVALID: 付款确认时，转账场景已不可用，系统做关单处理

total_amount 　必填 integer

【转账总金额】转账金额单位为“分”

total_num 　必填 integer

【转账总笔数】一个转账批次单最多发起三千笔转账

create_time 　选填 string(32)

【批次创建时间】批次受理成功时返回，按照使用rfc3339所定义的格式，格式为YYYY-MM-DDThh:mm:ss+TIMEZONE

update_time 　选填 string(32)

【批次更新时间】批次最近一次状态变更的时间，按照使用rfc3339所定义的格式，格式为YYYY-MM-DDThh:mm:ss+TIMEZONE

success_amount 　选填 integer

【转账成功金额】转账成功的金额，单位为“分”。当批次状态为“PROCESSING”（转账中）时，转账成功金额随时可能变化

success_num 　选填 integer

【转账成功笔数】转账成功的笔数。当批次状态为“PROCESSING”（转账中）时，转账成功笔数随时可能变化

fail_amount 　选填 integer

【转账失败金额】转账失败的金额，单位为“分”

fail_num 　选填 integer

【转账失败笔数】转账失败的笔数

transfer_scene_id 　选填 string(36)

【转账场景ID】指定的转账场景ID

transfer_detail_list 　选填 array[object]

【转账明细单列表】当批次状态为“FINISHED”（已完成），且成功查询到转账明细单时返回。包括微信明细单号、明细状态信息

属性

应答示例

200 OK

1{
2  "transfer_batch" : {
3    "mchid" : "1900001109",
4    "out_batch_no" : "plfk2020042013",
5    "batch_id" : "1030000071100999991182020050700019480001",
6    "appid" : "wxf636efh567hg4356",
7    "batch_status" : "ACCEPTED",
8    "batch_type" : "API",
9    "batch_name" : "2019年1月深圳分部报销单",
10    "batch_remark" : "2019年1月深圳分部报销单",
11    "close_reason" : "OVERDUE_CLOSE",
12    "total_amount" : 4000000,
13    "total_num" : 200,
14    "create_time" : "2015-05-20T13:29:35.120+08:00",
15    "update_time" : "2015-05-20T13:29:35.120+08:00",
16    "success_amount" : 3900000,
17    "success_num" : 199,
18    "fail_amount" : 100000,
19    "fail_num" : 1,
20    "transfer_scene_id" : "1000"
21  },
22  "transfer_detail_list" : [
23    {
24      "detail_id" : "1040000071100999991182020050700019500100",
25      "out_detail_no" : "x23zy545Bd5436",
26      "detail_status" : "SUCCESS"
27    }
28  ]
29}
30

错误码

公共错误码

状态码	错误码	描述	解决方案
400	PARAM_ERROR	参数错误	请根据错误提示正确传入参数
401	SIGN_ERROR	签名验证不通过	请参阅基本规则和签名常见问题
429	RATELIMIT_EXCEEDED	频率超限	请求量不要超过接口调用频率限制
429	FREQUENCY_LIMITED	频率超限	请求量不要超过接口调用频率限制
500	SYSTEM_ERROR	系统异常，请稍后重试	请稍后重试

业务错误码

状态码	错误码	描述	解决方案
400	INVALID_REQUEST	请求参数符合参数格式，但不符合业务规则	请参阅产品介绍和开发指引
403	NO_AUTH	没有相关权限	请参阅产品介绍和接入准备
404	NOT_FOUND	记录不存在	查询的批次单不存在

文档是否有帮助

更多支持

开发文档(服务商)开发文档(V2版)开发者社区微信开放平台微信公众平台腾讯客服