支付宝
  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. 口碑开店

接入指南

调用接口#

创建门店信息#

服务商/开发者可以调用 alipay.offline.material.image.upload(上传门店照片和视频接口)上传商家所需的图片和视频,调用 alipay.offline.market.shop.create(创建门店信息接口)在口碑平台帮助商家创建门店信息。

接口交互流程图#

3.png

上传门店照片#

服务商/开发者可以调用 alipay.offline.material.image.upload(上传门店照片和视频接口)上传商家所需的图片和视频。

示例代码#

//实例请求对象
AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do", APP_ID, APP_PRIVATE_KEY, "json", CHARSET, ALIPAY_PUBLIC_KEY, "RSA2"); 
//初始化请求对象实例
AlipayOfflineMaterialImageUploadRequest request = new AlipayOfflineMaterialImageUploadRequest();
//AppAuthToken的值获取方式查看第三方应用授权
request.putOtherTextParam("app_auth_token", AppAuthToken);
//图片格式
request.setImageType(imgType);
//图片名称
request.setImageName(imgName);
//图片二进制内容获取方式示例:imgContent = new FileItem("C:/Downloads/ooop6069/测试图片.jpg")
//Windows请填写绝对路径,不支持相对路径;Linux支持相对路径
request.setImageContent(imgContent);         
//初始化返回对象实例并获取返回信息
AlipayOfflineMaterialImageUploadResponse response = alipayClient.execute(request);      
//输出返回信息,开发者自行处理,此处打印实例为方便调试查看
System.out.print(response.getBody());

创建门店信息#

服务商/开发者调用 alipay.offline.market.shop.create(创建门店信息接口)在口碑平台帮助商家创建门店信息。

示例代码#

package com.java.sdk.demo;

import com.alipay.v3.ApiException;
import com.alipay.v3.ApiClient;
import com.alipay.v3.util.model.AlipayConfig;
import com.alipay.v3.Configuration;
import com.alipay.v3.api.AlipayOfflineMarketShopApi;
import com.alipay.v3.model.*;
import java.io.File;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

public class AlipayOfflineMarketShopApiCreate {

    public static void main(String[] args) throws ApiException {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // 初始化alipay参数(全局设置一次)
        AlipayConfig alipayConfig = new AlipayConfig();
        alipayConfig.setServerUrl("https://openapi.alipay.com");
        alipayConfig.setAppId("<-- 请填写您的AppId,例如:2019091767145019 -->");
        alipayConfig.setPrivateKey("<-- 请填写您的应用私钥,例如:MIIEvQIBADANB ... ... -->");
        alipayConfig.setAlipayPublicKey("<-- 请填写您的支付宝公钥,例如:MIIBIjANBg... -->");
        defaultClient.setAlipayConfig(alipayConfig);
        AlipayOfflineMarketShopApi api = new AlipayOfflineMarketShopApi();
        AlipayOfflineMarketShopCreateModel data = new AlipayOfflineMarketShopCreateModel();
        data.setMainImage("1T8Pp00AT7eo9NoAJkMR3AAAACMAAQEC");
        data.setIsvUid("2088001969784501");
        data.setContactNumber("13612344321,021-12336754");
        data.setProvinceCode("110000");
        data.setImplementId("HU002,HT002");
        data.setOpRole("ISV");
        data.setBizVersion("2.0");
        data.setLicenceExpires("2020-10-20");
        data.setBranchShopName("万塘路店");
        data.setNotifyMobile("13867498729");
        data.setNoSmoking("T");
        data.setBox("T");
        data.setBusinessCertificateExpires("2020-03-20");
        data.setIsOperatingOnline("T");
        data.setStoreId("hz001");
        data.setValueAdded("免费茶水、免费糖果");
        data.setRequestId("2015123235324534");
        data.setBrandLogo("1T8Pp00AT7eo9NoAJkMR3AAAACMAAQEC");
        data.setLicence("1T8Pp00AT7eo9NoAJkMR3AAAACMAAQEC");
        data.setLicenceName("来伊份上海分公司");
        data.setAddress("万塘路18号黄龙时代广场");
        data.setLatitude("30.548828");
        data.setWifi("T");
        data.setBrandName("肯德基");
        data.setDistrictCode("140521");
        data.setParking("F");
        data.setBusinessCertificate("1T8Pp00AT7eo9NoAJkMR3AAAACMAAQEC");
        data.setAuthLetter("1T8Pp00AT7eo9NoAJkMR3AAAACMAAQEC");
        data.setOtherAuthorization("1T8Pp00AT7eo9NoAJkMR3AAAACMAAQEC,1T8Pp00AT7eo9NoAJkMR3AAAACMAAQEC");
        data.setCityCode("140500");
        data.setLicenceCode("H001232");
        data.setCategoryId("2015050700000018");
        data.setBusinessTime("周一-周五 09:00-20:00,周六-周日 10:00-22:00");
        data.setLongitude("114.266418");
        data.setAuditImages("1T8Pp00AT7eo9NoAJkMR3AAAACMAAQEC,4Q8Pp00AT7eo9NoAJkMR3AAAACMAAUYT");
        data.setOperateNotifyUrl("http://abc.com");
        data.setOnlineUrl("http://www.******.com/shop/21831830");
        data.setMainShopName("海底捞");
        try {
            AlipayOfflineMarketShopCreateResponseModel response = api.create(data);
        } catch (ApiException e) {
            AlipayOfflineMarketShopCreateDefaultResponse errorObject = (AlipayOfflineMarketShopCreateDefaultResponse) e.getErrorObject();
            System.out.println("调用失败:" + errorObject);
        }
    }
}

