获取支付有礼活动列表

更新时间：2024.09.02

使用场景：商户根据一定过滤条件，查询已创建的支付有礼活动。
可调用商户：商户/服务商/渠道商

接口说明

支持商户：【普通商户】

请求方式：【GET】/v3/marketing/paygiftactivity/activities

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

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

请求参数

Header HTTP头参数

Authorization 　必填　string

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

Accept 　必填　string

请设置为application/json

query 查询参数

offset 　必填 integer

【分页页码】分页页码

limit 　必填 integer

【分页大小】分页大小

activity_name 　选填 string(10)

【活动名称】活动名称，支持模糊搜索

activity_status 　选填 string

【活动状态】活动状态

可选取值：

ACT_STATUS_UNKNOWN: 状态未知

CREATE_ACT_STATUS: 已创建

ONGOING_ACT_STATUS: 运行中

TERMINATE_ACT_STATUS: 已终止

STOP_ACT_STATUS: 已暂停

OVER_TIME_ACT_STATUS: 已过期

CREATE_ACT_FAILED: 创建活动失败

award_type 　选填 string

【奖品类型】奖品类型，暂时只支持商家券

可选取值：

BUSIFAVOR: 商家券

请求示例

1curl -X GET \
2  https://api.mch.weixin.qq.com/v3/marketing/paygiftactivity/activities?offset=1&limit=20&activity_name=良品铺子回馈活动&activity_status=ACT_STATUS_UNKNOWN&award_type=BUSIFAVOR \
3  -H "Authorization: WECHATPAY2-SHA256-RSA2048 mchid=\"1900000001\",..." \
4  -H "Accept: application/json" 
5

应答参数

200 OK

data 　选填 array[object]

【结果集】支付有礼活动列表

属性

activity_id 　选填 string(20)

【活动Id】活动Id

activity_type 　选填 string

【活动类型】活动类型

可选取值：

FULL_SEND_ACT_TYPE: 活动类型

STEP_SEND_ACT_TYPE: 活动类型

SPECIFIC_SEND_ACT_TYPE: 活动类型

activity_base_info 　选填 object

【活动基本信息】创建活动时录入的基本信息

属性

activity_name 　必填 string(10)

【活动名称】活动名称

activity_second_title 　必填 string(9)

【活动副标题】活动副标题

merchant_logo_url 　必填 string(128)

【商户logo】商户logo，送出优惠券时展示

background_color 　选填 string

【背景颜色】代金券的背景颜色，可设置10种颜色，颜色取值可参考开发指引 3.2.1 background_color取值，默认为微信支付绿色，颜色取值为颜色图中的颜色名称。

begin_time 　必填 string(32)

【活动开始时间】活动开始时间，最长可以配置1年内的活动，活动有效期最长90天

end_time 　必填 string(32)

【活动结束时间】活动结束时间，最长可以配置1年内的活动，活动有效期最长90天

available_periods 　选填 object

【可用时间段】可自定义活动有效时间内可用的多个时间段以及天内时间点

属性

out_request_no 　必填 string(128)

【商户请求单号】商户创建批次凭据号（格式：商户id+日期+流水号），商户侧需保持唯一性，可包含英文字母，数字，｜，_，*，-等内容，不允许出现其他不合法符号

delivery_purpose 　必填 string

【投放目的】OFF_LINE_PAY：拉用户回店消费；JUMP_MINI_APP：引导用户前往小程序消费

可选取值：

OFF_LINE_PAY: 投放目的枚举值

JUMP_MINI_APP: 投放目的枚举值

mini_programs_appid 　选填 string(32)

【商家小程序appid】投放目的为跳转小程序时必填

mini_programs_path 　选填 string(128)

【商家小程序path】投放目的为跳转小程序必填

award_send_rule 　选填 object

【活动奖品发放规则】奖品派送规则，分别对应满送、阶梯送、满A送B中的一种

属性

full_send_rule 　选填 object

【满送活动奖品发放规则】

