支付宝
  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. 相关资料

Schema 规则介绍

服务 Schema 体系说明#

一个标准化服务由若干的 Attribute 属性组成,属性描述服务需要的字段和对应的规则,Schema 结构如下:
image

Attribute 定义#

id:服务属性 ID,例如服务名称:id="serviceName"。
name:属性名称,例如name="服务名称"。
type:属性的类型,目前包含:
single:单值类型。
multi:多值类型。
complex:符合类型。
multiComplex:多组符合。
valueType:属性值类型,目前包含:
text:文本。
bollean:布尔。
numeric:数据类型。
enum:枚举,有对应的可选项 options。
object:对象,有子属性的属性,例如 multi 和 multiComplex。
options:枚举类型属性可选项。
rule:属性规则,描述属性值的规则。
name:规则名称。
value:规则内容。
type:规则类型,目前包含如下类型:
required:是否必填,true:必填;false:非必填。
maxLength:文本类型值最大字符数。
minLength:文本类型最小字符数。
exclusiveMaximum:最大值,包含最大值,即 <=。
exclusiveMinimum:最小值,包含最小值,即 >=。
maxValue:最大值,不包含最大值,即 <。
minValue:最小值,不包含最小值,即 >。
maxSize:最大个数,针对枚举类型。
minSize:最小个数,针对枚举类型。
precision:数据类型经度。
devTips:开发帮助提示,规则无法表达时会使用此规则。

示例#

single(单值属性类型)#

<attribute id="serviceName" name="服务名称" type="single" valueType="text">
    <value/>
    <rules>
      <rule type="maxLength" name="最大长度" value="15"/>
      <rule type="minLength" name="最小长度" value="2"/>
      <rule type="required" name="必填" value="true"/>
      <rule type="pattern" name="正则表达式" value="[\\u4E00-\\u9FA5A-Za-z0-9_+\\-()()]+"/>
      <rule type="devTip" name="开发者提示" value="字数限制2~15个字填写格式:可以由中文、数字、英文、下划线、+、-组成 审核提醒: 1.服务名称代表小程序内的某个功能或一类服务,服务名称不可重复且需代表不同的功能 2.服务名称不可与小程序名称重复 3.二级服务需要与小程序本身提供的服务相关,如租赁类小程序的服务名称需要与租赁服务有关"/>
    </rules>
</attribute>

multi(多值属性类型)#

<attribute id="area" name="服务区域" type="multi" valueType="text">
    <values/>
    <rules>
      <rule type="devTip" name="开发者提示" value="传值为字符串List,6位行政区编码,可以填省或者市或者区,全国填1,可以填多个;如果一个省下面所有的市都支持,则填写省的行政编码即可;举例:服务覆盖区域包含浙江省,江苏苏州和太仓。"/>
      <rule type="maxSize" name="最大条目数" value="256"/>
      <rule type="minSize" name="最小条目数" value="1"/>
      <rule type="required" name="必填" value="true"/>
    </rules>
</attribute>

complex(复合类型)#

<attribute id="businessHours" name="营业时间" type="complex" valueType="object">
        <attributes>
            <attribute id="startHour" name="开始时间" type="single" valueType="text">
                <rules>
                    <rule type="required" name="是否必填" value="true"/>
                    <rule type="pattern" name="正则表达式" value="([0-1][0-9]|2[0-3]):([0-5][0-9])"/>
                </rules>
                <value/>
            </attribute>
            <attribute id="closeHour" name="结束时间" type="single" valueType="text">
                <rules>
                    <rule type="required" name="是否必填" value="true"/>
                    <rule type="pattern" name="正则表达式" value="([0-1][0-9]|2[0-3]):([0-5][0-9])"/>
                </rules>
                <value/>
            </attribute>

multiComplex(多组复合类型)#