查询门店类目配置#

服务商/开发者可以调用 alipay.offline.market.shop.category.query(门店类目配置查询接口) 查询可用于开店的类目,以及类目上的配置约束信息。同时也可以在 口碑类目 和 非口碑类目 表格中获取和下载。

示例代码#

package com.java.sdk.demo;

import com.alipay.v3.ApiException;
import com.alipay.v3.ApiClient;
import com.alipay.v3.util.model.AlipayConfig;
import com.alipay.v3.Configuration;
import com.alipay.v3.api.AlipayOfflineMarketShopCategoryApi;
import com.alipay.v3.model.*;
import java.io.File;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

public class AlipayOfflineMarketShopCategoryApiQuery {

    public static void main(String[] args) throws ApiException {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // 初始化alipay参数(全局设置一次)
        AlipayConfig alipayConfig = new AlipayConfig();
        alipayConfig.setServerUrl("https://openapi.alipay.com");
        alipayConfig.setAppId("<-- 请填写您的AppId,例如:2019091767145019 -->");
        alipayConfig.setPrivateKey("<-- 请填写您的应用私钥,例如:MIIEvQIBADANB ... ... -->");
        alipayConfig.setAlipayPublicKey("<-- 请填写您的支付宝公钥,例如:MIIBIjANBg... -->");
        defaultClient.setAlipayConfig(alipayConfig);
        AlipayOfflineMarketShopCategoryApi api = new AlipayOfflineMarketShopCategoryApi();
        String categoryId = "2015050700000000";
        String opRole = "ISV";
        try {
            AlipayOfflineMarketShopCategoryQueryResponseModel response = api.query(categoryId, opRole);
        } catch (ApiException e) {
            AlipayOfflineMarketShopCategoryQueryDefaultResponse errorObject = (AlipayOfflineMarketShopCategoryQueryDefaultResponse) e.getErrorObject();
            System.out.println("调用失败:" + errorObject);
        }
    }
}

接口调用说明#

以上内容中的参数值均为示例,请开发者根据实际情况配置,参数说明详情可查看 alipay.offline.market.shop.create(创建门店信息接口)。
创建请求提交后,预计一个工作日通过审核。
提高审核通过率可查看 参数展示说明及注意事项 查看相关注意事项。
operate_notify_url 门店审核状态会通过此参数值通知给开发者,详情可查看 门店审核状态。
当支付宝或商家修改了开发者创建的门店,修改信息会通过 应用网关 通知给开发者,通知内容 点此了解。
门店创建接口中的 category_id 参数,开发者可在 口碑类目 和 非口碑类目 表格中获取和下载,也可以通过 alipay.offline.market.shop.category.query(门店类目配置查询接口) 获取(鉴于此 id 会跟随业务变动,推荐调用接口方法动态获取)。
说明:
商家可在未签约/已签约当面付产品的情况给开发者授权,由开发者帮助商家创建门店。
开发者只是发起方,开发者代商家做任何操作都需要传入商家授权的 token。
如门店需要做支付,收款方也须为商家,不允许开发者收款再分给商家的形式。

修改门店信息#