属性

transaction_amount_minimum 　必填 integer

【消费金额门槛】消费金额门槛单位分

send_content 　必填 string

【发放内容】发放内容，可选单张券或礼包，选礼包时奖品限定3-5个

可选取值：

SINGLE_COUPON: 单张券

GIFT_PACKAGE: 礼包

award_type 　必填 string

【奖品类型】奖品类型，暂时只支持商家券

可选取值：

BUSIFAVOR: 商家券

award_list 　必填 array[object]

【奖品基本信息列表】奖品基本信息列表

属性

merchant_option 　必填 string

【发券商户号选项】发券商户号选取规则，支持选择在用券商户或手动输入商户号两种，选择手动时，发券商户号必填（商家券只支持手动输入）

可选取值：

IN_SEVICE_COUPON_MERCHANT: 在用券商户号

MANUAL_INPUT_MERCHANT: 手动输入发券商户号

merchant_id_list 　选填 array[string(15)]

【发券商户号】发券商户号，列表

advanced_setting 　选填 object

【活动高级设置】创建时传入的高级设置信息

属性

delivery_user_category 　选填 string

【投放用户类别】DELIVERY_ALL_PERSON:所有用户；DELIVERY_MEMBER_PERSON：会员用户

可选取值：

DELIVERY_ALL_PERSON: 投放用户类型

DELIVERY_MEMBER_PERSON: 投放用户类型

merchant_member_appid 　选填 string(32)

【商家会员appid】当投放用户类别为会员用户时必填

payment_mode 　选填 object

【支付模式】主要用于指定可用的支付场景，不限制支付模式不填，限制选填（商家券暂不开放）

属性

payment_scene_list 　选填 array[string]

【支付场景列表】APP_SCENE：App场景；SWING_CARD:刷卡;NO_SECRET_SCENE:免密支付;MINIAPP_SCENE:小程序;FACE_PAY_SCENE:人脸支付; OTHER_SCENE:其他支付场景

可选取值：

APP_SCENE: app场景

SWING_CARD_SCENE: 刷卡

NO_SECRET_SCENE: 免密支付

MINIAPP_SCENE: 小程序

FACE_PAY_SCENE: 人脸支付

OTHER_SCENE: 其他支付场景

payment_method_information 　选填 object

【支付方式信息】支付方式信息，不填为不限制（商家券暂不开放）

属性

payment_method 　必填 string

【支付方式】支付方式，可以指定银行卡或零钱

可选取值：

CFT: 零钱

SPECIFIC_BANK_CARD: 指定银行卡

bank_abbreviation 　选填 string

【银行简称】银行简称，指定支付方式为银行卡必填，详询附录

goods_tags 　选填 array[string(15)]

【订单优惠标记】商户下单时需要传入相同的标记(goods_tag)，用户同时符合其他规则才能享受优惠

activity_status 　选填 string

【活动状态】活动当前状态枚举值

可选取值：

ACT_STATUS_UNKNOWN: 状态未知

CREATE_ACT_STATUS: 已创建

ONGOING_ACT_STATUS: 运行中

TERMINATE_ACT_STATUS: 已终止

STOP_ACT_STATUS: 已暂停

OVER_TIME_ACT_STATUS: 已过期

CREATE_ACT_FAILED: 创建活动失败

creator_merchant_id 　选填 string(15)

【创建商户号】创建商户号

belong_merchant_id 　选填 string(15)

【所属商户号】所属商户号

create_time 　选填 string

【活动创建时间】活动创建时间

update_time 　选填 string

【活动更新时间】活动更新时间

total_count 　选填 integer

【总数】总数

offset 　选填 integer

【分页页码】分页页码

limit 　选填 integer

【分页大小】分页大小

应答示例

200 OK

