获取支付有礼活动列表

更新时间：2024.12.25

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

# 接口说明

支持商户：

【普通服务商】

请求方式：

【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"

# 应答参数

200OK

data 选填 array[object]

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

属性

total_count 选填 integer

【总数】 总数

offset 选填 integer

【分页页码】 分页页码

limit 选填 integer

【分页大小】 分页大小

应答示例

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}

# 错误码

# 公共错误码

状态码	错误码	描述	解决方案
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	系统错误	请使用相同参数稍后重新调用

文档是否有帮助

商户文档

支付有礼参考文档

更多支持

开发者社区微信开放平台微信公众平台腾讯客服

获取支付有礼活动列表

# 接口说明

# 请求参数

# 应答参数

# 错误码

# 公共错误码

# 业务错误码

关于我们

服务支持

友情链接

客服帮助