支付宝
  1. 接入指南
支付宝
  • 支付
    • 当面付
      • 产品介绍
      • 接入准备
      • 接入指南
        • 基础功能
          • 付款码支付快速接入
          • 扫码支付快速接入
          • 当面付接入注意事项
          • 异步通知说明
        • 扩展功能
          • 当面付扩展功能
          • 对账说明
          • 商户风险联防指引
          • 用户下单 IP 获取指引
        • 集成工具
          • 沙箱环境联调
          • SDK & Demo 获取
      • API 列表
        • 常见问题
        • 付款码支付
          • 收单退款冲退完成通知接口
          • 统一收单交易支付接口
          • 统一收单交易查询
          • 统一收单交易退款接口
          • 统一收单交易退款查询
          • 统一收单交易撤销接口
          • 统一收单交易关闭接口
          • 查询对账单下载地址
        • 扫码支付
          • 收单退款冲退完成通知
          • 统一收单线下交易预创建
          • 统一收单交易创建接口
    • APP 支付
      • 产品介绍
      • 接入准备
      • 常见问题
      • 接入指南
        • 基础功能
          • 界面规范
          • APP 支付快速接入
          • iOS 集成流程
          • Android 集成流程
          • 鸿蒙 SDK 接入说明
          • 同步通知说明
          • 异步通知说明
        • 扩展功能
          • 手机网站支付转 APP 支付
          • APP 支付接入花呗分期
          • 花呗单通道支付界面规范
          • 对账说明
          • 商户风险联防指引
          • 用户下单 IP 获取指引
        • 集成工具
          • 沙箱环境联调
          • App 支付客户端 DEMO&SDK
      • API 列表
        • 收单退款冲退完成通知
        • 交易
          • 统一收单交易退款接口
          • 统一收单交易关闭接口
          • 统一收单交易退款查询
          • 统一收单交易查询
        • 账单
          • app支付接口2.0
    • 手机网站支付
      • 产品介绍
      • 接入准备
      • 常见问题
      • 接入指南
        • 基础功能
          • 界面规范
          • 手机网站支付快速接入
          • 异步通知说明
        • 扩展功能
          • 手机网站支付转Native支付(推荐)
          • 手机网站支付通过alipays协议唤起支付宝APP
          • 旧版手机网站支付升级为新版指南
          • 对账说明
          • 商户风险联防指引
          • 用户下单 IP 获取指引
        • 集成工具
          • 沙箱环境联调
          • SDK & Demo 获取
      • API 列表
        • 收单退款冲退完成通知
        • 交易
          • 统一收单交易退款接口
          • 统一收单交易关闭接口
          • 统一收单交易退款查询
          • 统一收单交易查询
        • 账单
          • 手机网站支付接口2.0
    • 电脑网站支付
      • 产品介绍
      • 接入准备
      • 接入指南
        • 基础功能
          • 界面规范
          • 电脑网站支付快速接入
          • 异步通知说明
        • 扩展功能
          • 花呗分期接入
          • 对账说明
          • 商户风险联防指引
          • 用户下单 IP 获取指引
        • 集成工具
          • 沙箱环境联调
          • SDK & Demo 获取
        • API 列表
          • 收单退款冲退完成通知
          • 常见问题
          • 交易
          • 账单
    • 商家扣款
      • 产品介绍
      • 权限集列表
        • 商家扣款(必选)
          • 产品介绍
          • 接入准备
          • 常见问题
          • 接入指南
            • 异步通知说明
            • 沙箱调试说明
          • API 列表
            • 签约
              • 小程序独立签约接口
              • 支付宝个人代扣协议查询接口
              • 支付宝个人代扣协议解约接口
              • 支付宝个人协议页面签约接口
            • 支付
              • app支付接口2.0
              • 统一收单交易支付接口
              • 统一收单交易查询
              • 统一收单交易退款接口
              • 统一收单交易关闭接口
              • 统一收单交易撤销接口
            • 对账
              • 查询对账单下载地址
          • 相关资料
            • 支付界面规范
            • 代扣产品常见场景值
        • 商家分账(可选)
          • 产品介绍
          • 接入准备
          • 接入指南
          • 常见问题
          • API 列表
            • 分账关系维护
              • 分账关系绑定
              • 分账关系解绑
              • 分账关系查询
            • 分账请求
              • 统一收单交易结算接口
            • 分账查询
              • 分账比例查询
              • 分账剩余金额查询
              • 交易分账查询接口
            • 消息通知
              • 交易分账结果通知
          • 相关资料
            • 沙箱调试说明
    • 周期扣款
      • 产品介绍
      • 接入准备
      • 常见问题
      • 接入指南
        • 异步通知说明
      • API 列表
        • 签约
          • 支付宝个人协议页面签约接口
          • 支付宝个人代扣协议查询接口
          • 支付宝个人代扣协议解约接口
        • 支付
          • app支付接口2.0
          • 统一收单交易支付接口
          • 统一收单交易查询
          • 统一收单交易退款接口
          • 统一收单交易退款查询
          • 统一收单交易撤销接口
          • 统一收单交易关闭接口
        • 对账
          • 查询对账单下载地址
      • 相关资料
        • 支付界面规范
        • 代扣产品常见场景值
    • 刷脸付
      • 产品介绍
      • 接入准备
      • 接入指南
      • 常见问题
      • API 列表
        • 刷脸支付初始化
        • 人脸ftoken查询消费接口
      • 相关资料
        • 异步通知说明
    • 预授权支付
      • 预授权支付产品介绍
      • 权限集列表
        • 预授权支付(必选)
          • 产品介绍
          • 接入准备
          • 常见问题
          • 接入指南
            • 快速接入
            • iOS 集成流程
            • Android 集成流程
          • API 列表
            • 预授权
              • my.tradePay
            • 交易
              • 统一收单交易支付接口
              • 统一收单交易关闭接口
              • 统一收单交易退款查询
              • 统一收单交易查询
              • 统一收单交易退款接口
            • 账单
              • 查询对账单下载地址
          • 相关资料
            • 对账说明
            • 异步通知说明
            • 支付渠道说明
            • 沙箱调试说明
        • 商家分账(可选)
          • 产品介绍
          • 接入准备
          • 接入指南
          • 常见问题
          • API 列表
            • 分账关系绑定接口
              • 分账关系绑定
              • 分账关系解绑
              • 分账关系查询
            • 分账请求
              • 统一收单交易结算接口
            • 分账查询
              • 分账比例查询
              • 分账剩余金额查询
              • 交易分账查询接口
            • 消息通知
              • 交易分账结果通知
          • 相关资料
            • 沙箱调试说明
    • 支付宝预授权
      • 产品介绍
      • 接入准备
      • 常见问题
      • 接入指南
        • 支付宝预授权快速接入
        • 异步通知说明
      • API 列表
        • 预授权
          • 线上资金授权冻结接口
          • 资金授权解冻接口
          • 资金授权操作查询接口
        • 支付
          • 统一收单交易支付接口
          • 统一收单交易退款接口
          • 统一收单交易查询
          • 支付宝订单信息同步接口
          • 统一收单交易退款查询
          • 统一收单交易关闭接口
        • 对账
          • 查询对账单下载地址
    • JSAPI 支付
      • JSAPI 支付产品介绍
      • 权限集列表
        • 支付(必选)
          • 产品介绍
          • 接入准备
          • 常见问题
          • 接入指南
          • API 列表
            • my.tradePay
            • 收单退款冲退完成通知
            • 统一收单交易创建接口
            • 统一收单交易撤销接口
            • 统一收单交易查询
            • 统一收单交易退款接口
            • 统一收单交易退款查询
            • 查询对账单下载地址
            • 统一收单交易关闭接口
          • 相关资料
            • 异步通知说明
            • 沙箱调试说明
            • 小程序细分业务场景
        • 分账(可选)
          • 产品介绍
          • 接入准备
          • 接入指南
          • 常见问题
          • API 列表
            • 分账关系维护
              • 分账关系绑定
              • 分账关系解绑
              • 分账关系查询
            • 分账请求
              • 统一收单交易结算接口
            • 分账查询
              • 交易分账查询接口
              • 分账比例查询
              • 分账剩余金额查询
            • 消息通知
              • 交易分账结果通知
          • 相关资料
            • 沙箱调试说明
  • 私域
    • 小程序产品
      • 小程序产品介绍
      • 集成说明
      • 权限集列表
        • 搜索关键词
          • 权限集介绍
          • 接入准备
          • 常见问题
          • 接入指南
            • 快速接入
            • 沙箱调试
          • API 列表
            • 申请搜索关键词
              • 提报搜索关键词
              • 查询小程序搜索关键词的审核工单的状态
              • 查询小程序可配置关键词数
              • 查询小程序已配置关键词
              • 删除搜索关键词
            • 申请服务关键词(服务推广)
              • 提报服务关键词
              • 查询小程序服务关键词的审核工单的状态
              • 服务关键词批量查询接口
              • 删除服务关键词
            • 审核进度通知
              • 小程序关键词审核进度消息通知
            • 申请搜索关键词(旧)
              • 搜索运营服务查询接口
              • 搜索运营提报基础信息工单
              • 查询搜索服务工单的详细信息
        • 搜索直达
          • 权限集介绍
          • 接入准备
          • 接入指南
          • 沙箱调试
          • 常见问题
          • region 取值说明
          • API 列表
            • 认证品牌
              • 小程序品牌提交认证时上传用户资质以及身份信息
              • 小程序品牌提交认证
              • 小程序品牌提交认证后查询品牌审核结果以及商户已有品牌
              • 小程序品牌提交认证后取消品牌认证
            • 配置搜索直达
              • 搜索直达审核进度消息通知
              • 搜索直达创建预校验
              • 申请创建搜索直达配置
              • 修改搜索直达配置
              • 下架搜索直达
              • 上架搜索直达
              • 批量查询搜索直达配置列表
              • 查询搜索直达配置详情
              • 查询可绑定的商圈查询
            • 运营搜索直达活动
              • 申请创建搜索直达活动配置
              • 修改搜索直达活动配置
              • 查询搜索直达活动配置详情
              • 批量查询搜索直达活动配置
              • 下架搜索直达活动
            • 支付宝文件
              • 支付宝文件上传接口
            • 升级/降级
              • 直达降级准入
              • 搜索直达降级
              • 搜索直达升级准入
              • 小程序升级成品牌直达
        • 收藏
          • 权限集介绍
          • 接入准备
          • 接入指南
          • 沙箱调试
          • 常见问题
          • API 列表
            • 小程序收藏引导投放活动配置创建
            • 小程序收藏引导投放活动修改
            • 小程序收藏引导投放活动详情查询
            • 小程序收藏引导投放活动配置批量查询
            • 小程序收藏引导汇总数据查询
        • 消息
          • 权限集介绍
          • 接入准备
          • 常见问题
          • 接入指南
            • 商家接入指南
            • 消息运营计划接入指南
            • 沙箱调试
          • API 列表
            • 订阅模板查询与领取
              • 消息母板批量查询接口
              • 消息子板批量查询接口
              • 消息模板申领接口
            • 订阅消息发送
              • 模板订阅关系查询
              • 小程序发送模板消息
            • 小程序内支付消息确认
              • 小程序支付消息确认接口
            • 非小程序支付消息关联关系
              • 取消关联账号和小程序
              • 查询可关联APP的账号列表
              • 查询已关联指定APP的账号列表
              • 关联账号和小程序
            • 消息运营计划
              • 推广计划状态变更消息
              • 创建推广计划
              • 查询推广计划
              • 停止推广计划
        • 小程序码
          • 权限集介绍
          • 接入准备
          • 接入指南
          • 沙箱调试
          • 常见问题
          • API 列表
            • 小程序二维码
              • 小程序生成推广二维码接口
            • 创建关联普通二维码模式
        • 小程序服务
          • 权限集介绍
          • 接入准备
          • 沙箱调试
          • 常见问题
          • API 列表
            • 服务提供
              • 服务schema下发
              • 服务提报申请
              • 服务查询
              • 服务批量查询
              • 服务失效接口
            • 消息通知
              • 服务消息审核通知
          • 相关资料
            • Schema 规则介绍
            • 各个行业场景服务接入资料
        • 订单中心
          • 权限集介绍
          • 接入准备
          • 常见问题
          • 接入指南
            • 开发接入
            • 沙箱调试
            • 各行业订单同步/查询详情
              • 行业订单模版列表
          • API 列表
            • 商户订单实时信息查询
            • 商品文件上传接口
            • 订单数据同步接口
          • 相关资料
            • 物流查询插件
        • 小程序开发管理
          • 权限集介绍
          • 接入准备
          • 接入指南
          • 沙箱调试
          • API 列表
            • 常见问题
            • 小程序基础信息
              • 查询小程序基础信息
              • 小程序修改基础信息
              • 小程序设置客服方式
            • 小程序开发版本
              • 小程序审核通过通知
              • 小程序审核不可营销通知
              • 小程序审核驳回通知
              • 小程序退回开发
              • 小程序灰度上架
              • 小程序结束灰度
              • 小程序上架
              • 小程序下架
              • 小程序回滚
              • 小程序删除版本
              • 小程序取消体验版
              • 小程序提交审核
              • 小程序撤销审核
              • 小程序基于模板上传版本
              • 查询使用模板的小程序列表
              • 小程序查询版本构建状态
              • 小程序版本详情查询
              • 小程序版本列表查询
              • 小程序体验版状态查询接口
              • 小程序生成体验版
            • 小程序应用成员
              • 应用删除成员
              • 应用查询成员列表
              • 应用添加成员
            • 个体账户
              • 个人账户升级为个体工商户
            • 小程序类目
              • 小程序类目树查询
              • 查询类目所需资质信息
            • 小程序二维码
              • 关联普通二维码
              • 删除已关联普通二维码
            • 待创建小程序
              • 商户确认服务商代创建小程序结果通知
              • isv查询代商家创建小程序记录
              • isv服务商代商户创建小程序
            • 小程序域名
              • 小程序添加域白名单
              • 小程序删除域白名单
            • 违规记录
              • 违规与处罚消息通知
              • 违规记录列表查询
              • 违规记录详情查询
            • 插件管理
              • 插件版本升级
              • 插件版本撤销灰度
              • 全量插件使用端版本配置
              • 插件使用关系查询
        • 交易组件
          • 权限集介绍
          • 接入准备
          • 接入指南
            • 升级SOP
            • 接入概述
            • 基础功能
              • 数字零售场景开发接入
              • 数娱景旅场景开发接入
            • 扩展功能
              • 扩展组件介绍
              • 前置优惠组件接入文档
              • 商品详情页组件接入文档
              • 商品订单页组件接入文档
            • 调试与验收
              • 验收工具
          • API 列表
            • API 概述
            • 订单前置判断接口
            • 小程序交易组件订单
              • 订单结果通知
              • 结算消息通知
              • 订单发货
              • 订单确认收货
              • 查询订单
              • 订单创建
            • 查询小程序订单对账列表信息
          • 常见问题
            • 通用问题
          • 相关资料
            • 商品详情页获取优惠信息
            • 商品订单页获取优惠信息
            • 物流编码
        • 小程序商品
          • 权限集介绍
          • 接入准备
          • 常见问题
          • 接入指南
            • 沙箱调试说明
            • 普通商品产品接入指南
              • 普通商品产品接入流程
              • 普通商品快速接入
              • 履约信息管理
            • 本地生活商品接入指南
              • 本地生活商品产品接入流程
              • 本地生活商品快速接入
          • API 列表
            • 普通商品
              • 普通商品履约模版
                • 履约模板查询接口
                • 履约信息查询接口
                • 履约信息同步
              • 获取普通商品模板信息
              • 获取普通商品类目接口
              • 小程序商品创建接口
              • 小程序商品更新接口
              • 商品免审更新接口
              • 小程序商品分页查询接口
              • 小程序商品详情查询接口
            • 本地生活商品
              • 商品管理
                • 获取本地商品类目接口
                • 统一收单交易支付接口
                • 获取本地商品模板信息
                • 小程序本地商品创建
                • 小程序本地商品免审更新商品接口
                • 小程序本地商品修改接口
                • 小程序本地商品详情查询接口
                • 小程序本地商品分页查询接口
              • 凭证管理
                • 三方凭证发放
                • 小程序内凭证核销准备接口
                • 凭证消息通知
                • 凭证核销准备
                • 同步凭证核销状态
                • 撤销凭证核销状态
                • 订单退款前商户回复确认退款结果
                • 查询凭证信息
                • 条件查询用户凭证
              • 支付宝文件
                • 支付宝文件上传接口
              • 商品变更相关
                • 商品状态变更消息同步接口
                • 小程序商品移除接口
          • 相关资料
            • 相关资料汇总
            • 本地生活商品模版
    • 支付有礼
      • 产品介绍
      • 接入准备
      • 接入指南
      • 沙箱调试
      • 常见问题
      • API 列表
        • 推广计划
          • 推广计划状态变更消息
          • 停止推广计划
          • 查询推广计划
          • 创建推广计划
  • 公域
    • 经营推广
      • 产品介绍
      • 权限集列表
        • 引流转化
          • 权限集介绍
          • 接入准备
          • 常见问题
          • 接入指南
            • 开发接入
            • 沙箱调试
          • API 列表
            • 推广计划
              • 推广计划状态变更消息
              • 创建推广计划
              • 查询推广计划
              • 停止推广计划
            • 图片素材
              • 营销图片资源上传接口
        • 商品卖货
          • 权限集介绍
          • 接入准备
          • 接入指南
          • 常见问题
          • API 列表
            • 推广计划状态变更消息
            • 创建推广计划
            • 查询推广计划
            • 停止推广计划
  • 营销
    • 商家卷
      • 商家券产品介绍
      • 接入准备
      • 常见问题
      • 接入指南
        • 沙箱调试说明
        • 商家券测试指导方案
        • 开发接入
          • 上传自定义券码模式
          • 发券时指定券码模式
      • API 列表
        • 接口概述
        • 活动创建
          • 券活动创建通知
          • 创建商家券活动
          • 同步商家券券码
        • 活动修改
          • 券活动修改通知
          • 修改商家券活动基本信息
        • 活动停止
          • 券活动停止通知
          • 停止商家券活动
        • 预算增加
          • 券活动预算追加通知
          • 修改商家券活动发券数量上限
        • 活动发放
          • 领券组件插件接入流程
          • 活动领取咨询接口
        • 优惠卷核销
          • 同步券核销状态
          • 取消券核销状态
        • 活动查询
          • 卷活动查询
            • 查询商家券活动
            • 查询活动详情
            • 统计商家券券码数量
            • 条件查询活动列表
          • 用户卷查询
            • 条件查询用户券
            • 查询用户券详情
          • 券状态消息
            • 券领取通知
            • 券核销消息
            • 券过期消息
          • 可用范围查询
            • 查询活动可用小程序
            • 查询活动可用门店
            • 查询活动适用商品
        • 蚂蚁店铺
          • 店铺保存审核通过消息
          • 店铺保存拒绝消息
          • 蚂蚁店铺创建
          • 修改蚂蚁店铺
          • 商户申请单查询
          • 店铺分页查询接口
          • 店铺查询接口
          • 蚂蚁店铺关闭
    • 商家会员卡
      • 产品介绍
      • 接入准备
      • 商户动态发码
      • 接入指南
        • 基础功能
        • 辅助功能
        • 扩展功能
        • 沙箱调试
      • API 列表
        • 基础功能
          • 会员卡开通,获取会员卡信息
          • 会员卡开卡结果通知
          • 会员卡模板创建
          • 上传门店照片和视频接口
          • 会员卡开卡表单模板配置
        • 辅助功能
          • 会员卡模板修改
          • 会员卡模板查询接口
          • 会员卡查询
          • 会员卡更新
          • 会员卡删卡
          • 会员卡消息通知
      • 常见问题
        • 常见问题
        • 升级指南
          • 升级说明
          • 升级至 3.1 版本(极速版)
          • 升级至 3.0 版本
          • 联调问题排查
    • 现金红包
      • 产品介绍
      • 接入准备
      • 接入指南
      • 常见问题
      • API 列表
        • 资金转账页面支付接口
        • “C2C”现金红包
          • 资金单据状态变更通知
          • 资金退回成功通知
          • 单笔转账接口
          • 转账业务单据查询接口
          • 资金退回接口
        • “B2C”现金红包
          • 资金单据状态变更通知
          • 单笔转账接口
          • 转账业务单据查询接口
        • 现金红包无线支付接口
    • 棋盘密云
      • 产品介绍
      • 接入准备
      • 接入指南
      • 常见问题
      • 参考资料
      • API 列表
        • 接口上传人群
          • 上传创建人群
          • 人群中追加用户
          • 人群中删除用户
        • 查询圈选标签列表
          • 查询圈选标签列表
          • 标签圈选创建人群
          • 标签圈选预估人群规模
        • 管理人群
          • 查询人群列表
          • 查询人群详情
          • 修改人群
        • 数据洞察
          • 看板分析
          • 画像分析
          • 行为分析
          • 趋势分析
          • 常住省市查询
    • 支付卷
      • 产品介绍
      • 接入准备
      • 接入指南
      • API 列表
        • 支付卷
          • 营销图片资源上传接口
          • 创建支付券
          • 激活支付券
          • 查询支付券详情
          • 修改支付券基本信息
          • 追加支付券预算
          • 停止支付券
          • 券活动创建通知
          • 券活动修改通知
          • 券活动预算追加通知
          • 券活动停止通知
  • 资金
    • 商家分账
      • 产品介绍
      • 接入准备
      • 接入指南
      • 常见问题
      • 沙箱调试说明
      • API 列表
        • 分账关系维护
          • 分账关系绑定
          • 分账关系解绑
          • 分账关系查询
        • 分账请求
          • 统一收单交易结算接口
        • 分账查询
          • 分账比例查询
          • 分账剩余金额查询
          • 交易分账查询接口
        • 消息通知
          • 交易分账结果通知
    • 花呗分期
      • 花呗分期产品介绍
      • 花呗分期付款界面规范
      • 常见问题
      • 接入指南
        • 接入说明
        • 接口说明
        • 应用案例
        • 花呗分期服务商合作说明
      • API 列表
        • 手机网站支付接口2.0
        • app支付接口2.0
        • 统一收单交易支付接口
        • 统一收单线下交易预创建
    • 转账到支付宝账户
      • 产品介绍
      • 接入准备
      • 支付界面规范
      • 接入指南
        • 开发接入
        • 沙箱调试
      • API 列表
        • 资金
          • 资金单据状态变更通知
          • 单笔转账接口
          • 转账业务单据查询接口
        • 账单
          • 查询对账单下载地址
        • 支付宝资金账户资产查询接口
        • 申请电子回单(incubating)
        • 查询电子回单状态(incubating)
      • 常见问题
        • 单笔转账账单回单获取说明
        • 帮助中心
        • 常见问题
        • 云排查
  • 会员
    • 支付宝身份验证
      • 支付宝身份验证产品介绍
      • 接入准备
      • 接入指南
        • 接入方式概览
        • 小程序接入流程
        • 服务端 SDK 接入流程
      • API 列表
        • 身份认证开始认证
        • 身份认证记录查询
        • 身份认证初始化服务
    • APP 支付宝登录
      • APP支付宝登录产品介绍
      • APP支付宝登录界面规范
      • 接入准备
      • 联调问题排查
      • 接入指南
        • 极简版 SDK 调用方法
        • 极简版授权请求参数和返回
        • 完整版授权 SDK 调用方法
        • 完整版授权请求参数和返回
        • 服务端接入
      • API 列表
        • 用户登录授权
        • 换取授权访问令牌
        • 支付宝会员授权信息查询接口
    • 获取会员信息
      • 产品介绍
      • 接入准备
      • 常见问题
      • 接入指南
        • PC 网页内获取用户信息
        • 生活号/H5 内获取用户信息
        • 沙箱调试说明
      • API 列表
        • 用户信息
          • 支付宝会员授权信息查询接口
        • 用户授权
          • 用户授权取消消息
          • 用户授权关系查询
  • 信用
    • 芝麻先享
      • 产品介绍
      • 接入准备
      • 验收规范
      • 常见问题
      • 接入指南
        • 固定金额模式
        • 动态金额模式
        • 异步扣款通知
      • API 列表
        • 服务开通
          • 服务开通/授权状态变更通知
          • 信用服务开通/授权
          • 查询服务开通/授权信息
        • 信用下单
          • 芝麻先享信用服务下单(用户确认场景)
          • 芝麻先享信用服务订单状态变更通知
          • 换取授权访问令牌
          • 统一收单交易支付接口
          • 芝麻信用服务下单(免用户确认场景)
          • 信用服务订单查询
          • 结束信用服务订单
          • app支付接口2.0
        • 扣款
          • 统一收单交易订单支付接口
          • 统一收单交易查询
          • 统一收单交易退款接口
    • 芝麻免押
      • 芝麻免押产品介绍
      • 接入准备
      • 接入指南
      • 常见问题
      • API 列表
        • 预授权
          • 线上资金授权冻结接口
          • 资金授权解冻接口
          • 资金授权操作查询接口
        • 支付
          • 统一收单交易支付接口
          • 统一收单交易查询
          • 统一收单交易退款接口
          • 统一收单交易退款查询
          • 统一收单交易关闭接口
          • 支付宝订单信息同步接口
        • 对账
          • 查询对账单下载地址
      • 相关资料
        • 异步通知参数说明
        • 全场景逾期时间说明
        • 接入要求及体验规范
    • 芝麻工作证
      • 产品介绍
      • 接入准备
      • 接入指南
      • API 列表
        • 工作证身份验真消息通知
        • 职得身份认证查询接口
    • 芝麻 GO
      • 产品介绍
      • 接入准备
      • 常见问题
      • 接入指南
        • 芝麻 GO 普通版
          • 开通芝麻 GO 普通版
          • 任务数据回传&查询
          • 关闭芝麻 GO 普通版
          • 协议变更通知
          • 结算芝麻 GO 普通版
          • 芝麻 GO 普通版退款
          • 辅助功能接入
          • 查询芝麻 GO 普通版模板
          • 创建芝麻 GO 承诺模式模板
        • 周期扣版
          • 创建芝麻 GO 月月省(周期扣)模式模板
          • 关键系统交互
          • 开通芝麻 GO 周期扣版
          • 周期代扣
          • 关闭芝麻 GO 周期扣版
          • 协议变更通知
          • 结算芝麻 GO 周期扣版
          • 芝麻 GO 退款
          • 辅助功能说明
          • 查询芝麻 GO 周期扣版模板
        • 周期灵活扣 FOR 运营商场景
          • 开通芝麻 GO
          • 履约期周期灵活代扣(履约期按期扣费能力)
          • 优惠任务数据回传&查询
          • 关闭芝麻 GO 灵活扣版
          • 协议变更通知
          • 结算芝麻 GO
          • 结算发起后进行拆单支付
          • 芝麻 GO 退款
          • 创建芝麻 GO 模板
          • 其他辅助说明
          • 查询芝麻 GO 周期灵活扣版模板
        • 芝麻GO 轻研版
          • 前端组件接入
          • 轻研 API 接入
          • 其他辅助功能
      • API 列表
        • 芝麻GO业务签约变更商户通知
        • 芝麻GO业务协议变更商户通知
        • 芝麻GO业务结算变更商户通知
        • 芝麻GO签约预创单
        • 商家芝麻GO累计数据回传接口
        • 芝麻GO页面签约接口
        • 商家芝麻GO累计数据查询接口
        • 芝麻GO结算申请
        • 芝麻GO结算退款接口
        • 芝麻Go协议查询接口
        • 芝麻GO协议解约
        • 商户创建芝麻GO模板接口
        • 芝麻GO模板查询
  • 安全
    • 交易安全防护
      • 交易安全防护产品介绍
      • 接入准备
      • 接入指南
      • API 列表
        • 商户数据同步
        • 停车场信息查询
  • 其他
    • 车主平台停车在线缴费
      • 车主平台停车在线缴费产品介绍
      • 车主平台停车在线缴费界面规范
      • 接入准备
      • 接入指南
      • 常见问题
      • API 列表
        • 统一收单交易创建接口
        • 统一收单交易查询
        • 换取授权访问令牌
        • 停车ISV系统配置接口
        • ISV系统配置查询接口
        • 录入停车场信息
        • 修改停车场信息
        • 车辆驶入接口
        • 车辆驶出接口
        • 车牌查询接口
        • 订单同步接口
        • 订单更新接口
        • 停车场价格信息同步
        • 停车场车位信息同步
        • 停车支付模板消息配置
        • 停车离场消息模板配置
        • 停车入场模板消息配置
    • 第三那方应用授权
      • 第三方应用授权产品介绍
      • 全权委托授权代开发模式说明
      • 支持全权委托授权代开发的产品
      • 接入指南
      • API 列表
        • 第三方应用授权取消消息
        • 查询某个应用授权AppAuthToken的授权信息
        • 换取应用授权令牌
        • ISV向商户发起应用授权邀约
    • 中小学教育缴费
      • 中小学教育缴费产品介绍
      • 接入准备
      • 接入指南
      • API 列表
        • 缴费
          • 教育缴费学校信息录入接口
          • 教育缴费账单发送接口
          • 教育缴费账单状态同步接口
          • 缴费账单查询
        • 支付
          • 统一收单交易退款接口
          • 统一收单交易查询
    • 服务市场基础包
      • 服务市场基础产品介绍
      • 接入准备
      • 接入指南
      • API 列表
        • 服务市场订单状态变更消息通知
        • 续费订单主动通知
        • 服务市场商户确认订购通知
        • 订购插件订单明细查询
        • 服务商接单操作
        • 服务商拒绝接单
        • 服务订单明细实施项单项取消
        • 服务商完成订单内单个明细实施项
        • 服务商代商家确认实施完成
        • 门店插件上架操作
        • 门店插件下架操作
        • 服务商推广关系查询
        • 服务市场产品授权升级
    • 服务商代运营基础包
      • 服务商代运营基础产品介绍
      • 接入准备
      • 间连分级商户入驻接入指南
      • 接入指南
        • 代运营授权
        • 代商家报名返佣政策
        • 餐饮新蓝海&快消直通车 IoT 交易协作费代报名资质要求
        • IoT 设备绑定门店 API 对接指南
      • API 列表
        • 代运营授权
          • 向商户发起代运营操作
          • 查询代运营授权或者账号绑定二维码
          • 查询服务商代运营操作结果
        • 新蓝海活动报名
          • 服务商返佣活动申请单结果通知
          • 图片上传接口
          • 服务商返佣活动报名申请
          • 服务商返佣活动申请单修改
          • 服务商返佣活动申请单详情查询
        • IoT 三绑定
          • 服务商代运营操作结果通知接口
          • IoT设备绑定校验
          • IoT设备绑定门店
          • IoT设备绑定关系查询
          • 查询代运营授权或者账号绑定二维码
          • 向商户发起代运营操作
          • 查询服务商代运营操作结果
    • 支付宝广告投放
      • 支付宝广告投放产品介绍
      • 接入准备
      • 接入指南
        • 接入指南_自建页留资和转化管理
        • DSP 创意送审和创意状态查询
      • API 列表
        • 自建推广页列表批量查询
        • 自建推广页留资数据查询
        • 转化数据回传
        • 外部DSP创意送审接口
        • DSP广告状态查询接口
    • 支付宝加油
      • 产品介绍
      • 接入准备
      • 接入指南
      • API 列表
        • 门店管理
          • 店铺保存拒绝消息
          • 店铺保存审核通过消息
          • 店铺分页查询接口
          • 修改蚂蚁店铺
          • 图片上传
          • 商户申请单查询
          • 蚂蚁店铺创建
          • 蚂蚁店铺关闭
        • 商品管理
          • 商品删除接口
          • 商品查询接口
          • 商品创建接口
          • 商品状态修改接口
          • 商品修改接口
        • 支付
          • 统一收单交易创建接口
          • 统一收单交易查询
          • 统一收单交易撤销接口
          • 统一收单交易退款接口
          • 统一收单交易关闭接口
          • 查询对账单下载地址
    • 应用AES密钥管理
      • 应用 AES 密钥管理产品介绍
      • 接入准备
      • 接入指南
      • API 列表
        • 授权应用aes密钥查询
        • 授权应用aes密钥设置
    • 分享到支付宝
      • 分享到支付宝产品介绍
      • 接入准备
      • Android 快速接入
        • Android 接入指南
        • Android 功能开发说明
      • IOS 快速接入
        • iOS 接入指南
        • iOS 功能开发说明
    • 三方开发基础包
      • 三方开发基础产品介绍
      • 接入准备
      • 接入指南
      • API 列表
        • 隐私政策审批驳回通知
        • 小程序隐私政策审批通过通知
        • 申请用户信息
          • 用户信息申请记录审核通知
          • 查询应用可申请的接口出参敏感字段列表
          • 申请获取接口用户敏感信息字段
          • 查询接口字段使用场景
          • 用户信息申请记录查询
        • 应用用户标识(openid)信息
          • 应用信息修改接口
          • 应用信息查询接口
        • 代商家创建小程序
          • 商户确认服务商代创建小程序结果通知
          • isv服务商代商户创建小程序
          • isv查询代商家创建小程序记录
        • 代商家创建试用小程序
          • 商户确认服务商代创建试用小程序结果通知
          • 查询试用小程序
          • ISV代创建试用小程序
        • 小程序创建隐私协议
        • 小程序隐私字段查询
        • 小程序隐私政策审核状态查询
    • 代开发核心 API
      • 代开发核心 API 产品介绍
      • 接入准备
      • 接入指南
        • 查询商家产品开通状态
        • 开通即授权
        • 调用接口代商家发起开通当面付申请
        • 调用接口代商家发起开通 App 支付申请
        • 调用接口代商家发起开通通用流程
      • API 列表
        • ISV邀约即授权页面创建
        • 查询商户某个产品的签约状态
        • 开启代商户签约、创建应用事务
        • 代商户签约,提交信息确认接口
        • 代签约当面付产品
        • 代签约APP支付产品
        • 代签约产品通用接口
        • 查询申请单状态
        • 提交代商户签约、创建应用事务
        • 取消代商户签约、创建应用事务
        • 查询签约申请单状态
        • 查询签约授权一体化订单状态详情
        • 创建签约授权一体化订单
    • 基础功能产品
      • 交易支付投诉处理
        • 交易支付投诉处理产品介绍
        • 接入准备
        • 接入指南
        • 常见问题
        • API 列表
          • 交易投诉通知回调
          • 查询单条交易投诉详情
          • 查询交易投诉列表
          • 商户上传处理图片
          • 商家处理交易投诉
          • 商家留言回复
          • 商家补充凭证
      • 付款码解码查询UID
        • 付款码解码查询UID产品介绍
        • 接入准备
        • 接入指南
        • API 列表
          • 通用当面付二阶段接口
      • 蚂蚁门店管理
        • 蚂蚁门店管理产品介绍
        • 接入准备
        • 接入指南
          • 接入指南
          • 沙箱调试
        • API 列表
          • 店铺保存审核通过消息
          • 店铺保存拒绝消息
          • 蚂蚁店铺
            • 蚂蚁店铺关闭
            • 店铺查询接口
            • 店铺分页查询接口
            • 商户申请单查询
            • 修改蚂蚁店铺
            • 蚂蚁店铺创建
          • 商户类目
            • 商户mcc信息查询
          • 商家图片
            • 图片上传
          • 店铺增加收单账号
      • CMM 插件化能力
        • 蚂蚁智能客服(CCM)插件化能力产品介绍
        • 接入准备
        • 快速接入
          • 基础功能
          • 实现SPI接口
          • 插件iframe安全验证机制
        • API 列表
          • 可实现的 SPI
            • 租户角色列表查询接口
            • 租户热线技能组列表查询接口
            • 客服角色设置接口
            • 客服已授权角色列表查询接口
            • 客服热线技能组列表查询接口
            • 客服热线技能组设置接口
            • ISV 订单查询
          • 商家/ISV 调用支付宝
            • 初始化
              • isv服务初始化接口
              • 创建租户实例
              • 查询单个租户实例(数据权限)
              • 列出所有的租户实例(数据权限)
              • 租户开通isv服务接口
              • 关闭租户开通的isv服务接口
              • ccm isv注册接口
              • 关闭租户开通的isv服务接口
              • 列出所有的功能点
            • 客服
              • 查询客服状态变更流水日志
              • 创建角色
              • 更新角色
              • 删除角色
              • 分页查询角色
              • 新增客服接口
              • 更新客服接口
              • 删除客服接口
              • 查询客服详情
              • 客服查询接口
            • 服务记录
              • 创建服务记录
              • 变更服务记录
            • 知识库
              • 知识库-库-创建
              • 知识库-库-删除
              • 知识库-库-修改
              • 知识库-库-批量查询
              • 知识库-类目-创建
              • 知识库-类目-删除
              • 知识库-类目-修改
              • 知识库-类目-获取
              • 知识库-类目-批量查询
              • 知识库-类目-发布
              • 知识库-节点-创建
              • 知识库-节点-删除
              • 知识库-节点-修改
              • 知识库-节点-批量查询
              • 知识库-问答-创建
              • 知识库-问答-删除
              • 知识库-问答-修改
              • 知识库-问答-批量查询
              • 知识库-问答-获取
              • 政务事项同步
              • 知识库问答管理
              • 政务事项删除
            • 数字人
              • 虚拟数字人开放接口调用
            • 在线
              • 查询用户未读信息数
      • 学校库
        • 学校库能力介绍
        • 接入准备
        • 接入指南
        • API 列表
          • 查询学校信息
          • 支付宝文件上传接口
          • 入驻学校信息
      • 商家账单
        • 商家账单产品介绍
        • 接入准备
        • 接入指南
        • API 列表
          • 账单
            • 查询对账单下载地址
          • 支付宝商家账户卖出交易查询
          • 支付宝商家账户买入交易查询
          • 支付宝商家账户账务明细查询
          • 支付宝商家账户充值,转账,提现查询
          • 支付宝商家账户保证金查询
          • 支付宝商家账户当前余额查询
          • 支付宝商家账户历史余额查询
      • 商户自主监控
        • 商户自主监控产品介绍
        • 快速接入
        • API 列表
          • 商户自主监控自定义指标数据上报接口
          • 商户自主监控日志数据上报接口
      • 支付宝卡包
        • 支付宝卡包产品介绍
        • 接入准备
        • 参数详细说明
        • 接入指南
          • 基础功能
          • 进阶功能-优惠券礼包
        • API 列表
          • 卡券模板创建接口
          • 卡券模板更新接口
          • 卡券实例发放接口
          • 卡券实例更新接口
          • 上传门店照片和视频接口
      • 生活缴费
        • 生活缴费产品介绍
        • 接入准备
        • API 列表
          • 创建账单
          • 缴费直连代扣签约
          • 缴费直连代扣取消签约
          • 公共事业缴费直连代扣扣款支付接口
          • 缴费直连代扣订单支付状态查询
      • 地铁线上购票
        • 地铁线上购票产品介绍
        • 接入准备
        • 接入指南
        • API 列表
          • 地铁购票核销码发码
          • 地铁购票发码退款
          • 地铁购票站点数据查询
          • 地铁购票订单批量查询
      • 口碑开店
        • 口碑开店产品介绍
        • 接入准备
        • 接入指南
        • 设置/修改门店收款账号
        • API 列表
          • 创建门店信息
          • 门店类目配置查询接口
          • 修改门店信息
          • 查询单个门店信息接口
          • 查询商户的门店编号列表
          • 门店摘要信息批量查询接口
          • 业务流水批量查询接口
          • 上传门店照片和视频接口
        • 相关资料
          • 门店类目
      • 营销活动
        • 营销活动产品介绍
        • 营销活动详情
        • 接入准备
        • 接入指南
          • 基础功能
          • 进阶指南
        • API 列表
          • 活动创建接口
          • 活动修改接口
          • 活动下架接口
          • 活动详情查询
          • 口碑营销活动列表查询
          • 招商门店分页查询接口
          • 商户创建商品代金券
          • 商户下架代金券
          • 商户查询商品代金券详情
          • 商户修改商品代金券
          • 商户查询商品代金券列表
      • 私域营销
        • 私域营销产品介绍
        • 接入准备
        • 接入指南
          • 开发接入
          • 领券组件插件接入流程
          • 沙箱调试
        • API 列表
          • 活动查询
            • 券活动查询
              • 查询活动详情
              • 条件查询活动列表
            • 用户卷查询
              • 条件查询用户券
              • 查询用户券详情
            • 卷状态消息
              • 券领取通知
              • 券核销消息
              • 券过期消息
            • 可用范围查询
              • 查询活动可用商户
              • 查询活动可用小程序
              • 查询活动可用门店
              • 查询活动适用商品
            • 订单可用卷查询
              • 订单优惠前置咨询
          • 活动发放
            • 领券组件插件接入流程
            • 活动领取咨询接口
        • 相关资料
          • 间连分级商户入驻接入指南
      • 获取 AliOS 车载设备信息
        • 获取 AliOS 车载设备信息产品介绍
        • 接入准备
        • 接入指南
        • API 列表
          • 换取授权访问令牌
          • 查询阿里车的车辆信息
      • 商家费率申请
        • 商家费率申请产品介绍
        • 接入准备
        • 接入指南
        • API 列表
        • 特殊费率申请
      • E签宝电子面签
        • e 签宝电子面签产品介绍
        • 接入准备
        • 常见问题
        • 接入指南
          • 开发接入
          • 文件流上传方法
        • API 列表
          • 合同模板管理接口
            • 创建合同模板(E签宝)
            • 获取合同模板设置地址(E签宝)
          • 合同签署接口
            • 创建电子合同签署流程(E签宝)
            • 签署流程查询(E签宝)
            • 获取签署地址
            • 获取签署流程合同与附件的下载地址(E签宝)
            • 获取文件直传地址(E签宝)
            • 签署流程撤销(E签宝)
          • 创建流程(E签宝)
          • 签署流程归档
  1. 接入指南

