支付宝
  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. 本地生活商品接入指南

本地生活商品产品接入流程

产品版本介绍#

支付宝提供 平台券码版 及 商家券码版 两个版本的接入方式。平台券码版 全量开放,商家券码版 为邀约制,可联系支付宝业务经理了解详细信息。
以下文档内容为 平台券码版 接入信息。

产品使用流程#

说明:
本地生活商品插件:必须接入,需要在小程序内集成插件并完成交易,此插件依赖交易组件开通。
商品接口:接入后可通过接口实现商品创建和管理。
凭证核销接口:接入后可在 商家POS/商家小程序 通过调用支付宝接口进行核销。
订单查询接口:接入后可通过接口查询订单详情。
订单核销后退款接口:订单核销前主要通过用户端发起随时退或过期自动退实现退款;若需要在用户核销后发起退款,需要通过接口集成。

准备工作#

发布小程序#

小程序是商家在支付宝经营的唯一载体,在本地生活商品发布前需具备一个 已发布 的小程序。如需创建,具体参见如下产品入口。
**商家:**登录 商家平台 > 运营中心 > 小程序。
**服务商:**登录 服务商平台 > 代运营中心 > 商家小程序。
image

开通交易组件#

交易组件为本地生活商品销售的必要能力,交易组件可实现下单支付、订单同步、履约结算等能力。通过订购并集成 本地生活商品页面插件,可由插件为商家代为调用交易组件服务,商家在该环节仅需开通交易组件即可。
产品入口**:**
**商家:**登录 商家平台 > 运营中心 > 小程序,选择具体小程序 > 交易组件菜单,点击 申请开通 按钮。
服务商:登录 服务商平台 > 代运营中心 > 商家小程序,选择具体小程序 > 交易组件菜单,点击 申请开通 按钮。
image

商家订购服务商模版小程序流程#

商户在服务市场订购小程序模版服务,前置条件是模版小程序已经订购本地生活商品插件和开通交易组件。
服务商小程序模版实例化小程序给到商家,此时小程序内已经集成本地生活商品插件和交易组件。
商家开通交易组件功能,或者服务商代商户开通交易组件:
若商家自己开通交易组件,可在商家平台上进行开通:登录 商家平台 > 运营中心 > 小程序,选择具体小程序 > 交易组件菜单,点击 申请开通 按钮。
若商家通过服务商代开通交易组件,请看服务商代开发模式。
若商家已经订阅过模版小程序,并且已上线,开通交易组件并完成业务功能开发后,需要 更新小程序版本。

服务商代开发模式开通交易组件#

1.
确认三方应用已经绑定了小程序交易组件。
image.png
2.
通过以下方式协助商家开通交易组件,请商家在商家平台运营中心 > 选择小程序 > 交易组件 的详情页面点击 申请开通,填写并提交相关信息,按操作指引完成接入。
image.png
3.
获取代开发授权,服务商需根据 第三方应用授权 指引,获取商家代开发授权,以此获取 app_auth_token(商家授权令牌)用于调用产品相关接口。
4.
服务商代商户接入交易组件,调用接口等步骤可参考:服务商代开发模式接入。
5.
进行 交易组件验收。

本地生活商品插件订购及集成#

为减少研发成本,商家可集成 本地生活商品插件,插件将生成商品详情页、下单页(含支付流程)、订单详情页(含订单同步)。插件将由支付宝平台代为调用交易组件,商家仅需集成插件本身。

订购“本地生活商品插件”#

提供 2 种方式进行本地生活商品插件订购。
可通过登录 开放平台控制台 进入小程序详情页,点击小程序,进入 插件服务,搜索 本地生活商品 并完成订购。
通过登陆 商家平台 / 服务商平台 后台,进入 服务市场,搜索 本地生活商品 并完成订购。
开放平台订购#
1.
登陆 开放平台控制台 进入对应小程序详情页,点击对应小程序,进入 插件服务 菜单。
image
2.
点击 订购其他插件 后跳转到订购插件页面,搜索 本地生活商品插件 并完成订阅。
image.png
image
服务商市场订购#
1.
通过登陆 商家平台 / 服务商平台 后台,进入 服务市场 > 开发者资源。
image
2.
搜索并选择 本地生活商品插件。
image
3.
进行 本地生活商品插件 订购。
image.png

集成“本地生活商品插件”#

订购完成后需进行插件集成,完整集成流程详见:本地生活商品插件集成指南。