服务商需要通过 alipay.offline.market.shop.modify(修改门店信息接口)在口碑平台帮助商家修改门店信息,所有的选项都为非必填项。修改门店名、品牌名、品牌 logo、首图、门店图片、营业执照、营业执照编号、营业执照名称、经营许可证、经营许可证有效期、门店授权函、是否在其它平台开店、在其它平台开店照片,会重新触发风控审核,修改其它字段不会触发风控审核。

接口交互流程#

4.png

示例代码#

package com.java.sdk.demo;

import com.alipay.v3.ApiException;
import com.alipay.v3.ApiClient;
import com.alipay.v3.util.model.AlipayConfig;
import com.alipay.v3.Configuration;
import com.alipay.v3.api.AlipayOfflineMarketShopApi;
import com.alipay.v3.model.*;
import java.io.File;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

public class AlipayOfflineMarketShopApiModify {

    public static void main(String[] args) throws ApiException {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // 初始化alipay参数(全局设置一次)
        AlipayConfig alipayConfig = new AlipayConfig();
        alipayConfig.setServerUrl("https://openapi.alipay.com");
        alipayConfig.setAppId("<-- 请填写您的AppId,例如:2019091767145019 -->");
        alipayConfig.setPrivateKey("<-- 请填写您的应用私钥,例如:MIIEvQIBADANB ... ... -->");
        alipayConfig.setAlipayPublicKey("<-- 请填写您的支付宝公钥,例如:MIIBIjANBg... -->");
        defaultClient.setAlipayConfig(alipayConfig);
        AlipayOfflineMarketShopApi api = new AlipayOfflineMarketShopApi();
        AlipayOfflineMarketShopModifyModel data = new AlipayOfflineMarketShopModifyModel();
        data.setMainImage("4G8gtQGKT7Ga1lS2_CkMBAAAACMAAQED");
        data.setContactNumber("13534567652,021-76391728");
        data.setProvinceCode("520000");
        data.setImplementId("UO001,TY002");
        data.setOpRole("ISV、PROVIDER");
        data.setBizVersion("2.0");
        data.setLicenceExpires("2020-10-20");
        data.setBranchShopName("万塘路店");
        data.setNotifyMobile("13827197382");
        data.setNoSmoking("T");
        data.setBox("T");
        data.setAvgPrice("56.73");
        data.setBusinessCertificateExpires("2020-03-20");
        data.setIsOperatingOnline("F");
        data.setStoreId("hz001");
        data.setValueAdded("免费茶水");
        data.setRequestId("20151234321423");
        data.setBrandLogo("4G8gtQGKT7Ga1lS2_CkMBAAAACMAAQED");
        data.setLicence("En00j29-TGyXNVEPXIssFQAAACMAAQED");
        data.setLicenceName("杭州市西湖区万塘路支小宝美甲店");
        data.setAddress("万塘路18号黄龙时代广场");
        data.setLatitude("27.296891");
        data.setWifi("F");
        data.setBrandName("海底捞");
        data.setShopId("2015052100077000000000120773");
        data.setDistrictCode("522401");
        data.setParking("F");
        data.setBusinessCertificate("AM-uJRh2SRKz9N0r9zW4wQAAACMAAQEC");
        data.setAuthLetter("AM-uJRh2SRKz9N0r9zW4wQAAACMAAQEC");
        data.setOtherAuthorization("1T8Pp00AT7eo9NoAJkMR3AAAACMAAQEC,1T8Pp00AT7eo9NoAJkMR3AAAACMAAQEC");
        data.setCityCode("522400");
        data.setLicenceCode("HZ001");
        data.setBusinessTime("周一-周五 09:00-20:00,周六-周日 10:00-22:00");
        data.setLongitude("105.291027");
        data.setAuditImages("02hkCZKaRgmLyirx4If6nAAAACMAAQED");
        data.setOperateNotifyUrl("http://example.com/gateway.do");
        data.setOnlineUrl("http://www.******.com/shop/21831830");
        data.setMainShopName("肯德基");
        try {
            AlipayOfflineMarketShopModifyResponseModel response = api.modify(data);
        } catch (ApiException e) {
            AlipayOfflineMarketShopModifyDefaultResponse errorObject = (AlipayOfflineMarketShopModifyDefaultResponse) e.getErrorObject();
            System.out.println("调用失败:" + errorObject);
        }
    }
}

参数说明#