沙箱调试说明

沙箱环境是支付宝开放平台为开发者提供的与生产环境完全隔离的联调测试环境,开发者在沙箱环境中完成的接口调用不会对生产环境中的数据造成任何影响。
沙箱为开放的产品提供 有限功能范围的支持(覆盖的功能范围参见下面的业务用例),可以覆盖产品的绝大部分核心链路和对接逻辑,便于开发者快速学习/尝试/开发/调试,推荐开发者遵循业务用例来使用沙箱。
沙箱环境会自动完成或忽略一些场景的业务门槛,例如:开发者无需等待产品开通,即可直接在沙箱环境调用接口,使得开发集成工作可以与商务流程并行,从而提高项目整体的交付效率。
注意:
由于沙箱环境并非 100% 与生产环境一致,接口的实际响应逻辑请以生产环境为准,沙箱环境开发调试完成后,仍然需要在生产环境进行测试验收。
沙箱环境拥有完全独立的数据体系,沙箱环境下返回的数据(比如用户 ID 等)在生产环境中都是不存在的,开发者不可将沙箱环境返回的数据与生产环境中的数据混淆。
本文仅说明如何在沙箱环境中调试商家券,非沙箱环境调试通用说明。
更多沙箱介绍和沙箱控制台使用说明可查看 沙箱环境。

