查询会员卡模板信息

更新时间:2024.09.20

通过此接口可查询指定会员卡模板的所有信息

接口说明

支持商户:【普通商户】

请求方式:【GET】/v3/marketing/membercard-open/cards/{card_id}

请求域名:【主域名】https://api.mch.weixin.qq.com 使用该域名将访问就近的接入点

     【备域名】https://api2.mch.weixin.qq.com 使用该域名将访问异地的接入点 ,指引点击查看

请求参数

Header HTTP头参数

Authorization  必填 string

请参考签名认证生成认证信息


Accept  必填 string

请设置为application/json


path 路径参数

card_id  必填 string(32)

【会员卡模板ID】商户创建微信会员卡模板成功后系统返回的会员卡模板ID

请求示例

GET

1curl -X GET \
2  https://api.mch.weixin.qq.com/v3/marketing/membercard-open/cards/pbLatjvWOibDc5-TBnbUk1pD12o0 \
3  -H "Authorization: WECHATPAY2-SHA256-RSA2048 mchid=\"1900000001\",..." \
4  -H "Accept: application/json" 
5

应答参数

200 OK

card_id  必填 string(32)

【会员卡模板ID】商户创建微信会员卡模板成功后系统返回的会员卡模板ID


create_time  选填 string(32)

【创建时间】 创建会员卡的时间
遵循rfc3339标准格式,格式为yyyy-MM-DDTHH:mm:ss.sss+TIMEZONE,yyyy-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss.sss表示时分秒毫秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。例如:2020-05-20T13:29:35.120+08:00表示北京时间2020年05月20日13点29分35秒。


update_time  选填 string(32)

【更新时间】 更新时间
遵循rfc3339标准格式,格式为yyyy-MM-DDTHH:mm:ss.sss+TIMEZONE,yyyy-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss.sss表示时分秒毫秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。例如:2020-05-20T13:29:35.120+08:00表示北京时间2020年05月20日13点29分35秒。


remain_quantity  选填 int

【剩余库存】会员卡剩余的库存


status  选填 string

【会员卡状态】会员卡当前的状态

  • NOT_APPROVE: 待审核

  • APPROVE_FAIL: 审核不通过

  • APPROVED: 审核通过,会员卡可以正常投放

  • DELETED: 商户删除了此会员卡


brand  必填 object

【品牌信息】该会员卡归属的品牌信息

属性

appid  必填 string(32)

【商户AppID】 商户的公众号AppID。
1、只能为服务号AppID,不支持App、小程序、订阅号的AppID。
2、该AppID用于获取会员OpenID及UnionID。
3、会员相关(会员状态、权益、服务)消息将通过该服务号触达用户
4、该AppID需要与会员卡归属品牌有B-A关系


logo_url  必填 string(128)

【会员卡logo】 会员卡logo的URL地址。仅支持通过《图片上传API》接口获取的图片URL地址。
1、商户logo大小需为120像素*120像素。
2、支持JPG/JPEG/PNG格式,且图片小于1M。


title  必填 string(10)

【卡名称】 1.展示在卡面上
2.支持最长10个中文字
3.支持中文字、英文字符、标点


background_picture_url  必填 string(128)

【会员卡背景图】 商家自定义会员卡背景图。仅支持通过《图片上传API》接口获取的图片URL地址。
1、大小需为1000像素*600像素。
2、支持JPG/JPEG/PNG格式,且图片小于1M。


description  必填 string(500)

【使用须知】展示在会员卡详情内,最长500个中文字符,建议填写会员权益及服务相关描述。


service_phone  选填 string(32)

【服务电话】展示在会员卡详情内,建议填写商家固定电话


code_type  必填 string(32)

【会员码型】 员卡的码型支持二维码/条形码/二维码+条形码/不展示码,这4种码型是根据membershipnumber字段生成,用户领卡后membershipnumber默认为code值,支持商户修改
枚举值:

  • BAR_CODE: 条形码

  • QRCODE: 二维码

  • BAR_CODE_AND_QRCODE: 条形码和二维码

  • NONE_CODE: 不显示任何码型


total_quantity  选填 int

【会员卡总库存】 可投放的最大会员卡数量。仅在会员卡code分配类型为系统自动分配(SYSTEM_ALLOCATE)时需要填写,其他分配类型不需要填写库存。系统分配code类型下,若未填写总库存,则微信支付系统会默认将总库存设置为5000000 (默认值)。


date_information  必填 object

【有效期】有效期

属性

code_mode  必填 string(32)

【会员卡code分配类型】 1、会员卡code是会员在card_id下唯一身份标识,平台支持3中分配类型:
SYSTEM_ALLOCATE 微信支付系统分配,用户领取会员卡时从微信支付系统分配12位数字作为会员code;
MERCHANT_DEPOSIT 商户预存code,商户可提前通过导入预存code接口导入code,用户领取会员卡时平台从商户导入的code中随机分配作为会员code
REAL_TIME 商家在激活时实时传入code,该模式仅支持小程序拉起开卡组件投放,不支持通过支付后、二维码投放。
2、会员卡code分配模式一旦指定,不支持修改。

  • SYSTEM_ALLOCATE: 由微信支付系统自动分配

  • MERCHANT_DEPOSIT: 商户预先存入自定义code,用户开卡时系统随机选取存入的code

  • REAL_TIME: 商户在用户开卡时实时传入自定义code