修改的参数为门店名、品牌名、品牌 logo、首图、门店图片、营业执照、营业执照编号、营业执照名称、经营许可证、经营许可证有效期、门店授权函、是否在其它平台开店、在其它平台开店照片,会重新触发门店审核,开发者用 operate_notify_url 的值进行接收,通知返回详情可查看 门店审核状态通知。
如开发者需要将门店信息修改为空,可将该参数的参数值配置为 #EMPTY#,如 "avg_price":"#EMPTY#" 表示将平均消费设置为空。目前门店接口支持将参数值设置为空的参数见下表格,其它参数暂不支持。
参数名参数说明
notify_mobile门店店长电话号码
implement_id机具号
branch_shop_name分店名称
value_added门店其它服务
avg_price人均消费价格

查询单个门店信息#

服务商/开发者通过 alipay.offline.market.shop.querydetail(查询单个门店信息接口)可以查询单个门店的详细信息,包括门店基础信息、门店状态等信息。

示例代码#

package com.java.sdk.demo;

import com.alipay.v3.ApiException;
import com.alipay.v3.ApiClient;
import com.alipay.v3.util.model.AlipayConfig;
import com.alipay.v3.Configuration;
import com.alipay.v3.api.AlipayOfflineMarketShopApi;
import com.alipay.v3.model.*;
import java.io.File;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

public class AlipayOfflineMarketShopApiQuerydetail {

    public static void main(String[] args) throws ApiException {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // 初始化alipay参数(全局设置一次)
        AlipayConfig alipayConfig = new AlipayConfig();
        alipayConfig.setServerUrl("https://openapi.alipay.com");
        alipayConfig.setAppId("<-- 请填写您的AppId,例如:2019091767145019 -->");
        alipayConfig.setPrivateKey("<-- 请填写您的应用私钥,例如:MIIEvQIBADANB ... ... -->");
        alipayConfig.setAlipayPublicKey("<-- 请填写您的支付宝公钥,例如:MIIBIjANBg... -->");
        defaultClient.setAlipayConfig(alipayConfig);
        AlipayOfflineMarketShopApi api = new AlipayOfflineMarketShopApi();
        String shopId = "2015052100077000000000120773";
        String opRole = "MERCHANT或PROVIDER";
        try {
            AlipayOfflineMarketShopQuerydetailResponseModel response = api.querydetail(shopId, opRole);
        } catch (ApiException e) {
            AlipayOfflineMarketShopQuerydetailDefaultResponse errorObject = (AlipayOfflineMarketShopQuerydetailDefaultResponse) e.getErrorObject();
            System.out.println("调用失败:" + errorObject);
        }
    }
}

查询商户的门店编号列表#

服务商/开发者可以调用 alipay.offline.market.shop.batchquery(查询商户的门店编号列表接口)快速查询对应 APPID 下所有的门店编号。

示例代码#

package com.java.sdk.demo;

import com.alipay.v3.ApiException;
import com.alipay.v3.ApiClient;
import com.alipay.v3.util.model.AlipayConfig;
import com.alipay.v3.Configuration;
import com.alipay.v3.api.AlipayOfflineMarketShopApi;
import com.alipay.v3.model.*;
import java.io.File;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

public class AlipayOfflineMarketShopApiBatchquery {

    public static void main(String[] args) throws ApiException {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // 初始化alipay参数(全局设置一次)
        AlipayConfig alipayConfig = new AlipayConfig();
        alipayConfig.setServerUrl("https://openapi.alipay.com");
        alipayConfig.setAppId("<-- 请填写您的AppId,例如:2019091767145019 -->");
        alipayConfig.setPrivateKey("<-- 请填写您的应用私钥,例如:MIIEvQIBADANB ... ... -->");
        alipayConfig.setAlipayPublicKey("<-- 请填写您的支付宝公钥,例如:MIIBIjANBg... -->");
        defaultClient.setAlipayConfig(alipayConfig);
        AlipayOfflineMarketShopApi api = new AlipayOfflineMarketShopApi();
        AlipayOfflineMarketShopBatchqueryModel data = new AlipayOfflineMarketShopBatchqueryModel();
        data.setPageNo("1");
        data.setBizChannel("POS、ALL");
        try {
            AlipayOfflineMarketShopBatchqueryResponseModel response = api.batchquery(data);
        } catch (ApiException e) {
            AlipayOfflineMarketShopBatchqueryDefaultResponse errorObject = (AlipayOfflineMarketShopBatchqueryDefaultResponse) e.getErrorObject();
            System.out.println("调用失败:" + errorObject);
        }
    }
}