蚂蚁门店新增和管理#

本地生活商品在支付宝公域分发强依赖门店 POI 信息,商家创建本地生活商品需关联支付宝门店,详细请查看 蚂蚁门店创建。

接口提报门店#

产品入口:
**商家:**登录 商家平台 > 运营中心 > 其他 > 门店管理。
**服务商:**登录 服务商平台 > 代运营中心 > 其他 > 门店管理。
操作指南详见:蚂蚁门店管理产品介绍。

蚂蚁门店店员维护#

支付宝商家端小程序核销时,可以在门店管理中维护店员账号并设定店员核销等权限,待店员确认权限后,可实现店员用个人支付宝账号登陆支付宝商家端小程序进行核销等操作。
产品入口:登录 商家平台 > 运营中心 > 其他 > 门店管理。
操作指南详见: 门店店员维护。

补充收款账号信息#

需补充收款账号用于本地生活商品所有账款的收款。点击 去补充,选择收款账号,完成补充。
image

类目申请指南#

为规范以及方便支付宝小程序商家(以下简称“您”或“商家”)在支付宝提报、推广、销售商品的相关行为,保护消费者权益,维护小程序技术平台安全,蚂蚁集团旗下杭州吱声信息技术有限公司(下文简称“吱声公司”或“我们”)制订本操作手册,方便您理解商品资质类目申请流程。
商品类目是基于小程序类目的经营资质管理下,限定开放给商家。若在后台选不到可提报的类目,可能存在以下 2 种情况:
小程序主营类目不准确或没有辅营类目,建议增加辅营类目。
商品类目暂未开放,请联系支付宝业务经理或商家客服咨询。
若要获取更多商品可提报类目,可查看 类目申请指南。

接入指南#

说明
本地生活商品提报和凭证核销接口:主要是针对有研发能力的商家和服务商提供的 API 接口,商家和服务商通过商品提报和凭证核销的接口集成,可以实现在商家后台对支付宝本地商品管理和发布,消费者购买后到店可通过商家 POS 机/商家小程序核销。针对无研发能力的商家和服务商,商品提报和凭证核销可以在支付宝 商家平台/服务商平台 进行管理和配置,商品需到店核销的场景,商家可通过支付宝搜索 本地生活商品商家端 小程序完成核销。
本地生活商品详情插件和订单查询:本地生活商品详情插件主要是在小程序内完成整个商品展示、交易等链路,订单查询主要是用户完成交易后,根据返回的交易单号查询订单并展示订单状态,本地生活商品详情插件和订单查询都必须研发接入。
开发前准备工作:
商家自研:商家自助完成产品开通与接口调用。
服务商代开发:服务商需获取商家应用的代开发授权,再协助商家开通产品,然后通过第三方应用调用接口。
详细请看 自研和服务商代开发技术接入准备。
本地生活商品接口时序图和详细说明请查看 本地生活商品快速接入。

本地生活商品接口开发接入#

本地生活商品类目查询#

在开始接入商品提报前,需要先获取商品类目,详细请查看 alipay.open.app.localitem.allcategory.query(获取本地商品类目接口),获取到商品类目后请进行本地生活商品模版查询接口。

本地生活商品模板查询接口#

获取商品类目后,通过 alipay.open.app.localitem.template.query(获取本地商品模板信息)获取本地商品创建接口的参数。

本地生活商品详细接口说明#

模块接口中文名类型&调用流向接口地址
商品创建小程序本地商品创建接口接口(开发者->支付宝)alipay.open.app.localitem.create(小程序本地商品创建)
商品管理小程序本地商品修改接口接口(开发者->支付宝)alipay.open.app.localitem.modify(小程序本地商品修改接口)
小程序本地商品免审更新商品接口接口(开发者->支付宝)alipay.open.app.localitem.direct.modify(小程序本地商品免审更新商品接口)
小程序商品移除接口接口(开发者->支付宝)alipay.open.app.item.delete(小程序商品移除接口)
商品查询获取本地商品类目接口接口(开发者->支付宝)alipay.open.app.localitem.allcategory.query(获取本地商品类目接口)
获取本地商品模板信息接口接口(开发者->支付宝)alipay.open.app.localitem.template.query(获取本地商品模板信息)
小程序本地商品详情查询接口接口(开发者->支付宝)alipay.open.app.localitem.query(小程序本地商品详情查询接口)
商品状态商品状态变更消息同步接口消息(支付宝->开发者)alipay.open.app.item.status.notify(商品状态变更消息同步接口)