多组符合属性,一个 attributes 的属性就是一组,如果有多组,上报时需要多个 attributes。
<attribute id="serviceUrl" name="服务链接" type="multiComplex" valueType="object">
    <attributes>
      <attribute id="carrierType" name="载体类型" type="single" valueType="enum">
        <rules>
          <rule type="required" name="必填" value="true"/>
          <rule type="maxSize" name="最大条目数" value="1"/>
          <rule type="minSize" name="最小条目数" value="1"/>
        </rules>
        <options>
          <option displayName="支付宝小程序" value="SC_MINI_APP"/>
          <option displayName="高德小程序" value="AMAP_MINI_APP"/>
          <option displayName="UC小程序地址" value="UC_MINI_APP"/>
          <option displayName="夸克小程序地址" value="QUARK_MINI_APP"/>
        </options>
        <value/>
      </attribute>
      <attribute id="carrierUrl" name="载体url" type="single" valueType="text">
        <rules>
          <rule type="required" name="必填" value="true"/>
        </rules>
        <value/>
      </attribute>
    </attributes>
  </attribute>
<attribute id="poi" name="poi信息" type="multiComplex" valueType="object">
        <attributes>
            <attribute id="shopId" name="门店ID" type="single" valueType="text">
                <rules>
                    <rule type="required" name="是否必填" value="false"/>
                    <rule type="devTip" name="开发者提示" value="如果服务对应的门店已创建过支付宝门店(https://opendocs.alipay.com/mini/0149jo),可以只传对应的shopID;门店ID和(门店名称+城市码+地址)二选一。"/>
                </rules>
                <value/>
            </attribute>
            <attribute id="poiName" name="门店名称" type="single" valueType="text">
                <rules>
                    <rule type="required" name="是否必填" value="false"/>
                    <rule type="devTip" name="开发者提示" value="服务对应的线下门店名称,需要填写标准,门店ID和(门店名称+城市码+地址)二选一。"/>
                </rules>
                <value/>
            </attribute>
            <attribute id="address" name="地址" type="single" valueType="text">
                <rules>
                    <rule type="required" name="是否必填" value="false"/>
                    <rule type="devTip" name="开发者提示" value="服门店详细地址,具体到门牌号,支付宝测会基于这个信息去高德转换经纬度信息,需要填写标准,门店ID和(门店名称+城市码+地址)二选一。"/>
                </rules>
                <value/>
            </attribute>
            <attribute id="cityCode" name="城市码" type="single" valueType="text">
                <rules>
                    <rule type="required" name="是否必填" value="false"/>
                    <rule type="devTip" name="开发者提示" value="服务对应线下门店所属城市6位行政编码,门店ID和(门店名称+城市码+地址)二选一。"/>
                </rules>
                <value/>
            </attribute>
            <attribute id="poiCarrierType" name="载体类型" type="single" valueType="enum">
                <rules>
                    <rule type="required" name="是否必填" value="false"/>
                    <rule type="maxSize" name="最大条目数" value="1"/>
                    <rule type="minSize" name="最小条目数" value="1"/>
                </rules>
                <options>
                    <option displayName="支付宝小程序" value="SC_MINI_APP"/>
                    <option displayName="高德小程序" value="AMAP_MINI_APP"/>
                    <option displayName="UC小程序地址" value="UC_MINI_APP"/>
                    <option displayName="夸克小程序地址" value="QUARK_MINI_APP"/>
                </options>
                <value/>
            </attribute>
            <attribute id="poiCarrierUrl" name="载体url" type="single" valueType="text">
                <rules>
                    <rule type="required" name="是否必填" value="false"/>
                    <rule type="devTip" name="开发者提示" value="1.支付宝小程序链接格式为alipays://platformapi/startapp?appId=2019042063892039&amp;amp;page=pages/home&amp;amp;query=class_id=0,其中alipays://platformapi/startapp?appId=为固定值,appId为服务所属小程序的APPID,若跳转时需携带参数可用 &amp;amp;query=a=1&amp;amp;b=2 方式拼接传递。 2.载体链接必须为小程序内的链接且唯一。"/>
                </rules>
                <value/>
            </attribute>
        </attributes>
    </attribute>

