商家批次单号查询批次单

Header HTTP头参数

Authorization 　必填　string

请参考签名认证生成认证信息

Accept 　必填　string

请设置为application/json

path 路径参数

out_batch_no 　必填 string(32)

【商家品牌红包批次单号】 商户系统内部的商家品牌红包批次单号，要求此参数只能由数字、大小写字母组成，在商户系统内部唯一

query 查询参数

need_query_detail 　选填 boolean

【是否需要查询品牌红包明细单】 枚举值： true：是； false：否，默认否。 商户可选择是否查询指定状态的品牌红包明细单，当品牌红包批次单状态为“FINISHED”（已完成）时，才会返回满足条件的品牌红包明细单

detail_state 　选填 string

【品牌红包明细单状态】 查询指定状态的品牌红包明细单信息

可选取值

• DETAIL_VIEW_ALL: 需要同时查询转账成功、失败和待确认的品牌红包明细单

• DETAIL_VIEW_SUCCESS: 只查询发送成功的品牌红包明细单

• DETAIL_VIEW_FAIL: 只查询发送失败的品牌红包明细单

请求示例

GET

1curl -X GET \
2  https://api.mch.weixin.qq.com/v3/fund-app/brand-redpacket/brand-merchant-out-batches/plfk2020042013?need_query_detail=false&detail_state=DETAIL_VIEW_FAIL \
3  -H "Authorization: WECHATPAY2-SHA256-RSA2048 mchid=\"1900000001\",..." \
4  -H "Accept: application/json" 
5

200 OK

brand_mchid 　必填 string(32)

【品牌主商户号】 微信服务商下特约商户的商户号，且已经认证品牌的品牌主商户号

batch_no 　必填 string(64)

【微信支付品牌红包批次单号】 品牌在微信支付进行品牌认证后的唯一标识品牌ID

out_batch_no 　必填 string(32)

【商家品牌红包批次单号】 品牌商户系统内部的品牌红包批次单号，要求此参数只能由数字、大小写字母组成，在商户系统内部唯一

brand_id 　选填 integer

【品牌ID】 品牌在微信支付进行品牌认证后的唯一标识品牌ID

template_id 　选填 string(128)

【品牌红包模板ID】 品牌主配置的品牌红包模板ID

brand_appid 　选填 string(32)

【品牌AppID】 品牌商户在微信申请公众号/小程序或移动应用成功后分配的账号ID，该AppID需与品牌ID有绑定关系，具体请参考普通商户模式开发必要参数说明。

batch_state 　必填 string

【品牌红包批次状态】 当前品牌红包批次状态

可选取值

• WAIT_PAY: 商户员工确认付款阶段

• ACCEPTED: 批次已受理成功，若发起品牌红包的30分钟后，品牌红包批次单仍处于该状态，可能原因是商户账户余额不足等。商户可查询账户资金流水，若该笔品牌红包批次单的扣款已经发生，则表示批次已经进入发送中，请再次查单确认

• PROCESSING: 已开始处理批次内的品牌红包明细单

• FINISHED: 批次内的所有品牌红包明细单都已处理完成

• CLOSED: 可查询具体的批次关闭原因确认

batch_name 　必填 string(32)

【品牌红包批次名称】 该批次品牌红包的备注，用于品牌商户内部管理

batch_remark 　必填 string(32)

【品牌红包批次备注】 该批次品牌红包的备注，仅用于品牌商户内部管理

close_reason 　选填 string

【品牌红包批次单关闭原因】 品牌红包批次单状态为“CLOSED”（已关闭）时返回

可选取值

• MERCHANT_REVOCATION: 商户主动撤销

• SYSTEM_OVERDUE_CLOSE: 系统超时关闭

total_amount 　必填 integer

【总金额】 品牌红包金额单位为“分”

total_num 　必填 integer

【总笔数】 一个品牌红包批次单最多发送10笔品牌红包明细。品牌红包总笔数必须与批次内所有品牌红包明细之和保持一致，否则无法发送品牌红包

