• 红包
    • 配置
    • 发送红包
      • 发送普通红包接口
      • 发送裂变红包接口
    • 红包预下单接口
    • 查询红包信息

    红包

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

    配置

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

    1. use EasyWeChat\Factory;
    2. $config = [
    3. 'app_id' => 'you-app-id',
    4. 'mch_id' => 'your-mch-id',
    5. 'key' => 'key-for-signature',
    6. 'cert_path' => 'path/to/your/cert.pem',
    7. 'key_path' => 'path/to/your/key',
    8. // ...
    9. ];
    10. $payment = Factory::payment($config);
    11. $redpack = $payment->redpack;

    发送红包

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

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

    发送普通红包接口

    1. $redpackData = [
    2. 'mch_billno' => 'xy123456',
    3. 'send_name' => '测试红包',
    4. 're_openid' => 'oxTWIuGaIt6gTKsQRLau2M0yL16E',
    5. 'total_num' => 1, //固定为1,可不传
    6. 'total_amount' => 100, //单位为分,不小于100
    7. 'wishing' => '祝福语',
    8. 'client_ip' => '192.168.0.1', //可不传,不传则由 SDK 取当前客户端 IP
    9. 'act_name' => '测试活动',
    10. 'remark' => '测试备注',
    11. // ...
    12. ];
    13. $result = $redpack->sendNormal($redpackData);

    发送裂变红包接口

    1. $redpackData = [
    2. 'mch_billno' => 'xy123456',
    3. 'send_name' => '测试红包',
    4. 're_openid' => 'oxTWIuGaIt6gTKsQRLau2M0yL16E',
    5. 'total_num' => 3, //不小于3
    6. 'total_amount' => 300, //单位为分,不小于300
    7. 'wishing' => '祝福语',
    8. 'act_name' => '测试活动',
    9. 'remark' => '测试备注',
    10. 'amt_type' => 'ALL_RAND', //可不传
    11. // ...
    12. ];
    13. $result = $redpack->sendGroup($redpackData);

    红包预下单接口

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

    1. $redpackData = [
    2. 'hb_type' => 'NORMAL', //NORMAL 或 GROUP
    3. 'mch_billno' => 'xy123456',
    4. 'send_name' => '测试红包',
    5. 're_openid' => 'oxTWIuGaIt6gTKsQRLau2M0yL16E',
    6. 'total_num' => 1, //普通红包固定为1,裂变红包不小于3
    7. 'total_amount' => 100, //单位为分,普通红包不小于100,裂变红包不小于300
    8. 'wishing' => '祝福语',
    9. 'client_ip' => '192.168.0.1', //可不传,不传则由 SDK 取当前客户端 IP
    10. 'act_name' => '测试活动',
    11. 'remark' => '测试备注',
    12. 'amt_type' => 'ALL_RAND',
    13. // ...
    14. ];
    15. $result = $redpack->prepare($redpackData);

    查询红包信息

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

    1. $mchBillNo = "商户系统内部的订单号(mch_billno)";
    2. $redpack->info($mchBillNo);