沙箱调试说明#

沙箱通过业务用例定义支持的功能范围。业务用例描述了典型业务场景下,开发者可通过先后对接哪些接口来实现业务目标,每个业务用例会为开发者提供接口调用时序与参数示例值。
推荐开发者遵循业务用例来使用沙箱。
注意:示例参数值中与沙箱当前账号、应用上下文相关的参数,需开发者自行参照接入指南调用配套接口获取。

沙箱环境用户领券方式#

通过调用如下拼接链接来触发沙箱领券:
http://sandboxsys.dl.alipaydev.com/prods/voucher/${merchantUid}/${appId}?activityId=${activityId}&logonId=${userLoginId}
说明:
针对新箱环境领券链接规则,需要将 merchantUid替换成沙箱环境中自己的卖家UID,‘{appId} 替换为新沙箱环境中自己的沙箱应用 APPID,activityId‘替换为新沙箱环境下创建的商家券活动ID,‘{userLoginId}` 替换为领券用户的沙箱账号,如 xxxxx@sandbox.com,访问拼接后的链接即可完成领券。
该拼接链接的方式只适用于 沙箱环境,生产环境需要按照 开发接入 推广、领取商家券。

业务用例#

管理全场满减券活动#

上传营销图片资源#

调用 OpenAPI:alipay.marketing.material.image.upload(营销图片资源上传接口)
入参示例值
package com.java.sdk.demo;

import com.alipay.api.AlipayApiException;
import com.alipay.api.AlipayClient;
import com.alipay.api.DefaultAlipayClient;
import com.alipay.api.CertAlipayRequest;
import com.alipay.api.AlipayConfig;
import com.alipay.api.response.AlipayMarketingMaterialImageUploadResponse;
import com.alipay.api.request.AlipayMarketingMaterialImageUploadRequest;
import com.alipay.api.domain.BelongMerchantInfo;
import com.alipay.api.FileItem;
import java.util.Base64;
import java.util.ArrayList;
import java.util.List;

public class AlipayMarketingMaterialImageUpload {

    public static void main(String[] args) throws AlipayApiException {
        String privateKey = "<-- 请填写您的应用私钥,例如:MIIEvQIBADANB ... ... -->";
        String alipayPublicKey = "<-- 请填写您的支付宝公钥,例如:MIIBIjANBg... -->";
        AlipayConfig alipayConfig = new AlipayConfig();
        alipayConfig.setServerUrl("https://openapi-sandbox.dl.alipaydev.com/gateway.do");
        alipayConfig.setAppId("<-- 请填写您的AppId,例如:20210917671xxxx -->");
        alipayConfig.setPrivateKey(privateKey);
        alipayConfig.setFormat("json");
        alipayConfig.setAlipayPublicKey(alipayPublicKey);
        alipayConfig.setCharset("UTF8");
        alipayConfig.setSignType("RSA2");
        AlipayClient alipayClient = new DefaultAlipayClient(alipayConfig);
        FileItem fileContent = new FileItem("本地文件的绝对路径");
        AlipayMarketingMaterialImageUploadRequest request = new AlipayMarketingMaterialImageUploadRequest();
        request.setFileContent(fileContent);
        request.setFileKey("<-- 请填写文件业务标识 -->"); 
        request.setMerchantAccessMode("SELF_MODE");
        AlipayMarketingMaterialImageUploadResponse response = alipayClient.execute(request);
        System.out.println(response.getBody());
        if (response.isSuccess()) {
            System.out.println("调用成功");
        } else {
            System.out.println("调用失败");
        }
    }
}
出参示例值
{
  "alipay_marketing_material_image_upload_response": {
    "code": "10000",
    "msg": "Success",
    "resource_id": "X35lTqWuaHYAAAAAAAAAAAAADgSLAQBr",
    "resource_url": "https://mdn.alipayobjects.com/afts/img/X35lTqWuaHYAAAAAAAAAAAAADgSLAQBr/original?bz=sandboxsys",
    "resource_enhance": false
  },
  "sign": "waBB4OtqWUESwuhOBQRQo16S6kjddTFyWkNUw7+NlD9RTZE3DJPgz3BhWOJgEPaJWVLEv1m3Vgd3WMmvaaR2fEYr/IpySJnBIDsH7bDKRtu67+B1F2RCBOVOzIKBXoYVuChtMjR6rSNXPnsr395V2zBy1/BWiMkVVXPrDQnzBxraExkqVEW8B3HrMp/L3nP7utSLcFC0ici2Z6PmDpBmXcSNJHtG4tzkuVoUcty+6WAIv3N64Es89gHi4N2HHJeywXzfPTP8O978f6X2Wl/kPYZbkA9K1R3n/hJLOOBqqYCeAgNe+o0AX6Dd8JIxI7iC2lhwEZscZ1JrY8RNduFyoQ=="
}

创建商家券活动#

OpenAPI:alipay.marketing.activity.ordervoucher.create(创建商家券活动)
入参示例值
{
    "activity_base_info":{
        "activity_name":"导码商家券全场满减满1减0.1活动",
        "code_mode":"MERCHANT_UPLOAD"
    },
    "product_version":"1.0.0",
    "voucher_available_scope_info":{
        "voucher_available_geography_scope_info":{
            "available_geography_city_info":{
                "available_city_codes":[
                    "513200"
                ]
            },
            "available_geography_scope_type":"CITY_CODE"
        }
    },
    "voucher_customer_guide_info":{
        "voucher_use_guide_info":{
            "mini_app_use_guide_info":{
                "mini_app_url":"alipays://platformapi/startapp?appId=2017052601000815"
            },
            "use_guide_mode":[
                "MINI_APP",
                "OFFLINE_CODE"
            ]
        }
    },
    "voucher_deduct_info":{
        "fix_voucher_info":{
            "amount":"0.1",
            "floor_amount":"1"
        },
        "voucher_type":"FIX_VOUCHER"
    },
    "voucher_display_pattern_info":{
        "brand_name":"品牌名称测试",
        "brand_logo":"A*tM9gTonOnsoAAAAAAAAAAAAAARwnAQ",
        "customer_service_mobile":"1111122222",
        "voucher_image":"A*CcF9T6Jt3QYAAAAAAAAAAAAAARwnAQ",
        "voucher_detail_images":[
            "A*inGVQYQT4w4AAAAAAAAAAAAAARwnAQ"
        ],
        "voucher_description":"测试说明"
    },
    "voucher_send_mode_info":{
        "voucher_send_mode":"DIRECT_SEND_MODE",
        "voucher_send_rule_info":{
            "natural_person_limit":false,
            "phone_number_limit":false,
            "publish_end_time":"2023-06-21 11:00:16",
            "publish_start_time":"2023-04-22 11:00:16",
            "quantity":0,
            "quantity_limit_per_user":100
        }
    },
    "voucher_use_rule_info":{
        "voucher_use_time_info":{
            "relative_period_info":{
                "wait_days_after_receive":"0",
                "valid_days_after_receive":"5"
            },
            "period_type":"RELATIVE"
        }
    },
    "out_biz_no":"20230522912030157116926040551246907077",
    "merchant_access_mode":"SELF_MODE"
}
出参示例值
{
  "sign": "PBxzpNx/oyJTfp/CYkd3jLM9zoUjV77MTth49NTeowWXfQTszD1ROoSrgOkD2t4v5mVBiAliWe7r/RsEHtwB8daVMIvMJrmFgiMh7OLdhvWQn2vDHmNai/hQ5799LiIsOktrp787SeGfUe1hRGHObfwZD5hjEgOscDJPmUqfnyZ+ahBx29P+oEh0SGvOWd1HYr/un3Dtyu8D8SJs+QYQprXiVhvkUfwoKdw5qGZO5D6xjPpr3ebGbl1/dJBCrxcmBfXuyPhLRAOpckZlSIwjffWLA0whAVxnPpGFFMI9UiXJlpMQgvDoDf/NWLg7qiFKJt5iKWM95Y0ivozzqcSs2g==",
  "alipay_marketing_activity_ordervoucher_create_response": {
    "msg": "Success",
    "code": "10000",
    "activity_id": "2023052200826004099500110943"
  }
}

接收商家券成功通知#

接收 MsgAPI 消息:alipay.marketing.activity.message.created(券活动创建通知)
消息业务参数示例值
{
    "activity_id": "2023052200826004099500110943",
    "id": "CREATED_2023052200826001099500379341",
    "out_biz_no": "20230522912030157116926040551246907077",
    "event_time": "1684724416760"
}

同步商家券券码#

OpenAPI:alipay.marketing.activity.ordervoucher.codedeposit(同步商家券券码)
入参示例值
{
    "voucher_codes":[
        "yufaceshi001",
        "yufaceshi002",
        "yufaceshi003",
        "yufaceshi004",
        "yufaceshi005",
        "yufaceshi006",
        "yufaceshi007",
        "yufaceshi008",
        "yufaceshi009",
        "yufaceshi0010",
        "yufaceshi0011",
        "yufaceshi0012",
        "yufaceshi0013",
        "yufaceshi0014",
        "yufaceshi0015",
        "yufaceshi0016",
        "yufaceshi0017",
        "yufaceshi0018",
        "yufaceshi0019",
        "yufaceshi0020"
    ],
    "activity_id":"2023052200826004099500110943",
    "out_biz_no":"20230522912030157116926040551246907077",
    "merchant_access_mode":"SELF_MODE"
}
出参示例值
{
  "alipay_marketing_activity_ordervoucher_codedeposit_response": {
    "msg": "Success",
    "code": "10000",
    "success_count": 20,
    "success_voucher_code_list": [
      "yufaceshi001",
      "yufaceshi002",
      "yufaceshi003",
      "yufaceshi004",
      "yufaceshi005",
      "yufaceshi006",
      "yufaceshi007",
      "yufaceshi008",
      "yufaceshi009",
      "yufaceshi0010",
      "yufaceshi0011",
      "yufaceshi0012",
      "yufaceshi0013",
      "yufaceshi0014",
      "yufaceshi0015",
      "yufaceshi0016",
      "yufaceshi0017",
      "yufaceshi0018",
      "yufaceshi0019",
      "yufaceshi0020"
    ],
    "fail_count": 0
  },
  "sign": "Oez7ZqGO+tHZpA3C/LKYGosgP+BEF/rBECUNg5taRAkBwa4sLowmgpMM8zrQ8yTUnOHD56HzoDLqp8lztr//tyI1IXMNrnaszC/4JTG5bETvsZpnmcp7girolTuG5LWq4wzvHpJupGBJpKanTmFUIG9+bDiy/HTWYHiWRpZ4R1ZEUCboqni8yDh+JHg6eNbmSrBb4JpRORlFBTJXTD+X/8HQo3xQ4fS2Tc/kPJTdvRfCysRXwqS6m465A18NPhe9s/6Y7d4oqcLuM3XRdAB7o/ZsnFYOAF43Su3GNt0Rm0vXNGAnawzT6A1lUUpRNkdvKtny/U9s/FNsNz7RHdgvpg=="
}

统计商家券券码数量#

OpenAPI:alipay.marketing.activity.ordervoucher.codecount(统计商家券券码数量)
入参示例值
{
    "activity_id":"2023052200826004099500110943",
    "merchant_access_mode":"SELF_MODE"
}
出参示例值
{
  "alipay_marketing_activity_ordervoucher_codecount_response": {
    "msg": "Success",
    "code": "10000",
    "success_count": 20
  },
  "sign": "gxz6bUUWIAErgB2dIA+J+MzHZ3EO9YxsOOWNbSzGZk35cbWamH/bgRmCmHQQS/18bn+71+DhJfVyTkBTnoIQHlM89XBWflcFm5dMJvZpKeEo9Txx4gtX6cnNFAhACqCEf8rOFSGyK+nxRac6FmKdx5bwltblzv2nCTnV7aPxCvlSDrQMiMJ8sEZJuNaDyhslIj+wI9Hc/kNmdJMsB0dFFW0pGEAPR1DHnLcn26jaOBmPl8gqSRVFKPFB6hzVQPr5uOTCxToVPxf/GXmUkBn7HoFZooUhh4tU4YTZVNDTMhvMDwmFLWkkG3XQfV8MRU56tSGkpgdxeap1nL6pCLkKlQ=="
}

修改商家券活动发券数量上限#

OpenAPI:alipay.marketing.activity.ordervoucher.append(修改商家券活动发券数量上限)
入参示例值
{
    "voucher_quantity":20,
    "activity_id":"2023052200826004099500110943",
    "out_biz_no":"20230522912030157116926040551246907077",
    "merchant_access_mode":"SELF_MODE"
}
出参示例值
{
  "alipay_marketing_activity_ordervoucher_append_response": {
    "msg": "Success",
    "code": "10000"
  },
  "sign": "r/FviTzLsxlldPF33y7mf3C5BEbCW/7WiyGmXPiRJGQ54+XEpNI93gd6I5nPG9o/AU7pxwGwSUYWAz02m0dTjkdMzU9NfC+ln9OkRFDUHMDolR9HqZwkGDCcWYu3FRIdXE81WCmz5g7Ld3RuEet2f7hht7EsXlSzghWDhO3UbZgodm5QmVt0rcITYe0DWaDdJHR3eozBNr/KPqt7Uu0nvwsVAbvTWY2Jy81FzicD611J3vFsY558MBczmWz8X/clIDfXhiGT7BOraLveywgUGTI64o4b5JNS2teETco8tcWcM5OCBEn+v+f20HpP9sieIG5xVXOV5Bp2NKATG9y2ew=="
}

券活动预算追加通知#

接收 MsgAPI 消息:alipay.marketing.activity.message.appended(券活动预算追加通知)
消息业务参数示例值
{
    "activity_id": "2023052200826004099500110943",
    "id": "APPENDED_2023052200826001099500379344",
    "out_biz_no": "20230522912030157116926040551246907077",
    "event_time": "1684724417711"
}

修改商家券活动基本信息#

OpenAPI:alipay.marketing.activity.ordervoucher.modify(修改商家券活动基本信息)
入参示例值
{
    "activity_base_info":{
        "activity_id":"2023052200826004099500110943"
    },
    "voucher_display_pattern_info":{
        "brand_name":"品牌名称测试修改",
        "brand_logo":"A*tM9gTonOnsoAAAAAAAAAAAAAARwnAQ",
        "voucher_image":"A*CcF9T6Jt3QYAAAAAAAAAAAAAARwnAQ",
        "voucher_detail_images":[
            "A*inGVQYQT4w4AAAAAAAAAAAAAARwnAQ",
            "A*inGVQYQT4w4AAAAAAAAAAAAAARwnAQ"
        ],
        "voucher_description":"测试说明"
    },
    "out_biz_no":"20230522912030157116926040551246907077",
    "merchant_access_mode":"SELF_MODE"
}
出参示例值
{
  "alipay_marketing_activity_ordervoucher_modify_response": {
    "msg": "Success",
    "code": "10000"
  },
  "sign": "r/FviTzLsxlldPF33y7mf3C5BEbCW/7WiyGmXPiRJGQ54+XEpNI93gd6I5nPG9o/AU7pxwGwSUYWAz02m0dTjkdMzU9NfC+ln9OkRFDUHMDolR9HqZwkGDCcWYu3FRIdXE81WCmz5g7Ld3RuEet2f7hht7EsXlSzghWDhO3UbZgodm5QmVt0rcITYe0DWaDdJHR3eozBNr/KPqt7Uu0nvwsVAbvTWY2Jy81FzicD611J3vFsY558MBczmWz8X/clIDfXhiGT7BOraLveywgUGTI64o4b5JNS2teETco8tcWcM5OCBEn+v+f20HpP9sieIG5xVXOV5Bp2NKATG9y2ew=="
}

接收商家券基本信息修改成功通知#

接收 MsgAPI 消息:alipay.marketing.activity.message.modified(券活动修改通知)
消息业务参数示例值
{
    "activity_id": "2023052200826004099500110943",
    "id": "MODIFIED_2023052200826001099500379449",
    "out_biz_no": "20230522912030157116926040551246907077",
    "event_time": "1684724440000"
}

查询商家券活动#

OpenAPI:alipay.marketing.activity.ordervoucher.query(查询商家券活动)
入参示例值
{
    "activity_id":"2023052200826004099500110943",
    "merchant_access_mode":"SELF_MODE"
}
出参示例值
{
  "alipay_marketing_activity_ordervoucher_query_response": {
    "msg": "Success",
    "voucher_send_mode_info": {
      "voucher_send_rule_info": {
        "quantity": 20,
        "natural_person_limit": false,
        "publish_end_time": "2023-06-21 11:00:16",
        "real_name_limit": false,
        "quantity_limit_per_user": 100,
        "quantity_limit_per_user_period_type": "LIFE_CYCLE",
        "phone_number_limit": false,
        "publish_start_time": "2023-04-22 11:00:16"
      },
      "voucher_send_mode": "DIRECT_SEND_MODE"
    },
    "voucher_deduct_info": {
      "fix_voucher_info": {
        "amount": "0.10",
        "floor_amount": "1.00"
      },
      "voucher_type": "FIX_VOUCHER"
    },
    "voucher_customer_guide_info": {
      "voucher_use_guide_info": {
        "use_guide_mode": [
          "MINI_APP",
          "OFFLINE_CODE"
        ],
        "mini_app_use_guide_info": {
          "mini_app_url": "alipays://platformapi/startapp?appId=2017052601000815"
        }
      }
    },
    "code": "10000",
    "voucher_use_rule_info": {
      "voucher_use_time_info": {
        "relative_period_info": {
          "wait_days_after_receive": 0,
          "valid_days_after_receive": 5
        },
        "period_type": "RELATIVE"
      },
      "voucher_max_use_times": 1
    },
    "voucher_available_scope_info": {
      "voucher_available_geography_scope_info": {
        "available_geography_scope_type": "CITY_CODE",
        "available_geography_city_info": {
          "available_city_codes": [
            "513200"
          ]
        }
      }
    },
    "activity_base_info": {
      "activity_name": "导码商家券全场满减满1减0.1活动",
      "activity_product_type": "ORDER_VOUCHER",
      "activity_id": "2023052200826004099500110943",
      "code_mode": "MERCHANT_UPLOAD",
      "activity_status": "ACTIVE"
    },
    "voucher_display_pattern_info": {
      "customer_service_mobile": "1111122222",
      "voucher_image": "A*CcF9T6Jt3QYAAAAAAAAAAAAAARwnAQ",
      "voucher_name": "全场通用满1元减0.1元券",
      "voucher_image_url": "https://mdgwdev.alipay.net/afts/img/A*CcF9T6Jt3QYAAAAAAAAAAAAAARwnAQ/original?bz=promo_merchant",
      "voucher_description": "测试说明",
      "voucher_detail_images": [
        "A*inGVQYQT4w4AAAAAAAAAAAAAARwnAQ",
        "A*inGVQYQT4w4AAAAAAAAAAAAAARwnAQ"
      ],
      "brand_name": "品牌名称测试修改",
      "brand_logo_url": "https://mdgwdev.alipay.net/afts/img/A*tM9gTonOnsoAAAAAAAAAAAAAARwnAQ/original?bz=promo_merchant",
      "voucher_detail_image_urls": [
        "https://mdgwdev.alipay.net/afts/img/A*inGVQYQT4w4AAAAAAAAAAAAAARwnAQ/original?bz=promo_merchant",
        "https://mdgwdev.alipay.net/afts/img/A*inGVQYQT4w4AAAAAAAAAAAAAARwnAQ/original?bz=promo_merchant"
      ],
      "brand_logo": "A*tM9gTonOnsoAAAAAAAAAAAAAARwnAQ"
    },
    "voucher_inventory_info": {
      "use_count": 0,
      "send_count": 0
    }
  },
  "sign": "lHepGwJ/462qUcerZrBa1/PbCzfURwh8UHepJeqG/L5y4hV25Gh6uBUIf3DfcssY297QFGhsrTDUNW2p9nhxNZ2GcHZxcSYd35LYsN1XMpxcWUs8WG0jtxUzHvnwzdhC6XbA7aj8gW8ffB3hjorgqSSloZ+lFzOonxEC2G8ifY7dbM3ZSHY3m1yV9sPyGSFPlJPkaAt+5WqRGjO50Xfylq6p35H3u0jfChh6S0lQO0wy3Sj+gUBTYDDgPP6EStMCB3jXOxRW9aRZe0GoXpqmuz8PTmErBZDNomyfrVUJAosTWRhDXBErTPAnaOqPPhO4RjOIzY076s6KcE3xSlrCRg=="
}

停止商家券活动#

OpenAPI:alipay.marketing.activity.ordervoucher.stop(停止商家券活动)
入参示例值
{
    "activity_id":"2023052200826004099500110943",
    "out_biz_no":"20230522912030157116926040551246907077",
    "merchant_access_mode":"SELF_MODE"
}
出参示例值
{
  "alipay_marketing_activity_ordervoucher_stop_response": {
    "msg": "Success",
    "code": "10000"
  },
  "sign": "r/FviTzLsxlldPF33y7mf3C5BEbCW/7WiyGmXPiRJGQ54+XEpNI93gd6I5nPG9o/AU7pxwGwSUYWAz02m0dTjkdMzU9NfC+ln9OkRFDUHMDolR9HqZwkGDCcWYu3FRIdXE81WCmz5g7Ld3RuEet2f7hht7EsXlSzghWDhO3UbZgodm5QmVt0rcITYe0DWaDdJHR3eozBNr/KPqt7Uu0nvwsVAbvTWY2Jy81FzicD611J3vFsY558MBczmWz8X/clIDfXhiGT7BOraLveywgUGTI64o4b5JNS2teETco8tcWcM5OCBEn+v+f20HpP9sieIG5xVXOV5Bp2NKATG9y2ew=="
}

接收商家券活动停止成功通知#

接收 MsgAPI 消息:alipay.marketing.activity.message.stopped(券活动停止通知)
消息业务参数示例值
{
    "activity_id": "2023052200826004099500110943",
    "id": "STOPPED_2023052200826001099500379451",
    "out_biz_no": "20230522912030157116926040551246907077",
    "event_time": "1684724462203"
}

管理全场折扣券活动#

上传营销图片资源#

调用OpenAPI:alipay.marketing.material.image.upload(营销图片资源上传接口)
入参示例值
package com.java.sdk.demo;
import com.alipay.api.AlipayApiException;
import com.alipay.api.AlipayClient;
import com.alipay.api.DefaultAlipayClient;
import com.alipay.api.CertAlipayRequest;
import com.alipay.api.AlipayConfig;
import com.alipay.api.response.AlipayMarketingMaterialImageUploadResponse;
import com.alipay.api.request.AlipayMarketingMaterialImageUploadRequest;
import com.alipay.api.domain.BelongMerchantInfo;
import com.alipay.api.FileItem;
import java.util.Base64;
import java.util.ArrayList;
import java.util.List;
public class AlipayMarketingMaterialImageUpload {
    public static void main(String[] args) throws AlipayApiException {
        String privateKey = "<-- 请填写您的应用私钥,例如:MIIEvQIBADANB ... ... -->";
        String alipayPublicKey = "<-- 请填写您的支付宝公钥,例如:MIIBIjANBg... -->";
        AlipayConfig alipayConfig = new AlipayConfig();
        alipayConfig.setServerUrl("https://openapi-sandbox.dl.alipaydev.com/gateway.do");
        alipayConfig.setAppId("<-- 请填写您的AppId,例如:20210917671xxxx -->");
        alipayConfig.setPrivateKey(privateKey);
        alipayConfig.setFormat("json");
        alipayConfig.setAlipayPublicKey(alipayPublicKey);
        alipayConfig.setCharset("UTF8");
        alipayConfig.setSignType("RSA2");
        AlipayClient alipayClient = new DefaultAlipayClient(alipayConfig);
        FileItem fileContent = new FileItem("本地文件的绝对路径");
        AlipayMarketingMaterialImageUploadRequest request = new AlipayMarketingMaterialImageUploadRequest();
        request.setFileContent(fileContent);
        request.setFileKey("<-- 请填写文件业务标识 -->"); 
        request.setMerchantAccessMode("SELF_MODE");
        AlipayMarketingMaterialImageUploadResponse response = alipayClient.execute(request);
        System.out.println(response.getBody());
        if (response.isSuccess()) {
            System.out.println("调用成功");
        } else {
            System.out.println("调用失败");
        }
    }
}
出参示例值
{
  "alipay_marketing_material_image_upload_response": {
    "code": "10000",
    "msg": "Success",
    "resource_id": "X35lTqWuaHYAAAAAAAAAAAAADgSLAQBr",
    "resource_url": "https://mdn.alipayobjects.com/afts/img/X35lTqWuaHYAAAAAAAAAAAAADgSLAQBr/original?bz=sandboxsys",
    "resource_enhance": false
  },
  "sign": "waBB4OtqWUESwuhOBQRQo16S6kjddTFyWkNUw7+NlD9RTZE3DJPgz3BhWOJgEPaJWVLEv1m3Vgd3WMmvaaR2fEYr/IpySJnBIDsH7bDKRtu67+B1F2RCBOVOzIKBXoYVuChtMjR6rSNXPnsr395V2zBy1/BWiMkVVXPrDQnzBxraExkqVEW8B3HrMp/L3nP7utSLcFC0ici2Z6PmDpBmXcSNJHtG4tzkuVoUcty+6WAIv3N64Es89gHi4N2HHJeywXzfPTP8O978f6X2Wl/kPYZbkA9K1R3n/hJLOOBqqYCeAgNe+o0AX6Dd8JIxI7iC2lhwEZscZ1JrY8RNduFyoQ=="
}

创建商家券活动#

OpenAPI:alipay.marketing.activity.ordervoucher.create(创建商家券活动)
入参示例值
{
    "out_biz_no":"20230522609522159170123281479315008101",
    "merchant_access_mode":"SELF_MODE",
    "activity_base_info":{
        "activity_name":"全场折扣券折扣5折活动",
        "code_mode":"MERCHANT_UPLOAD"
    },
    "voucher_send_mode_info":{
        "voucher_send_mode":"DIRECT_SEND_MODE",
        "voucher_send_rule_info":{
            "natural_person_limit":false,
            "phone_number_limit":false,
            "publish_end_time":"2023-06-21 11:00:16",
            "publish_start_time":"2023-04-22 11:00:16",
            "quantity":0,
            "quantity_limit_per_user":100
        }
    },
    "voucher_deduct_info":{
        "voucher_type":"DISCOUNT_VOUCHER",
        "discount_voucher_info":{
            "discount":"5",
            "ceiling_amount":1,
            "floor_amount":1
        }
    },
    "voucher_available_scope_info":{
        "voucher_available_geography_scope_info":{
            "available_geography_scope_type":"SHOP",
            "available_geography_shop_info":{
                "available_shop_ids":[
                    "2020110200077000000007869130"
                ]
            }
        }
    },
    "voucher_use_rule_info":{
        "voucher_use_time_info":{
            "period_type":"RELATIVE",
            "relative_period_info":{
                "valid_days_after_receive":"5",
                "wait_days_after_receive":"0"
            }
        }
    },
    "voucher_customer_guide_info":{
        "voucher_use_guide_info":{
            "mini_app_use_guide_info":{
                "mini_app_url":"alipays://platformapi/startapp?appId=2017052601000815"
            },
            "use_guide_mode":[
                "MINI_APP",
                "OFFLINE_CODE"
            ]
        }
    },
    "voucher_display_pattern_info":{
        "brand_name":"品牌名称测试",
        "brand_logo":"A*tM9gTonOnsoAAAAAAAAAAAAAARwnAQ",
        "customer_service_mobile":"1111122222",
        "voucher_image":"A*CcF9T6Jt3QYAAAAAAAAAAAAAARwnAQ",
        "voucher_detail_images":[
            "A*inGVQYQT4w4AAAAAAAAAAAAAARwnAQ"
        ],
        "voucher_description":"测试说明"
    }
}
出参示例值
{
  "sign": "tytujsv7n5yBRtUE+ydTOVOQgp4Nd7wNKDSAIKmWqUpE+232LeKVGt8g8zN8XbGOJXFkzLCBx4I6wqOuuuj7BD8zscGYgWBUXVUtt4SWok+q970KcDYzW0H7IFvQM1caNl2AWGlWvLF+Y412sDkM2WBi2l8Pqlq5WhcOg78iJcMIWqSU20SO5qpUcIlGSeCLKleOAL7W2TuUpDJWNYyjbGZeHQF2cg8TTH7WqKnqO7gaYgk6uHcKfuXLYOdaDkksRZzk6mwkVGCmD7AfJsE/MlUoeO5KwHYdKyGtnMy/rIb+Yi+pyrAVd9lXY72Txjubbs8j5FgBTdhgSZQlqlOlJQ==",
  "alipay_marketing_activity_ordervoucher_create_response": {
    "msg": "Success",
    "code": "10000",
    "activity_id": "2023052200826004099500110944"
  }
}

接收活动创建成功消息#

接收 MsgAPI 消息:alipay.marketing.activity.message.created(券活动创建通知)
消息业务参数示例值
{
    "activity_id": "2023052200826004099500110944",
    "id": "CREATED_2023052200826001099500379343",
    "out_biz_no": "20230522609522159170123281479315008101",
    "event_time": "1684724417778"
}

同步商家券券码#

OpenAPI:alipay.marketing.activity.ordervoucher.codedeposit(同步商家券券码)
入参示例值
{
    "voucher_codes":[
        "yufaceshi001",
        "yufaceshi002",
        "yufaceshi003",
        "yufaceshi004",
        "yufaceshi005",
        "yufaceshi006",
        "yufaceshi007",
        "yufaceshi008",
        "yufaceshi009",
        "yufaceshi0010",
        "yufaceshi0011",
        "yufaceshi0012",
        "yufaceshi0013",
        "yufaceshi0014",
        "yufaceshi0015",
        "yufaceshi0016",
        "yufaceshi0017",
        "yufaceshi0018",
        "yufaceshi0019",
        "yufaceshi0020"
    ],
    "activity_id":"2023052200826004099500110944",
    "out_biz_no":"20230522609522159170123281479315008101",
    "merchant_access_mode":"SELF_MODE"
}
出参示例值
{
  "alipay_marketing_activity_ordervoucher_codedeposit_response": {
    "msg": "Success",
    "code": "10000",
    "success_count": 20,
    "success_voucher_code_list": [
      "yufaceshi001",
      "yufaceshi002",
      "yufaceshi003",
      "yufaceshi004",
      "yufaceshi005",
      "yufaceshi006",
      "yufaceshi007",
      "yufaceshi008",
      "yufaceshi009",
      "yufaceshi0010",
      "yufaceshi0011",
      "yufaceshi0012",
      "yufaceshi0013",
      "yufaceshi0014",
      "yufaceshi0015",
      "yufaceshi0016",
      "yufaceshi0017",
      "yufaceshi0018",
      "yufaceshi0019",
      "yufaceshi0020"
    ],
    "fail_count": 0
  },
  "sign": "Oez7ZqGO+tHZpA3C/LKYGosgP+BEF/rBECUNg5taRAkBwa4sLowmgpMM8zrQ8yTUnOHD56HzoDLqp8lztr//tyI1IXMNrnaszC/4JTG5bETvsZpnmcp7girolTuG5LWq4wzvHpJupGBJpKanTmFUIG9+bDiy/HTWYHiWRpZ4R1ZEUCboqni8yDh+JHg6eNbmSrBb4JpRORlFBTJXTD+X/8HQo3xQ4fS2Tc/kPJTdvRfCysRXwqS6m465A18NPhe9s/6Y7d4oqcLuM3XRdAB7o/ZsnFYOAF43Su3GNt0Rm0vXNGAnawzT6A1lUUpRNkdvKtny/U9s/FNsNz7RHdgvpg=="
}

统计券码数量#

OpenAPI:alipay.marketing.activity.ordervoucher.codecount(统计商家券券码数量)
入参示例值
{
    "activity_id":"2023052200826004099500110944",
    "merchant_access_mode":"SELF_MODE"
}
出参示例值
{
  "alipay_marketing_activity_ordervoucher_codecount_response": {
    "msg": "Success",
    "code": "10000",
    "success_count": 20
  },
  "sign": "gxz6bUUWIAErgB2dIA+J+MzHZ3EO9YxsOOWNbSzGZk35cbWamH/bgRmCmHQQS/18bn+71+DhJfVyTkBTnoIQHlM89XBWflcFm5dMJvZpKeEo9Txx4gtX6cnNFAhACqCEf8rOFSGyK+nxRac6FmKdx5bwltblzv2nCTnV7aPxCvlSDrQMiMJ8sEZJuNaDyhslIj+wI9Hc/kNmdJMsB0dFFW0pGEAPR1DHnLcn26jaOBmPl8gqSRVFKPFB6hzVQPr5uOTCxToVPxf/GXmUkBn7HoFZooUhh4tU4YTZVNDTMhvMDwmFLWkkG3XQfV8MRU56tSGkpgdxeap1nL6pCLkKlQ=="
}

修改商家券活动发券数量上限#

OpenAPI:alipay.marketing.activity.ordervoucher.append(修改商家券活动发券数量上限)
入参示例值
{
    "voucher_quantity":20,
    "activity_id":"2023052200826004099500110944",
    "out_biz_no":"20230522609522159170123281479315008101",
    "merchant_access_mode":"SELF_MODE"
}
出参示例值
{
  "alipay_marketing_activity_ordervoucher_append_response": {
    "msg": "Success",
    "code": "10000"
  },
  "sign": "r/FviTzLsxlldPF33y7mf3C5BEbCW/7WiyGmXPiRJGQ54+XEpNI93gd6I5nPG9o/AU7pxwGwSUYWAz02m0dTjkdMzU9NfC+ln9OkRFDUHMDolR9HqZwkGDCcWYu3FRIdXE81WCmz5g7Ld3RuEet2f7hht7EsXlSzghWDhO3UbZgodm5QmVt0rcITYe0DWaDdJHR3eozBNr/KPqt7Uu0nvwsVAbvTWY2Jy81FzicD611J3vFsY558MBczmWz8X/clIDfXhiGT7BOraLveywgUGTI64o4b5JNS2teETco8tcWcM5OCBEn+v+f20HpP9sieIG5xVXOV5Bp2NKATG9y2ew=="
}

接收活动发券数量上限修改成功通知#

接收 MsgAPI 消息:alipay.marketing.activity.message.appended(券活动预算追加通知)
消息业务参数示例值
{
    "activity_id": "2023052200826004099500110944",
    "id": "APPENDED_2023052200826001099500379345",
    "out_biz_no": "20230522609522159170123281479315008101",
    "event_time": "1684724418789"
}

修改商家券活动基本信息#

OpenAPI:alipay.marketing.activity.ordervoucher.modify(修改商家券活动基本信息)
入参示例值
{
    "activity_base_info":{
        "activity_id":"2023052200826004099500110944"
    },
    "voucher_display_pattern_info":{
        "brand_name":"品牌名称测试修改",
        "brand_logo":"A*tM9gTonOnsoAAAAAAAAAAAAAARwnAQ",
        "voucher_description":"测试说明",
        "voucher_image":"A*CcF9T6Jt3QYAAAAAAAAAAAAAARwnAQ",
        "voucher_detail_images":[
            "A*inGVQYQT4w4AAAAAAAAAAAAAARwnAQ",
            "A*inGVQYQT4w4AAAAAAAAAAAAAARwnAQ"
        ]
    },
    "voucher_use_rule_info":{
        "voucher_use_time_info":{
            "relative_period_info":{
                "valid_days_after_receive":"6"
            }
        }
    },
    "voucher_send_mode_info":{
        "voucher_send_rule_info":{
            "publish_end_time":"2023-06-22 11:00:16"
        }
    },
    "out_biz_no":"20230522609522159170123281479315008101",
    "merchant_access_mode":"SELF_MODE"
}
出参示例值
{
  "alipay_marketing_activity_ordervoucher_modify_response": {
    "msg": "Success",
    "code": "10000"
  },
  "sign": "r/FviTzLsxlldPF33y7mf3C5BEbCW/7WiyGmXPiRJGQ54+XEpNI93gd6I5nPG9o/AU7pxwGwSUYWAz02m0dTjkdMzU9NfC+ln9OkRFDUHMDolR9HqZwkGDCcWYu3FRIdXE81WCmz5g7Ld3RuEet2f7hht7EsXlSzghWDhO3UbZgodm5QmVt0rcITYe0DWaDdJHR3eozBNr/KPqt7Uu0nvwsVAbvTWY2Jy81FzicD611J3vFsY558MBczmWz8X/clIDfXhiGT7BOraLveywgUGTI64o4b5JNS2teETco8tcWcM5OCBEn+v+f20HpP9sieIG5xVXOV5Bp2NKATG9y2ew=="
}

接收商家券基本信息修改成功通知#

接收 MsgAPI 消息:alipay.marketing.activity.message.modified(券活动修改通知)
消息业务参数示例值
{
    "activity_id": "2023052200826004099500110944",
    "id": "MODIFIED_2023052200826001099500379348",
    "out_biz_no": "20230522609522159170123281479315008101",
    "event_time": "1684724451000"
}

查询商家券活动#

OpenAPI:alipay.marketing.activity.ordervoucher.query(查询商家券活动)
入参示例值
{
    "activity_id":"2023052200826004099500110944",
    "merchant_access_mode":"SELF_MODE"
}
出参示例值
{
  "alipay_marketing_activity_ordervoucher_query_response": {
    "msg": "Success",
    "voucher_send_mode_info": {
      "voucher_send_rule_info": {
        "quantity": 20,
        "natural_person_limit": false,
        "publish_end_time": "2023-06-22 11:00:16",
        "real_name_limit": false,
        "quantity_limit_per_user": 100,
        "quantity_limit_per_user_period_type": "LIFE_CYCLE",
        "phone_number_limit": false,
        "publish_start_time": "2023-04-22 11:00:16"
      },
      "voucher_send_mode": "DIRECT_SEND_MODE"
    },
    "voucher_deduct_info": {
      "voucher_type": "DISCOUNT_VOUCHER",
      "discount_voucher_info": {
        "ceiling_amount": "1.00",
        "discount": "5",
        "floor_amount": "1.00"
      }
    },
    "voucher_customer_guide_info": {
      "voucher_use_guide_info": {
        "use_guide_mode": [
          "MINI_APP",
          "OFFLINE_CODE"
        ],
        "mini_app_use_guide_info": {
          "mini_app_url": "alipays://platformapi/startapp?appId=2017052601000815"
        }
      }
    },
    "code": "10000",
    "voucher_use_rule_info": {
      "voucher_use_time_info": {
        "relative_period_info": {
          "wait_days_after_receive": 0,
          "valid_days_after_receive": 6
        },
        "period_type": "RELATIVE"
      },
      "voucher_max_use_times": 1
    },
    "voucher_available_scope_info": {
      "voucher_available_geography_scope_info": {
        "available_geography_shop_info": {
          "available_shop_ids": [
            "2020110200077000000007869130"
          ]
        },
        "available_geography_scope_type": "SHOP"
      }
    },
    "activity_base_info": {
      "activity_name": "全场折扣券折扣5折活动",
      "activity_product_type": "ORDER_VOUCHER",
      "activity_id": "2023052200826004099500110944",
      "code_mode": "MERCHANT_UPLOAD",
      "activity_status": "ACTIVE"
    },
    "voucher_display_pattern_info": {
      "customer_service_mobile": "1111122222",
      "voucher_image": "A*CcF9T6Jt3QYAAAAAAAAAAAAAARwnAQ",
      "voucher_name": "全场通用满1元打5折券",
      "voucher_image_url": "https://mdgwdev.alipay.net/afts/img/A*CcF9T6Jt3QYAAAAAAAAAAAAAARwnAQ/original?bz=promo_merchant",
      "voucher_description": "测试说明",
      "voucher_detail_images": [
        "A*inGVQYQT4w4AAAAAAAAAAAAAARwnAQ",
        "A*inGVQYQT4w4AAAAAAAAAAAAAARwnAQ"
      ],
      "brand_name": "品牌名称测试修改",
      "brand_logo_url": "https://mdgwdev.alipay.net/afts/img/A*tM9gTonOnsoAAAAAAAAAAAAAARwnAQ/original?bz=promo_merchant",
      "voucher_detail_image_urls": [
        "https://mdgwdev.alipay.net/afts/img/A*inGVQYQT4w4AAAAAAAAAAAAAARwnAQ/original?bz=promo_merchant",
        "https://mdgwdev.alipay.net/afts/img/A*inGVQYQT4w4AAAAAAAAAAAAAARwnAQ/original?bz=promo_merchant"
      ],
      "brand_logo": "A*tM9gTonOnsoAAAAAAAAAAAAAARwnAQ"
    },
    "voucher_inventory_info": {
      "use_count": 0,
      "send_count": 0
    }
  },
  "sign": "phHpxDku6aybEharSGpJdfrwOh+hcUy3MV+MTYlIu/jlRup0mAhtHjPWHhmj+69TzcsYsBbw1+2LezAFiZegBpbnvunlgXsuhA/fgjzwICvRi+5Xprcba99oyLCSAecrQ58zDZmxdTgW0wqZtF5qEFL3QjfKQFn3CYq4We+mOqGfTBcQo7bRLK3rKgYagly7f+3s7b9lrszSeoMZMfWb0uDO/ziyINYHl16HiuzPPzKv9IjVTYmfBZJ0kK2qsWoRLSVtYYvjquRfGpGdrUUQ3lfed7UwBifie8wAS26aMxfsCtvXs633BKoy5FRVhqnRr/kqaalpCAmUnjfwHAHxJw=="
}

停止商家券活动#

OpenAPI:alipay.marketing.activity.ordervoucher.stop(停止商家券活动)
入参示例值
{
    "activity_id":"2023052200826004099500110944",
    "out_biz_no":"20230522609522159170123281479315008101",
    "merchant_access_mode":"SELF_MODE"
}
出参示例值
{
  "alipay_marketing_activity_ordervoucher_stop_response": {
    "msg": "Success",
    "code": "10000"
  },
  "sign": "r/FviTzLsxlldPF33y7mf3C5BEbCW/7WiyGmXPiRJGQ54+XEpNI93gd6I5nPG9o/AU7pxwGwSUYWAz02m0dTjkdMzU9NfC+ln9OkRFDUHMDolR9HqZwkGDCcWYu3FRIdXE81WCmz5g7Ld3RuEet2f7hht7EsXlSzghWDhO3UbZgodm5QmVt0rcITYe0DWaDdJHR3eozBNr/KPqt7Uu0nvwsVAbvTWY2Jy81FzicD611J3vFsY558MBczmWz8X/clIDfXhiGT7BOraLveywgUGTI64o4b5JNS2teETco8tcWcM5OCBEn+v+f20HpP9sieIG5xVXOV5Bp2NKATG9y2ew=="
}

接收商家券活动停止成功通知#

接收 MsgAPI 消息:alipay.marketing.activity.message.stopped(券活动停止通知)
消息业务参数示例值
{
    "activity_id": "2023052200826004099500110944",
    "id": "STOPPED_2023052200826001099500379453",
    "out_biz_no": "20230522609522159170123281479315008101",
    "event_time": "1684724472634"
}

管理单品特价券活动#

上传营销图片资源#

调用OpenAPI:alipay.marketing.material.image.upload(营销图片资源上传接口)
入参示例值
package com.java.sdk.demo;
import com.alipay.api.AlipayApiException;
import com.alipay.api.AlipayClient;
import com.alipay.api.DefaultAlipayClient;
import com.alipay.api.CertAlipayRequest;
import com.alipay.api.AlipayConfig;
import com.alipay.api.response.AlipayMarketingMaterialImageUploadResponse;
import com.alipay.api.request.AlipayMarketingMaterialImageUploadRequest;
import com.alipay.api.domain.BelongMerchantInfo;
import com.alipay.api.FileItem;
import java.util.Base64;
import java.util.ArrayList;
import java.util.List;
public class AlipayMarketingMaterialImageUpload {
    public static void main(String[] args) throws AlipayApiException {
        String privateKey = "<-- 请填写您的应用私钥,例如:MIIEvQIBADANB ... ... -->";
        String alipayPublicKey = "<-- 请填写您的支付宝公钥,例如:MIIBIjANBg... -->";
        AlipayConfig alipayConfig = new AlipayConfig();
        alipayConfig.setServerUrl("https://openapi-sandbox.dl.alipaydev.com/gateway.do");
        alipayConfig.setAppId("<-- 请填写您的AppId,例如:20210917671xxxx -->");
        alipayConfig.setPrivateKey(privateKey);
        alipayConfig.setFormat("json");
        alipayConfig.setAlipayPublicKey(alipayPublicKey);
        alipayConfig.setCharset("UTF8");
        alipayConfig.setSignType("RSA2");
        AlipayClient alipayClient = new DefaultAlipayClient(alipayConfig);
        FileItem fileContent = new FileItem("本地文件的绝对路径");
        AlipayMarketingMaterialImageUploadRequest request = new AlipayMarketingMaterialImageUploadRequest();
        request.setFileContent(fileContent);
        request.setFileKey("<-- 请填写文件业务标识 -->"); 
        request.setMerchantAccessMode("SELF_MODE");
        AlipayMarketingMaterialImageUploadResponse response = alipayClient.execute(request);
        System.out.println(response.getBody());
        if (response.isSuccess()) {
            System.out.println("调用成功");
        } else {
            System.out.println("调用失败");
        }
    }
}
出参示例值
{
  "alipay_marketing_material_image_upload_response": {
    "code": "10000",
    "msg": "Success",
    "resource_id": "X35lTqWuaHYAAAAAAAAAAAAADgSLAQBr",
    "resource_url": "https://mdn.alipayobjects.com/afts/img/X35lTqWuaHYAAAAAAAAAAAAADgSLAQBr/original?bz=sandboxsys",
    "resource_enhance": false
  },
  "sign": "waBB4OtqWUESwuhOBQRQo16S6kjddTFyWkNUw7+NlD9RTZE3DJPgz3BhWOJgEPaJWVLEv1m3Vgd3WMmvaaR2fEYr/IpySJnBIDsH7bDKRtu67+B1F2RCBOVOzIKBXoYVuChtMjR6rSNXPnsr395V2zBy1/BWiMkVVXPrDQnzBxraExkqVEW8B3HrMp/L3nP7utSLcFC0ici2Z6PmDpBmXcSNJHtG4tzkuVoUcty+6WAIv3N64Es89gHi4N2HHJeywXzfPTP8O978f6X2Wl/kPYZbkA9K1R3n/hJLOOBqqYCeAgNe+o0AX6Dd8JIxI7iC2lhwEZscZ1JrY8RNduFyoQ=="
}

创建商家券活动#

OpenAPI:alipay.marketing.activity.ordervoucher.create(创建商家券活动)
入参示例值
{
    "out_biz_no":"20230522001381528602180554150594877695",
    "merchant_access_mode":"SELF_MODE",
    "activity_base_info":{
        "activity_name":"单品特价券享0.1特价活动",
        "code_mode":"MERCHANT_UPLOAD"
    },
    "voucher_send_mode_info":{
        "voucher_send_mode":"DIRECT_SEND_MODE",
        "voucher_send_rule_info":{
            "natural_person_limit":false,
            "phone_number_limit":false,
            "publish_end_time":"2023-06-21 11:00:16",
            "publish_start_time":"2023-04-22 11:00:16",
            "quantity":0,
            "quantity_limit_per_user":100
        }
    },
    "voucher_deduct_info":{
        "voucher_type":"SPECIAL_VOUCHER",
        "special_voucher_info":{
            "special_amount":"0.1",
            "floor_amount":1
        }
    },
    "voucher_available_scope_info":{
        "voucher_available_geography_scope_info":{
            "available_geography_scope_type":"SHOP",
            "available_geography_shop_info":{
                "available_shop_ids":[
                    "2020110200077000000007869130"
                ]
            }
        },
        "voucher_available_goods_info":{
            "goods_name":"单品特价券",
            "origin_amount":10
        }
    },
    "voucher_use_rule_info":{
        "voucher_use_time_info":{
            "period_type":"RELATIVE",
            "relative_period_info":{
                "valid_days_after_receive":"5",
                "wait_days_after_receive":"0"
            }
        }
    },
    "voucher_customer_guide_info":{
        "voucher_use_guide_info":{
            "mini_app_use_guide_info":{
                "mini_app_url":"alipays://platformapi/startapp?appId=2017052601000815"
            },
            "use_guide_mode":[
                "MINI_APP",
                "OFFLINE_CODE"
            ]
        }
    },
    "voucher_display_pattern_info":{
        "brand_name":"品牌名称测试",
        "brand_logo":"A*tM9gTonOnsoAAAAAAAAAAAAAARwnAQ",
        "customer_service_mobile":"1111122222",
        "voucher_image":"A*CcF9T6Jt3QYAAAAAAAAAAAAAARwnAQ",
        "voucher_detail_images":[
            "A*inGVQYQT4w4AAAAAAAAAAAAAARwnAQ"
        ],
        "voucher_description":"测试说明"
    }
}
出参示例值
{
  "sign": "H8PZQixxzepm7O73ldLr8u3WIqFH+K0yMLvuqSlEWoKT3bZiq0SxUPYCwM7xPpghYP5ZWSIqJtujhGxJtJ+f+82R26Z0t7cdOTN0HyzMtjgmZ4OcxT3rfHrRCUtxTcBEMrDA29njmfuuI0+blnDPdWP1/R/K+P+IIwFuUPrgNzmOaXC7+Qs9Q9uuJkUrUAs7nZvWZaq2Czd6A7yXrjUsm0XhpgjqfKh8YouATZ1EwTiOpzLzK0E5aPIVf6VMq5Yq3p+y4sI2wdiqmo+QZ0NO+KKg+pNdM138+3WQIZ4pcQAISbfHw1OdeqWx8Y2f/qhrh0NC4ybfmvl0fEO53GyP2g==",
  "alipay_marketing_activity_ordervoucher_create_response": {
    "msg": "Success",
    "code": "10000",
    "activity_id": "2023052200826004099500111042"
  }
}

接收活动创建成功消息#

接收 MsgAPI 消息:alipay.marketing.activity.message.created(券活动创建通知)
消息业务参数示例值
{
    "activity_id": "2023052200826004099500111042",
    "id": "CREATED_2023052200826001099500379554",
    "out_biz_no": "20230522001381528602180554150594877695",
    "event_time": "1684724417962"
}

同步商家券券码#

OpenAPI:alipay.marketing.activity.ordervoucher.codedeposit(同步商家券券码)
入参示例值
{
    "voucher_codes":[
        "yufaceshi001",
        "yufaceshi002",
        "yufaceshi003",
        "yufaceshi004",
        "yufaceshi005",
        "yufaceshi006",
        "yufaceshi007",
        "yufaceshi008",
        "yufaceshi009",
        "yufaceshi0010",
        "yufaceshi0011",
        "yufaceshi0012",
        "yufaceshi0013",
        "yufaceshi0014",
        "yufaceshi0015",
        "yufaceshi0016",
        "yufaceshi0017",
        "yufaceshi0018",
        "yufaceshi0019",
        "yufaceshi0020"
    ],
    "activity_id":"2023052200826004099500111042",
    "out_biz_no":"20230522001381528602180554150594877695",
    "merchant_access_mode":"SELF_MODE"
}
出参示例值
{
  "alipay_marketing_activity_ordervoucher_codedeposit_response": {
    "msg": "Success",
    "code": "10000",
    "success_count": 20,
    "success_voucher_code_list": [
      "yufaceshi001",
      "yufaceshi002",
      "yufaceshi003",
      "yufaceshi004",
      "yufaceshi005",
      "yufaceshi006",
      "yufaceshi007",
      "yufaceshi008",
      "yufaceshi009",
      "yufaceshi0010",
      "yufaceshi0011",
      "yufaceshi0012",
      "yufaceshi0013",
      "yufaceshi0014",
      "yufaceshi0015",
      "yufaceshi0016",
      "yufaceshi0017",
      "yufaceshi0018",
      "yufaceshi0019",
      "yufaceshi0020"
    ],
    "fail_count": 0
  },
  "sign": "Oez7ZqGO+tHZpA3C/LKYGosgP+BEF/rBECUNg5taRAkBwa4sLowmgpMM8zrQ8yTUnOHD56HzoDLqp8lztr//tyI1IXMNrnaszC/4JTG5bETvsZpnmcp7girolTuG5LWq4wzvHpJupGBJpKanTmFUIG9+bDiy/HTWYHiWRpZ4R1ZEUCboqni8yDh+JHg6eNbmSrBb4JpRORlFBTJXTD+X/8HQo3xQ4fS2Tc/kPJTdvRfCysRXwqS6m465A18NPhe9s/6Y7d4oqcLuM3XRdAB7o/ZsnFYOAF43Su3GNt0Rm0vXNGAnawzT6A1lUUpRNkdvKtny/U9s/FNsNz7RHdgvpg=="
}

统计券码数量#

OpenAPI:alipay.marketing.activity.ordervoucher.codecount(统计商家券券码数量)
入参示例值
{
    "activity_id":"2023052200826004099500111042",
    "merchant_access_mode":"SELF_MODE"
}
出参示例值
{
  "alipay_marketing_activity_ordervoucher_codecount_response": {
    "msg": "Success",
    "code": "10000",
    "success_count": 20
  },
  "sign": "gxz6bUUWIAErgB2dIA+J+MzHZ3EO9YxsOOWNbSzGZk35cbWamH/bgRmCmHQQS/18bn+71+DhJfVyTkBTnoIQHlM89XBWflcFm5dMJvZpKeEo9Txx4gtX6cnNFAhACqCEf8rOFSGyK+nxRac6FmKdx5bwltblzv2nCTnV7aPxCvlSDrQMiMJ8sEZJuNaDyhslIj+wI9Hc/kNmdJMsB0dFFW0pGEAPR1DHnLcn26jaOBmPl8gqSRVFKPFB6hzVQPr5uOTCxToVPxf/GXmUkBn7HoFZooUhh4tU4YTZVNDTMhvMDwmFLWkkG3XQfV8MRU56tSGkpgdxeap1nL6pCLkKlQ=="
}

修改商家券活动发券数量上限#

OpenAPI:alipay.marketing.activity.ordervoucher.append(修改商家券活动发券数量上限)
入参示例值
{
    "voucher_quantity":20,
    "activity_id":"2023052200826004099500111042",
    "out_biz_no":"20230522001381528602180554150594877695",
    "merchant_access_mode":"SELF_MODE"
}
出参示例值
{
  "alipay_marketing_activity_ordervoucher_append_response": {
    "msg": "Success",
    "code": "10000"
  },
  "sign": "r/FviTzLsxlldPF33y7mf3C5BEbCW/7WiyGmXPiRJGQ54+XEpNI93gd6I5nPG9o/AU7pxwGwSUYWAz02m0dTjkdMzU9NfC+ln9OkRFDUHMDolR9HqZwkGDCcWYu3FRIdXE81WCmz5g7Ld3RuEet2f7hht7EsXlSzghWDhO3UbZgodm5QmVt0rcITYe0DWaDdJHR3eozBNr/KPqt7Uu0nvwsVAbvTWY2Jy81FzicD611J3vFsY558MBczmWz8X/clIDfXhiGT7BOraLveywgUGTI64o4b5JNS2teETco8tcWcM5OCBEn+v+f20HpP9sieIG5xVXOV5Bp2NKATG9y2ew=="
}

接收活动发券数量上限修改成功通知#

接收 MsgAPI 消息:alipay.marketing.activity.message.appended(券活动预算追加通知)
消息业务参数示例值
{
    "activity_id": "2023052200826004099500111042",
    "id": "APPENDED_2023052200826001099500379559",
    "out_biz_no": "20230522001381528602180554150594877695",
    "event_time": "1684724418982"
}

修改商家券活动基本信息#

OpenAPI:alipay.marketing.activity.ordervoucher.modify(修改商家券活动基本信息)
入参示例值
{
    "activity_base_info":{
        "activity_id":"2023052200826004099500111042"
    },
    "voucher_display_pattern_info":{
        "brand_name":"品牌名称测试修改",
        "brand_logo":"A*tM9gTonOnsoAAAAAAAAAAAAAARwnAQ",
        "voucher_description":"测试说明",
        "voucher_image":"A*CcF9T6Jt3QYAAAAAAAAAAAAAARwnAQ",
        "voucher_detail_images":[
            "A*inGVQYQT4w4AAAAAAAAAAAAAARwnAQ",
            "A*inGVQYQT4w4AAAAAAAAAAAAAARwnAQ"
        ]
    },
    "voucher_use_rule_info":{
        "voucher_use_time_info":{
            "relative_period_info":{
                "valid_days_after_receive":"6"
            }
        }
    },
    "voucher_send_mode_info":{
        "voucher_send_rule_info":{
            "publish_end_time":"2023-06-22 11:00:16"
        }
    },
    "out_biz_no":"20230522001381528602180554150594877695",
    "merchant_access_mode":"SELF_MODE"
}
出参示例值
{
  "alipay_marketing_activity_ordervoucher_modify_response": {
    "msg": "Success",
    "code": "10000"
  },
  "sign": "r/FviTzLsxlldPF33y7mf3C5BEbCW/7WiyGmXPiRJGQ54+XEpNI93gd6I5nPG9o/AU7pxwGwSUYWAz02m0dTjkdMzU9NfC+ln9OkRFDUHMDolR9HqZwkGDCcWYu3FRIdXE81WCmz5g7Ld3RuEet2f7hht7EsXlSzghWDhO3UbZgodm5QmVt0rcITYe0DWaDdJHR3eozBNr/KPqt7Uu0nvwsVAbvTWY2Jy81FzicD611J3vFsY558MBczmWz8X/clIDfXhiGT7BOraLveywgUGTI64o4b5JNS2teETco8tcWcM5OCBEn+v+f20HpP9sieIG5xVXOV5Bp2NKATG9y2ew=="
}

接收商家券基本信息修改成功通知#

接收 MsgAPI 消息:alipay.marketing.activity.message.modified(券活动修改通知)
消息业务参数示例值
{
    "activity_id": "2023052200826004099500111042",
    "id": "MODIFIED_2023052200826001099500379450",
    "out_biz_no": "20230522001381528602180554150594877695",
    "event_time": "1684724447000"
}

查询商家券活动#

OpenAPI:alipay.marketing.activity.ordervoucher.query(查询商家券活动)
入参示例值
{
    "activity_id":"2023052200826004099500111042"
}
出参示例值
{
  "alipay_marketing_activity_ordervoucher_query_response": {
    "msg": "Success",
    "summary": {
      "used_count": 0,
      "publish_count": 0
    },
    "activity_name": "单品特价券享0.1特价活动",
    "voucher_use_rule": {
      "voucher_available_scope": {
        "order_voucher_available_shop": {
          "shop_ids": [
            "2020110200077000000007869130"
          ]
        },
        "voucher_available_type": "SHOP"
      },
      "voucher_valid_period": {
        "wait_days_after_receive": 0,
        "valid_days_after_receive": 6,
        "type": "RELATIVE"
      },
      "special_voucher": {
        "goods_name": "单品特价券",
        "origin_amount": "10.00",
        "special_amount": "0.10",
        "floor_amount": "1.00"
      }
    },
    "code": "10000",
    "publish_start_time": "2023-04-22 11:00:16",
    "voucher_display_info": {
      "customer_service_mobile": "1111122222",
      "voucher_image": "A*CcF9T6Jt3QYAAAAAAAAAAAAAARwnAQ",
      "voucher_description": "测试说明",
      "voucher_detail_images": [
        "A*inGVQYQT4w4AAAAAAAAAAAAAARwnAQ",
        "A*inGVQYQT4w4AAAAAAAAAAAAAARwnAQ"
      ],
      "brand_name": "品牌名称测试修改",
      "brand_logo": "A*tM9gTonOnsoAAAAAAAAAAAAAARwnAQ"
    },
    "publish_end_time": "2023-06-22 11:00:16",
    "voucher_type": "SPECIAL_VOUCHER",
    "customer_guide": {
      "voucher_use_guide": {
        "offline_code_use_guide": true,
        "mini_app_id": "2017052601000815",
        "mini_app_use_guide": true
      },
      "store_ids": [
        "2020110200077000000007869130"
      ],
      "mini_app_id": "2017052601000815",
      "shop_ids": [
        "2020110200077000000007869130"
      ]
    },
    "activity_id": "2023052200826004099500111042",
    "voucher_send_rule": {
      "voucher_quantity": 20,
      "natural_person_limit": false,
      "voucher_quantity_limit_per_user": 100,
      "phone_number_limit": false
    },
    "activity_status": "ACTIVE"
  },
  "sign": "sENymNZvuv/3MH0NG+r3JRQN7Q5QI4HKBD0dV2sFx91EMQ2lulSbWBRe9LLnwKMAw3qhHL+vnQDF1cLXdR8CvSPpfnzJmhxQeRfTS6E5qdyjXai8MtMafBzGchy+u/DZ7wT2HPQN6y5LdH7jT4SxDtHrf4GJhQN9ckpvKAH2wOcj1P1Izz8WnlKxjNPIvF/pNLFuZr06/4HIV24Ms1HvMoYo+0WF4Cl/BVCcE2OM1MDVOFRh1KzRdRZqJdsghtaWBfBhJJ8WH1nmmkmLHvHXm/BpHUvIUfro0LFVT84T3P3Wqhi6gLosDMFFpcuBucRejfa1HdJGWLP3VyigYrZFSA=="
}

停止商家券活动#

OpenAPI:alipay.marketing.activity.ordervoucher.stop(停止商家券活动)
入参示例值
{
    "activity_id":"2023052200826004099500111042",
    "out_biz_no":"20230522001381528602180554150594877695"
}
出参示例值
{
  "alipay_marketing_activity_ordervoucher_stop_response": {
    "msg": "Success",
    "code": "10000"
  },
  "sign": "r/FviTzLsxlldPF33y7mf3C5BEbCW/7WiyGmXPiRJGQ54+XEpNI93gd6I5nPG9o/AU7pxwGwSUYWAz02m0dTjkdMzU9NfC+ln9OkRFDUHMDolR9HqZwkGDCcWYu3FRIdXE81WCmz5g7Ld3RuEet2f7hht7EsXlSzghWDhO3UbZgodm5QmVt0rcITYe0DWaDdJHR3eozBNr/KPqt7Uu0nvwsVAbvTWY2Jy81FzicD611J3vFsY558MBczmWz8X/clIDfXhiGT7BOraLveywgUGTI64o4b5JNS2teETco8tcWcM5OCBEn+v+f20HpP9sieIG5xVXOV5Bp2NKATG9y2ew=="
}

接收商家券活动停止成功通知#

接收 MsgAPI 消息:alipay.marketing.activity.message.stopped(券活动停止通知)
消息业务参数示例值
{
    "activity_id": "2023052200826004099500111042",
    "id": "STOPPED_2023052200826001099500379452",
    "out_biz_no": "20230522001381528602180554150594877695",
    "event_time": "1684724464282"
}

非导码模式券活动管理#

上传营销图片资源#

调用OpenAPI:alipay.marketing.material.image.upload(营销图片资源上传接口)
入参示例值
package com.java.sdk.demo;
import com.alipay.api.AlipayApiException;
import com.alipay.api.AlipayClient;
import com.alipay.api.DefaultAlipayClient;
import com.alipay.api.CertAlipayRequest;
import com.alipay.api.AlipayConfig;
import com.alipay.api.response.AlipayMarketingMaterialImageUploadResponse;
import com.alipay.api.request.AlipayMarketingMaterialImageUploadRequest;
import com.alipay.api.domain.BelongMerchantInfo;
import com.alipay.api.FileItem;
import java.util.Base64;
import java.util.ArrayList;
import java.util.List;
public class AlipayMarketingMaterialImageUpload {
    public static void main(String[] args) throws AlipayApiException {
        String privateKey = "<-- 请填写您的应用私钥,例如:MIIEvQIBADANB ... ... -->";
        String alipayPublicKey = "<-- 请填写您的支付宝公钥,例如:MIIBIjANBg... -->";
        AlipayConfig alipayConfig = new AlipayConfig();
        alipayConfig.setServerUrl("https://openapi-sandbox.dl.alipaydev.com/gateway.do");
        alipayConfig.setAppId("<-- 请填写您的AppId,例如:20210917671xxxx -->");
        alipayConfig.setPrivateKey(privateKey);
        alipayConfig.setFormat("json");
        alipayConfig.setAlipayPublicKey(alipayPublicKey);
        alipayConfig.setCharset("UTF8");
        alipayConfig.setSignType("RSA2");
        AlipayClient alipayClient = new DefaultAlipayClient(alipayConfig);
        FileItem fileContent = new FileItem("本地文件的绝对路径");
        AlipayMarketingMaterialImageUploadRequest request = new AlipayMarketingMaterialImageUploadRequest();
        request.setFileContent(fileContent);
        request.setFileKey("<-- 请填写文件业务标识 -->"); 
        request.setMerchantAccessMode("SELF_MODE");
        AlipayMarketingMaterialImageUploadResponse response = alipayClient.execute(request);
        System.out.println(response.getBody());
        if (response.isSuccess()) {
            System.out.println("调用成功");
        } else {
            System.out.println("调用失败");
        }
    }
}
出参示例值
{
  "alipay_marketing_material_image_upload_response": {
    "code": "10000",
    "msg": "Success",
    "resource_id": "X35lTqWuaHYAAAAAAAAAAAAADgSLAQBr",
    "resource_url": "https://mdn.alipayobjects.com/afts/img/X35lTqWuaHYAAAAAAAAAAAAADgSLAQBr/original?bz=sandboxsys",
    "resource_enhance": false
  },
  "sign": "waBB4OtqWUESwuhOBQRQo16S6kjddTFyWkNUw7+NlD9RTZE3DJPgz3BhWOJgEPaJWVLEv1m3Vgd3WMmvaaR2fEYr/IpySJnBIDsH7bDKRtu67+B1F2RCBOVOzIKBXoYVuChtMjR6rSNXPnsr395V2zBy1/BWiMkVVXPrDQnzBxraExkqVEW8B3HrMp/L3nP7utSLcFC0ici2Z6PmDpBmXcSNJHtG4tzkuVoUcty+6WAIv3N64Es89gHi4N2HHJeywXzfPTP8O978f6X2Wl/kPYZbkA9K1R3n/hJLOOBqqYCeAgNe+o0AX6Dd8JIxI7iC2lhwEZscZ1JrY8RNduFyoQ=="
}

创建商家券活动#

OpenAPI:alipay.marketing.activity.ordervoucher.create(创建商家券活动)
入参示例值
{
    "out_biz_no":"20230522517845632133395030515605110475",
    "merchant_access_mode":"SELF_MODE",
    "activity_base_info":{
        "activity_name":"非导码商家单品折扣券活动",
        "code_mode":"MERCHANT_API"
    },
    "voucher_send_mode_info":{
        "voucher_send_mode":"DIRECT_SEND_MODE",
        "voucher_send_rule_info":{
            "natural_person_limit":false,
            "phone_number_limit":false,
            "publish_end_time":"2023-06-21 11:00:16",
            "publish_start_time":"2023-04-22 11:00:16",
            "quantity":5,
            "quantity_limit_per_user":100
        }
    },
    "voucher_deduct_info":{
        "voucher_type":"DISCOUNT_VOUCHER",
        "discount_voucher_info":{
            "discount":"5",
            "ceiling_amount":1,
            "floor_amount":1
        }
    },
    "voucher_available_scope_info":{
        "voucher_available_geography_scope_info":{
            "available_geography_scope_type":"SHOP",
            "available_geography_shop_info":{
                "available_shop_ids":[
                    "2020110200077000000007869130"
                ]
            }
        }
    },
    "voucher_use_rule_info":{
        "voucher_use_time_info":{
            "period_type":"RELATIVE",
            "relative_period_info":{
                "valid_days_after_receive":"5",
                "wait_days_after_receive":"0"
            }
        }
    },
    "voucher_customer_guide_info":{
        "voucher_use_guide_info":{
            "mini_app_use_guide_info":{
                "mini_app_url":"alipays://platformapi/startapp?appId=2017052601000815"
            },
            "use_guide_mode":[
                "MINI_APP",
                "OFFLINE_CODE"
            ]
        }
    },
    "voucher_display_pattern_info":{
        "brand_name":"品牌名称测试",
        "brand_logo":"A*tM9gTonOnsoAAAAAAAAAAAAAARwnAQ",
        "customer_service_mobile":"1111122222",
        "voucher_image":"A*CcF9T6Jt3QYAAAAAAAAAAAAAARwnAQ",
        "voucher_detail_images":[
            "A*inGVQYQT4w4AAAAAAAAAAAAAARwnAQ"
        ],
        "voucher_description":"测试说明"
    }
}
出参示例值
{
  "sign": "2iMM1H/v0O4RXhplhOcBVQ+L8+e4jThsHvvLpPZAQU9VBFTxJRFxMkxDJB8i4ls8zeMrdqbi0nKeaFgaGB9giM9T6YvSqICzMdQt4oN88BR+veL0iLOG+GTlie4LtntSH4MbLSmKmWhkHAItF36ZB+ulIv4eFEm8FdTR6DVnCQPf8GfHoyNuzkwCGxy+LwbSfhFCwifzUxFPx+E57lre5ms33Gu1CJvkZbXDQM4KB8THQpbpSrgUFpfr7FoUX+pMtswE9DkkAfV4GK+8GOYZhoyoYKNcg0JSjywQI+oyyWglp9kAkB2ELnES8eM8ARb/Pqr8oJLgbD1XehfpFhPc7g==",
  "alipay_marketing_activity_ordervoucher_create_response": {
    "msg": "Success",
    "code": "10000",
    "activity_id": "2023052200826004099500111170"
  }
}

接收商家券活动创建通知#

接收 MsgAPI 消息:alipay.marketing.activity.message.created alipay.marketing.activity.message.created(券活动创建通知)
消息业务参数示例值
{
    "activity_id": "2023052200826004099500111170",
    "id": "CREATED_2023052200826001099500379441",
    "out_biz_no": "20230522517845632133395030515605110475",
    "event_time": "1684724418069"
}

修改商家券活动发券数量上限#

OpenAPI:alipay.marketing.activity.ordervoucher.append(修改商家券活动发券数量上限)
入参示例值
{
    "voucher_quantity":120,
    "activity_id":"2023052200826004099500111170",
    "out_biz_no":"20230522517845632133395030515605110475",
    "merchant_access_mode":"SELF_MODE"
}
出参示例值
{
  "alipay_marketing_activity_ordervoucher_append_response": {
    "msg": "Success",
    "code": "10000"
  },
  "sign": "r/FviTzLsxlldPF33y7mf3C5BEbCW/7WiyGmXPiRJGQ54+XEpNI93gd6I5nPG9o/AU7pxwGwSUYWAz02m0dTjkdMzU9NfC+ln9OkRFDUHMDolR9HqZwkGDCcWYu3FRIdXE81WCmz5g7Ld3RuEet2f7hht7EsXlSzghWDhO3UbZgodm5QmVt0rcITYe0DWaDdJHR3eozBNr/KPqt7Uu0nvwsVAbvTWY2Jy81FzicD611J3vFsY558MBczmWz8X/clIDfXhiGT7BOraLveywgUGTI64o4b5JNS2teETco8tcWcM5OCBEn+v+f20HpP9sieIG5xVXOV5Bp2NKATG9y2ew=="
}

券活动预算追加通知#

接收 MsgAPI 消息:alipay.marketing.activity.message.appended(券活动预算追加通知)
消息业务参数示例值
{
    "activity_id": "2023052500826004099500113445",
    "id": "APPENDED_2023052500826001099500387648",
    "out_biz_no": "20230525912692381165216816745894780943",
    "event_time": "1684998017767"
}

修改商家券活动基本信息#

OpenAPI:alipay.marketing.activity.ordervoucher.modify(修改商家券活动基本信息)
入参示例值
{
    "activity_base_info":{
        "activity_id":"2023052200826004099500111170"
    },
    "voucher_display_pattern_info":{
        "brand_name":"品牌名称测试修改",
        "brand_logo":"A*tM9gTonOnsoAAAAAAAAAAAAAARwnAQ",
        "voucher_description":"测试说明",
        "voucher_image":"A*CcF9T6Jt3QYAAAAAAAAAAAAAARwnAQ",
        "voucher_detail_images":[
            "A*inGVQYQT4w4AAAAAAAAAAAAAARwnAQ",
            "A*inGVQYQT4w4AAAAAAAAAAAAAARwnAQ"
        ]
    },
    "voucher_use_rule_info":{
        "voucher_use_time_info":{
            "relative_period_info":{
                "valid_days_after_receive":"6"
            }
        }
    },
    "voucher_send_mode_info":{
        "voucher_send_rule_info":{
            "publish_end_time":"2023-06-22 11:00:16"
        }
    },
    "out_biz_no":"20230522517845632133395030515605110475",
    "merchant_access_mode":"SELF_MODE"
}
出参示例值
{
  "alipay_marketing_activity_ordervoucher_modify_response": {
    "msg": "Success",
    "code": "10000"
  },
  "sign": "r/FviTzLsxlldPF33y7mf3C5BEbCW/7WiyGmXPiRJGQ54+XEpNI93gd6I5nPG9o/AU7pxwGwSUYWAz02m0dTjkdMzU9NfC+ln9OkRFDUHMDolR9HqZwkGDCcWYu3FRIdXE81WCmz5g7Ld3RuEet2f7hht7EsXlSzghWDhO3UbZgodm5QmVt0rcITYe0DWaDdJHR3eozBNr/KPqt7Uu0nvwsVAbvTWY2Jy81FzicD611J3vFsY558MBczmWz8X/clIDfXhiGT7BOraLveywgUGTI64o4b5JNS2teETco8tcWcM5OCBEn+v+f20HpP9sieIG5xVXOV5Bp2NKATG9y2ew=="
}

券活动修改通知#

接收 MsgAPI 消息:alipay.marketing.activity.message.modified(券活动修改通知)
消息业务参数示例值
{
    "activity_id": "2023052500826004099500113445",
    "id": "MODIFIED_2023052500826001099500387529",
    "out_biz_no": "20230525912692381165216816745894780943",
    "event_time": "1684998017000"
}

查询商家券活动#

OpenAPI:alipay.marketing.activity.ordervoucher.query(查询商家券活动)
入参示例值
{
    "activity_id": "2023052500826004099500113445",
    "merchant_access_mode": "SELF_MODE"
}
出参示例值:
{
  "alipay_marketing_activity_ordervoucher_query_response": {
    "msg": "Success",
    "voucher_send_mode_info": {
      "voucher_send_rule_info": {
        "quantity": 120,
        "natural_person_limit": false,
        "publish_end_time": "2023-06-25 15:00:15",
        "real_name_limit": false,
        "quantity_limit_per_user": 100,
        "quantity_limit_per_user_period_type": "LIFE_CYCLE",
        "phone_number_limit": false,
        "publish_start_time": "2023-04-25 15:00:15"
      },
      "voucher_send_mode": "DIRECT_SEND_MODE"
    },
    "voucher_deduct_info": {
      "voucher_type": "DISCOUNT_VOUCHER",
      "discount_voucher_info": {
        "ceiling_amount": "1.00",
        "discount": "5",
        "floor_amount": "1.00"
      }
    },
    "voucher_customer_guide_info": {
      "voucher_use_guide_info": {
        "use_guide_mode": [
          "MINI_APP",
          "OFFLINE_CODE"
        ],
        "mini_app_use_guide_info": {
          "mini_app_url": "alipays://platformapi/startapp?appId=2017052601000815"
        }
      }
    },
    "code": "10000",
    "voucher_use_rule_info": {
      "voucher_use_time_info": {
        "relative_period_info": {
          "wait_days_after_receive": 0,
          "valid_days_after_receive": 6
        },
        "period_type": "RELATIVE"
      },
      "voucher_max_use_times": 1
    },
    "voucher_available_scope_info": {
      "voucher_available_geography_scope_info": {
        "available_geography_shop_info": {
          "available_shop_ids": [
            "2020110200077000000007869130"
          ]
        },
        "available_geography_scope_type": "SHOP"
      }
    },
    "activity_base_info": {
      "activity_name": "非导码商家单品折扣券活动",
      "activity_product_type": "ORDER_VOUCHER",
      "activity_id": "2023052500826004099500113445",
      "code_mode": "MERCHANT_API",
      "activity_status": "ACTIVE"
    },
    "voucher_display_pattern_info": {
      "customer_service_mobile": "1111122222",
      "voucher_image": "A*CcF9T6Jt3QYAAAAAAAAAAAAAARwnAQ",
      "voucher_name": "全场通用满1元打5折券",
      "voucher_image_url": "https://mdgwdev.alipay.net/afts/img/A*CcF9T6Jt3QYAAAAAAAAAAAAAARwnAQ/original?bz=promo_merchant",
      "voucher_description": "测试说明",
      "voucher_detail_images": [
        "A*inGVQYQT4w4AAAAAAAAAAAAAARwnAQ",
        "A*inGVQYQT4w4AAAAAAAAAAAAAARwnAQ"
      ],
      "brand_name": "品牌名称测试修改",
      "brand_logo_url": "https://mdgwdev.alipay.net/afts/img/A*tM9gTonOnsoAAAAAAAAAAAAAARwnAQ/original?bz=promo_merchant",
      "voucher_detail_image_urls": [
        "https://mdgwdev.alipay.net/afts/img/A*inGVQYQT4w4AAAAAAAAAAAAAARwnAQ/original?bz=promo_merchant",
        "https://mdgwdev.alipay.net/afts/img/A*inGVQYQT4w4AAAAAAAAAAAAAARwnAQ/original?bz=promo_merchant"
      ],
      "brand_logo": "A*tM9gTonOnsoAAAAAAAAAAAAAARwnAQ"
    },
    "voucher_inventory_info": {
      "use_count": 0,
      "send_count": 0
    }
  },
  "sign": "N8j+OJZ2ulMIWcCbB2jjsPx7Pc5piFWBkGWxOMYZlDn3Qhm5E8hum4CWE+M0Q/a7q7+lFgMSGbhPffkwRZZ3argeAcIQIo38VfykRvdT1TcKjLYVKb9rxI9bHt45xVDTqxQ5i2WqwthhzZGgn0HQDLGxZMg4pEuVQfmBSoO6bikFKNpeHhRBPnpqE3HZbmyK9q3wQUpGtIUgd9rx/+xcmb0+y1VSCkOi4jDBKGUVsJ+dKzyARo/T6oCXMFqeuHjpDyrWZVktFtDPexuItpJrizZUhF94HRI/MlSNmA/0ZUyIV+YG7UPrc5506pdJ8XbuH7y4ksrlmT7fvDpN80+fTQ=="
}

停止商家券活动#

OpenAPI:alipay.marketing.activity.ordervoucher.stop(停止商家券活动)
入参示例值
{
    "activity_id":"2023052200826004099500111170",
    "out_biz_no":"20230522517845632133395030515605110475",
    "merchant_access_mode":"SELF_MODE"
}
出参示例值
{
  "alipay_marketing_activity_ordervoucher_stop_response": {
    "msg": "Success",
    "code": "10000"
  },
  "sign": "r/FviTzLsxlldPF33y7mf3C5BEbCW/7WiyGmXPiRJGQ54+XEpNI93gd6I5nPG9o/AU7pxwGwSUYWAz02m0dTjkdMzU9NfC+ln9OkRFDUHMDolR9HqZwkGDCcWYu3FRIdXE81WCmz5g7Ld3RuEet2f7hht7EsXlSzghWDhO3UbZgodm5QmVt0rcITYe0DWaDdJHR3eozBNr/KPqt7Uu0nvwsVAbvTWY2Jy81FzicD611J3vFsY558MBczmWz8X/clIDfXhiGT7BOraLveywgUGTI64o4b5JNS2teETco8tcWcM5OCBEn+v+f20HpP9sieIG5xVXOV5Bp2NKATG9y2ew=="
}

券活动停止通知#

接收 MsgAPI 消息:alipay.marketing.activity.message.stopped(券活动停止通知)
消息业务参数示例值
{
    "activity_id": "2023052500826004099500113445",
    "id": "STOPPED_2023052500826001099500387803",
    "out_biz_no": "20230525912692381165216816745894780943",
    "event_time": "1684998061563"
}

投放商家券到支付成功页#

上传营销图片资源#

调用OpenAPI:alipay.marketing.material.image.upload(营销图片资源上传接口)
入参示例值
package com.java.sdk.demo;
import com.alipay.api.AlipayApiException;
import com.alipay.api.AlipayClient;
import com.alipay.api.DefaultAlipayClient;
import com.alipay.api.CertAlipayRequest;
import com.alipay.api.AlipayConfig;
import com.alipay.api.response.AlipayMarketingMaterialImageUploadResponse;
import com.alipay.api.request.AlipayMarketingMaterialImageUploadRequest;
import com.alipay.api.domain.BelongMerchantInfo;
import com.alipay.api.FileItem;
import java.util.Base64;
import java.util.ArrayList;
import java.util.List;
public class AlipayMarketingMaterialImageUpload {
    public static void main(String[] args) throws AlipayApiException {
        String privateKey = "<-- 请填写您的应用私钥,例如:MIIEvQIBADANB ... ... -->";
        String alipayPublicKey = "<-- 请填写您的支付宝公钥,例如:MIIBIjANBg... -->";
        AlipayConfig alipayConfig = new AlipayConfig();
        alipayConfig.setServerUrl("https://openapi-sandbox.dl.alipaydev.com/gateway.do");
        alipayConfig.setAppId("<-- 请填写您的AppId,例如:20210917671xxxx -->");
        alipayConfig.setPrivateKey(privateKey);
        alipayConfig.setFormat("json");
        alipayConfig.setAlipayPublicKey(alipayPublicKey);
        alipayConfig.setCharset("UTF8");
        alipayConfig.setSignType("RSA2");
        AlipayClient alipayClient = new DefaultAlipayClient(alipayConfig);
        FileItem fileContent = new FileItem("本地文件的绝对路径");
        AlipayMarketingMaterialImageUploadRequest request = new AlipayMarketingMaterialImageUploadRequest();
        request.setFileContent(fileContent);
        request.setFileKey("<-- 请填写文件业务标识 -->"); 
        request.setMerchantAccessMode("SELF_MODE");
        AlipayMarketingMaterialImageUploadResponse response = alipayClient.execute(request);
        System.out.println(response.getBody());
        if (response.isSuccess()) {
            System.out.println("调用成功");
        } else {
            System.out.println("调用失败");
        }
    }
}
出参示例值
{
  "alipay_marketing_material_image_upload_response": {
    "code": "10000",
    "msg": "Success",
    "resource_id": "X35lTqWuaHYAAAAAAAAAAAAADgSLAQBr",
    "resource_url": "https://mdn.alipayobjects.com/afts/img/X35lTqWuaHYAAAAAAAAAAAAADgSLAQBr/original?bz=sandboxsys",
    "resource_enhance": false
  },
  "sign": "waBB4OtqWUESwuhOBQRQo16S6kjddTFyWkNUw7+NlD9RTZE3DJPgz3BhWOJgEPaJWVLEv1m3Vgd3WMmvaaR2fEYr/IpySJnBIDsH7bDKRtu67+B1F2RCBOVOzIKBXoYVuChtMjR6rSNXPnsr395V2zBy1/BWiMkVVXPrDQnzBxraExkqVEW8B3HrMp/L3nP7utSLcFC0ici2Z6PmDpBmXcSNJHtG4tzkuVoUcty+6WAIv3N64Es89gHi4N2HHJeywXzfPTP8O978f6X2Wl/kPYZbkA9K1R3n/hJLOOBqqYCeAgNe+o0AX6Dd8JIxI7iC2lhwEZscZ1JrY8RNduFyoQ=="
}

券活动预算追加通知#

接收 MsgAPI 消息:alipay.marketing.activity.message.appended(券活动预算追加通知)
消息业务参数示例值
{
    "activity_id": "2023052500826004099500113442",
    "id": "APPENDED_2023052500826001099500387641",
    "out_biz_no": "launch20230525145013659",
    "event_time": "1684997415327"
}

投放计划创建#

OpenAPI:alipay.marketing.activity.delivery.create(创建推广计划)
入参示例值
{
    "belong_merchant_info":{
        "merchant_id":"2088621957795094",
        "merchant_id_type":"PID",
        "business_type":"ISV_FOR_MERCHANT"
    },
    "delivery_booth_code":"PAYMENT_RESULT",
    "out_biz_no":"20230522894240713264806124199388778350",
    "delivery_base_info":{
        "delivery_name":"本店优惠第十期投放计划",
        "delivery_begin_time":"2023-04-22 11:00:15",
        "delivery_end_time":"2023-06-21 11:00:15",
        "delivery_material":{
            "delivery_single_material":{
                "delivery_image":"A*cEs9Q4YdPOEAAAAAAAAAAAAAARwnAQ"
            }
        }
    },
    "delivery_play_config":{
        "delivery_full_send_config":{
            "delivery_floor_amount":"11.00",
            "delivery_content_info":{
                "delivery_content_type":"ACTIVITY",
                "delivery_activity_content":{
                    "activity_id":"2023052200826004099500111169"
                }
            }
        }
    },
    "delivery_target_rule":{
        "delivery_merchant_infos":[
            {
                "merchant_id_type":"PID",
                "merchant_id":"2088621957795094"
            }
        ]
    }
}
出参示例值
{
  "alipay_marketing_activity_delivery_create_response": {
    "msg": "Success",
    "code": "10000",
    "delivery_id": "2023052200826029099500065633"
  },
  "sign": "IpdTIAaM6K9CzbFFcpLjUM3fvHjHAkuwmMIk5q4aFcSeMinqEtdHwusHTqvCls0tCAeneY+tHK4D9Q6BCQUeSP4yeigpN9EDBq4kTyNXHi889lxQfh50gBNI/S6rcHklddBE71Rvz/VtdXmy1Gtk/M/2O4zWaZXgEaRdedcu9Z/+wwEnHfD79EbIzf6Bw7GCIrbWAi/y/QzdAfBeJrLK9jjEun98Fv5iUPsUmfdyd670EO5JMGg4O0hmHLeVXb4UMChV6siv/An5ULQW3btHGxl6rlU/DWaV++mj9/grJOaQIUtJtP5mynlieeCgv3ESUP3ZwPIdrHS+E6czqMZRFA=="
}

查询投放计划#

OpenAPI:alipay.marketing.activity.delivery.query(查询推广计划)
入参示例值
{
    "belong_merchant_info":{
        "merchant_id":"2088621957795094",
        "merchant_id_type":"PID",
        "business_type":"ISV_FOR_MERCHANT"
    },
    "delivery_id":"2023052200826029099500065633"
}
出参示例值
{
  "sign": "TNuIHug95otgmQbkVssvqJvqjZmxamrmRp0YLuJSPifkUd16v8TY8mqY4E6s7u9NYqCIgUYiuTlMK7CoUOPXL5aEUOGL9TYwm1f7kbAxSD/exERXY7ZpAUCzmyaz8TwvqEpQJtIqu2KDNsonuM+fB0dAip8pPLXh8cKcp3nm/tDfDN0zkfolf9RdFh7ryZ72QaM0UKshRICqEx49K8eTY+rwY+nMPQoaoXjRlR4NRvKL7yiaa6lpOKQRwJeQsRsgWbDuiWQBTN559q6NLNOmwg7nB2qaooeWTW3tU3zzIG7GnG7xfTh9jEfcFZDrXdNjNRUAWa61RLVYr7OI+Fy3xg==",
  "alipay_marketing_activity_delivery_query_response": {
    "msg": "Success",
    "delivery_base_info": {
      "delivery_end_time": "2023-06-21 11:00:15",
      "delivery_name": "本店优惠第十期投放计划",
      "delivery_begin_time": "2023-04-22 11:00:15"
    },
    "code": "10000",
    "delivery_id": "2023052200826029099500065633",
    "delivery_play_config": {
      "delivery_full_send_config": {
        "delivery_floor_amount": "11.00",
        "delivery_content_info": {
          "delivery_display_info": {},
          "delivery_content_type": "GENERALIZED_ACTIVITY",
          "delivery_activity_content": {
            "activity_id": "2023052200826004099500111169"
          }
        }
      }
    },
    "delivery_booth_code": "PAYMENT_RESULT",
    "delivery_target_rule": {
      "delivery_merchant_infos": [
        {
          "merchant_id_type": "PID",
          "merchant_id": "2088621957795094"
        }
      ],
      "delivery_merchant_mode": "MANUAL_INPUT_MERCHANT",
      "delivery_merchant_rule": {
        "delivery_merchant_infos": [
          {
            "merchant_id_type": "PID",
            "merchant_id": "2088621957795094"
          }
        ],
        "delivery_merchant_mode": "MANUAL_INPUT_MERCHANT"
      }
    },
    "delivery_status": "ACTIVE"
  }
}

停止投放#

OpenAPI:alipay.marketing.activity.delivery.stop(停止推广计划)
入参示例值
{
    "belong_merchant_info":{
        "merchant_id":"2088621957795094",
        "merchant_id_type":"PID",
        "business_type":"ISV_FOR_MERCHANT"
    },
    "delivery_id":"2023052200826029099500065633",
    "out_biz_no":"20230522894240713264806124199388778350"
}
出参示例值
{
  "sign": "IpdTIAaM6K9CzbFFcpLjUM3fvHjHAkuwmMIk5q4aFcSeMinqEtdHwusHTqvCls0tCAeneY+tHK4D9Q6BCQUeSP4yeigpN9EDBq4kTyNXHi889lxQfh50gBNI/S6rcHklddBE71Rvz/VtdXmy1Gtk/M/2O4zWaZXgEaRdedcu9Z/+wwEnHfD79EbIzf6Bw7GCIrbWAi/y/QzdAfBeJrLK9jjEun98Fv5iUPsUmfdyd670EO5JMGg4O0hmHLeVXb4UMChV6siv/An5ULQW3btHGxl6rlU/DWaV++mj9/grJOaQIUtJtP5mynlieeCgv3ESUP3ZwPIdrHS+E6czqMZRFA==",
  "alipay_marketing_activity_delivery_stop_response": {
    "msg": "Success",
    "code": "10000",
    "delivery_id": "2023052200826029099500065633"
  }
}

使用商家券#

券活动预算追加通知#

接收 MsgAPI 消息:alipay.marketing.activity.message.appended(券活动预算追加通知)
消息业务参数示例值
{
    "activity_id": "2023052500826004099500113597",
    "id": "APPENDED_2023052500826001099500387521",
    "out_biz_no": "city20230525145022186",
    "event_time": "1684997423467"
}

触发沙箱环境领券#

通过使用 沙箱环境用户领券方式 来触发用户领券。

接收商家券成功通知#

接收 MsgAPI 消息:alipay.marketing.activity.message.received(券领取通知)
消息业务参数示例值
{
    "activity_id": "2023052500826004099500113597",
    "voucher_id": "2023052500073002164900001J1W",
    "receive_user_id": "2088622957849163",
    "voucher_code": "yufaceshi0016",
    "id": "RECEIVED_2023052500073011164900001L5P",
    "event_time": "1684998017688"
}

同步券核销状态#

OpenAPI:alipay.marketing.activity.ordervoucher.use(同步券核销状态)
入参示例值
{
    "biz_dt":"2023-05-22 11:00:15",
    "total_fee":0.01,
    "activity_id":"2023052200826004099500110940",
    "trade_channel":"ZHIFUBAO_TRADE_CHANNEL",
    "trade_no":"20230522110015969",
    "voucher_code":"yufaceshi007",
    "out_biz_no":"20230522951812890601315198707234921699",
    "goods_detail":[
        {
            "goods_name":"ipad",
            "quantity":1,
            "price":2000,
            "goods_id":"apple-01"
        }
    ]
}
出参示例值
{
  "alipay_marketing_activity_ordervoucher_use_response": {
    "msg": "Success",
    "code": "10000",
    "voucher_use_detail_result_info": {}
  },
  "sign": "s5ibB6u2at+pN84YLBv3Fnq8595MP2LI4oqapNNAdPI66ztby0m4e9of8L9UCMTwvoipbQm9EQ3Qp0VvmVaexVXS/REmUdpK+tm8Hgxmupfj6XazkE8VDzOCnCLFNLbPI7Zeibtee8uLLn5b9U+rCwBfYnbNNaMiP0uAbpVfHMkM+gd6wnrYvmiHsLjaJ251hVQjNHrvaUATRkSrHcil4MpZMkKPZ3lG62ZNNs/8VNHw1VMKirz2bEc5REAo3BZB/8rPxSxw7ArAQ3FdhdQGTFRC5BFOBHWksJXncysWz5PYNQ2iIm/wzai038XbsGXuVdg5bhYoFAMhSquBpRr3eA=="
}
注意:
沙箱环境不会校验券码有效性。
沙箱环境下券核销后,对应商家券活动的 券已核销数量 不会更新。

取消核销券码#

OpenAPI:alipay.marketing.activity.ordervoucher.refund(取消券核销状态)
入参示例值
{
    "biz_dt":"2023-05-22 11:00:15",
    "total_fee":0.01,
    "activity_id":"2023052200826004099500110940",
    "trade_channel":"ZHIFUBAO_TRADE_CHANNEL",
    "trade_no":"20230522110015969",
    "voucher_code":"yufaceshi007",
    "out_biz_no":"20230522951812890601315198707234921699",
    "goods_detail":[
        {
            "goods_name":"ipad",
            "quantity":1,
            "price":2000,
            "goods_id":"apple-01"
        }
    ]
}
出参示例值
{
  "alipay_marketing_activity_ordervoucher_use_response": {
    "msg": "Success",
    "code": "10000",
    "voucher_use_detail_result_info": {}
  },
  "sign": "s5ibB6u2at+pN84YLBv3Fnq8595MP2LI4oqapNNAdPI66ztby0m4e9of8L9UCMTwvoipbQm9EQ3Qp0VvmVaexVXS/REmUdpK+tm8Hgxmupfj6XazkE8VDzOCnCLFNLbPI7Zeibtee8uLLn5b9U+rCwBfYnbNNaMiP0uAbpVfHMkM+gd6wnrYvmiHsLjaJ251hVQjNHrvaUATRkSrHcil4MpZMkKPZ3lG62ZNNs/8VNHw1VMKirz2bEc5REAo3BZB/8rPxSxw7ArAQ3FdhdQGTFRC5BFOBHWksJXncysWz5PYNQ2iIm/wzai038XbsGXuVdg5bhYoFAMhSquBpRr3eA=="
}
上一页
常见问题
下一页
商家券测试指导方案
Built with