门店摘要信息批量查询#

服务商/开发者可以调用 alipay.offline.market.shop.summary.batchquery(门店摘要信息批量查询接口)进行门店摘要信息批量查询。

示例代码#

package com.java.sdk.demo;

import com.alipay.v3.ApiException;
import com.alipay.v3.ApiClient;
import com.alipay.v3.util.model.AlipayConfig;
import com.alipay.v3.Configuration;
import com.alipay.v3.api.AlipayOfflineMarketShopSummaryApi;
import com.alipay.v3.model.*;
import java.io.File;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

public class AlipayOfflineMarketShopSummaryApiBatchquery {

    public static void main(String[] args) throws ApiException {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // 初始化alipay参数(全局设置一次)
        AlipayConfig alipayConfig = new AlipayConfig();
        alipayConfig.setServerUrl("https://openapi.alipay.com");
        alipayConfig.setAppId("<-- 请填写您的AppId,例如:2019091767145019 -->");
        alipayConfig.setPrivateKey("<-- 请填写您的应用私钥,例如:MIIEvQIBADANB ... ... -->");
        alipayConfig.setAlipayPublicKey("<-- 请填写您的支付宝公钥,例如:MIIBIjANBg... -->");
        defaultClient.setAlipayConfig(alipayConfig);
        AlipayOfflineMarketShopSummaryApi api = new AlipayOfflineMarketShopSummaryApi();
        AlipayOfflineMarketShopSummaryBatchqueryModel data = new AlipayOfflineMarketShopSummaryBatchqueryModel();
        data.setDistrictCode("120104");
        data.setShopStatus("PAUSED");
        data.setPageNo(1);
        data.setPageSize(20);
        data.setRelatedPartnerId("2088001969784501");
        data.setBizChannel("POS、ALL");
        data.setCityCode("120100");
        data.setProvinceCode("120000");
        data.setOpRole("ISV、PROVIDER");
        data.setQueryType("BRAND_RELATION");
        data.setBrandName("麦当劳");
        data.setShopId("2015062100077000000000120773");
        try {
            AlipayOfflineMarketShopSummaryBatchqueryResponseModel response = api.batchquery(data);
        } catch (ApiException e) {
            AlipayOfflineMarketShopSummaryBatchqueryDefaultResponse errorObject = (AlipayOfflineMarketShopSummaryBatchqueryDefaultResponse) e.getErrorObject();
            System.out.println("调用失败:" + errorObject);
        }
    }
}

业务流水批量查询#

服务商/开发者通过 alipay.offline.market.applyorder.batchquery(业务流水批量查询接口)可分页查询 Leads、门店、商品相关操作流水信息。

示例代码#

package com.java.sdk.demo;

import com.alipay.v3.ApiException;
import com.alipay.v3.ApiClient;
import com.alipay.v3.util.model.AlipayConfig;
import com.alipay.v3.Configuration;
import com.alipay.v3.api.AlipayOfflineMarketApplyorderApi;
import com.alipay.v3.model.*;
import java.io.File;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

public class AlipayOfflineMarketApplyorderApiBatchquery {

    public static void main(String[] args) throws ApiException {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // 初始化alipay参数(全局设置一次)
        AlipayConfig alipayConfig = new AlipayConfig();
        alipayConfig.setServerUrl("https://openapi.alipay.com");
        alipayConfig.setAppId("<-- 请填写您的AppId,例如:2019091767145019 -->");
        alipayConfig.setPrivateKey("<-- 请填写您的应用私钥,例如:MIIEvQIBADANB ... ... -->");
        alipayConfig.setAlipayPublicKey("<-- 请填写您的支付宝公钥,例如:MIIBIjANBg... -->");
        defaultClient.setAlipayConfig(alipayConfig);
        AlipayOfflineMarketApplyorderApi api = new AlipayOfflineMarketApplyorderApi();
        AlipayOfflineMarketApplyorderBatchqueryModel data = new AlipayOfflineMarketApplyorderBatchqueryModel();
        data.setBizType("SHOP");
        data.setPageNo(1);
        data.setPageSize(20);
        List<String> requestIds = new ArrayList<String>();
        requestIds.add("2015123235324534,2015123235324535");
        data.setRequestIds(requestIds);
        data.setStartTime("2015-10-27 10:51:57");
        data.setAction("CREATE_SHOP");
        List<String> applyIds = new ArrayList<String>();
        applyIds.add("2015052100077000000000120773,2015052100077000000000120774");
        data.setApplyIds(applyIds);
        data.setBizId("2015052100077000000000120774");
        data.setOpRole("ISV");
        data.setOpId("2088001969784501");
        data.setStatus("FAIL");
        data.setEndTime("2015-10-29 10:51:57");
        try {
            AlipayOfflineMarketApplyorderBatchqueryResponseModel response = api.batchquery(data);
        } catch (ApiException e) {
            AlipayOfflineMarketApplyorderBatchqueryDefaultResponse errorObject = (AlipayOfflineMarketApplyorderBatchqueryDefaultResponse) e.getErrorObject();
            System.out.println("调用失败:" + errorObject);
        }
    }
}