完整的 Schema 示例#

开发者通过 alipay.open.app.service.schema.query(服务schema下发接口)查询查询获取的特定类型的服务声明(即支付宝要求开发者向支付宝平台提报的服务元数据列表)。
<?xml version="1.0" encoding="utf-8"?>
<serviceSchema>
  <attribute id="serviceName" name="服务名称" type="single" valueType="text">
    <value/>
    <rules>
      <rule type="required" name="必填" value="true"/>
      <rule type="maxLength" name="最大长度" value="15"/>
      <rule type="minLength" name="最小长度" value="2"/>
      <rule type="pattern" name="正则表达式" value="[\\u4E00-\\u9FA5A-Za-z0-9_+\\-()()]+"/>
      <rule type="devTip" name="开发者提示" value="字数限制2~15个字填写格式:可以由中文、数字、英文、下划线、+、-组成 审核提醒: 1.服务名称代表小程序内的某个功能或服务,服务名称不可重复且需代表不同的功能 2.服务名称不可与小程序名称重复 3.服务名称需要与小程序本身提供的服务相关,如租赁类小程序的服务名称需要与租赁服务有关"/>
    </rules>
  </attribute>
  <attribute id="serviceDesc" name="服务描述" type="single" valueType="text">
    <value/>
    <rules>
      <rule type="required" name="必填" value="true"/>
      <rule type="maxLength" name="最大长度" value="100"/>
      <rule type="minLength" name="最小长度" value="5"/>
      <rule type="devTip" name="开发者提示" value="请描述具体的服务内容,字数限制为5-100字审核提醒: 1.要清楚介绍服务功能,例如提供了什么功能,便于通过审核 2.请不要填写无意义的内容3.请不要出现向外部应用引流的文案"/>
    </rules>
  </attribute>
  <attribute id="serviceUrl" name="服务链接" type="multiComplex" valueType="object">
    <attributes>
      <attribute id="carrierType" name="载体类型" type="single" valueType="enum">
        <rules>
          <rule type="required" name="必填" value="true"/>
          <rule type="maxSize" name="最大条目数" value="1"/>
          <rule type="minSize" name="最小条目数" value="1"/>
        </rules>
        <options>
          <option displayName="支付宝小程序" value="SC_MINI_APP"/>
          <option displayName="高德小程序" value="AMAP_MINI_APP"/>
          <option displayName="UC小程序地址" value="UC_MINI_APP"/>
          <option displayName="夸克小程序地址" value="QUARK_MINI_APP"/>
        </options>
        <value/>
      </attribute>
      <attribute id="carrierUrl" name="载体url" type="single" valueType="text">
        <rules>
          <rule type="required" name="必填" value="true"/>
        </rules>
        <value/>
      </attribute>
    </attributes>
  </attribute>
  <attribute id="poi" name="poi信息" type="complex" valueType="object">
    <attributes>
      <attribute id="poiName" name="门店名称" type="single" valueType="text">
        <rules>
          <rule type="required" name="必填" value="false"/>
          <rule type="devTip" name="开发者提示" value="服务对应的线下门店名称,需要填写标准"/>
        </rules>
        <value/>
      </attribute>
      <attribute id="shopId" name="门店ID" type="single" valueType="text">
        <rules>
          <rule type="required" name="必填" value="false"/>
          <rule type="devTip" name="开发者提示" value="服务对应的线下门店id,通过支付宝门店创建接口ant.merchant.expand.shop.create创建门店后唯一标识,如果已经创建则填对应的shopId"/>
        </rules>
        <value/>
      </attribute>
      <attribute id="address" name="地址" type="single" valueType="text">
        <rules>
          <rule type="required" name="必填" value="false"/>
          <rule type="devTip" name="开发者提示" value="服门店详细地址,具体到门牌号,支付宝测会基于这个信息去高德转换经纬度信息,需要填写标准"/>
        </rules>
        <value/>
      </attribute>
      <attribute id="cityCode" name="城市码" type="single" valueType="text">
        <rules>
          <rule type="required" name="必填" value="false"/>
          <rule type="devTip" name="开发者提示" value="服务对应线下门店所属城市6位行政编码"/>
        </rules>
        <value/>
      </attribute>
    </attributes>
    <rules>
      <rule type="devTip" name="开发者提示" value="门店id和(adress+门店名称+cityCode)二选一,有门店id传shopId,没有门店id就填门店详细地址adress;如果选择adress,对应的门店名称和门店所在城市码必须传"/>
      <rule type="required" name="必填" value="true"/>
      <rule type="maxSize" name="最大条目数" value="1"/>
      <rule type="minSize" name="最小条目数" value="1"/>
    </rules>
  </attribute>
  <attribute id="businessHours" name="营业时间" type="complex" valueType="object">
    <attributes>
      <attribute id="startHour" name="开始时间" type="single" valueType="text">
        <rules>
          <rule type="required" name="必填" value="true"/>
          <rule type="pattern" name="正则表达式" value="([0-1][0-9]|2[0-3]):([0-5][0-9])"/>
        </rules>
        <value/>
      </attribute>
      <attribute id="closeHour" name="结束时间" type="single" valueType="text">
        <rules>
          <rule type="required" name="必填" value="true"/>
          <rule type="pattern" name="正则表达式" value="([0-1][0-9]|2[0-3]):([0-5][0-9])"/>
        </rules>
        <value/>
      </attribute>
      <attribute id="weekDays" name="周几" type="multi" valueType="enum">
        <rules>
          <rule type="maxSize" name="最大条目数" value="7"/>
          <rule type="minSize" name="最小条目数" value="1"/>
          <rule type="required" name="必填" value="true"/>
        </rules>
        <options>
          <option displayName="周一" value="monday"/>
          <option displayName="周二" value="tuesday"/>
          <option displayName="周三" value="wednesday"/>
          <option displayName="周四" value="thursday"/>
          <option displayName="周五" value="friday"/>
          <option displayName="周六" value="saturday"/>
          <option displayName="周日" value="sunday"/>
        </options>
        <values/>
      </attribute>
    </attributes>
    <rules>
      <rule type="required" name="必填" value="true"/>
      <rule type="devTip" name="开发者提示" value="请严格按照,weekDays请输入monday,tuesday,wednesday,thursday,friday,saturday,sunday的集合,startHour中是开始时间(格式例09:00),closeHour是结束时间(格式例09:00)"/>
      <rule type="maxSize" name="最大条目数" value="1"/>
      <rule type="minSize" name="最小条目数" value="0"/>
    </rules>
  </attribute>
  <attribute id="A2021031700370062" name="品牌名称" type="single" valueType="text">
    <value/>
    <rules>
      <rule type="required" name="必填" value="true"/>
      <rule type="maxLength" name="最大长度" value="20"/>
      <rule type="minLength" name="最小长度" value="1"/>
    </rules>
  </attribute>
  <attribute id="contactTele" name="门店电话" type="single" valueType="text">
    <value/>
    <rules>
      <rule type="required" name="必填" value="true"/>
      <rule type="pattern" name="正则表达式" value="1[3-9]\\d{9}|0\\d{2,3}-[1-9]\\d{6,7}-?\\d{0,10}"/>
      <rule type="devTip" name="开发者提示" value="请输入合法的手机号码或者固定号码,其中固定号码的区号3到4位,电话7到8位,分机号选填(例:固定电话:0834-1133567   或者 0834-1133567-1234 "/>
    </rules>
  </attribute>
