(Connect)

• 8. Manage Membership Card

• 8.1 Retrieve member information (points lookup) interface

• 8.2 Change the Member Card Information Interface

• 8.3 Set up to follow recommended interfaces

• 8.4 Setting up payments to place coupons (payments are memberships)

• 8.5 Set up Member Card support WeChat

• 8.6 Other management interfaces

• 9. Statistical member card data

• 10. I'm a third party.

# 8 Manage Membership Card

# 8.1 Pulling member information (points lookup) interface

Interface Dxplaination

Support developers to query membership information based on card_id and Code, including activation data, credit information, and balance information.

Dxplaination of Interface Call Request

HTTP request mode: POST URL: https://api.weixin.qq.com/card/membercard/userinfo/get?access_token=TOKEN

Parameter explaination

POST data

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

Return 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": "微信"
            }
        ],
        "custom_field_list": []
    },
    "user_card_status": "NORMAL"
}

# 8.2 Change the Member Card Information Interface

Interface Dxplaination

Supports changing member card surface information as well as card attribute information.

Dxplaination of Interface Call Request

HTTP request mode: POST URL: https://api.weixin.qq.com/card/update?access_token=TOKEN

Parameter explaination

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:\/\/mmbiz.qpic.cn\/uploads\/allimg\/120216\/1_120216214725_1.jpg",
            "color": "Color010",
            "notice": "使用时向服务员出示此券",
            "service_phone": "020-88888888",
            "description": "不可与其他优惠同享\n如需团购券发票，请在消费时向商户提出\n店内均可使用，仅限堂食\n餐前不可打包，餐后未吃完，可打包\n本团购券不限人数，建议2人使用，超过建议人数须另收酱料费5元/位\n本单谢绝自带酒水饮料",
            "location_id_list": [
                123,
                12321,
                345345
            ]
        },
        "bonus_cleared": "aaaaaaaaaaaaaa",
        "bonus_rules": "aaaaaaaaaaaaaa",
        "prerogative": "",
        "auto_activate": true,
        //也可以填写wx_activate"activate_url"：""
    }
}

Support for modifying fields:

Base_info field:

Changes to the membership card exclusive field:

Note in particular that the following update-enabled fields are not in the structure of base_info.

Returning data instructions

Data examples:

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

Note for developers

1. Changes to some of the voucher fields are re-submitted for review. See the field explaination for more details. When the update is successful, you can check the results of the update by calling the View voucher details interface;

2. Only fill in the fields that need to be updated. Many developers will fill in fields that do not support modification, such as brandname, when calling the interface, resulting in unsuccessful updates.

3. Once you have changed the card information after calling this interface, be sure to call* Home To verify that the change has been successful.*

# 8.3 Set up to follow recommendations

Features Description

Developers are able to configure a coupon or set a bounce outer link URL at the bottom of messages such as points, balance changes, and member card activation, in the form of a URL or a card coupon as shown below.

8.3.1 Setting to follow the recommended interface Interface explaination Developers can use this interface to set up member activation and to give coupons when a transaction occurs (a change in points, a change in balance). Interface details Interface Invocation Request Dxplaination > Http request method: POST URL: https://api.weixin.qq.com/card/update?access_token=TOKEN Parameter Dxplaination | Parameters | Is it necessary | Dxplaination | | --- | --- | --- | | access_token | Yes | Call Interface Credentials | | POST Data | Yes | Json Data |

Use Messages to Configure Coupons

{
    "card_id": "pbLatjkoa7luhR3zIBjtQiaYtnz4",
    "member_card": {
        "activate_msg_operation": {
   //若指定的是积分、余额等变动消息赠券，则为modify_msg_operation
            "url_cell": {
                "card_id_list": [
                    "pbLatjhcI6XUxJWA0Au3Gaq5eFPs"
                ],
                "end_time": 1492724561,
                "text": "恭喜你获得一张50元代金券",
                "url": "www.qq.com"
            }
        }
    }
}

Field Dxplaination

Return data

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

Field Dxplaination

Developers' Note

1. Supports one member card to set points / balance change message coupons and activate coupons at the same time. Developers must set them separately;

2. If the developer fills in the card_id_list, and then fills in the url field, the card_id_list content will be invalid;

3. If the developer sets a URL, it must support receiving coupons on the URL, otherwise it will be regarded as a malicious marketing penalty.

# 8.4 Set up to place coupons after payment

8.4.1 Set up an interface for placing coupons after payment

Merchants who open WeChat to pay can set up in the user Weixin Pay automatically send a request for the user's card message, the user can click on the message to receive a membership card / coupon.

At present, this function only supports the configuration of the main body of the payment merchant number and the production of the membership card, otherwise the error is reported. Developers can log in

"Public platform" - "Service Account settings" , "WeChat Payment Merchant Platform Home" Whether the information of enterprise subject is consistent.

Interface explaination Supports merchants to set rules for placing coupons after payment, and can differentiate between time periods and amount bands to issue membership cards. Interface Invocation Request Dxplaination > HTTP request mode: POST URL: https://api.weixin.qq.com/card/paygiftcard/add?access_token=TOKEN Parameter Dxplaination | Parameters | Is it necessary | Dxplaination | | --- | --- | --- | | POST Data | Yes | Json Data | | access_token | Yes | Call Interface Credentials |

Set up POST data when paying that is a member

{
    "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"
        }
         }
  }

Field Dxplaination

Rule_info is a JSON structure that contains the following fields

Base_info is a JSON structure that contains the following fields

Member_rule is a JSON structure that is currently set to be filled in when you pay as a member and contains the following fields

Returning data instructions

