支付宝
  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. 接入指南

开发接入

完成 接入准备 后,开发者可根据本文指引集成 e签宝电子合同功能。

调用接口#

注意事项#

e签宝能力不支持服务商通过第三方应用 代调用模式 代商家接入。
使用e签宝能力的所有接口时,都需要使用如下构造函数,accessToken 固定为 null 、 appAuthToken 固定为 null、targetAppId 为固定值 2021001101679589。
公钥模式: alipayClient.execute(request,accessToken,appAuthToken,targetAppId)
公钥证书模式:alipayClient.certificateExecute(request,accessToken,appAuthToken,targetAppId)

第一步:创建合同模板#

e签宝电子合同均基于 合同模板 使用。发起电子合同签署前,需要调用 alipay.eco.doc.template.create(创建合同模板接口)创建模板,在获取到的模板设置页面配置模板输入组件、签署区。

接口时序图#

image

示例代码#

AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key","RSA2");
AlipayEcoDocTemplateCreateRequest request = new AlipayEcoDocTemplateCreateRequest();
request.setBizContent("{" +
  "\"content_md_5\":\"feac769fb4cfa1a9290d3f5461ba8339\"," +//模板文件的md5值
  "\"content_type\":\"application/pdf\"," +//文件MIME类型。
  "\"file_name\":\"contract.pdf\"," +//文件名需带后缀名
  "\"convert_to_pdf\":\"false\"" +//是否需要转换为PDF
"}");
// e签宝功能暂不支持三方调用,accessToken及appAuthToken参数入参 null 即可。
//注意:execute 方法入参最后一个参数为 targetId 该值固定为 2021001101679589
AlipayEcoDocTemplateCreateResponse response = alipayClient.execute(request,accessToken,appAuthToken,"2021001101679589");
if(response.isSuccess()){
  System.out.println("调用成功");
} else {
  System.out.println("调用失败");
}
注意:
1.
调用 alipay.eco.doc.template.create(创建合同模板接口)与支付宝服务端交互时,execute 方法需参照如下示例入参且第四个参数为 targetId 该值固定为 2021001101679589 ;
AlipayEcoDocTemplateCreateResponse response = alipayClient.execute(request,accessToken,appAuthToken,"2021001101679589");
1.
获取文件 MIME 类型,示例代码:
说明**:**需额外引入 javax.activation 。
String contentType = new MimetypesFileTypeMap().getContentType(new File("filePath"));
1.
获取文件 MD5 码,示例代码:
File file = new File("filePath");
FileInputStream fileInputStream = null;
try {
  MessageDigest MD5 = MessageDigest.getInstance("MD5");
  fileInputStream = new FileInputStream(file);
  byte[] buffer = new byte[8092];
  int length;
  while ((length = fileInputStream.read(buffer)) != -1) {
  MD5.update(buffer, 0, length);
}
// 取摘要的base64
  return Base64.encodeBase64String(MD5.digest());
} catch (Exception e) {
  e.printStackTrace();
  return null;
} finally {
try {
  if (fileInputStream != null) {
    fileInputStream.close();
}
} catch (IOException e) {
  e.printStackTrace();
}
}
1.
上传文件到指定URL 示例代码如下,具体注意事项可查看 文件流上传方法。
public boolean sendFileToUrl(String url, File file, String contentType, String md5)throws IOException {
  CloseableHttpClient httpclient = HttpClients.createDefault();
  try {
 HttpPut httpPut = new HttpPut(url);
 if (StringUtils.isNotBlank(contentType)) {
             httpPut.setHeader("Content-Type", contentType);
 } else {
               httpPut.setHeader("Content-Type", "application/octet-stream");
             }
             if (StringUtils.isNotBlank(md5)) {
                 httpPut.setHeader("Content-MD5", md5);
             }
 httpPut.setEntity(new FileEntity(file, ContentType.APPLICATION_OCTET_STREAM));
 System.out.println(httpPut.getRequestLine());
 CloseableHttpResponse execute = httpclient.execute(httpPut);
 if (execute.getStatusLine().getStatusCode() == 200) {
 String result = EntityUtils.toString(execute.getEntity(), "UTF-8");
 JSONObject object = JSON.parseObject(result);
 if (object.getIntValue("errCode") == 0) {
 return true;
 }
 }
 return false;
 } catch (Exception e) {
 e.printStackTrace();
 return false;
 } finally {
 httpclient.close();
 }
 }

第二步:模板配置#

