发放指定批次的代金券

更新时间：2024.09.19

商户平台/API完成制券后，可使用发放代金券接口发券。通过调用此接口可发放指定批次给指定用户，发券场景可以是小程序、H5、APP等。

注意：

商户可在H5活动页面、商户小程序、商户APP等自有场景内调用该接口完成发券，商户默认只允许发放本商户号（调用发券接口的商户号）创建的代金券，如需发放其他商户商户创建的代金券，请参考常见问题Q1。
跨商户发券时，请求参数中除了stock_id和stock_creator_mchid为创建方提供的数据，其他的所有调用数据都由发放方提供。

频率限制：500/s

处理耗时：100ms

幂等规则：接口支持幂等重入

接口说明

支持商户：【普通商户】

请求方式：【POST】/v3/marketing/favor/users/{openid}/coupons

请求域名：【主域名】https://api.mch.weixin.qq.com 使用该域名将访问就近的接入点

　　　　　【备域名】https://api2.mch.weixin.qq.com 使用该域名将访问异地的接入点，指引点击查看

请求参数

Header HTTP头参数

Authorization 　必填　string

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

Accept 　必填　string

请设置为application/json

Content-Type 　必填　string

请设置为application/json

path 路径参数

openid 　必填 string(128)

【用户openid】openid信息，用户在appid下的唯一标识。
校验规则：该openid需要与接口传入中的appid有对应关系。

body 包体参数

stock_id 　必填 string(20)

【批次id】微信为每个批次分配的唯一id。
校验规则：必须为代金券（全场券或单品券）批次号，不支持立减与折扣。

out_request_no 　必填 string(128)

【商户单据号】商户此次发放凭据号（格式：商户id+日期+流水号），商户侧需保持唯一性

appid 　必填 string(128)

【公众账号ID】微信为发券方商户分配的公众账号ID，接口传入的所有appid应该为公众号的appid或者小程序的appid（在mp.weixin.qq.com申请的）或APP的appid（在open.weixin.qq.com申请的）。
校验规则：
1、该appid需要与接口传入中的openid有对应关系；
2、该appid需要与调用接口的商户号（即请求头中的商户号）有绑定关系，若未绑定，可参考该指引完成绑定（商家商户号与AppID账号关联管理）

stock_creator_mchid 　必填 string(20)

【创建批次的商户号】批次创建方商户号。
校验规则：接口传入的批次号需由stock_creator_mchid所创建。

coupon_value 　选填 integer

【指定面额发券，面额】指定面额发券场景，券面额，其他场景不需要填，单位：分。（该字段暂未开放）
校验规则：仅在发券时指定面额及门槛的场景才生效，常规发券场景请勿传入该信息。

coupon_minimum 　选填 integer

【指定面额发券，券门槛】指定面额发券批次门槛，其他场景不需要，单位：分。（该字段暂未开放）
校验规则：仅在发券时指定面额及门槛的场景才生效，常规发券场景请勿传入该信息。

请求示例

1curl -X POST \
2  https://api.mch.weixin.qq.com/v3/marketing/favor/users/openid_example/coupons \
3  -H "Authorization: WECHATPAY2-SHA256-RSA2048 mchid=\"1900000001\",..." \
4  -H "Accept: application/json" \
5  -H "Content-Type: application/json" \
6  -d '{
7    "stock_id" : "example_stock_id",
8    "out_request_no" : "example_out_request_no",
9    "appid" : "example_appid",
10    "stock_creator_mchid" : "example_stock_creator_mchid",
11    "coupon_value" : 1,
12    "coupon_minimum" : 1
13  }'
14

应答参数

200 OK

coupon_id 　必填 string

【代金券id】微信为代金券唯一分配的id。

应答示例

200 OK

1{
2  "coupon_id" : "9867041"
3}
4

错误码

公共错误码

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

业务错误码

状态码	错误码	描述	解决方案
400	APPID_MCHID_NOT_MATCH	商户号与AppID不匹配	调用接口的商户号需与接口传入的AppID有绑定关系，请参考常见问题Q4
400	INVALID_REQUEST	OpenID与AppID不匹配	OpenID与AppID需有对应关系
400	INVALID_REQUEST	非法的商户号	请检查商户号准确性
400	INVALID_REQUEST	调用频率过高	请降低API调用频率
400	INVALID_REQUEST	活动已结束或未激活	请检查批次状态
400	INVALID_REQUEST	批次信息获取失败，请确认参数是否有误	请检查创建商户号与批次号的对应关系
400	PARAM_ERROR	AppID必填	请输入AppID
400	PARAM_ERROR	OpenID必填	请输入OpenID
400	PARAM_ERROR	批次号必填	请输入批次号
400	PARAM_ERROR	商户号必填	请输入商户号
400	PARAM_ERROR	非法的批次状态	请检查批次状态，仅支持发放状态为“运营中”的代金券批次
403	MCH_NOT_EXISTS	商户号不合法	请检查商户号准确性
403	NOT_ENOUGH	批次预算不足	批次预算已发放完，请补充批次预算
403	NOT_ENOUGH	发券超过单天限额	已超过该批次设置的单天发放限制额度，无法发放
403	NOT_ENOUGH	账户余额不足，请充值	商户号余额不足，无法继续发券，请充值
403	NOT_ENOUGH	批次预算耗尽	该批次的预算已经耗尽
403	REQUEST_BLOCKED	商户无权发券	该批次不支持其他商户发放，请参考常见问题Q1
403	REQUEST_BLOCKED	批次不支持跨商户发券	该批次不支持其他商户发放，请参考常见问题Q1
403	REQUEST_BLOCKED	用户被限领拦截	该用户已达到该批次的领取上限，请参考常见问题Q6
403	REQUEST_BLOCKED	不能在API渠道发放	请检查批次信息，仅支持发放微信支付代金券，不支持发放立减与折扣
403	REQUEST_BLOCKED	不支持指定面额发券	仅在发券时指定面额及门槛的场景才生效，常规发券场景请勿传入该信息
403	REQUEST_BLOCKED	仅在广告场景下发放批次	该批次已在朋友圈广告发放，不支持在其他渠道发放
403	RULE_LIMIT	用户已达最大领券次数	该用户已达到该批次的领取上限，请参考常见问题Q6
403	RULE_LIMIT	被自然人规则拦截	该自然人已达到该批次的领取上限，请参考常见问题Q6
403	USER_ACCOUNT_ABNORMAL	用户非法	用户命中微信支付风控模型，请参考常见问题Q5
404	RESOURCE_NOT_EXISTS	批次不存在	请检查批次及制券商户号信息
429	FREQUENCY_LIMITED	当前请求人数过多，请稍后重试	请降低API调用频率

文档是否有帮助

更多支持

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