create_time 　必填 string(32)

【品牌红包批次创建时间】 品牌红包批次受理成功时返回，遵循rfc3339标准格式，格式为yyyy-MM-DDTHH:mm:ss+TIMEZONE，yyyy-MM-DD表示年月日，T出现在字符串中，表示time元素的开头，HH:mm:ss表示时分秒，TIMEZONE表示时区（+08:00表示东八区时间，领先UTC 8小时，即北京时间）。例如：2015-05-20T13:29:35+08:00表示北京时间2015年05月20日13点29分35秒

update_time 　必填 string(32)

【品牌红包批次更新时间】 品牌红包批次最近一次状态变更时间，遵循rfc3339标准格式，格式为yyyy-MM-DDTHH:mm:ss+TIMEZONE，yyyy-MM-DD表示年月日，T出现在字符串中，表示time元素的开头，HH:mm:ss表示时分秒，TIMEZONE表示时区（+08:00表示东八区时间，领先UTC 8小时，即北京时间）。例如：2015-05-20T13:29:35+08:00表示北京时间2015年05月20日13点29分35秒

success_amount 　必填 integer

【发放成功金额】 品牌红包发放成功的金额，单位为“分”。当批次状态为“PROCESSING”（发送中）时，发放成功金额随时可能变化

success_num 　必填 integer

【发放成功笔数】 品牌红包发放成功的笔数。当批次状态为“PROCESSING”（发放中）时，发放成功笔数随时可能变化

fail_amount 　必填 integer

【发放失败金额】 品牌红包发放失败的金额，单位为“分”

fail_num 　必填 integer

【发放失败笔数】 品牌红包发放失败的笔数

detail_list 　选填 array[object]

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

属性

transfer_detail_no 　必填 string(64) 【微信支付品牌红包明细单号】 微信支付系统内部区分品牌红包批次单下不同品牌红包明细单的唯一标识 out_detail_no 　必填 string(32) 【商家品牌红包明细单号】 品牌商户系统内部区分品牌红包批次单下不同品牌红包明细单的唯一标识，要求此参数只能由数字、大小写字母组成 detail_state 　必填 string 【品牌红包明细单状态】 品牌红包明细单的状态 可选取值 DETAIL_INIT: 系统转账校验中 DETAIL_WAIT_PAY: 待商户确认，符合免密条件时，系统会自动扭转为发送中 DETAIL_PROCESSING: 正在处理中，品牌红包发送结果尚未明确 DETAIL_SUCCESS: 发送成功 DETAIL_FAIL: 需要确认失败原因后，再决定是否重新对该笔品牌红包明细单进行发送（并非整个品牌红包批次单）

应答示例

200 OK

1{
2  "brand_mchid" : "1900001109",
3  "batch_no" : "1030000071100999991182020050700019480001",
4  "out_batch_no" : "plfk2020042013",
5  "brand_id" : 1234,
6  "template_id" : "12340000000001",
7  "brand_appid" : "wxf636efh567hg4356",
8  "batch_state" : "ACCEPTED",
9  "batch_name" : "双十一营销发放品牌红包",
10  "batch_remark" : "双十一营销发放品牌红包",
11  "close_reason" : "SYSTEM_OVERDUE_CLOSE",
12  "total_amount" : 10000,
13  "total_num" : 10,
14  "create_time" : "2015-05-20T13:29:35+08:00",
15  "update_time" : "2015-05-20T13:29:35+08:00",
16  "success_amount" : 5000,
17  "success_num" : 10,
18  "fail_amount" : 5000,
19  "fail_num" : 10,
20  "detail_list" : [
21    {
22      "transfer_detail_no" : "1220000071100999991182020050700019500100",
23      "out_detail_no" : "x23zy545Bd5436",
24      "detail_state" : "DETAIL_SUCCESS"
25    }
26  ]
27}
28