200 OK
activity_id 必填 string(16)
【活动ID】 活动的主键,唯一定义此资源的标识
activity_status 必填 string(16)
【活动的当前状态】 活动的当前状态:
可选取值
CREATED
: 已创建,调用创建活动API成功后该活动状态
ONGOING
: 运行中,当活动正式开始的时候活动状态
TERMINATED
: 已终止,调用终止活动API接口活动状态
OVER_TIME
: 已过期,当前活动时间超过结束时间
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秒。
card_id 必填 string(32)
【会员卡ID】 商户创建微信会员卡模板成功后系统返回的会员卡ID
activity_name 必填 string(10)
【活动名称】 活动名称,用于内部管理,不对外展示。不超过10个字符
activity_type 必填 string(32)
【活动类型】 活动类型
可选取值
NON_MEMBER_AFTERPAY
: 支付后开卡有礼活动(说明:非会员用户在商户侧消费完成后,可曝光在微信支付成功页面的开卡有礼活动)
MEMBER_AFTERPAY
: 支付后老会员有礼活动 (会员用户在商户侧消费完成后,可曝光在微信支付成功页面的老会员有礼活动)
NON_MEMBER_MINIPROGRAM
: 支付前场景开卡有礼活动(说明:覆盖扫码/小程序场景,对于非会员用户,访问开卡组件时可看到开卡有礼活动信息,开卡后获得对应优惠券)
MEMBER_MINIPROGRAM
: 支付前场景老会员有礼活动(说明:覆盖扫码/小程序场景,对于会员用户,访问开卡组件时可直接获得活动设置的优惠券)
begin_time 必填 string(32)
【活动开始时间】 活动开始时间,最长可以配置1年内的活动,活动有效期最长90天,遵循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秒。
end_time 必填 string(32)
【活动结束时间】 活动结束时间,最长可以配置1年内的活动,活动有效期最长90天,遵循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秒。
award_send_period 选填 object
【发放时间段】 活动时段,可选择活动有效期内部分日期或部分时间段
 | 属性 |
| award_send_time 选填 array 【有效期内指定部分活动时间段】 在整个活动有效期内,指定更小范围的活动时间。 举例:活动整体时间在7月1日-31日,指定具体时间:7月7日、8日;7月17日、18日。  | 属性 | | begin_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秒。
end_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秒。 |
award_send_day_time 选填 array 【指定时间段】 基于“指定日期(award_send_time)”范围内,可再设置每日可用时间,取两者的交集时间段发券。 注意:若想设置指定时间段,则必须同时设置指定日期award_send_time,否则指定时间段的设置不会生效。 举例:活动整体时间在7月1日-31日,指定具体时间:7月7日、8日;7月17日、18日,指定具体时间段:上午9点-下午6点。  | 属性 | | begin_day_time 必填 object 【每日发放开始时间】 每日发放开始时间  | 属性 | | hours 必填 integer 【时】 小时,比如时间09:34:06,则填hours填9,minutes填34,seconds填6
minutes 必填 integer 【分】 分钟,比如时间09:34:06,则填hours填9,minutes填34,seconds填6
seconds 必填 integer 【秒】 秒,比如时间09:34:06,则填hours填9,minutes填34,seconds填6 |
end_day_time 必填 object 【每日发放结束时间】 每日发放结束时间  | 属性 | | hours 必填 integer 【时】 小时,比如时间09:34:06,则填hours填9,minutes填34,seconds填6
minutes 必填 integer 【分】 分钟,比如时间09:34:06,则填hours填9,minutes填34,seconds填6
seconds 必填 integer 【秒】 秒,比如时间09:34:06,则填hours填9,minutes填34,seconds填6 |
|
|
stock_list 必填 array
【优惠券列表】 发放的优惠券,一个活动最多支持发放3个批次
 | 属性 |
| stock_creator_mchid 必填 string(15) 【创建批次的商户号】 代金券或商家券的创建商户号。 注意:若制造的是代金券,则需要满足以下其一: (1)制券商户号=活动创建方商户号; (2)制券商户号已获得授权。若制造的是商家券,则需要满足以下关系:制券商户号=活动创建方商户号
stock_id 必填 string(20) 【券批次ID】 活动发放的代金券或商家券的券批次ID。 注意: (1)针对活动类型为:支付后开卡有礼/支付后老会员有礼,若要发商家券,则商家券code分配方式不支持「实时分配」; (2)活动创建方的商户号,需要与会员卡归属品牌号(brand_id)绑定b-m关系 |
out_request_no 必填 string(64)
【商户请求单号】 商户创建活动凭据号(建议格式:商户ID+日期+流水号),商户侧需保持唯一性,主要用于幂等判断,可包含英文字母,数字,|,_,*,-等内容,不允许出现其他不合法符号
pay_activity_setting 选填 object
【支付后活动设置】 支付后活动的相关配置。当活动类型是NON_MEMBER_AFTERPAY或者MEMBER_AFTERPAY时,必填
 | 属性 |
