品牌商户发放红包

Header HTTP头参数

Authorization 　必填　string

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

Accept 　必填　string

请设置为application/json

Content-Type 　必填　string

请设置为application/json

Wechatpay-Serial 　必填　string

【微信支付公钥ID】或【微信支付平台证书序列号】 请求参数中的敏感字段，需要使用微信支付公钥加密（推荐），请参考获取微信支付公钥ID说明以及微信支付公钥加密敏感信息指引；也可以使用微信支付平台证书公钥加密，参考获取平台证书序列号、平台证书加密敏感信息指引

body 包体参数

brand_id 　必填 integer

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

brand_appid 　必填 string(32)

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

scene 　必填 string

【品牌红包发放场景】 品牌红包发放场景，用户可以在指定的场景领取到红包

可选取值

• CUSTOM_SEND: 自定义场景发放红包，使用已配置的自定义发放模板进行发红包

template_id 　必填 string(128)

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

out_batch_no 　必填 string(32)

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

batch_name 　必填 string(32)

【品牌红包批次名称】 该品牌红包批次的名称，展示在用户红包领取通知的红包活动名称

batch_remark 　必填 string(32)

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

total_amount 　必填 integer

【总金额】 品牌红包总金额必须与品牌红包批次内所有品牌红包明细发送金额之和保持一致，否则无法发送品牌红包

total_num 　必填 integer

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

detail_list 　选填 array[DetailEntityForCreate]

【品牌红包明细列表】 品牌红包明细列表，最多10笔

属性

out_detail_no 　必填 string(32) 【商家品牌红包明细单号】 品牌商户系统内部区分品牌红包批次单下不同品牌红包明细单的唯一标识，非全局唯一（在同一批次下不允许重复，不同批次下允许相同），要求此参数只能由数字、大小写字母组成 amount 　必填 integer 【红包金额（单位：分）】 红包金额单位为“分”，红包金额的最大限额取决于商户在商户平台的设置额度 openid 　必填 string(64) 【接收红包用户OpenID】 接收红包的用户OpenID，该OpenID为用户在上方指定的AppID下的唯一标识。注：openid是微信用户在公众号appid下的唯一用户标识（appid不同，则获取到的openid就不同），可用于永久标记一个用户。获取openid user_name 　选填 string(1024) 【接收红包用户姓名】 1、明细转账金额 >= 2,000，收款用户姓名必填； 2、同一批次转账明细中，收款用户姓名字段需全部填写、或全部不填写； 3、 若传入收款用户姓名，微信支付会校验用户OpenID与姓名是否一致，并提供电子回单； 4、收款方姓名。采用标准RSA算法，公钥由微信侧提供 5、该字段需进行加密处理，加密方法详见敏感信息加密说明。(提醒：必须在HTTP头中上送Wechatpay-Serial) remark 　必填 string(32) 【红包备注】 单个红包备注，会展示在客户端收款凭证的“红包说明”字段，UTF8编码，最多允许32个字符

请求示例

POST

1curl -X POST \
2  https://api.mch.weixin.qq.com/v3/fund-app/brand-redpacket/brand-merchant-batches \
3  -H "Authorization: WECHATPAY2-SHA256-RSA2048 mchid=\"1900000001\",..." \
4  -H "Accept: application/json" \
5  -H "Wechatpay-Serial: 5157F09EFDC096DE15EBE81A47057A7232F1B8E1"  \
6  -H "Content-Type: application/json" \
7  -d '{
8    "brand_id" : 1234,
9    "brand_appid" : "wxf636efh567hg4356",
10    "scene" : "CUSTOM_SEND",
11    "template_id" : "123400001",
12    "out_batch_no" : "plfk2020042013",
13    "batch_name" : "双十一营销用品牌红包",
14    "batch_remark" : "双十一营销用品牌红包",
15    "total_amount" : 10000,
16    "total_num" : 10,
17    "detail_list" : [
18      {
19        "out_detail_no" : "x23zy545Bd5436",
20        "amount" : 100,
21        "openid" : "o-MYE42l80oelYMDE34nYD456Xoy",
22        "user_name" : "757b340b45ebef5467rter35gf464344v3542sdf4t6re4tb4f54ty45t4yyry45",
23        "remark" : "来自XX的红包"
24      }
25    ]
26  }'
27

200 OK

out_batch_no 　必填 string(32)

【商家品牌红包批次单号】 品牌商户系统内部区分品牌红包批次单下不同品牌红包明细单的唯一标识，要求此参数只能由数字、大小写字母组成

batch_no 　必填 string(64)

【微信支付品牌红包批次单号】 微信批次单号，微信商家转账系统返回的唯一标识

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秒

batch_state 　选填 string

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

可选取值

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

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

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

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

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

应答示例

200 OK

1{
2  "out_batch_no" : "plfk2020042013",
3  "batch_no" : "1210000071100999991182020050700019480001",
4  "create_time" : "2015-05-20T13:29:35+08:00",
5  "batch_state" : "ACCEPTED"
6}
7