</serviceSchema>

完整提报服务内容示例#

开发者根据 Schema 规范,通过 alipay.open.app.service.apply(服务提报申请接口)向支付宝提交的一个具体的服务基本数据信息。
<?xml version="1.0" encoding="utf-8"?>
<serviceSchema> 
  <attribute id="serviceName" name="服务名称" type="single" valueType="text"> 
    <value>服务提报demo</value> 
  </attribute>  
  <attribute id="serviceDesc" name="服务描述" type="single" valueType="text"> 
    <value>服务提报demo</value> 
  </attribute>  
  <attribute id="serviceUrl" name="服务链接" type="multiComplex" valueType="object"> 
    <attributes> 
      <attribute id="carrierType" name="载体类型" type="single" valueType="enum"> 
        <value>SC_MINI_APP</value> 
      </attribute>  
      <attribute id="carrierUrl" name="载体url" type="single" valueType="text"> 
        <value>alipays://platformapi/startapp?appId=2018999902363017&amp;b=1</value> 
      </attribute> 
    </attributes>  
    <attributes> 
      <attribute id="carrierType" name="载体类型" type="single" valueType="enum"> 
        <value>AMAP_MINI_APP</value> 
      </attribute>  
      <attribute id="carrierUrl" name="载体url" type="single" valueType="text"> 
        <value>amapuri://applets/platformapi/startapp?appId=2019042363892048&amp;213</value> 
      </attribute> 
    </attributes> 
  </attribute>  
  <attribute id="poi" name="poi信息" type="complex" valueType="object"> 
    <attributes> 
      <attribute id="shopId" name="门店ID" type="single" valueType="text"> 
        <value/> 
      </attribute>  
      <attribute id="poiName" name="门店名称" type="single" valueType="text"> 
        <value>测试门店名称</value> 
      </attribute>  
      <attribute id="address" name="地址" type="single" valueType="text"> 
        <value>文三路18号</value> 
      </attribute>  
      <attribute id="cityCode" name="城市码" type="single" valueType="text"> 
        <value>330100</value> 
      </attribute> 
    </attributes> 
  </attribute>  
  <attribute id="businessHours" name="营业时间" type="complex" valueType="object"> 
    <attributes> 
      <attribute id="startHour" name="开始时间" type="single" valueType="text"> 
        <value>09:00</value> 
      </attribute>  
      <attribute id="closeHour" name="结束时间" type="single" valueType="text"> 
        <value>23:00</value> 
      </attribute>  
      <attribute id="weekDays" name="周几" type="multi" valueType="enum"> 
        <values> 
          <value>monday</value> 
        </values> 
      </attribute> 
    </attributes> 
  </attribute>  
  <attribute id="A2021031700370062" name="品牌名称" type="single" valueType="text"> 
    <value>支付宝</value> 
  </attribute>  
  <attribute id="contactTele" name="门店电话" type="single" valueType="text"> 
    <value>13566666666</value> 
  </attribute> 
