红包

你在阅读本文之前确认你已经仔细阅读了：微信支付 | 现金红包文档 。

配置

与支付接口一样，红包接口也需要配置如下参数，需要特别注意的是，红包相关的全部接口都需要使用 SSL 证书，因此 cert_path 以及 cert_key 必须正确配置。

  1. <?php
  3. use EasyWeChat\Foundation\Application;
  5. $options = [
  6.     // payment
  7.     'payment' => [
  8.         'merchant_id'        => 'your-mch-id',
  9.         'key'                => 'key-for-signature',
  10.         'cert_path'          => 'path/to/your/cert.pem',
  11.         'key_path'           => 'path/to/your/key',
  12.         // ...
  13.     ],
  14. ];
  16. $app = new Application($options);
  18. $luckyMoney = $app->lucky_money;

发送红包

微信的现金红包分为普通红包和裂变红包两类。SDK 中对其分别进行了封装，同时也提供了一个统一的调用方法。

默认情况下，通过接口发送的红包金额应该在200元以内，但可以通过在调用发送接口时传递场景 ID (scene_id)来发送特定场景的红包，不同场景红包可以由商户自己登录商户平台设置最大金额。scene_id 的可选值及对应含义可参阅微信支付官方文档。

通用发送接口

  1. <?php
  3. $luckyMoneyData = [
  4.     'mch_billno'       => 'xy123456',
  5.     'send_name'        => '测试红包',
  6.     're_openid'        => 'oxTWIuGaIt6gTKsQRLau2M0yL16E',
  7.     'total_num'        => 1,  //普通红包固定为1，裂变红包不小于3
  8.     'total_amount'     => 100,  //单位为分，普通红包不小于100，裂变红包不小于300
  9.     'wishing'          => '祝福语',
  10.     'client_ip'        => '192.168.0.1',  //可不传，不传则由 SDK 取当前客户端 IP
  11.     'act_name'         => '测试活动',
  12.     'remark'           => '测试备注',
  13.     // ...
  14. ];
  16. $result = $luckyMoney->send($luckyMoneyData, \EasyWeChat\Payment\LuckyMoney\API::TYPE_NORMAL);
  17. 或
  18. $result = $luckyMoney->send($luckyMoneyData, \EasyWeChat\Payment\LuckyMoney\API::TYPE_GROUP);

不同类型红包所传参数有所差别，请参考官方文档中参数列表。

发送普通红包接口

<?php

$luckyMoneyData = [
    'mch_billno'       => 'xy123456',
    'send_name'        => '测试红包',
    're_openid'        => 'oxTWIuGaIt6gTKsQRLau2M0yL16E',
    'total_num'        => 1,  //固定为1，可不传
    'total_amount'     => 100,  //单位为分，不小于100
    'wishing'          => '祝福语',
    'client_ip'        => '192.168.0.1',  //可不传，不传则由 SDK 取当前客户端 IP
    'act_name'         => '测试活动',
    'remark'           => '测试备注',
    // ...
];

$result = $luckyMoney->sendNormal($luckyMoneyData);

发送裂变红包接口

<?php

$luckyMoneyData = [
    'mch_billno'       => 'xy123456',
    'send_name'        => '测试红包',
    're_openid'        => 'oxTWIuGaIt6gTKsQRLau2M0yL16E',
    'total_num'        => 3,  //不小于3
    'total_amount'     => 300,  //单位为分，不小于300
    'wishing'          => '祝福语',
    'act_name'         => '测试活动',
    'remark'           => '测试备注',
    'amt_type'         => 'ALL_RAND',  //可不传
    // ...
];

$result = $luckyMoney->sendGroup($luckyMoneyData);

红包预下单接口

红包预下单接口是为摇一摇红包接口配合使用的，在开发摇一摇周边的摇红包相关功能时，需要调用本接口获取红包单号。详情参见官方文档

<?php

$luckyMoneyData = [
    'hb_type'          => 'NORMAL',  //NORMAL 或 GROUP
    'mch_billno'       => 'xy123456',
    'send_name'        => '测试红包',
    're_openid'        => 'oxTWIuGaIt6gTKsQRLau2M0yL16E',
    'total_num'        => 1,  //普通红包固定为1，裂变红包不小于3
    'total_amount'     => 100,  //单位为分，普通红包不小于100，裂变红包不小于300
    'wishing'          => '祝福语',
    'client_ip'        => '192.168.0.1',  //可不传，不传则由 SDK 取当前客户端 IP
    'act_name'         => '测试活动',
    'remark'           => '测试备注',
    'amt_type'         => 'ALL_RAND',
    // ...
];

$result = $luckyMoney->prepare($luckyMoneyData);

查询红包信息

用于商户对已发放的红包进行查询红包的具体信息以及领取情况 ，普通红包和裂变包均使用这一接口进行查询。

$mchBillNo = "商户系统内部的订单号（mch_billno）";
$luckyMoney->query($mchBillNo);