1{
2  "data" : [
3    {
4      "activity_id" : "10028001",
5      "activity_type" : "FULL_SEND_ACT_TYPE",
6      "activity_base_info" : {
7        "activity_name" : "良品铺子回馈活动",
8        "activity_second_title" : "海飞丝的券",
9        "merchant_logo_url" : "https://tool.oschina.net/regex.jpg",
10        "background_color" : "Color010",
11        "begin_time" : "2015-05-20T13:29:35.120+08:00",
12        "end_time" : "2015-05-20T13:29:35.120+08:00",
13        "available_periods" : {
14          "available_time" : [
15            {
16              "begin_time" : "2015-05-20T00:00:00.000+08:00",
17              "end_time" : "2015-05-20T23:59:59.000+08:00"
18            }
19          ],
20          "available_day_time" : [
21            {
22              "begin_day_time" : "110000",
23              "end_day_time" : "135959"
24            }
25          ]
26        },
27        "out_request_no" : "100002322019090134234sfdf",
28        "delivery_purpose" : "OFF_LINE_PAY",
29        "mini_programs_appid" : "wx23232232323",
30        "mini_programs_path" : "/path/index/index"
31      },
32      "award_send_rule" : {
33        "full_send_rule" : {
34          "transaction_amount_minimum" : 100,
35          "send_content" : "SINGLE_COUPON",
36          "award_type" : "BUSIFAVOR",
37          "award_list" : [
38            {
39              "stock_id" : "98065001",
40              "original_image_url" : "https://tool.oschina.net/regex.jpg",
41              "thumbnail_url" : "https://tool.oschina.net/regex.jpg"
42            }
43          ],
44          "merchant_option" : "IN_SEVICE_COUPON_MERCHANT",
45          "merchant_id_list" : [
46            "10000022"
47          ]
48        }
49      },
50      "advanced_setting" : {
51        "delivery_user_category" : "DELIVERY_ALL_PERSON",
52        "merchant_member_appid" : "34567890",
53        "payment_mode" : {
54          "payment_scene_list" : [
55            "APP_SCENE"
56          ]
57        },
58        "payment_method_information" : {
59          "payment_method" : "CFT",
60          "bank_abbreviation" : "AHRCUB_CREDIT"
61        },
62        "goods_tags" : [
63          "xxx"
64        ]
65      },
66      "activity_status" : "ACT_STATUS_UNKNOWN",
67      "creator_merchant_id" : "10000022",
68      "belong_merchant_id" : "10000022",
69      "create_time" : "2015-05-20T13:29:35.120+08:00",
70      "update_time" : "2015-05-20T13:29:35.120+08:00"
71    }
72  ],
73  "total_count" : 245,
74  "offset" : 1,
75  "limit" : 50
76}
77

错误码

公共错误码

状态码	错误码	描述	解决方案
400	PARAM_ERROR	参数错误	请根据错误提示正确传入参数
400	INVALID_REQUEST	HTTP 请求不符合微信支付 APIv3 接口规则	请参阅接口规则
401	SIGN_ERROR	验证不通过	请参阅签名常见问题
500	SYSTEM_ERROR	系统异常，请稍后重试	请稍后重试

业务错误码

状态码	错误码	描述	解决方案
400	APPID_MCHID_NOT_MATCH	AppID与MchID不匹配	请确认AppID是否正确填写
400	INVALID_REQUEST	请求参数符合参数格式，但不符合业务规则	根据错误提示，传入符合业务规则的参数
400	MCH_NOT_EXISTS	商户号不存在	请确认发券商户号信息是否有误
401	SIGN_ERROR	签名错误或签名信息不完整	登录商户平台核对，传入正确信息
403	NO_AUTH	商户未被授权	登录商户平台核对，传入正确信息
404	RESOURCE_NOT_EXISTS	资源不存在或无可用	请确认资源均存在且可用
429	FREQUENCY_LIMITED	频率超限	请求量不要超过接口调用频率限制
500	SYSTEM_ERROR	系统错误	请使用相同参数稍后重新调用

文档是否有帮助

更多支持

开发文档(服务商)开发文档(V2版)开发者社区微信开放平台微信公众平台腾讯客服