</serviceSchema>

提报服务 SDK#

因支付宝提报服务采用 Schema 体系,如果开发者直接使用 DoM4j 或其它工具操作 XML 成本较高,特提供了 Java、PHP 版本 SDK,协助开发者完成 XML 文件的拼装,提升开发者的集成效率。
Java SDK 主要提供 XML 文件和基于 Map 的 K-V 键值对转换,方便开发者快速从 XML 文件中提取服务 Schema 中约定的 K-V 对,或通过 Map 快速拼装符合 Schema 规范的 XML 片段。
image

SDK 提供的主要接口#

Java 示例#

schema xml 文本反序列化属性列表#

List<Attribute> ServiceSchemaReader.readXmlForList(String schemaXml)
//基于xml格式的的服务schema解析成服务属性模型列表

schema xml 文件反序列化属性列表#

List<Attribute> ServiceSchemaReader.readXmlForList(File xmlfile)
//读取本地服务schema xml文件并解析成属性模型列表

schema xml 文本反序列化属性 Map#

Map<String,Attribute> ServiceSchemaReader.readXmlForMap(String schemaXml)
//基于xml格式的服务schema字符串解析成服务属性列表,Map的key为属性id

schema xml 文件反序列化属性 Map#

Map<String,Attribute> ServiceSchemaReader.readXmlForMap(File xmlfile)
//读取本地服务schema xml文件并解析成服务属性列表,Map的key为属性id

