向用户发放商品券

更新时间:2025.07.15

商户可通过该接口向指定用户发放关联了商品信息的商家券,未关联商品信息的商家券不支持通过该接口发放;支持指定券 code 发放或系统自动分配券 code。

接口说明

支持商户:【普通服务商】 【渠道商】

请求方式:【POST】/v3/marketing/busifavor/product-coupons/send

请求域名:【主域名】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


body  包体参数

 openid  必填   string(128)

【用户OpenID】 OpenID信息,用户在AppID下的唯一标识。校验规则:传入的 OpenID 需是调用方商户号(即请求头里面的商户号)有绑定关系的 AppID 获取的 OpenID。获取 OpenID 文档


 appid  必填   string(32)

【公众账号ID】 支持传入与当前调用接口商户号有绑定关系的 AppID。支持小程序 AppID 与公众号 AppID。如何获取AppID可参考开发必要参数说明。校验规则:传入的 AppID 需与调用方商户号(即请求头里面的商户号)有绑定关系的 AppID 或传入的 AppID 需是归属商户号有绑定关系的 AppID


 stock_id  必填   string(128)

【批次号】 微信为每个商家券批次分配的唯一 ID


 out_request_no  必填   string(128)

【发券凭证】 发券凭证,可包含英文字母,数字,|,_,*,-等内容,不允许出现其他不合法符号,商户侧需保证在单个批次单个用户下的唯一性


 coupon_code  选填   string

【券code】 创建商家券时,设定 coupon_code_mode 为 MERCHANT_API,则该字段必填


 coupon_type  必填   string(32)

【券类型】 枚举值:NORMAL-普通券;MEMBER-会员券


 member_card_id  选填   string(32)

【会员卡ID】 当 coupon_type 为 MEMBER 时必填,通过《创建会员卡模板》接口创建成功时,获得的会员卡模板 card_id

请求示例

Java
Go
curl

需配合微信支付工具库 WXPayUtility 使用,请参考 Java 

1package com.java.demo;
2
3import com.java.utils.WXPayUtility; // 引用微信支付工具库,参考:https://pay.weixin.qq.com/doc/v3/partner/4014985777
4
5import com.google.gson.annotations.SerializedName;
6import com.google.gson.annotations.Expose;
7import okhttp3.MediaType;
8import okhttp3.OkHttpClient;
9import okhttp3.Request;
10import okhttp3.RequestBody;
11import okhttp3.Response;
12
13import java.io.IOException;
14import java.io.UncheckedIOException;
15import java.security.PrivateKey;
16import java.security.PublicKey;
17import java.util.ArrayList;
18import java.util.HashMap;
19import java.util.List;
20import java.util.Map;
21
22/**
23 * 向用户发放商品券
24 */
25public class SendProductCoupon {
26  private static String HOST = "https://api.mch.weixin.qq.com";
27  private static String METHOD = "POST";
28  private static String PATH = "/v3/marketing/busifavor/product-coupons/send";
29
30  public static void main(String[] args) {
31    // TODO: 请准备商户开发必要参数,参考:https://pay.weixin.qq.com/doc/v3/partner/4013080340
32    SendProductCoupon client = new SendProductCoupon(
33      "19xxxxxxxx",                    // 商户号,是由微信支付系统生成并分配给每个商户的唯一标识符,商户号获取方式参考 https://pay.weixin.qq.com/doc/v3/partner/4013080340
34      "1DDE55AD98Exxxxxxxxxx",         // 商户API证书序列号,如何获取请参考 https://pay.weixin.qq.com/doc/v3/partner/4013058924
35      "/path/to/apiclient_key.pem",    // 商户API证书私钥文件路径,本地文件路径
36      "PUB_KEY_ID_xxxxxxxxxxxxx",      // 微信支付公钥ID,如何获取请参考 https://pay.weixin.qq.com/doc/v3/partner/4013038589
37      "/path/to/wxp_pub.pem"           // 微信支付公钥文件路径,本地文件路径
38    );
39
40    SendProductCouponRequest request = new SendProductCouponRequest();
41    request.openid = "xsd3434454567676";
42    request.appid = "wx1234567889999";
43    request.stockId = "12312354";
44    request.outRequestNo = "2335465";
45    request.couponCode = "202007019999";
46    request.couponType = "NORMAL";
47    request.memberCardId = "pbLatjvWOibDc5-TBnbUk1pD12o0";
48    try {
49      SendProductCouponResponse response = client.run(request);
50
51      // TODO: 请求成功,继续业务逻辑
52      System.out.println(response);
53    } catch (WXPayUtility.ApiException e) {
54      // TODO: 请求失败,根据状态码执行不同的逻辑
55      e.printStackTrace();
56    }
57  }
58
59  public SendProductCouponResponse run(SendProductCouponRequest request) {
60    String uri = PATH;
61    String reqBody = WXPayUtility.toJson(request);
62
63    Request.Builder reqBuilder = new Request.Builder().url(HOST + uri);
64    reqBuilder.addHeader("Accept", "application/json");
65    reqBuilder.addHeader("Wechatpay-Serial", wechatPayPublicKeyId);
66    reqBuilder.addHeader("Authorization", WXPayUtility.buildAuthorization(mchid, certificateSerialNo,privateKey, METHOD, uri, reqBody));
67    reqBuilder.addHeader("Content-Type", "application/json");
68    RequestBody requestBody = RequestBody.create(MediaType.parse("application/json; charset=utf-8"), reqBody);
69    reqBuilder.method(METHOD, requestBody);
70    Request httpRequest = reqBuilder.build();
71
72    // 发送HTTP请求
73    OkHttpClient client = new OkHttpClient.Builder().build();
74    try (Response httpResponse = client.newCall(httpRequest).execute()) {
75      String respBody = WXPayUtility.extractBody(httpResponse);
76      if (httpResponse.code() >= 200 && httpResponse.code() < 300) {
77        // 2XX 成功,验证应答签名
78        WXPayUtility.validateResponse(this.wechatPayPublicKeyId, this.wechatPayPublicKey,
79            httpResponse.headers(), respBody);
80
81        // 从HTTP应答报文构建返回数据
82        return WXPayUtility.fromJson(respBody, SendProductCouponResponse.class);
83      } else {
84        throw new WXPayUtility.ApiException(httpResponse.code(), respBody, httpResponse.headers());
85      }
86    } catch (IOException e) {
87      throw new UncheckedIOException("Sending request to " + uri + " failed.", e);
88    }
89  }
90
91  private final String mchid;
92  private final String certificateSerialNo;
93  private final PrivateKey privateKey;
94  private final String wechatPayPublicKeyId;
95  private final PublicKey wechatPayPublicKey;
96
97  public SendProductCoupon(String mchid, String certificateSerialNo, String privateKeyFilePath, String wechatPayPublicKeyId, String wechatPayPublicKeyFilePath) {
98    this.mchid = mchid;
99    this.certificateSerialNo = certificateSerialNo;
100    this.privateKey = WXPayUtility.loadPrivateKeyFromPath(privateKeyFilePath);
101    this.wechatPayPublicKeyId = wechatPayPublicKeyId;
102    this.wechatPayPublicKey = WXPayUtility.loadPublicKeyFromPath(wechatPayPublicKeyFilePath);
103  }
104
105  public static class SendProductCouponRequest {
106    @SerializedName("openid")
107    public String openid;
108  
109    @SerializedName("appid")
110    public String appid;
111  
112    @SerializedName("stock_id")
113    public String stockId;
114  
115    @SerializedName("out_request_no")
116    public String outRequestNo;
117  
118    @SerializedName("coupon_code")
119    public String couponCode;
120  
121    @SerializedName("coupon_type")
122    public String couponType;
123  
124    @SerializedName("member_card_id")
125    public String memberCardId;
126  }
127  
128  public static class SendProductCouponResponse {
129    @SerializedName("send_coupon_result")
130    public SendCouponResult sendCouponResult;
131  }
132  
133  public static class SendCouponResult {
134    @SerializedName("stock_id")
135    public String stockId;
136  
137    @SerializedName("out_request_no")
138    public String outRequestNo;
139  
140    @SerializedName("coupon_code")
141    public String couponCode;
142  }
143  
144}
145