凭证核销开发接入#

说明:可通过对接凭证管理相关接口,实现门店店员通过 POS 机/商家小程序进行调用支付宝进行核销凭证。
用户支付成功后,由支付宝侧直接给用户发放一方凭证(平台码)。
平台凭证的发放、核销等状态会驱动订单状态的变化,商家通过接口可实现凭证核销及撤销核销。
商家通过核销准备接口获取平台加密券码,并通过核销接口告知支付宝平台加密券码核销成功,订单状态会自动同步为“已核销”;
商家订单退款成功,订单和凭证状态会自动同步为已退款。

凭证核销详细接口说明#

模块接口中文名类型&调用流向接口地址
凭证核销凭证核销准备接口(开发者->支付宝)alipay.marketing.certificate.certification.prepareuse(凭证核销准备)
同步凭证核销状态接口(开发者->支付宝)alipay.marketing.certificate.certification.use(同步凭证核销状态)
撤销凭证核销状态接口(开发者->支付宝)alipay.marketing.certificate.certification.refund(撤销凭证核销状态)
凭证退款(核销前随时退和过期退前置咨询)退款前向商户确认是否可以退款接口(支付宝->开发者)spi.alipay.marketing.certificate.order.refundconfirm(退款前向商户确认是否可以退款)
订单退款前商户回复确认退款结果接口(开发者->支付宝)alipay.marketing.certificate.order.refundconfirmcommit(订单退款前商户回复确认退款结果)
凭证状态查询查询凭证信息接口(开发者->支付宝)alipay.marketing.certificate.certification.batchquery(查询凭证信息)
小程序私域用户凭证查询条件查询用户凭证接口(开发者->支付宝)alipay.marketing.certificate.user.batchquery(条件查询用户凭证)
小程序私域核销准备核销准备 JSAPI接口(开发者->支付宝)my.ap.prepareUseCertificate(凭证核销准备)入参:certificateId出参可获得:encryptedCode

本地生活商品插件开发接入#

本地生活商品插件是小程序内必须对接的插件,请在完成订购后进行开发,同时请保证已经订阅交易组件。
本地生活商品插件支持“静态加载”、“懒加载模式加载”和“动态加载”三种模式集成,更多内容可参考 支付宝插件使用文档。
静态加载模式下仅支持一个小程序最多关联 10 个插件,当小程序少于 10 个静态插件时,推荐使用懒加载模式加载。
动态加载无插件个数限制。

普通静态加载#

兼容规则
插件的运行要求小程序基础库为 1.22.4 及以上版本,支付宝客户端 10.1.85 及以上的版本。若不满足请将以下代码放到小程序 app.js 文件中。
// app.js
if (!my.canIUse('plugin') && !my.isIDE) {
  my.ap && my.ap.updateAlipayClient && my.ap.updateAlipayClient(); // 如果动态加载不可用则打开支付宝客户端升级界面
}
App({
  onLaunch() {},
  onShow() {},
});

app.json 配置#

{
  "plugins": {
    "groupPurchaseoucherPlugin": {
      "version": "*", // 目前只支持设置 * ,自动选择版本
      "provider": "插件ID"
    },
  }
}

页面配置#

说明:通过 reLaunchAPI 进行跳转,这样才会有首页的 icon 的显示。(若使用 navigateTo Api只会有返回箭头 icon)
my.reLaunch({
  url: `plugin://groupPurchaseoucherPlugin/index?outItemId=${outItemId}`
  // outItemId为外部商品id
});

懒加载模式加载#

兼容规则#
使用懒加载模式的小程序项目支持 IDE 3.0.0 及以上版本编译构建。懒加载模式插件运行小程序支持基础库 2.7.18 及以上版本,如不符合建议请 设置最低基础库版本进行兼容。

app.json 配置#

// 使用静态懒加载
{
  "plugins": {
    "groupPurchaseoucherPlugin": {
      "lazy": true, // 开启懒加载模式
      "version": "*", // 目前只支持设置 * ,自动选择版本
      "provider": "2021003190661263"
    }
  },
  // 配置懒加载插件预加载
  "preloadRule": {
    "pages/index/index": {  // 这里路径为需要加载插件的本地小程序页面路径
      "network": "all",
      "plugins": ["groupPurchaseoucherPlugin"]
    }
  }
}

页面配置#

