支持商戶在小程序場(chǎng)景內(nèi)，向指定用戶發(fā)放指定批次的支付券或商家券。

# 接口說明

支持商戶： 【普通服務(wù)商】

接口規(guī)則： 本接口使用V2版本接口規(guī)則，詳見V2接口規(guī)則 (opens new window)內(nèi)容

# 小程序接入插件操作

插件版本號(hào)：latest（更新時(shí)間 2021/06/23）

【推薦】如希望每次默認(rèn)使用最新版本，可在App.json 文件配置"version": "latest"；

如需指定版本，可點(diǎn)擊查看更新記錄 (opens new window)選擇版本

# 1、添加插件配置（引入插件包）

在小程序配置App.json 文件中加入如下配置：

1{
2  "plugins": {
3    "sendCoupon": {
4      "version": "latest",
5      "provider": "wxf3f436ba9bd4be7b"
6    }
7  }
8}

# 2、在小程序頁面中引入發(fā)券插件

1）在小程序頁面配置文件中加入如下配置，引入send-coupon組件：

1{
2  "usingComponents": {
3    "send-coupon": "plugin://sendCoupon/send-coupon"
4  }
5}

2）在小程序頁面的WXML模板中加入如下代碼，并填入相關(guān)字段，字段說明參見下方小程序發(fā)券插件字段說明表

1//page.wxml
2<send-coupon
3    bind:sendcoupon="getcoupon"
4    bind:userconfirm="redirectuser"
5    send_coupon_params="{{send_coupon_params}}"
6    sign="{{sign}}"
7    send_coupon_merchant="{{send_coupon_merchant}}"
8    suggest_immediate_use="{{suggest_immediate_use}}"
9  >
10    <!-- 內(nèi)部為自定義代碼，按鈕點(diǎn)擊部分的代碼寫在這里 -->
11    <!-- [[以下為示例代碼 -->
12    <view class="text">領(lǐng)券</view>
13    <!-- 以上為示例代碼 ]] -->
14  </send-coupon>

# 小程序發(fā)券插件字段說明表

bind:sendcoupon / bindsendcoupon【原接口為bindcustomevent，建議更新原接口名稱】 選填 string
插件在用戶點(diǎn)擊后成功獲取到優(yōu)惠券信息觸發(fā)的事件函數(shù)名稱，使用方法可參考《自定義組件文檔》的自定義組件觸發(fā)事件
注意：查詢到優(yōu)惠券信息不代表用戶一定能夠看到優(yōu)惠券彈窗或者發(fā)券成功，如果參數(shù)send_coupon_result中沒有券發(fā)送成功（券狀態(tài)碼不為SUCCESS），用戶會(huì)被告知領(lǐng)券失敗
bind:userconfirm / binduserconfirm 選填 string
用戶點(diǎn)擊彈窗中的確認(rèn)收券按鈕后觸發(fā)的事件函數(shù)名稱，可用作跳轉(zhuǎn)到優(yōu)惠券的使用界面
suggest_immediate_use 選填 boolean
提示優(yōu)惠券是否要立即使用，如果為true，彈窗中的確認(rèn)按鈕內(nèi)的文字為“立即使用”，如果為false，則顯示為“我知道了”，參數(shù)默認(rèn)值為false
注意：此參數(shù)對(duì)用戶是否立即使用沒有約束力，需要商家在用戶確認(rèn)領(lǐng)券事件內(nèi)自行約束。如果此參數(shù)設(shè)為true，請(qǐng)?jiān)赽induserconfirm事件中引導(dǎo)用戶使用優(yōu)惠券
send_coupon_params 必填 array
發(fā)券參數(shù)，一次最多10張
• 數(shù)組
sign 必填 string(64)
簽名計(jì)算值。
簽名方式：HMAC-SHA256。
簽名規(guī)則：詳見《V2 簽名規(guī)則》
參與簽名字段說明
send_coupon_merchant 必填 string(15)
發(fā)券商戶號(hào)

# 參與簽名字段說明

send_coupon_merchant 必填 string(15)
發(fā)券商戶號(hào)
stock_id{n} 必填 string(20)
微信支付券批次ID，{n}為下標(biāo)，從0開始，例如stock_id0
out_request_no{n} 必填 string(64)
發(fā)券憑證，{n}為下標(biāo)，從0開始，例如out_request_no0。可包含英文字母，數(shù)字，｜，_，*，-等內(nèi)容，不允許出現(xiàn)其他不合法符號(hào)，需在單個(gè)批次單個(gè)用戶下確保唯一性
coupon_code{n} 選填 string(128)
券code，如果批次是發(fā)放時(shí)指定code的類型，則發(fā)券時(shí)必填coupon_code{n}為下標(biāo)，從0開始，例如stock_id0
customize_send_time 選填 string(32)
商家券在商戶業(yè)務(wù)系統(tǒng)里的實(shí)際領(lǐng)取時(shí)間，僅針對(duì)有設(shè)置相對(duì)領(lǐng)取時(shí)間的批次生效（即批次有設(shè)置“生效后N天內(nèi)有效”或“領(lǐng)取后N天開始生效”時(shí)間字段）。傳入后，將使用傳入的時(shí)間點(diǎn)，做為商家券領(lǐng)取時(shí)間來計(jì)算有效期，而非用戶在微信支付系統(tǒng)中點(diǎn)擊領(lǐng)取的時(shí)間 。
遵循rfc3339標(biāo)準(zhǔn)格式，格式為yyyy-MM-DDTHH:mm:ss+TIMEZONE，yyyy-MM-DD表示年月日，T出現(xiàn)在字符串中，表示time元素的開頭，HH:mm:ss表示時(shí)分秒，TIMEZONE表示時(shí)區(qū)（+08:00表示東八區(qū)時(shí)間，領(lǐng)先UTC 8小時(shí)，即北京時(shí)間）。例如：2015-05-20T13:29:35.+08:00表示，北京時(shí)間2015年5月20日 13點(diǎn)29分35秒。
目前只支持商家券、支付券暫不支持
create_coupon_merchant{n} 選填 string(15)
創(chuàng)建支付券的商戶號(hào)； {n}為下標(biāo)，從0開始，例如create_coupon_merchant0。 如果是支付券，則是必填項(xiàng)； 商家券無需填寫

# 3、在小程序頁面對(duì)應(yīng)的JS邏輯中，獲取插件實(shí)例并執(zhí)行初始化操作

1javascript
2//page.js
3Page({
4  // 此函數(shù)名稱可以自定義，跟bindcustomevent綁定的保持一致
5  getcoupon: function(params) {
6    // 插件返回信息在params.detail
7    console.log('getcoupon', params)
8  }
9})

如果事件綁定正確，在用戶點(diǎn)擊領(lǐng)券后，會(huì)觸發(fā)領(lǐng)券事件，得到返回之后會(huì)調(diào)用getcoupon函數(shù)。

1javascript
2//獲取代碼示例
3Page({
4  data: {
5    // ...
6  },
7  onLoad: function() {
8    // ...
9  },
10  getcoupon: function(params) {
11    console.log('getcoupon', params)
12    console.log('detail', params.detail)
13  }
14})

# 錯(cuò)誤碼

# Detail中errcode返回錯(cuò)誤碼

# 發(fā)券結(jié)果（send_coupon_result）中的錯(cuò)誤碼