Data examples:

  {
    "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"
    ]
}

Developers' Note

1. Membership card receipt messages are sent only once to a new user and are not repeated if the user has received or has received a membership card ;

2. The ticket AppID primary of the card_id set by this rule must be consistent with the Primary of current mch_id, otherwise error 72001;

Developers can log into "Public Platform" - Service Account Settings , “WeChat Payment Merchant Platform Home” Whether the main information of the enterprise is consistent;

3. Only coupons of the member card type are supported, otherwise the error is reported: 72003;

4.Set up payment that is, members must confirm the call interface of the AppID must be business card printing appid , otherwise error: 72002;

5.Must ensure that mchid has not been set by other AppID before, otherwise the error is reported 72004, must delete the payment is called after the member rule;

6. A single set of only 10 mchid, if more than 10 please call this interface multiple times.

Q&A

Q: I already have a business number and Service Account, how do I know if the body of both is the same?

A: In the "public platform" - "Service Account settings," "WeChat payment merchant platform home page" to check whether the enterprise main information is consistent.

**Q: We are the relationship between the group and the subsidiary, and hope to issue the group's Service Account membership card after payment under the subsidiary's merchant number.However, using the AppID of the subsidiary as the mchid configuration rules of the subsidiary, and setting the card_id of the group company reported an error 72002, what can I do?**

A: In this case, you can log on to the WeChat open platformhttps://open.weixin.qq.com/ ] binds the Service Account of all subsidiaries under the Third Party Platform account of the head office, and when the binding is completed, it can implement the configuration of intergroup card issuers and recognize each other's membership (UnionID mechanism).

Q: We are the relationship between the group and the subsidiary, and hope to issue the group's Service Account membership card after payment under the subsidiary's merchant number.But with the group's AppID for the sub-merchant mchid configuration rules, set the group's card_id wrong 72001, how to do?

A: The solution is as above

8.4.2 Remove the rule interface for placing coupons after payment

Remove payment-as-a-membership rules that were previously set up.

Interface Dxplaination

Enable the merchant to delete the previously set rule id

Dxplaination of Interface Call Request

HTTP request mode: POST URL: https://api.weixin.qq.com/card/paygiftcard/delete?access_token=TOKEN

Parameter explaination

POST data

{    "rule_id": 1233}

Field Dxplaination

Returning data instructions

Data examples:

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

8.4.3 Find out the details of the rules for placing coupons after payment

Interface Dxplaination

You can query the content of a payment or membership rule.

Dxplaination of Interface Call Request

HTTP request mode: POST URL: https://api.weixin.qq.com/card/paygiftcard/getbyid?access_token=TOKEN

Parameter explaination

POST data

{    "rule_id": 11233}

Field Dxplaination

Returning data instructions

Data examples:

{
    "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.3 Batch inquiry rules for placing coupons after payment interface

Interface Dxplaination

You can query in bulk the content of a merchant's payment-as-a-member rule

Dxplaination of Interface Call Request

HTTP request mode: POST URL: https://api.weixin.qq.com/card/paygiftcard/batchget?access_token=TOKEN

Parameter explaination

POST data

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

Field Dxplaination

Returning data instructions

Data examples:

{
    "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"
            }
        }
    ]
}

NOTE:

1. The above is the new payment-as-a-member interface protocol, and the old interface can still be called. See the old protocol:

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

# 8.5 WeChat Payment Card Support

Membership cards that support swipe types are created through the interface, and users can pull out the swipe interface to pay after clicking on a quick purchase. Here is a diagram:

8.5.1 Create Membership Card Support WeChat Merchants can create a membership card that supports WeChat payment by adding the following fields to the JSON that creates the membership card interface:

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

For details, see: Create a membership card

8.5.2 Update membership card support WeChat

Merchants can update their existing membership card support WeChat by adding the following fields to the JSON update membership card interface:

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

For more details, please see: Manage Membership Card

Developers' Note

1.Before setting this function, please confirm whether you have opened WeChat payment, otherwise the interface will report error ( open Weixin Pay )

2.When the user makes payment, the user can query the OPENID interface https://pay.weixin.qq.com/doc/v2/merchant/4011940944 to obtain the user's openid.

Then call the user to get the card coupon interface http://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1451025272&token=&lang=zh_CN to get the openid membership, and the corresponding price.

3.Only WeChat 6.3.18 and above version supports Member card pull out credit card payment, lower than 6.3.18 version will prompt users to upgrade.

# 8.6 Other Interfaces

8.6.1 Modify the inventory interface

Call the Modify Inventory interface to increase or decrease the inventory of a card coupon, see: Manage Card Coupons

8.6.2 Query code interface

Developers can query the basic information of the membership card through the interface, including the recipient's OpenID, membership card status, see:

8.6.3 Get vouchers that the user has received

Support the developer to call the interface to obtain a specified user card package belonging to the AppID under the card voucher, see: Manage Card Voucher

8.6.4 View voucher details

Calling this interface queries the details of the fields that card_id is creating and the audit status of the card voucher.See: Manage Card Vouchers

8.6.5 Bulk query card list

Developers can pull through the interface of the current merchant (AppID) under all the card voucher list, for card voucher management, details see:

8.6.6 Delete membership card

Developers can delete the card_id of the merchant list through this interface, for card voucher management, see:

8.6.7 Set up membership card expiration interface

Developers can through the interface to a user of a card coupon set as invalid, for refunds and other scenarios, see:

# 9 Statistical membership card data

Developers can pull through the interface card data, see:

# 10 I am a third party

A third party can be for access to the merchant generation Membership Card, details refer to: