微信小程序API Card卡券

2022-05-10 16:00 更新

wx.addCard(OBJECT)


基礎(chǔ)庫(kù)版本 1.1.0 開(kāi)始支持,低版本需做兼容處理

批量添加卡券。

Object參數(shù)說(shuō)明:

參數(shù)類型必填說(shuō)明
cardListObjectArray需要添加的卡券列表,列表內(nèi)對(duì)象說(shuō)明請(qǐng)參見(jiàn)請(qǐng)求對(duì)象說(shuō)明
successFunction接口調(diào)用成功的回調(diào)函數(shù)
failFunction接口調(diào)用失敗的回調(diào)函數(shù)
completeFunction接口調(diào)用結(jié)束的回調(diào)函數(shù)(調(diào)用成功、失敗都會(huì)執(zhí)行)

請(qǐng)求對(duì)象說(shuō)明

參數(shù)類型說(shuō)明
cardIdString卡券 Id
cardExtString卡券的擴(kuò)展參數(shù)

cardExt 說(shuō)明

參數(shù)類型必填是否參與簽名說(shuō)明
codeString用戶領(lǐng)取的 code,僅自定義 code 模式的卡券須填寫,非自定義 code 模式卡券不可填寫,詳情
openidString指定領(lǐng)取者的openid,只有該用戶能領(lǐng)取。 bind_openid 字段為 true 的卡券必須填寫,bind_openid 字段為 false 不可填寫。
timestampNumber時(shí)間戳,東八區(qū)時(shí)間,UTC+8,單位為秒
nonce_strString隨機(jī)字符串,由開(kāi)發(fā)者設(shè)置傳入,加強(qiáng)安全性(若不填寫可能被重放請(qǐng)求)。隨機(jī)字符串,不長(zhǎng)于 32 位。推薦使用大小寫字母和數(shù)字,不同添加請(qǐng)求的 nonce_str 須動(dòng)態(tài)生成,若重復(fù)將會(huì)導(dǎo)致領(lǐng)取失敗。
fixed_begintimestampNumber卡券在第三方系統(tǒng)的實(shí)際領(lǐng)取時(shí)間,為東八區(qū)時(shí)間戳(UTC+8,精確到秒)。當(dāng)卡券的有效期類為 DATE_TYPE_FIX_TERM 時(shí)專用,標(biāo)識(shí)卡券的實(shí)際生效時(shí)間,用于解決商戶系統(tǒng)內(nèi)起始時(shí)間和領(lǐng)取微信卡券時(shí)間不同步的問(wèn)題。
outer_strString領(lǐng)取渠道參數(shù),用于標(biāo)識(shí)本次領(lǐng)取的渠道值。
signatureString-簽名,商戶將接口列表中的參數(shù)按照指定方式進(jìn)行簽名,簽名方式使用 SHA1,具體簽名方案參見(jiàn):卡券簽名

注:cardExt 需進(jìn)行 JSON 序列化為字符串傳入

回調(diào)結(jié)果:

回調(diào)類型errMsg說(shuō)明
successaddCard:ok添加卡券成功
failaddCard:fail cancel用戶取消添加卡券
failaddCard:fail (detail message)添加卡券失敗,其中 detail message 為后臺(tái)返回的詳細(xì)失敗原因

success返回參數(shù):

參數(shù)類型說(shuō)明
cardListObjectArray卡券添加結(jié)果列表,列表內(nèi)對(duì)象說(shuō)明請(qǐng)?jiān)斠?jiàn)返回對(duì)象說(shuō)明

返回對(duì)象說(shuō)明

參數(shù)類型說(shuō)明
codeString加密 code,為用戶領(lǐng)取到卡券的code加密后的字符串,解密請(qǐng)參照:code 解碼接口
cardIdString用戶領(lǐng)取到卡券的Id
cardExtString用戶領(lǐng)取到卡券的擴(kuò)展參數(shù),與調(diào)用時(shí)傳入的參數(shù)相同
isSuccessBoolean是否成功

示例代碼:

wx.addCard({
  cardList: [
    {
      cardId: '',
      cardExt: '{"code": "", "openid": "", "timestamp": "", "signature":""}'
    }, {
      cardId: '',
      cardExt: '{"code": "", "openid": "", "timestamp": "", "signature":""}'
    }
  ],
  success: function(res) {
    console.log(res.cardList) // 卡券添加結(jié)果
  }
})

wx.openCard(OBJECT)


基礎(chǔ)庫(kù)版本 1.1.0 開(kāi)始支持,低版本需做兼容處理

查看微信卡包中的卡券。

Object參數(shù)說(shuō)明:

參數(shù)類型必填說(shuō)明
cardListObjectArray需要打開(kāi)的卡券列表,列表內(nèi)參數(shù)詳見(jiàn)openCard 請(qǐng)求對(duì)象說(shuō)明
successFunction接口調(diào)用成功的回調(diào)函數(shù)
failFunction接口調(diào)用失敗的回調(diào)函數(shù)
completeFunction接口調(diào)用結(jié)束的回調(diào)函數(shù)(調(diào)用成功、失敗都會(huì)執(zhí)行)

openCard 請(qǐng)求對(duì)象說(shuō)明

參數(shù)類型說(shuō)明
cardIdString需要打開(kāi)的卡券 Id
codeString由 addCard 的返回對(duì)象中的加密 code 通過(guò)解密后得到,解密請(qǐng)參照:code 解碼接口

示例代碼:

wx.openCard({
  cardList: [
    {
      cardId: '',
      code: ''
    }, {
      cardId: '',
      code: ''
    }
  ],
  success: function(res) {
  }
})

Tip

  1. tip: 目前只有認(rèn)證小程序才能使用卡券接口,可參考指引進(jìn)行認(rèn)證。
  2. tip: 了解更多信息,請(qǐng)查看微信卡券接口文檔

以上內(nèi)容是否對(duì)您有幫助:
在線筆記
App下載
App下載

掃描二維碼

下載編程獅App

公眾號(hào)
微信公眾號(hào)

編程獅公眾號(hào)