(Continued)

• 8. Managing Member Cards

• 8.1 Fetching Member Information (Querying Loyalty Points)

• 8.2 Updating Member Card Information

• 8.3 Tracking and Recommendation

• 8.4 Issuing Cards After Payment (Becoming Member upon Payment)

• 8.5 Setting a Member Card to Support WeChat Pay

• 8.6 Other Management APIs

• 9. Collecting Member Card Data

• 10. I Am a Third Party

# 8 Managing Member Cards

# 8.1 Fetching Member Information (Querying Loyalty Points

API Description

This API allows developers to query member information by card_id and code. The member information includes the information for activation, loyalty points, and the balance.

API Request Format

HTTP request method: POSTURL:https://api.weixin.qq.com/card/membercard/userinfo/get?access_token=TOKEN

Parameters

POST Data

{
   "card_id": "pbLatjtZ7v1BG_ZnTjbW85GYc_E8",
   "code": "916679873278" 
}

Response Data

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

# 8.2 Updating Member Card Information

API Description

This API allows you to change the information and attributes of member cards.

API Request Format

HTTP request method: POSTURL:https://api.weixin.qq.com/card/update?access_token=TOKEN

Parameters

POST Data

{
    "card_id": "ph_gmt7cUVrlRk8swPwx7aDyF-pg",
    "member_card": {
        "background_pic_url": "https://mmbiz.qlogo.cn/mmbiz/0?wx_fmt=jpeg",
        "base_info": {
            "logo_url": "http:\/\/www.supadmin.cn\/uploads\/allimg\/120216\/1_120216214725_1.jpg",
            "color": "Color010",
            "notice": "Present this coupon to the waiter at the time of use",
            "service_phone": "020-88888888",
            "description": "Using with other coupons is not allowed.\nAsk the merchant for an invoice for the group purchase during check-out.\nAvailable for in-store dining only.\nTakeout is offered for leftovers after dining only.\nThis coupon is for 2 persons. You may have to pay a 5-CNY sauce fee for each extra person.\nDo not bring your own drink.",
            "location_id_list": [
                123,
                12321,
                345345
            ]
        },
        "bonus_cleared": "aaaaaaaaaaaaaa",
        "bonus_rules": "aaaaaaaaaaaaaa",
        "prerogative": "",
        "auto_activate": true,
        //You can also enter wx_activate"activate_url":"."
    }
}

The following fields can be modified:

base_info:

Member card-dedicated fields

Note that the following modifiable fields are not contained in the structure of base_info.

Response Data

Example:

{
   "errcode":0,
   "errmsg":"ok",
  "send_check": true
}

Notes

1. When some fields of a voucher are modified, the code will be resubmitted for review. For the specific fields, see the field description. After the voucher is updated, you can call the "View Voucher Details" API to check the update results.

2. Enter the to-be-updated fields only. If fields that cannot be modified, such as brandname, are entered when the API is called, the update will fail.

3. If you update the coupon information by calling this API, call the Homepage to verify whether the update is successful.

# 8.3 Setting Track and Recommendation

Feature description

This feature allows developers to configure coupons or external redirect URLs at the bottom of messages for loyalty points, balance changes, and member card activation. The following figure shows the specific form, which may be a URL or a coupon.

8.3.1 Setting Track and Recommendation

API Description

This API allows developers to gift coupons to users when the users activate member cards and make payments (which can be determined based on changes in the loyalty points and balance).

API details

API Request Format

HTTP request method: POSTURL:https://api.weixin.qq.com/card/update?access_token=TOKEN

Parameters

Configuring a coupon by using a message

{
    "card_id": "pbLatjkoa7luhR3zIBjtQiaYtnz4",
    "member_card": {
        "activate_msg_operation": {
   //If the coupon is gifted based on a loyalty points or balance change message, enter modify_msg_operation instead.
            "url_cell": {
                "card_id_list": [
                    "pbLatjhcI6XUxJWA0Au3Gaq5eFPs"
                ],
                "end_time": 1492724561,
                "text": "Congrats! You are gifted a 50 CNY coupon.",
                "url": "www.qq.com"
            }
        }
    }
}

Fields

Response Data

{
   "errcode":0,
   "errmsg":"ok"
}

Fields

Notes

1. Coupons gifted based on loyalty points or balance change messages and coupons gifted based on member card activation messages can be set for a same member card. You need to set them separately.

2. If you specify the url field after specifying card_id_list, the setting of card_id_list fails to take effect.

3. If you have specified url, you must allow users to claim the coupon via the specified URL. Otherwise, the merchant is punished for malicious promotion.

# 8.4 Issuing Cards After Payment

8.4.1 Setting Card Issuance After Payment

A merchant who has enabled WeChat Pay can set the system to automatically send a coupon claiming message to a user who pay money to the merchant via WeChat Pay. The user can claim a member card or a coupon by tapping the message.

Currently, this feature is available only when the entity of the merchant ID that has enabled WeChat Pay is the same as the entity of the Official Account that provides the member card. Otherwise, an error occurs. To check whether the corporate entities are the same, log in to

Weixin Official Accounts Platform and choose Account Info to view Entity Info, and go to the homepage of WeChat Pay Merchant Platform to view the entity.

API Description

This API allows merchants to set rules for issuing coupons after payment. Merchants can issue member cards by time ranges and amount ranges.

API Request Format

HTTP request method: POSTURL:https://api.weixin.qq.com/card/paygiftcard/add?access_token=TOKEN

Parameters

POST data for setting Become Member Upon Payment

{
    "rule_info": {
        "type": "RULE_TYPE_PAY_MEMBER_CARD",
        "base_info": {
            "mchid_list": [
                            "123",
                            "456"
            ],
            "begin_time": 1480317217,
            "end_time": 1580317217
        },
        "member_rule": {
            "card_id": "abcdefg",
            "least_cost": 2,
            "max_cost": 20000,
            "jump_url": "www.qq.com"
        }
         }
  }

Fields

rule_info is in the JSON structure. It contains the following fields:

base_info is in the JSON structure. It contains the following fields:

member_rule is in the JSON structure. The current settings are specified when the Become Member Upon Payment feature is enabled. It contains the following fields:

Response Data

Example:

  {
    "errcode": 0,
    "errmsg": "ok",
    "rule_id": 1231243,
    "fail_mchid_list": [
        {
            "mchid": "111",
            "errcode": 23112,
            "errmsg": "err",
            "occupy_rule_id": 12332123,
            "occupy_appid": "appid"
        }
    ]
    "succ_mchid_list": [
        "123",
        "456"
    ]
}

Notes

1. The member card claiming message is sent only once to a single new user. If a user received or claimed a member card before, the message will not be sent to the user repeatedly.

2. The entity corresponding to the AppID who provides the coupon or coupon with the card_id specified in the rule must be the same as the entity corresponding to the current mch_id. Otherwise, an error 72001 is reported.

To check whether the corporate entities are the same, log in to Weixin Official Accounts Platform and choose Account Info to view Entity Info, and go to the homepage of WeChat Pay Merchant Platform to view the entity.

3. Only membership coupons are supported. Otherwise, an error 72003 is reported.

4. When setting the Become Member Upon Payment feature, ensure that the AppID for calling the API must be the AppID for providing the member card. Otherwise, an error 72002 is reported.

5. Ensure that the merchant ID is currently not used by other AppIDs. Otherwise, an error 72004 is reported, and you need to delete the Become Member Upon Payment rule before calling the API.

6. A maximum of 10 merchant IDs are supported in the setting at a time. If more than 10 merchant IDs are required, call this API for multiple times.

Q&A

Q: I have a merchant ID and an Official Account. How can I know whether their entities are the same?

A: To check whether the corporate entities are the same, log in to the Weixin Official Accounts Platform and choose Account Info to view Entity Info, and go to the homepage of WeChat Pay Merchant Platform to view the entity.

Q: We are in the group-subsidiary relationship. We want to issue member cards created by the group's Official Account to users who pay money to the subsidiary's merchant ID. However, when we use the subsidiary's AppID to configure a rule for the subsidiary's merchant ID[TH1], an error 72002 is reported when we are setting the group's card_id. What can we do?

A: In this case, you can log in to Weixin Open Platform (https://open.weixin.qq.com/) to link Official Accounts of all subsidiaries to the group's third-party platform account. After that, cards can be issued from both the group's ID and subsidiaries' IDs, and members can be identified by all of them (in other words, the UnionID mechanism is applied).

Q: We are in the group-subsidiary relationship. We want to issue member cards created by the group's Official Account to users who pay money to the subsidiary's merchant ID. However, when we use the group's AppID to configure a rule for the subsidiary's merchant ID, an error 72001 is reported when we are setting the group's card ID. What can we do?

A: In this case, you can log in to Weixin Open Platform (https://open.weixin.qq.com/) to link Official Accounts of all subsidiaries to the group's third-party platform account. After that, cards can be issued from both the group's ID and subsidiaries' IDs, and members can be identified by all of them (in other words, the UnionID mechanism is applied).

8.4.2 Deleting rules for issuing coupons after payment

Deletes a previous "Become Member Upon Payment" rule.

API Description

This API allows merchants to delete a previous rule ID.

API Request Format

HTTP request method: POSTURL:https://api.weixin.qq.com/card/paygiftcard/delete?access_token=TOKEN

Parameters

POST Data

{    "rule_id": 1233}

Fields

Response Data

Example:

{
    "errcode": 0,
    "errmsg": "ok"
}

8.4.3 Querying rules for issuing coupons after payment

API Description

This API is usd to query a "Become Member Upon Payment" rule.

API Request Format

HTTP request method: POSTURL:https://api.weixin.qq.com/card/paygiftcard/getbyid?access_token=TOKEN

Parameters

POST Data

{    "rule_id": 11233}

Fields

Response Data

Example:

{
    "errcode": 0,
    "errmsg": "ok",
    "rule_info": {
        "type": "RULE_TYPE_PAY_MEMBER_CARD",
        "base_info": {
            "mchid_list": [
                "123",
                "456"
            ],
            "begin_time": 1480317217,
            "end_time": 1580317217,
            "status": "RULE_STATUS_OK",
            "create_time": 1480317217,
            "update_time": 1480317217
        },
        "member_rule": {
            "card_id": "abcdefg",
            "least_cost": 2,
            "max_cost": 20000,
            "jump_url": "www.qq.com"
        }
    }
}

8.4.4 Querying rules for issuing coupons after payment in batch

API Description

This API allows you to query a merchant's "Become Member Upon Payment" rules in batch.

API Request Format

HTTP request method: POSTURL:https://api.weixin.qq.com/card/paygiftcard/batchget?access_token=TOKEN

Parameters

POST Data

{
    "type": "RULE_TYPE_PAY_MEMBER_CARD",
    "effective": true,
    "offset": 0,
    "count" : 1
}

Fields

Response Data

Example:

{
    "errcode": 0,
    "errmsg": "ok",
    "total_count": 4,
    "rule_list": [
        {
            "type": "RULE_TYPE_PAY_MEMBER_CARD",
            "base_info": {
                "mchid_list": [
                    "123",
                    "456"
                    ],
                "begin_time": 1480317217,
                "end_time": 1580317217,
                "status": "RULE_STATUS_OK",
                "create_time": 1480317217,
                "update_time": 1480317217
            },
            "member_rule": {
                "card_id": "abcdefg",
                "least_cost": 2,
                "max_cost": 20000,
                "jump_url": "www.qq.com"
            }
        }
    ]
}

Notes:

1. The preceding content describes the new API protocol for the Become Member Upon Payment feature. The old API is still available. For the old API protocol, visit the following link:

https://mp.weixin.qq.com/cgi-bin/announce?action=getannouncement&key=1481363811&version=1&lang=zh_CN&platform=2

# 8.5 Setting a Member Card to Support WeChat Pay[TH2]

For member cards that are created via the API and support Quick Pay, users can tap Weixin Checkout to go to the Quick Pay screen for making payments, as shown below

8.5.1 Creating a member card to support WeChat Pay

A merchant can create a member card to support WeChat Pay. To do this, the merchant needs to add the following fields to the JSON of the "Create Member Card" API:

{
     "card": {
         "card_type": "MEMBER_CARD",
         "member_card": {
             "base_info": {
                 "pay_info":
                 {
                         "swipe_card":
                         {
                           "is_swipe_card":true
                      }
                    }
             }
         }
     } 
}

For details, see Creating Member Cards.

8.5.2 Updating a member card to support WeChat Pay

A merchant can update an existing member card to support WeChat Pay. To do this, the merchant needs to add the following fields to the JSON of the "Update Member Card" API:

{
    "card_id": "ph_gmt7cUVrlRk8swPwx7aDyF-pg",
    "member_card": {
             "base_info": {
                 "pay_info":
                 {
                         "swipe_card":
                         {
                             "is_swipe_card":true
                     }
                   }
              }
     } 
}

For details, see Managing Member Cards.

Notes

1. Before setting this feature, ensure that you have activated WeChat Pay. Otherwise, the API reports an error. (Activating WeChat Pay)

2. After the API is called to enable a member card to support WeChat Pay, when a user makes payment, you can get the users' OpenID by Querying OpenID via Authorization Code and the member identity of the OpenID by calling the "Get Coupons Received by User" API, and then set the price.

3. Using WeChat Pay from Member cards is supported as of Weixin 6.3.18. In Weixin earlier than 6.3.18, an upgrade notification is displayed when this feature is to be used.

# 8.6 Other Management APIs

8.6.1 Modifying Inventory

This API is used to increase/decrease the inventory of a coupon. For details, see Managing Coupons.

8.6.2 Querying Code

This API allows developers to view basic information of a member card, including the status of the member card and the OpenID of the user who receives the member card. For details, see Managing Coupons.

8.6.3 Getting Coupons Received by User

This API allows developers to get all coupons under the specified AppID in Cards & Offers. For details, see Managing Coupons.

8.6.4 Checking Coupon Details

This API allows developers to query details about the fields that are passed in when the card_id is created and the review status of the coupon. For details, see Managing Coupons.

8.6.5 Querying Coupons in Batch

This API allows developers to query the list of all coupons under the current AppID for coupon management. For details, see Managing Coupons.

8.6.6 Deleting Member Cards

This API allows developers to delete a card_id from the merchant list for coupon management. For details, see Managing Coupons.

8.6.7 Invalidating Member Cards

This API allows developers to invalidate a use's member card. It is used in scenarios such as refunds. For details, see Managing Coupons.

# 9 Collecting Member Card Data

This API allows developers to fetch data of a member card. For details, see Managing Coupons.

# 10 I Am a Third Party

A third party can develop member cards for the linked merchants. For details, see Third-Party Developer Mode.