说明:通过 reLaunchAPI 进行跳转,这样才会有首页的 icon 的显示。(若使用 navigateTo Api 只会有返回箭头 icon)
my.reLaunch({
  url: `plugin://groupPurchaseoucherPlugin/index?outItemId=${outItemId}`
  // outItemId为外部商品id
});

动态加载#

app.json配置
{
  "useDynamicPlugins": true
}

页面配置#

通过 reLaunchAPI 进行跳转,这样才会有首页的 icon 的显示。(若使用 navigateTo Api只会有返回箭头 icon)
Page({
  data: {
  },
  onLoad() {
  },
  navToPluginPage() {
    // 跳转到插件页面,index为插件plugin.json中对外暴露的页面
    my.reLaunch({
      url: `dynamic-plugin://插件ID/index?outItemId=${outItemId}`
      // outItemId为外部商品id
    });
  },
});

公域到小程序插件地址#

注意
outItemId:外部商品 id。
orderId:订单号 id。
encodeURIComponent 为 JSAPI,链接中 page 后的内容需要 URL 编码。
链接暂不支持拼接商家埋点。
规则
alipays://platformapi/startapp?appId=宿主A&page=${encodeURIComponent(plugin-private://插件A/页面?outItemId=${outItemId})}
商品详情页
alipays://platformapi/startapp?appId=宿主小程序appid&page=${encodeURIComponent(plugin-private://插件ID/pages/index/index?outItemId=${outItemId})}
订单详情页
alipays://platformapi/startapp?appId=宿主小程序appid&page=${encodeURIComponent(plugin-private://插件ID/pages/orderdetail/orderdetail?orderId=${orderId})}

开发环境联调说明(非必须流程)#

1.
需提供 appid 给支付宝插件技术服务人员,进行开发环境配置。
2.
在 支付宝开放平台 小程序插件服务的插件联调中确认授权,实现在开发环境进行联调。

首次进入插件处理登入逻辑#

若宿主小程序在首次进入插件的时候需要强验证登入逻辑,可以在在宿主小程序的 onLaunch 钩子里提供方法。
若要从支付宝公域到插件也支持登入逻辑,则可以在宿主小程序 onShow 钩子里提供方法。
App({
  onLaunch() {
    // 第一次打开
    // options.query == {number:1}
    // console.log(options);
    // console.info('App onLaunch');
    // 处理登入逻辑
  },
  onShow() {
    // 从后台被 scheme 重新打开
    // options.query == {number:1}
    // console.log(options);
    // 处理登入逻辑
  },
});

“去小程序使用”链接规则#

链接是在创建本地生活商品时写入,需根据以下 url 规则配置。
url 格式:alipays://platformapi/startapp?appId=[appId]&page=[page]&query=[query]
跳非宿主/跳宿主:
非宿主跳转:支持最小传 appId,page、query 可不传,默认跳首页。
跳宿主:支持最小传 appId 和 page, query 可不传,跳指定页面。
query 的获取:getLaunchOptionsSync
示例图:
image.png
其它详细内容请查看 参考文档。

订单查询开发接入#

必须接入,可通过对接订单相关接口,查询订单数据并集成在小程序私域订单列表进行查看,说明如下。
模块接口中文名类型&调用流向接口英文名说明
订单结果订单创建结果通知消息(支付宝->开发者)alipay.open.mini.order.changed用户支付后同步订单消息
订单查询订单详情查询接口接口(开发者->支付宝)alipay.open.mini.order.query查询订单详情信息,用于小程序内展示订单状态

订单核销后退款开发接入#

订单核销前主要通过用户端发起随时退或过期自动退实现退款。若需要在用户核销后发起退款,目前可通过调用订单退款接口实现退款,需要通过退款接口接入。
接口明细:
模块接口中文名类型&调用流向接口英文名
订单退款(核销后)订单售后退款接口(开发者->支付宝)alipay.open.mini.order.refund

常见问题#

1.
结算周期:T+3,即核销后第 3 天自动打款至统一收款账户/结算到核销门店账号。
2.
撤销核销规则:核销后 1 小时可通过接口或 本地生活商品商家端 撤销核销状态。
3.
退款与商家确认规则:
用户发起核销前退款/过期未核销自动退款,默认与商家系统确认,拒绝退款后需在 1 自然日返回核销消息,否则平台自动执行退款给用户。
若商户未集成退款确认 SPI,平台自动执行退款给用户。
上一页
履约信息管理
下一页
本地生活商品快速接入
Built with