应答参数

200 OK

 send_coupon_result  选填   object

【发券结果】 仅在发券成功时返回,发券失败无此字段

属性

应答示例

200 OK

1{
2  "send_coupon_result" : {
3    "stock_id" : "1262260000000268",
4    "out_request_no" : "2335465",
5    "coupon_code" : "2312323"
6  }
7}
8

 

错误码

公共错误码

状态码

错误码

描述

解决方案

400

PARAM_ERROR

参数错误

请根据错误提示正确传入参数

400

INVALID_REQUEST

HTTP 请求不符合微信支付 APIv3 接口规则

请参阅 接口规则

401

SIGN_ERROR

验证不通过

请参阅 签名常见问题

500

SYSTEM_ERROR

系统异常,请稍后重试

请稍后重试

业务错误码

状态码

错误码

描述

解决方案

400 

APPID_MCHID_NOT_MATCH 

AppID 与请求方商户无关联关系

AppID 与请求方商户不匹配,请确认 AppID 与请求方商户是否有关联关系

400 

INVALID_REQUEST 

发券模式不合法 

请更换支持预上传 code 的批次后重试

400 

MCH_NOT_EXISTS 

商户号不存在 

请确认传入的商户号是否正确 

400 

RESOURCE_ALREADY_EXISTS 

发券凭证已存在 

查看 out_request_no 字段是否重复使用

400 

STOCK_NOT_EXISTS 

批次不存在 

请确认批次号是否正确 

400 

STOCK_STATE_ERROR 

批次状态错误 

请确认批次是否处于可发券状态 

400 

STOCK_EXPIRED 

批次已过期 

请确认批次是否在有效期内 

400 

STOCK_INSUFFICIENT 

批次库存不足 

请确认批次是否还有可发放的券 

400 

STOCK_NO_PRODUCT

批次未关联商品信息

请联系微信支付运营为批次关联商品信息

400 

USER_ALREADY_RECEIVED 

用户已领取 

该用户已经领取过此批次的券 

400 

USER_RECEIVE_LIMIT 

用户领取限制 

用户领取数量已达上限 

403 

NO_AUTH 

无权限 

查看具体错误信息,确认是否有权限 

403

RULE_LIMIT

券批次未关联商品信息

请联系微信支付运营,关联商品信息

403

RULE_LIMIT

品牌未开通名片功能

请开通品牌名片

403

RULE_LIMIT

用户未开通会员功能

请引导用户开通会员

404 

RESOURCE_NOT_EXISTS 

查询的资源不存在 

请检查查询资源的对应 ID 是否填写正确

404 

USER_NOT_EXISTS 

OpenID不正确 

请确认传入的 OpenID 是否正确

429 

FREQUENCY_LIMITED 

频率限制 

调用太频繁,请降低调用接口频率 

500 

SYSTEM_ERROR 

系统失败 

多为网络超时引起,重试 

 

 

 

反馈
咨询
目录
置顶