| logo_url 必填 string(256) 【商户logo】 商户活动logo,会展示在支付结果页。仅支持通过《图片上传API》接口获取的图片URL地址。 1、商户logo大小需为120像素*120像素。 2、支持JPG/JPEG/PNG格式,且图片小于1M。
activity_second_title 必填 string(9) 【支付结果页活动副标题】 支付结果页活动入口的副标题,商家填写的文案会直接展示给用户
mchid_list 必填 array 【活动曝光商户号】 活动曝光商户号。 注意:需要和会员卡归属的品牌号(brand_id)绑定b-m关系
activate_setting 选填 object 【激活方式设置】 设置会员卡激活方式,在活动类型是NON_MEMBER_AFTERPAY时必填  | 属性 | | activate_type 必填 string(16) 【激活类型】 枚举值: 可选取值
activate_url 选填 string(256) 【跳转激活的URL】 激活类型是跳转激活时,用户点击开卡后跳转到商家网页的URL。如果同时配置了activate_url和activate_miniprogram,则优先跳转到小程序
activate_miniprogram 选填 object 【跳转激活的小程序】 激活类型是跳转激活时,用户点击开卡后跳转到商家小程序。如果同时配置了activate_url和activate_miniprogram,则优先跳转到小程序  | 属性 | | activate_appid 必填 string(32) 【跳转激活的AppID】 激活类型是跳转激活时,用户点击开卡后跳转到商家小程序的AppID。如果同时配置了activate_url和activate_appid/path,则优先跳转到小程序
activate_path 必填 string(256) 【跳转激活的path】 激活类型是跳转激活时,用户点击开卡后跳转到商家小程序的path |
|
payment_setting 选填 object 【支付设置】 可以指定支付模式、支付方式、订单标识等,如果设置了,用户订单需要符合支付设置,才可能曝光  | 属性 | | payment_mode 选填 object 【支付模式】 不限制支付模式不填,限制选填  | 属性 | | payment_scene_list 选填 array 【支付场景列表】 枚举值: 可选取值 APP : APP支付场景
MICROPAY : 付款码支付
PAP : 委托代扣
MINIPROGRAM : 小程序支付
FACEPAY : 刷脸支付
|
limit_bank 选填 string(32) 【指定银行的简称】 指定银行的简称,不填则不限制支付银行。银行简称列表详见:银行类型
goods_tags 选填 string(15) 【订单优惠标记】 商户下单时需要传入相同的标记(goods_tag),用户同时符合其他规则才能享受优惠 |
|
miniprogram_activity_setting 选填 object
【支付前会员活动设置】 支付前会员活动设置,当活动类型为:NON_MEMBER_MINIPROGRAM或MEMBER_MINIPROGRAM时,可选填
 | 属性 |
| outer_str 选填 array 【指定领取渠道】 支付前会员有礼活动可通过配置outer_str来实现定向曝光: 1、outer_str 是商户自定义的字符串。只能录入数字及中英文/半角标点 匹配正则表达式: ^[0-9a-zA-Z\u0000-\u00FF\u4e00-\u9fa5]+$ 2、如果创建活动时不填写outer_st,默认活动在所有支付前场景生效; 3、如果活动配置了指定outer_str,则只有在拉起开卡组件时入参对应的outer_str,用户访问开卡组件时,才可匹配到对应的支付前会员有礼活动; 4、最多支持填写5000个值。
award_jump_deploy 选填 object 【领奖页面跳转配置】 用户获得优惠后,跳转到商家小程序页面配置  | 属性 | | mini_program_appid 必填 string(32) 【小程序AppID】 跳转的小程序AppID
mini_program_path 必填 string(256) 【小程序path】 跳转的小程序path
button_text 必填 string(8) 【跳转按钮文案】 领券页面跳转到小程序的按钮文案 |
|
应答示例
200 OK

1{
2 "activity_id" : "371067",
3 "activity_status" : "CREATED",
4 "create_time" : "2015-05-20T13:29:35.120+08:00",
5 "update_time" : "2015-05-20T13:29:35.120+08:00",
6 "card_id" : "pbLatjvWOibDc5-TBnbUk1pD12o0",
7 "activity_name" : "良品铺子回馈活动",
8 "activity_type" : "NON_MEMBER_AFTERPAY",
9 "begin_time" : "2020-01-20T13:29:35.120+08:00",
10 "end_time" : "2020-01-29T13:29:35.120+08:00",
11 "award_send_period" : {
12 "award_send_time" : [
13 {
14 "begin_time" : "2020-01-21T00:00:00.000+08:00",
15 "end_time" : "2020-01-27T00:00:00.000+08:00"
16 }
17 ],
18 "award_send_day_time" : [
19 {
20 "begin_day_time" : {
21 "hours" : 9,
22 "minutes" : 34,
23 "seconds" : 6
24 },
25 "end_day_time" : {
26 "hours" : 9,
27 "minutes" : 34,
28 "seconds" : 6
29 }
30 }
31 ]
32 },
33 "stock_list" : [
34 {
35 "stock_creator_mchid" : "10000022",
36 "stock_id" : "98065001"
37 }
38 ],
39 "out_request_no" : "100002322019090134234sfdf",
40 "pay_activity_setting" : {
41 "logo_url" : "https://wxpaylogo.qpic.cn/wxpaylogo/xxxxx/0",
42 "activity_second_title" : "湖南麻辣美食券",
43 "mchid_list" : [
44 "10000022"
45 ],
46 "activate_setting" : {
47 "activate_type" : "AUTO_ACTIVATE",
48 "activate_url" : "https://w.url.cn/s/Ahz3p2C",
49 "activate_miniprogram" : {
50 "activate_appid" : "wxea9c30a90fs8d3fe",
51 "activate_path" : "pages/activate/activate"
52 }
53 },
54 "payment_setting" : {
55 "payment_mode" : {
56 "payment_scene_list" : [
57 "APP"
58 ]
59 },
60 "limit_bank" : "CFT",
61 "goods_tags" : [
62 "xxx"
63 ]
64 }
65 },
66 "miniprogram_activity_setting" : {
67 "outer_str" : [
68 "example_outer_str"
69 ],
70 "award_jump_deploy" : {
71 "mini_program_appid" : "wxc0b84a53ed8e8d29",
72 "mini_program_path" : "mall/pages/List",
73 "button_text" : "点击"
74 }
75 }
76}
77