在调用 alipay.eco.doctemplate.settingurl.query(获取合同模板设置地址接口)获取到的合同模板设置地址上进行模板配置,包含设置输入组件和签署区两部分。
输入组件:合同模板上预留的空白位置,创建合同签署流程时可填充指定内容(一个模板至少包含一个输入组件)。
签署区:需要签名/盖章的位置,合同需几方签署,就拖拽几个签署区(一个模板至少包含一个签署区)。

设置模板输入组件#

拖拽控件至填充区域 > 设置控件名称 > 设置控件 key 值;
控件库:目前支持文本、数字、日期,请根据需要选择对应控件;
控件长度:可填充字符限制由控件长度决定,添加控件后,右侧按钮可修改控件长度;
名称:自定义名称,如:甲方姓名;
key 值:可定义为业务对应的参数名,如 name,需确保模板内 key 值唯一性;也可点击 控件设置 右侧按钮复制系统生成的 key 值。调用 alipay.eco.contract.signflows.create(创建电子合同签署流程接口)需根据 key 值传入对应 value,如李聪,进行控件填充;
字符限制:可填充字符长度限制,入参 value 超出长度限制会报错。
image

设置签署区#

1.
拖拽签署区控件至需要签署的位置 > 设置签署区名称(如:甲方签署区)> 设置签署区 key 值 > 设置是否显示签署时间;
key 值:调用 alipay.eco.contract.signflows.create(创建电子合同签署流程)接口需要根据 key 值关联对应的签署人。
签署日期:如设置了签署日期,签署后会在印章下限制签署的时间。
1.
设置完成后请点击 保存。
image

第三步:合同签署#

根据配置好的合同模板,调用接口填充内容并指定签署人创建电子合同签署流程后,签署方通过插件完成合同签署。

电子合同的签署流程#

image#

1. 创建签署流程#

开发者通过调用 alipay.eco.contract.signflows.create(创建电子合同签署流程接口)创建合同签署流程并获取 fow_id,关键参数如下表所示:
参数名称参数说明注意事项/示例值
流程主题 business_scene流程主题(简要概括合同的签署内容)。爱租机手机租赁合同;蚂蚁集团劳动合同
模板id template_id创建模板时获取的模板 ID。3bfdab20187b43cb940362b8f5d05a50
模板填充项 fill_contents根据组件 key 值传入填写内容 value 填充模板配置的输入组件,创建流程后,会生成完整的合同文件。name:折颜性别:男
签署区 signfields根据签署区 key 值传入对应签署区的签署人信息,目前支持三种签署类型:platform-平台自动签:无需指定签署人。创建流程后,系统将自动盖上商户的默认企业印章。 person-个人签署:需要指定签署人个人信息。创建流程后,需通过签署插件完成签署。 org-企业签署:需要指定签署企业信息与经办人个人信息。创建流程后,需经办人代企业完成签署。(企业暂不支持插件签署,可通过获取签署地址接口获取企业签署地址)签署人信息说明:合同需要几方签署,就设置几个签署区,每个签署区对应一个签署人; 个人签署的需传入个人唯一标识+姓名,为确保签署的可靠性,建议传入个人身份证号码; 企业签署需传入经办人个人信息+企业信息。
平台订单号 platform_order_no将商家订单与电子合同进行关联。用户通过支付宝官方小程序 合同管家 查看合同时,可快速进入商家的小程序及对应的订单详情页,为商家的小程序提供了流量入口,提高用户的活跃度和留存率。如传入的订单号为:DD12345678跳转商户小程序的链接拼接格式为:alipays://platformapi/startapp?appId=appIds&page=pages&order=DD12345678(小程序路径由商家提供,商家小程序需要支持上述链接解析并跳转到内部订单详情页。)
签署人上传附件列表 specify_attachment_infos通过用户唯一标识,指定每个签署人需要上传的附件列表,设置后签署人在签署合同前需要上传指定图片。目前支持以下类型附件:身份证:collect_cert_types 传入 ["IDCARD"] 。 自定义图片:collect_common_codes 传入自定义图片 code 列表。目前仅支持个人签署时上传附件,企业签署暂不支持。
收集附件任务信息 attachment_explain配置自定义图片上传页面的描述及需签署人上传的图片,如租赁场景,可以上传租赁物的照片。image附件信息只支持现场拍摄,不支持相册上传。
回调通知地址notice_developer_url签署任务的执行采用异步方式进行,完成后通过回调的方式通知平台方签署结果,目前e签宝提供两种场景的回调通知:场景一:在签署流程中某一个签署人完成签署或拒签时,通知对接平台该签署人的签署状态的更新。如一个需要张三和李四共同签署的合同,当张三签署完成时,e签宝通知平台张三完成了其相关合同的签署。 场景二:在签署流程结束时(正常签署完成或拒签等原因导致的非正常结束时),e签宝通知对接平台签署任务的状态。详情可查看 通知说明 。
**说明:**模板填充项 fill_contents ,签署区 signfields 中 struct_key 参数也可入参系统生成 key 值,获取如下图所示:
9.png