属性列表序列化服务 schema xml 文本#

String ServiceSchemaWriter.writeSchemaXmlString(List<Attribute> attributes)
//将构建好的服务属性列表序列化成服务schema xml字符串

PHP 示例#

schema xml 文本反序列化属性列表#

<?php
//基于xml格式的的服务schema解析成服务属性模型数组(数组的key为属性id)
public static function readXmlForArrayByFile($filePath)
//读取本地服务schema xml文件并解析成属性模型数组(数组的key为属性id)
public static function readXmlForArrayByString($xmlString)
  
?>

属性列表序列化服务 schema xml 文本#

<?php
//将构建好的服务属性数组序列化成服务schema xml字符串
public static function writeSchemaXmlString(array $attributesArr)
//将构建好的服务属性数组序列化成服务schema xml字符串(含<rules>和<options>标签)
public static function writeFullchemaXmlString(array $attributesArr)  
?>

集成 SDK#

Java SDK#

如果开发者采用 Java 技术栈并使用 Maven 进行 JAR 文件的依赖管理,可直接引入如下依赖即可引入 SDK。
<dependency>
    <groupId>com.alipay.sdk</groupId>
    <artifactId>alipay-sdk-java</artifactId>
    <version>4.13.32.ALL</version>
</dependency>
如果开发者没有使用 Maven,可直接 下载 JAR 文件 ,并导入本地即可。

PHP SDK#

如果开发者采用 PHP 进行开发,可前往 GitHub 项目主页 下载 PHP SDK。
**说明:**适用于 PHP 5.5 以上的开发环境。

SDK 使用 Demo#

Java 示例#

single 类型#

Map<String,Attribute> attributeMap = ServiceSchemaReader.readXmlForMap(serviceSchema);
 SingleAttribute serviceName = (SingleAttribute) attributeMap.get("serviceName");
 serviceName.setValue("饿了么外卖");

multi 类型#

MultiAttribute area = (MultiAttribute) attributeMap.get("area");
 List<String> areaCodes = new ArrayList<>();
 areaCodes.add("330100");
 area.setValues(areaCodes);

complex 类型#

ComplexAttribute businessHours = (ComplexAttribute) attributeMap.get("businessHours");
List<Attribute> attributes = businessHours.getAttributes();
Map<String, Attribute> businessHoursAttributes = attributes.stream()
    .collect(Collectors.toMap(Attribute::getId, attribute -> attribute));
SingleAttribute startHour = (SingleAttribute) businessHoursAttributes.get("startHour");
startHour.setValue("08:00");
SingleAttribute closeHour = (SingleAttribute) businessHoursAttributes.get("closeHour");
closeHour.setValue("20:00");
MultiAttribute weekDays = (MultiAttribute) businessHoursAttributes.get("weekDays");
weekDays.setValues(Lists.newArrayList("monday", "tuesday", "wednesday"));

multiComplex 类型#

MultiComplexAttribute serviceUrl = (MultiComplexAttribute) attributeMap.get("serviceUrl");
 List<ComplexAttribute> serviceUrlAttributes = new ArrayList<>();
 //支付宝小程序
 ComplexAttribute serviceUrl1 = serviceUrl.cloneAttribute();
 Map<String, Attribute> serviceUrlAttr1 = serviceUrl1.getAttributes().stream()
            .collect(Collectors.toMap(Attribute::getId, attribute -> attribute));
 SingleAttribute carrierType1 = (SingleAttribute) serviceUrlAttr1.get("carrierType");
 carrierType1.setValue("SC_MINI_APP");
 SingleAttribute carrierUrl1 = (SingleAttribute) serviceUrlAttr1.get("carrierUrl");
 carrierUrl1.setValue("alipays://platformapi/startapp?appId=2019071065847105&amp;chInfo=ch_bill");
 serviceUrlAttributes.add(serviceUrl1);
 //高德小程序
 ComplexAttribute serviceUrl2 = serviceUrl.cloneAttribute();
 Map<String, Attribute> serviceUrlAttrs2 = serviceUrl2.getAttributes().stream()
            .collect(Collectors.toMap(Attribute::getId, attribute -> attribute));
 SingleAttribute carrierType2 = (SingleAttribute) serviceUrlAttrs2.get("carrierType");
 carrierType2.setValue("AMAP_MINI_APP");
 SingleAttribute carrierUrl2 = (SingleAttribute) serviceUrlAttrs2.get("carrierUrl");
 carrierUrl2.setValue("amapuri://applets/platformapi/startapp?appId=2019042363892048&amp;213");
 serviceUrlAttributes.add(serviceUrl2);
 serviceUrl.setAttributes(serviceUrlAttributes);