门店参数展示说明及注意点#

品牌#

通过输入品牌名,可以搜索到相关品牌。
如果搜索不到匹配的品牌,则自动归类为 其它品牌。

品牌 Logo#

品牌 Logo 的尺寸建议为 500px*500px。
相同品牌的门店可以上传同一张品牌 Logo 图片。
品牌 Logo 在支付宝客户端的 支付宝 Tab 中的卡券中有露出,入口及效果详见下图:
5.jpeg

门店名称#

门店名称分为两部分,主店名及分店名,主店名如 海底捞,分店名如 万塘路店。对于只有一个门店的商家而言,可以不填写分店名。
门店名称在支付宝客户端的 口碑 Tab 里有多处展现,是一个非常重要的字段,请务必确保填写正确,如下图所示:
6.png

门店地址#

含经纬度,高德坐标,经纬度需要开发者帮助商家校准。
7.png

电话#

该字段在支付宝客户端的 口碑 Tab 中的商家详情有所展现,用户点击该按钮后可以拨通电话。
手机号为内部管理员手机号,不在客户端展示。
8.png

品类#

即当前门店属于什么类别,对应创建门店中类目 category_id。
9.png
在支付宝客户端 商家 Tab 中,品类的 二级类目 将作为一个搜索过滤条件供用户选择,商家在后台为门店选择的品类。
10.png

门店首图#

门店首图是至关重要的一张图片,在支付宝客户端有大量的展现,可首选优质菜品图、优质门店图作为首图,建议尺寸 2000px*1500px,首图会在支付宝移动端中重点展示。封面照片在支付宝客户端展现如下:
11.png

门店照片#

至少选择三张照片(门头照片及内景照片),建议图片分辨率 2000px*1500px 及以上,更容易通过审核。
丽人行业用于审核的图片会展示在商家相册的 环境 相册中。
**收款账号:**开发者不能设置商户门店的收款账号,收款账号默认为签约的支付宝账号。

门店编号#

门店编号指该门店在开发者系统中的门店编号,在收单请求中传入该参数用于查询支付宝端对应的门店。
对于收银系统直接打通的商户,填写门店编号,门店编号支持中文、英文以及其它符号。

营业时间#

选填,支持多个时间段,或者 24 小时。

提供服务#

选填,支持多选,需要按照商户的实际情况填写。

更多服务#

选填,支持换行,需要按照商户的实际情况填写。

人均价格#

选填,商户填写的人均消费价格,需要尽量准确,只支持整数,最大不超过99999。

接口调用结果码说明#

同步返回结果码描述
10000业务处理成功。
40001~40006业务处理失败。具体失败原因请查看 公共错误码。其它请查看对应 API 文档。
20000业务出现未知错误或者系统异常。业务出现未知错误或者系统异常(请一定要在确定本次调用结果后,再发起重试),可调用查询接口发起查询确定结果。

关于沙箱#

如何接入沙箱#

沙箱是开放平台提供给开发者用户调试接口的环境,详情可查看 沙箱接入指南。

口碑开店沙箱接入注意事项#

口碑开店支持沙箱接入。在沙箱调通接口后,必须在线上进行测试与验收,所有返回码及业务逻辑以线上为准。
alipay.offline.market.applyorder.batchquery(业务流水批量查询接口),请求时带上 apply_ids 参数。
可登录支付宝 开放平台 使用沙箱 口碑门店账号&二维码转换工具,通过支付宝沙箱版客户端的扫一扫功能,进入商家详情页,查看门店效果。
沙箱测试创建门店,推荐使用北京、上海、杭州三个城市在 国家统计局 中有的区域进行测试,如遇到区域不存在的情况,请更换区域调试。
上一页
接入准备
下一页
设置/修改门店收款账号
Built with