2. 通过插件完成签署#

获取签署流程 ID 后,前端开发者需在小程序中集成 e签宝电子合同插件 引导用户完成签署**。接入详情可查看下文 集成插件。
**

3. 查询签署结果#

开发者可调用 alipay.eco.sign.flow.query(签署流程查询接口),查询对应签署流程签署结果。

签署流程管理接口#

更多合同签署相关接口及功能:
接口名称描述使用说明
获取流程签署地址alipay.eco.signflows.url.query创建签署流程后,可通过此接口获取指定签署人的签署链接。对于无法使用小程序插件签署的场景,可在应用内集成H5签署页,或者通过短信发送签署链接。
流程文档下载alipay.eco.signflows.detail.query可通过此接口获取签署流程合同与附件的下载地址。e签宝会对已签署合同进行永久保存与存证,商家可在需要的时候下载合同文件,无需全量下载。
获取文件直传地址alipay.eco.file.path.query通过获取到的 uploadUrl 进行文件流上传合同的附件,如订单截图等,可作为电子合同的辅助证明材料。上传文件具体注意事项可查看 文件流上传方法。附件目前不会向签署人展示。需要附件的合同,需先上传附件后,将返回的 file_id传入"创建签署流程"的附件信息中。
签署流程撤销alipay.eco.sign.flow.cancel可通过此接口撤销合同签署流程。场景举例:用户取消订单后,需通过流程ID(flow_id)撤销对应的电子合同签署流程。只能撤销状态为签署中的流程。

集成插件#

开发者在移动端扫码进入 服务市场 后,在支付宝服务市场搜索 e签宝电子合同插件,完成插件订购,详细订购步骤可参考 插件获取 文档。
订购完成后,开发者即可在小程序业务流程中引用 e签宝电子合同插件进行签署,完成商家服务自闭环。以下仅展示在商家小程序中集成 e签宝电子合同签署插件的主要步骤,详情请查看 插件使用文档。

1. 声明插件配置#

在小程序项目 app.json 中声明e签宝电子合同插件。
{
  "plugins": {
    "esign": {
      "version": "*",
      "provider": "2021001115656413"
    }
  },
}
version:指定插件版本号,由于插件的上架版本只有一个版本,因此这里需始终指定 *最新版本。
provider:固定的插件 ID(e签宝电子合同插件 ID 为 2021001115656413)。

2. 兼容处理#

插件的运行要求 小程序基础库版本 为 1.22.4 及以上版本,支付宝客户端 10.1.82 及以上的版本,小程序在使用插件的时候,需要按照以下方式兼容(非常重要):
// app.js
if (!my.canIUse('plugin') && !my.isIDE) {
  my.ap && my.ap.updateAlipayClient && my.ap.updateAlipayClient();
}
App({
  onLaunch() {},
  onShow() {},
})
**注意:**兼容代码一定要放到 app.js 文件的开头处,不能放到生命周期方法中,如果不做上述兼容处理,在基础库版本低于 1.18.0 的时候可能会导致页面白屏。

3. 小程序跳转插件签署页#

针对电子合同的不用应用场景,小程序插件提供了两种签署方式,支持混用。

场景1:可应用于签收单(顺丰快递签收)等个人签署场景。#

仅支持个人签署。
支持上传身份证&照片附件。
点击确认后刷脸完成签署,自动盖章。
// flowId 表示发起的e签宝电子合同流程id
my.navigateTo({
  url: `plugin://esign/home?flowId=${flowId}`,
})

场景2:可应用于所有签署场景。#

支持个人&企业签署。
不支持上传身份证&照片附件。
需要签署人盖章或签字后刷脸完成签署。
// flowId:创建电子合同签署流程返回的流程id
// thirdPartyUserId:创建签署流程时指定的个人唯一标识
// skipResult:true 跳过插件签署结果页,直接返回母体小程序页面,默认false
// skipGuide:true 跳过签署前置页(当前用户登录已实名时有效),默认false
my.navigateTo({
  url: `plugin://esign/esign?flowId=${flowId}&thirdPartyUserId=${thirdPartyUserId}&skipResult=${skipResult}&skipGuide=${skipGuide}`,
})