need_display_level  选填 boolean

【是否展示会员等级】是否在会员卡面向用户展示等级信息,默认不展示(false)


init_level  选填 string(5)

【会员初始等级】如果展示会员等级,必填init_level,作为新用户开卡后的初始等级。如因商家业务规则需要变更某会员等级,可通过更新用户会员卡接口更新等级信息


out_request_no  必填 string(128)

【商户请求单号】 商户创建会员卡凭据号。商户自定义,注意保持唯一性,仅供参考的格式:商户ID+日期+流水号。可包含英文字母,数字,|,_,*,-等内容,不允许出现其他不合法符号。


balance_information  选填 object

【储值信息】

属性

user_information_form  选填 object

【开卡信息】用户在开通会员卡时需要填写的信息

属性

additional_statement  选填 object

【商户补充声明】

属性

bonus  选填 object

【会员积分】会员积分信息。商户为当前会员卡设置了积分权益后有返回

属性

favor  选填 object

【会员优惠】会员优惠信息。商户为当前会员卡设置了优惠权益后有返回

属性

service_modules  选填 array[object]

【会员服务项】已添加的会员服务项。商户为当前会员卡设置了会员服务项时返回

属性

fapiao  选填 object

【会员发票】设置发票栏目的文案、跳转小程序

属性

guide  选填 object

【客服信息】 设置发票栏目的文案、跳转小程序

属性

need_dynamic_code  选填 boolean

【是否启用动态码】是否启用动态码功能。若启用,用户会员卡的身份识别码会被系统生成的18位数字取替,动态改变,可有效保障用户的储值资产安全,降低用户因被截图带来的储值盗用风险。默认为false

应答示例

200 OK

1{
2  "card_id" : "pbLatjvWOibDc5-TBnbUk1pD12o0",
3  "create_time" : "2020-05-20T13:29:35.120+08:00",
4  "update_time" : "2020-05-20T13:29:35.120+08:00",
5  "remain_quantity" : 1,
6  "status" : "NOT_APPROVE",
7  "brand" : {
8    "brand_id" : "1004",
9    "display_name" : "微信支付"
10  },
11  "appid" : "wxea9c30890f48d5ae",
12  "logo_url" : "https://wxpaylogo.qpic.cn/wxpaylogo/xxxxx/0",
13  "title" : "微信支付测试卡",
14  "background_picture_url" : "https://wxpaylogo.qpic.cn/wxpaylogo/xxxxx/0",
15  "description" : "使用本会员卡表示你同意xxx公司的协议,最终解释权归xxx公司所有",
16  "service_phone" : "010-8877xxxx",
17  "code_type" : "BAR_CODE",
18  "total_quantity" : 5000000,
19  "date_information" : {
20    "type" : "FIX_TIME_RANGE",
21    "available_begin_time" : "2020-05-20T13:29:35.120+08:00",
22    "available_end_time" : "2030-05-20T13:29:35.120+08:00",
23    "available_day_after_receive" : 1,
24    "wait_days_after_receive" : 1
25  },
26  "code_mode" : "SYSTEM_ALLOCATE",
27  "need_display_level" : true,
28  "init_level" : "白银会员",
29  "out_request_no" : "100002322019090134234sfdf",
30  "balance_information" : {
31    "need_balance" : false,
32    "balance_appid" : "wxea9c30890f48d5ae",
33    "balance_path" : "pages/balance/balance",
34    "balance_url" : "https://xxx.com"
35  },
36  "user_information_form" : {
37    "can_modify_after_activate" : false,
38    "common_field_list" : [
39      "USER_FORM_FLAG_MOBILE"
40    ],
41    "custom_field_list" : [
42      {
43        "type" : "TEXT",
44        "name" : "喜欢的运动",
45        "values" : [
46          "篮球"
47        ]
48      }
49    ]
50  },
51  "additional_statement" : {
52    "title" : "xxx会员卡使用须知",
53    "url" : "https://xxx.111.com",
54    "appid" : "wxea9c30890f48d5ae",
55    "path" : "pages/statement/statement"
56  },
57  "bonus" : {
58    "init_bonus" : 0,
59    "bonus_value_word" : "我的积分",
60    "bonus_cost_title" : "积分兑换",
61    "bonus_cost_word" : "500积分=2小时免费停车券",
62    "bonus_jump_word" : "更多礼品",
63    "bonus_jump_appid" : "wxea9c30a90fs8d3fe",
64    "bonus_jump_path" : "/pages/bonus/bonus",
65    "bonus_support_appid" : "wxea9c30a90fs8d3fe",
66    "bonus_support_path" : "pages/selfbonus/selfbonus"
67  },
68  "favor" : {
69    "show_coupon" : true,
70    "member_price_word" : "周二会员全场八折",
71    "member_price_appid" : "wxea9c30a90fs8d3fe",
72    "member_price_path" : "pages/favor/favor",
73    "member_price_title" : "MEMBER_PRICE",
74    "favor_module_title" : "FAVOR"
75  },
76  "service_modules" : [
77    {
78      "service_module_id" : "666",
79      "jump_miniprogram" : {
80        "appid" : "wx37178d097a6851d8",
81        "path" : "pages/index/index"
82      }
83    }
84  ],
85  "fapiao" : {
86    "fapiao_jump_word" : "查看我的发票",
87    "fapiao_jump_appid" : "wxea9c30a90fs8d3fe",
88    "fapiao_jump_path" : "pages/fapiao/fapiao"
89  },
90  "guide" : {
91    "staff_name" : "酒店管家-何小明",
92    "head_image_url" : "https://wxpaylogo.qpic.cn/wxpaylogo/xxxxx/0",
93    "contact_information_name" : "微信号",
94    "contact_information_value" : "weixin123",
95    "phone_number" : "0755-12345677"
96  },
97  "need_dynamic_code" : false,
98  "enable_real_name_authentication" : false
99}
100

 

