# Contents

1. Receiving Coupons in Mini Program

2. Checking Coupons in Mini Program

3. Mini Program Card Activation Component

4.Redirecting to Mini Program from Coupons

# Receiving Coupons in Mini Program

# Scenario

Merchants who run campaigns via Mini Programs can issue coupons to users, who then add the coupons to Cards & Offers in their Weixin. When making payments for orders, users can directly redeem the coupons in Card & Offers to enjoy discounts for the services or products they buy.

In addition, users can add the tickets purchased from some ticketing Mini Programs to Cards & Offers for use upon ticket checking.

# Procedures

1. You must have an Official Account with coupon permission and a verified Mini Program account.

2. You need to apply for an Open Platform account, to which the Mini Program account and Official Account are linked. For more information on Open Platform, see Weixin Open Platform.

3. Create coupons and obtain the card_id by following the instructions in Coupon API Documentation and "Create Coupon" API.

4. Call the wx.addcard API in the Mini Program and process the callback for successful receipt.

5. Call the Decoding API using the card_id and code (encrypted code) obtained in the Step 3 to get the real code.

6. Record user's openid in Mini Program, the code received by the user, and the card_id.

7. Process the coupon receipt event, record the user's openid in Official Account, and the code received by the user and the card_id.

# API Description

For more information on wx.addcard API, see wx.addcard.

# Notes

1. The api_ticket in the signature involved in the wx.addcard API should be passed to the ticket obtained by the Official Account which creates the coupon.

2. After a user receives the coupon, the coupon receipt event will be pushed to developer's server for processing. For more information, see Coupon-Related Event Notifications.

3. You can determine the source of the user's coupon via outer_str.

4. This feature only supports base library 1.1.0 or above. For a Mini Program, the compatibility with lower version should be ensured.

# Checking Coupons in Mini Programs

# Scenario

You can call this API to allow users to check and present their coupons in Mini Programs.

# Procedures

1. When a user enters the Mini Program, you must obtain the coupon's card_id and code (real code) received by the user. 2. Call the wx.opencard API to open a coupon for the user to check and use.

# API Description

For more information on wx.opencard API, see wx.opencard.

# Notes

1. After receiving a coupon, the user will automatically return to the Mini Program page. If you want the user to stay on the coupon page for additional operations, call the wx.opencard API in the callback of wx.addcard function.

2. The code returned after the success request for wx.addcard is an encrypted field, and must be decrypted before wx.opencard can be called. For more information, see Decoding API.

# Mini Program Card Activation Component

# Scenario

You can develop your own membership modules within the Mini Program, and embed the card activation process into it. Weixin coupon feature provides the card activation component for member cards in Mini Programs.

When a user enters the card activation component in the Mini Program, the information they entered during the card activation in Weixin will be fetched and entered, so that the user can activate the card in Mini Program quickly.

The card activation component combines "card registration" and “add to Cards & Offers" features, eliminating the need of verification via mobile phone and greatly increasing the merchants' efficiency.

The card activation component can be a redirect-based one, or a non-redirect one.

Notes:

1. The Official Account must have the Weixin coupon feature before you can call the card activation component in the Mini Program. For more information, see Weixin Coupon Documentation.

2. You must have the basic knowledge of coupon development before you can call the component. For more information, see Weixin Coupon APIs.

# Procedures

Redirect-based card activation:

1. Create a member card, select "wx_activate":true,"wx_activate_after_submit" : true" for the card activation method, input information in activate_app_brand_user_name and activate_app_brand_pass to activate Mini Program page, and get card_id. For more information, see "Create Member Card" API.
2. Set the required and optional fields for activating the card. For more information, see the "Set Card Activation Fields" API.
3. Obtain the parameters required by card activation component.
4. Determine whether to call the card activation plug-in based on whether the user is a new one and the Weixin version.
5. Call the card activation plug-in for the user to activate the card, and process the callback of the card activation plug-in.
6. Obtain the user information for card activation and activate the user's member card.

The workflow is as follows:

Non-redirect card activation:

1. Create a member card, select "wx_activate":true,"wx_activate_after_submit" : false" for the card activation method, and obtain the card_id. For more information, see the "Create Member Card" API.
2. Set the required and optional fields for activating the card. For more information, see the "Set Card Activation Fields" API.
3. Obtain the parameters required by card activation component.
4. Determine whether to call the card activation plug-in based on whether the user is a new one and the Weixin version.
5. Call the card activation plug-in for the user to activate the card, and process the callback of the card activation plug-in.
6. Obtain the user information for card activation.

# API Description

# API 1: Obtain card activation plug-in parameters

API Description

This API is used to get the parameters required to call the card activation plug-in.

Request Parameters

{ "card_id" : "pbLatji6o5g7hJh8Otuvux4y1ty0", "outer_str" : "123" }

{   "errcode": 0,   "errmsg": "ok",   "url": "https://mp.weixin.qq.com/bizmall/activatemembercard?    action=preshow&&enxxxxxxx=MjM5Mzc0OTEwMA%3D%3D#wechat_redirect" }

Response Parameters

Notes: 1. The parameters returned for this API must be entered in the card activation plug-in API as they are, and the urldecode operation is required.

# API 2: Open card activation plug-in in Mini Program

API Description

1. This API is used to open the card activation plug-in in your Mini Program.

2. As this is a Mini Program API, you must learn about how to call Mini Program APIs before calling it. For more information, see Coupon-Related Event Notifications.

3. It is supported by base library 1.3.0 or above. Compatibility with lower versions should be ensured.

4. It is supported by Weixin 6.5.9 or above on iOS devices, and 6.5.10 or above on Android devices. Please use Weixin on an iOS device for debugging first.

Open another Mini Program linked with the same Official Account.

OBJECT Parameters:

Success Response Parameters:

Parameter | Type | Description | errMsg | String | API request result

Sample code:

wx.navigateToMiniProgram({   appId: 'wxeb490c6f9b154ef9', // It is always the appid and cannot be changed.    extraData: data, // Include encrypt_card_id, outer_str and biz. The parameters come from the link obtained in the Step 3.   success: function() {    },   fail: function() {   },   complete: function() {   } })

Response Description

Analyze the data returned from the card activation Mini Program in App.onShow.

1. Determine whether data.referrerInfo.appId is the appId wxeb490c6f9b154ef9 of the card activation Mini Program. If not, stop the process.
2. Determine whether there is data for data.referrerInfo.extraData. If not, it indicates that the user swipes left to return or taps the return button without activating the card, or the user has activated the card.
3. If activation is successful, get the activate_ticket, card_id and code parameters from data.referrerInfo.extraData for next operations.

Notes: 1. Calling this API on Weixin DevTools does not actually cause the redirect to another Mini Program, but the DevTools verifies whether the redirect is successful. 2. The Weixin DevTools can debug processing of received parameters by the target Mini Program.

# API 3: Obtain user information submitted during card activation (for redirect-based card activation component)

API Description

This API is used to fetch the field values a user entered during the card activation.

Request Parameters

{     "activate_ticket" : "abcdefg"         }

{
     "errcode": 0,
     "errmsg": "ok",
     "info": {
         "common_field_list": [
             {
                 "name": "USER_FORM_INFO_FLAG_MOBILE",
                 "value": "15*****518"
             },
             {
                 "name": "USER_FORM_INFO_FLAG_NAME",
                 "value": "HK"
             },
             {
                 "name": "USER_FORM_INFO_FLAG_EDUCATION_BACKGROUND",
                 "value": "postgraduate"
             }
         ],
         "custom_field_list": []
     } 
}

Response Parameters

common_field_id_list supports the following options:

• Note: 1. This API can only be called by the redirect-based card activation component. The callback function of non-redirect card activation component does not contain activate_ticket.

# API 4: Obtain user information submitted during card activation (for non-redirect card activation component)

API Description

This API is used to fetch the field values a user entered during the card activation.

Request Parameters

{     "card_id" : "abcdefg",     "code" : "abcdefg"         }

• Response data

{
     "errcode": 0,
     "errmsg": "ok",
     "openid": "obLatjjwDxxxxdoGIdwNqRXw",
     "nickname": "Fourier",
     "membership_number": "316510891298",
     "bonus": 460,
     "sex": "MALE",
     "user_info": {
         "common_field_list": [
             {
                 "name": "USER_FORM_INFO_FLAG_MOBILE",
                 "value": "1552xxxx8888"
             },
             {
                 "name": "USER_FORM_INFO_FLAG_NAME",
                 "value": "Weixin"
             }
         ],
         "custom_field_list": []
     },
     "user_card_status": "NORMAL" 
}

common_field_id_list supports the following options:

# API 5: Activate a member card received by a user (for redirect-based card activation component)

API Description

This API is used to fetch the field values a user entered during the card activation.

Request Parameters

{
     "init_bonus": 100,
     "init_bonus_record":" Initial points synchronization",
     "init_balance": 200,
     "membership_number": "AAA00000001",
     "code": "12312313",
     "card_id": "xxxx_card_id",
     "background_pic_url": "https://mmbiz.qlogo.cn/mmbiz/0?wx_fmt=jpeg",
     "init_custom_field_value1": "xxxxx" 
}

Response Data

{
     "init_bonus": 100,
     "init_bonus_record":" Initial points synchronization",
     "init_balance": 200,
     "membership_number": "AAA00000001",
     "code": "12312313",
     "card_id": "xxxx_card_id",
     "background_pic_url": "https://mmbiz.qlogo.cn/mmbiz/0?wx_fmt=jpeg",
     "init_custom_field_value1": "xxxxx" 
}

# Notes

• If a user has received the Weixin member card, you can obtain the user's unionid through the "Obtain User Information" API. After the user authorizes to log in to the Mini Program, the user's existing member account can be linked with the Mini Program.
• Two processes should be designed for member card activation: for Weixin 6.5.9 or above on iOS devices and Weixin 6.5.10 or above on Android devices, card activation component can be invoked; for lower versions of Weixin, the Mini Program's own registration page must be developed, on which users complete the registration to receive the member cards.

# Redirecting to Mini Program from Coupons

# Scenario

When creating a coupon, a merchant can set the access to the services provided by the card/coupon to the path of a Mini Program.

# Procedures

1. You need to link the Mini Program to the Official Account by following the steps described in Linking Mini Program to Official Account.

2. Create a coupon, and set the "cell" in the coupon to the path of the Mini Program.

3. Process the information obtained upon the redirection to the Mini Program.

# API Description

• Create a member card.

{ "card": {
     "card_type": "MEMBER_CARD",
     "member_card": {
         "base_info": {
             "custom_url_name": "Use Now",
             "custom_url": "http://www.qq.com",
             "custom_app_brand_user_name": "gh_86a091e50ad4@app",
             "custom_app_brand_pass":"API/cardPage",
             "custom_url_sub_title": "6 Chinese characterstips",
             "promotion_url_name": "More discounts",
           "promotion_url": "http://www.qq.com",
             "promotion_app_brand_user_name": "gh_86a091e50ad4@app",
             "promotion_app_brand_pass":"API/cardPage"
        }
         } 
}

* Please call the Coupon Update API to update the Mini Program page to the structure of external redirect link, and retain the original H5 fields for redirect.

• Obtain redirection parameters

After a user is redirected from a coupon to the Mini Program, you can obtain the card_id and encrypt_code that initiate the redirection, as well as the user's openid in Official Account. You must call the Decoding API to decode the encrypt_code into the real code.