4. 通过 js 接口获取签署状态#

**方式1:**当插件完成签署/用户点击返回,会返回到商户小程序页面,小程序可以监听 onShow 事件,通过e签宝电子合同小程序插件提供的 js 接口来获取插件签署结果。
**方式2:**通过 js 接口 addEventListener 方法监听 signStatusInfo 事件。
签署状态 code、message 枚举:
code(场景名)message 举例状态类型建议操作流程状态
000(签署成功)签署成功终态-2-完成
001(插件服务异常)插件服务异常,请重新调用插件非终态重新操作1-签署中
002(签署失败)签署失败的错误信息非终态重新操作1-签署中
003(未找到签署流程)签署失败的错误信息终态-流程不存在
004(账户校验失败)签署人信息不一致终态-1-签署中
005(签署流程查询失败)签署失败的错误信息非终态重新操作1-签署中
006(账号实名失败)签署失败的错误信息终态-1-签署中
007(没有需要签署的文件)签署失败的错误信息终态-1-签署中

商家闭环#

用户通过支付宝官方小程序 合同管家 查看合同时,除了完成查看合同详情、咨询售后相关问题等操作,可快速进入商家的小程序及对应的订单详情页,为商家的小程序提供了流量入口,提高用户的活跃度和留存率。
image

商家小程序跳转合同管家查看合同详情#

在小程序中增加合同查看入口,参考以下代码片段:
my.navigateToMiniProgram({
// 合同管家小程序的appid,固定值请勿修改   
appId: '2021001108663491',  
// 合同管家跳转地址和参数,flowId为 创建合同签署流程 时返回的参数  
path: 'pages/login/index?flowId=flowId'     
success: (res) => {
        console.log(JSON.stringify(res))
      },
      fail: (res) => {
        console.log(JSON.stringify(res))
      }
    });

合同管家跳转商户订单详情页#

提供商家小程序订单详情页跳转地址,包含商家小程序 appid 与 path,如:
alipays://platformapi/startapp?appId=2018031602388641&page=pages/components/orderDetail/orderDetail?outOrderNo=
调用接口创建合同签署流程时,传入平台订单号 platform_order_no 。
商家在开放平台控制台对应小程序详情页,设置 > 基础设置 > 小程序相互跳转 中设置为 允许所有小程序跳转 或 指定合同管家小程序跳转(需支付宝客户端 10.1.25 及以上版本支持)。
用户在合同管家查看合同时点击 订单详情,即可跳转至商户小程序订单详情页,并在路径拼接参数 platform_order_no(平台订单号)。商家小程序需支持如下方式的跳转:
alipays://platformapi/startapp?appId=2018031602388641&page=pages/components/orderDetail/orderDetail?outOrderNo=platform_order_no

附录:顺丰快递电子签收单功能接入#

快递员派件时展示签收二维码,用户使用支付宝扫一扫,在小程序完刷脸签收后,快递员投妥。
如需将电子合同能力应用于快递签收,需注意以下事项:

接入前提#

持有 顺丰月结账号 ,并采购顺丰派件增值服务。
集成顺丰微派接口,实现在线下单。
详情可在钉群咨询。

创建流程时需要特别指定以下参数#

参数名称参数说明
快递单号 serial_no12 或 15 位快递单号
快递公司编号 company_no目前只支持顺丰快递,固定传入 SF。为避免影响生产订单,联调及测试环境请务必传入 SF_TEST。
签署方式 sign_model**1-商家小程序:**扫码后跳转商家小程序进行签收;**0-e签宝小程序:**如商户没有支付宝小程序,可使用e签宝小程序完成签收。
商户小程序签署地址 merchant_mini_sign_url签署方式为"商户小程序"的,需传入扫码后跳转的商家小程序地址,链接格式如:alipays://platformapi/startapp?appId=2019042364288308&page=pages&query=flowid=flowids(收货人扫码后会打开上述小程序地址,商户小程序根据传入的flowid拉起e签宝小程序插件进行签署)
签署完成跳转地址 jump_url签署方式为"e签宝小程序"的,支持签署完成跳转一个固定地址,可传入商户小程序地址。(可选项)
上一页
常见问题
下一页
文件流上传方法
Built with