错误码

公共错误码

状态码

错误码

描述

解决方案

400

PARAM_ERROR

参数错误

请根据错误提示正确传入参数

400

INVALID_REQUEST

HTTP 请求不符合微信支付 APIv3 接口规则

请参阅 接口规则

401

SIGN_ERROR

验证不通过

请参阅 签名常见问题

500

SYSTEM_ERROR

系统异常,请稍后重试

请稍后重试

业务错误码

状态码

错误码

描述

解决方案

403

NO_AUTH

商户暂无权限使用此功能

请开通商户号权限。请联系产品或商务申请

500

SYSTEM_ERROR

生成二维码链接失败,请重试

系统异常,请使用相同参数稍后重新调用

400

INVALID_REQUEST

扫码投放场景不支持实时code模式

请更换非实时code模式的会员卡再重试

400

INVALID_REQUEST

会员卡的创建商户号不等于调用方商户号

请使用会员卡的创建商户号进行操作

400

INVALID_REQUEST

请先升级会员卡才能使用此功能

请先调用《升级会员卡API》升级会员卡

400

INVALID_REQUEST

AppID非服务号

请使用正确的服务号的AppID重新调用,不支持App、小程序、订阅号。

400

INVALID_REQUEST

会员卡code分配类型不支持修改

会员卡code分配类型为“系统分配”,不支持修改

400

INVALID_REQUEST

会员卡code分配类型不支持修改为“系统分配”

会员卡code分配类型无法修改为“系统分配”。

400

INVALID_REQUEST

储值小程序path为空

请填写储值小程序path

400

INVALID_REQUEST

会员卡ID无效

请检查会员卡ID是否正确填写

400

INVALID_REQUEST

该会员1年内未在本商家有微信支付交易,无法导入

请更换手机号重试

400

INVALID_REQUEST

会员已经领取过该卡

请使用其他会员卡

400

INVALID_REQUEST

会员卡code为实时模式,需要传入卡code

请填入卡code

400

INVALID_REQUEST

积分跳转path为空

请填写积分跳转path

400

INVALID_REQUEST

自助积分跳转path为空

请填写自助积分跳转path

400

INVALID_REQUEST

会员专享价跳转path为空

请填写会员专享价跳转path

400

INVALID_REQUEST

该手机号和会员卡已被导入过

请更换手机号或会员卡ID重试

400

INVALID_REQUEST

该商户号不是会员卡的创建商户号

请使用会员卡的创建商户号进行操作

400

INVALID_REQUEST

手机号未绑定微信号,无法导入

请更换手机号重试

400

INVALID_REQUEST

商户无授权,请重试

请开通商户号权限。请联系产品或商务申请

400

INVALID_REQUEST

该手机号会员卡记录不存在

请更换手机号或会员卡ID重试

400

INVALID_REQUEST

没有符合条件的数据

请使用正确的参数重新调用

400

INVALID_REQUEST

商户号不属于该卡的创建方

请使用会员卡创建方的商户号重新调用

400

INVALID_REQUEST

会员卡已经迁移

会员卡已经迁移,无需重复操作

400

INVALID_REQUEST

会员权益一旦展示无法关闭

会员权益一旦展示无法关闭

400

INVALID_REQUEST

会员储值一旦展示无法关闭

会员储值一旦展示无法关闭

400

INVALID_REQUEST

需要上架至少一个积分权益、优惠权益、服务才可以投放

请先给会员卡上架至少一个积分权益、优惠权益、服务

400

PARAM ERROR

AppID有误

请使用正确的AppID重新调用

400

PARAM ERROR

OpenID有误

请使用正确的OpenID重新调用

400

PARAM ERROR

商户和品牌关系校验失败

请先将商户号绑定到品牌

400

PARAM ERROR

品牌、AppID关系校验失败

请先将AppID绑定到品牌

400

PARAM_ERROR

参数错误

请使用正确的参数重新调用

 

 

反馈
咨询
目录
置顶