Map<String, Attribute> attributeMap = new HashMap<>();
MultiComplexAttribute poi = (MultiComplexAttribute) attributeMap.get("poi");
List<ComplexAttribute> poiAttributes = new ArrayList<>();
//poi1
ComplexAttribute poi1 = poi.cloneAttribute();
Map<String, Attribute> poiAttr1 = poi1.getAttributes().stream()
    .collect(Collectors.toMap(Attribute::getId, attribute -> attribute));
SingleAttribute poiName1 = (SingleAttribute) poiAttr1.get("poiName");
poiName1.setValue("肯德基文三路店");
SingleAttribute adress1 = (SingleAttribute) poiAttr1.get("address");
adress1.setValue("文三路478号华星时代广场C座1层");
SingleAttribute cityCode1 = (SingleAttribute) poiAttr1.get("cityCode");
cityCode1.setValue("330100");//杭州市编码
poiAttributes.add(poi1);
//poi2
ComplexAttribute poi2 = poi.cloneAttribute();
Map<String, Attribute> poiAttr2 = poi2.getAttributes().stream()
    .collect(Collectors.toMap(Attribute::getId, attribute -> attribute));
SingleAttribute poiName2 = (SingleAttribute) poiAttr2.get("poiName");
poiName2.setValue("麦当劳(杭州西湖银泰店)");
SingleAttribute adress2 = (SingleAttribute) poiAttr2.get("address");
adress2.setValue("延安路98号西湖银泰一楼L1-96号商铺(近吴山广场)");
SingleAttribute cityCode2 = (SingleAttribute) poiAttr2.get("cityCode");
cityCode2.setValue("330100");//杭州市编码
poiAttributes.add(poi2);
poi.setAttributes(poiAttributes);

PHP 示例#

single 类型#

<?php
$result = ServiceSchemaReader::readXmlForArrayByString($xml_string);
$result['serviceName']>setValues("饿了么外卖");
?>

multi 类型#

<?php
$result = ServiceSchemaReader::readXmlForArrayByString($xml_string);
$result['area']>setValues(array("330100"));
?>

complex 类型#

<?php
$result = ServiceSchemaReader::readXmlForArrayByString($xml_string);
foreach ($result['poi']->getValues() as $attr){
  if($attr->getId() == 'poiName'){
    $attr->setValues('肯德基文三路店');
  }elseif ($attr->getId() == 'address'){
    $attr->setValues('文三路478号华星时代广场C座1层');
  }elseif ($attr->getId() == 'cityCode'){
    $attr->setValues('330100');
  }
}
?>

multiComplex 类型#

<?php
$result = ServiceSchemaReader::readXmlForArrayByString($xml_string);
foreach ($result['serviceUrl']->getValues() as $item){
  foreach ($item->getValues() as $attr) {
    if($attr->getId() == 'carrierType'){
      $attr->setValues('SC_MINI_APP');
    }elseif ($attr->getId() == 'carrierUrl'){
      $attr->setValues('alipays://platformapi/startapp?appId=2019071065847105&amp;chInfo=ch_bill');
    }
  }
}
?>
上一页
服务消息审核通知
下一页
各个行业场景服务接入资料
Built with