支付宝
  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. 芝麻免押

接入指南

完成 接入准备 后,商家/服务商可根据本文指引快速接入 芝麻免押。
说明:
芝麻免押 仅支持自研商家/服务商通过 自研应用 或 第三方应用 代调用方式,调用 API 接入。
芝麻免押 暂不支持沙箱调试。
为保证正常调用接口,调接口之前需要先确保应用 上线 状态、应用 已绑定 且 已开通 芝麻免押产品,可以使用 配置项检测工具 检查是否完成接入前的准备工作。
当用户选择如租车、充电桩、酒店预订等服务时,商家在冻结用户资金前先由芝麻信用对其进行信用评估,信用好则不用冻结资金,信用不满足要求才会冻结用户资金。通过信用的奖惩来规范用户行为,提升解冻转支付的成功率。用户授权成功之后商家根据自身业务需要主动调支付接口完成守约。支持一次授权多次扣款,累计扣款不能超过冻结金额,因此商家每支付成功一笔就会生成一条已守约记录。

接口调用时序图#

image.png

芝麻账单信用状态变化流程说明#

子交易单(项):冻结转支付商家每调一次交易支付接口生成一笔交易称为子交易单(项)。一个服务可以有一笔子交易单 out_trade_no(同一个商户订单号)或者多笔交易单 out_trade_no(不同的商户订单号,多次扣款)。
服务状态:若一次授权单次扣款这时子交易单(项)的状态就是服务状态,若一次授权多次扣款则服务状态由多个子交易单(项)状态决定。
服务状态如下:
服务使用中:当商家调授权冻结接口,用户点击 同意协议,免押先用并输入密码之后,会在支付宝 APP 的 芝麻信用 界面下方的 守约记录 页看到一条 信用服务 记录。
已守约:用户授权成功后商家调支付接口单次扣款或者多次扣款完成支付(转账金额等于冻结金额)或剩余金额解冻后服务状态变为已守约。若剩余金额未解冻服务状态变为待守约,子交易单(项)是待确认守约项。
待守约:用户授权成功后商家调支付接口转支付失败,2 小时后服务使用中变为待守约状态。失败的交易订单会影响用户信用额度 建议 商家保持 out_trade_no 不变,尝试再次调支付或者关闭失败的交易订单。
逾期:转支付失败后超过服务支付指定日期会变成逾期此时服务状态由待守约变为逾期(不同场景逾期时间不同,可以查看 全场景逾期时间说明)。一旦逾期会影响用户信用额度需要商家及时处理逾期单停止对用户芝麻分的影响。
逾期已结清:其中有一笔或多笔逾期 建议 商家保持 out_trade_no 不变,尝试再次支付,支付成功后子交易单(项)的逾期状态变为逾期已结清。逾期已结清不会再蔓延影响用户信用额度。
服务已取消:授权成功之后商家根据自身业务需要调授权撤销接口或者是资金授权解冻接口(全额解冻)成功后服务变为已取消。
下图详细介绍服务守约状态不同情况下处理方式(信用授权有效期默认是一年具体以协议为准):
图片 1.png
注意:商家可调 alipay.fund.auth.operation.detail.query(资金授权操作查询接口)当 授权单状态 order_status 是 FINISH 或 CLOSED 且用户存在逾期记录,同时商家同意给用户消除这些逾期记录时,商家就可以调 alipay.trade.orderinfo.sync(支付宝订单信息同步接口)把冻结转失败的逾期交易单 trade_no 同步履约状态,履约状态支持 COMPLETE(用户已履约)、CLOSED(同步履约已取消)。

接入芝麻免押#

生成资金冻结订单#

开发者可调用 alipay.fund.auth.order.app.freeze(线上资金授权冻结接口)生成资金冻结订单并获取参数串用于小程序端唤起收银台完成冻结。
注意:
请严格按照接口文档中的参数入参,传入非接口文档中的参数是无效的,并且可能会导致请求被拦截或其它异常。
接入芝麻信用服务,信用服务 ID 必须是 审核通过 状态才可以使用,商家至少需拥有一个 已上架 的支付宝小程序。信用预授权冻结转支付失败,重试需使同一个外部商户号 out_trade_no。

示例代码#

AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key","RSA2");
AlipayFundAuthOrderAppFreezeRequest request = new AlipayFundAuthOrderAppFreezeRequest();
// 设置异步通知
request.setNotifyUrl("http://api.test.alipay.net/atinterface/receive_notify.htm");

JSONObject bizContent = new JSONObject();
bizContent.put("out_order_no","outOrderNo123");
bizContent.put("out_request_no","outRequestNo123");
bizContent.put("order_title","XX租车押金");
bizContent.put("amount",0.01);
bizContent.put("product_code","PRE_AUTH_ONLINE");
bizContent.put("payee_user_id","2088102000275795");
bizContent.put("timeout_express","30m");

//设置免押模式(POSTPAY、POSTPAY_UNCERTAIN、DEPOSIT_ONLY)
//bizContent.put("deposit_product_mode","DEPOSIT_ONLY");

//设置后付费项目开始
//JSONArray postPayments = new JSONArray();
//后付费项目
// JSONObject postPayment = new JSONObject();
// postPayment.put("name","租金");
// postPayment.put("amount","1");
// postPayment.put("description","1元/小时");
// postPayments.add(postPayment);
// bizContent.put("post_payments",postPayments);
//设置后付费项目结束


//JSONArray disablePayChannels = new JSONArray();
//// 禁用渠道添加信用卡快捷
//JSONObject disableChannel1 = new JSONObject();
//disableChannel1.put("payChannelType","OPTIMIZED_MOTO");
//disablePayChannels.add(disableChannel1);
//// 禁用渠道添加信用卡卡通
//JSONObject disableChannel2 = new JSONObject();
//disableChannel2.put("payChannelType","BIGAMOUNT_CREDIT_CARTOON");
//disablePayChannels.add(disableChannel2);
//// 设置禁用渠道(无特殊诉求请勿传入)
//bizContent.put("disable_pay_channels",disablePayChannels);

//// 买家实名信息(无特殊诉求请勿传入)
//JSONObject identityParams = new JSONObject();
//String identityHash = genHashCode("SHA-256","UTF-8","张三","4566498798498498498498");
//identityParams.put("identity_hash",identityHash);
//identityParams.put("alipay_user_id","2088345012230098");
//bizContent.put("identity_params",identityParams);

//// 设置扩展参数
//JSONObject extraParam = new JSONObject();
//extraParam.put("category","CHARGE_PILE_CAR");
//extraParam.put("serviceId","2020042800000000000001450466");
//bizContent.put("extra_param",extraParam);

// 设置整体请求参数
request.setBizContent(bizContent.toString());

// 使用sdkExecute方法发起请求
AlipayFundAuthOrderAppFreezeResponse response = alipayClient.sdkExecute(request);

if(response.isSuccess()){
    System.out.println("调用成功");
} else {
    System.out.println("调用失败");
}

/*******以下为identity_hash生成加密串的方法示例,无实名校验诉求可忽略********/

/**
     * 根据给定的一个或多个字符串获得摘要
     * 使用SHA256摘要方式与UTF8编码,返回十六进制的字符串
     *
     * @param strsToBeDigest
     * @return  十六进制的字符串
     */
private static String genHashCode(String algorithmType, String charset, String... strsToBeDigest) {
    //拼接字符串,再hash
    StringBuilder sb = new StringBuilder();
    for (String str : strsToBeDigest) {
        sb.append(str);
    }
    String identity = sb.toString();
    MessageDigest messageDigest;
    String hashResult = "";
    try {
        messageDigest = MessageDigest.getInstance(algorithmType);
        byte[] bytes = messageDigest.digest(identity.getBytes(charset));
    hashResult = convertByteToHexString(bytes);
} catch (NoSuchAlgorithmException e) {
    System.out.println("获得实名hash值出错,无此hash算法");
} catch (UnsupportedEncodingException e) {
    System.out.println("获得实名hash值出错,不支持此编码");
}
    return hashResult;
}

    /**
    * 将字节数组转为十六进制字符串
    *
    * @param bytes
    * @return
    */
    private static String convertByteToHexString(byte[] bytes) {
    StringBuilder sb = new StringBuilder();
    String byteString;
    for (byte aByte : bytes) {
    //byte转为int时高位补零
    byteString = Integer.toHexString(aByte & 0xFF);
    if (byteString.length() == 1) {
    //补齐2位
    sb.append("0");
}
    sb.append(byteString);
}
    return sb.toString();
}

重要入参说明#

参数名称参数说明
out_order_no商户授权资金订单号。
out_request_no商户本次资金操作的请求流水号。
order_title订单标题。
amount需要冻结的金额,由商户根据自身业务评估金额。
product_code产品码,根据开通支付产品传参;开通预授权支付产品传 PREAUTH_PAY,开通支付宝预授权产品传 PRE_AUTH_ONLINE
extra_param业务扩展参数,用于商家的特定业务信息的传递,JSON 格式。 授权业务对应的类目:key 为 category 信用场景下必传,value 为业务分类,例如:充电桩业务传 CHARGE_PILE_CAR 。 信用服务ID:key 为 serviceId 信用场景下 必传。信用服务 ID 需要商家在 芝麻信用服务平台 创建信用服务获取,详情可查看 创建信用服务。在创建过程中如果有其它疑问,可以咨询芝麻客服小二(0571-88158055 转 2)。例如:{"category":"CHARGE_PILE_CAR","serviceId":"2019*********************300"}
外部商户的门店编号:key 为 outStoreCode,可选。
外部商户的门店简称:key 为 outStoreAlias,可选,将在用户端信用守护、支付信息、账单详情页展示。
间联模式必须传入二级商户所属机构 ID,key 为 requestOrgId。
notify_url异步通知地址,异步通知响应详情可查看文中 授权异步通知 章节,当用户授权成功时将触发异步通知返回 auth_no等授权结果信息。若未设置 notify_url 则需调用 alipay.fund.auth.operation.detail.query(资金授权操作查询接口)轮询用户授权结果,当接口返回 order_status = AUTHORIZED 时则用户授权成功
deposit_product_mode免押受理台模式,根据免押不同业务模式将开通受理台区分三种模式,商家可根据调用预授权冻结接口传入的参数决定该笔免押订单使用哪种受理台模式。不同受理台模式需要传入不同参数,其中:POSTPAY 表示后付金额已知,POSTPAY_UNCERTAIN 表示后付金额未知,DEPOSIT_ONLY 表示纯免押。具体规则参考文档:https://opendocs.alipay.com/b/08tf3t?pathHash=d67d7545
post_payments后付费项目, 有付费项目时需要传入该字段。不同受理台模式需要传入不同参数,后付费项目名称和计费说明需要通过校验规则,同时计费说明将展示在开通受理台上。具体规则参考文档:https://opendocs.alipay.com/b/08tf3t?pathHash=d67d7545
payee_user_id可选字段,收款账户的支付宝用户号,支付宝用户号可以登录 开放平台控制台 查看 账号 ID 获得。
payee_logon_id可选字段,收款账户的支付宝登录号(email 或手机号)。如果商户希望用户能够使用花呗,则用户号(payee_user_id)和登录号(payee_logon_id)两者必须传入其一。
enable_pay_channels可选字段,可以指定支付渠道,如果不传,默认为签约协议的支付渠道;若需要限制支付渠道,目前仅支持余额宝(MONEY_FUND)、花呗(PCREDIT_PAY)以及芝麻信用(CREDITZHIMA)。冻结用户花呗(PCREDIT_PAY)额度渠道升级中,暂不支持新用户申请接入,请关注后续通知。
**
**

唤起冻结页#

说明:
请将支付宝客户端升级至最新版本。
若唤起支付宝收银台报错 参数异常,请关注支付宝返回给客户端的具体错误信息。

APP 支付冻结#

Android 样例代码#

final  String orderInfo = info;    // 订单信息 
Runnable payRunnable =  new  Runnable() {
     @Override
  public   void   run ()   {
      PayTask alipay =  new  PayTask(DemoActivity. this );
      Map<String,String> result = alipay.payV2(orderInfo, true );
      Message msg =  new  Message();
      msg.what = SDK_PAY_FLAG;
      msg.obj = result;
      mHandler.sendMessage(msg);
  }
};  
// 必须异步调用 
Thread payThread =  new  Thread(payRunnable);
payThread.start();
入参说明#
PayTask 对象主要为商家提供订单支付、查询功能,及获取当前开发包版本号。
获取 PayTask 支付对象调用支付(支付行为需要在独立的非 ui 线程中执行)。
出参获取#
示例代码:
private  Handler mHandler =  new  Handler() {
  public   void   handleMessage (Message msg)   {
  Result result =  new  Result((String) msg.obj);
  Toast.makeText(DemoActivity. this , result.getResult(),
     Toast.LENGTH_LONG).show();
};
};

iOS 样例代码#

可查看 iOS集成方案。

H5 支付冻结#

开发者可通过 ap.tradePay 接口,传入支付宝订单字符串唤起支付,用户确认后即可冻结资金。
注意:该组件仅支持支付宝端内 H5 访问唤起,不支持端外H5访问。

示例代码#

<script src= "https://gw.alipayobjects.com/as/g/h5-lib/alipayjsapi/3.1.1/alipayjsapi.inc.min.js"></script> 
<button id = "J_btn" class = "btn btn-default">支付</button>
<script>
  var btn = document.querySelector('#J_btn');
  btn.addEventListener('click', function(){
    ap.tradePay({
       orderStr : 'timestamp=2016-12-27%2018%3A00%3A00&method=alipay.trade.app.pay&app_id=2014073000007292......'
    }, function( res ) {
      ap.alert(res.resultCode);
    });
  });
</script>

使用介绍#

可直接传入一个字符串作为 OPTION.orderStr 参数。
OPTION 参数说明
名称类型必填描述
tradeNOString否交易号,多个交易号请用英文分号 ; 分隔
partnerIDString否商户 id
bizTypeString否交易类型,默认为 trade
bizSubTypeString否交易子类型
bizContextString否支付额外的参数,格式为 JSON 字符串
orderStrString否完整的支付参数拼接成的字符串,从服务端获取。
CALLBACK 参数说明
名称类型描述
resultCodeString支付结果状态码,详情可查看下表。
resultCode 支付状态码说明:
resultCode描述
9000订单支付成功
8000正在处理中
4000订单支付失败
6001用户中途取消
6002网络连接出错
99用户点击忘记密码导致快捷界面退出(only iOS)

小程序支付唤起冻结#

开发者通过在小程序内调用 my.tradePay 接口,唤起预授权冻结流程(入参即接入流程中获取的 orderStr)。
**注意:**开发者需通过真机调试的方式调试该接口的功能,若用 IDE 调试该接口则会报无效的 API 入参。

示例代码#

my.tradePay({
  orderStr: 'myOrderStr', // 完整的支付参数拼接成的字符串,从服务端获取
  success: (res) => {
    my.alert({
      content: JSON.stringify(res),
    });
  },
  fail: (res) => {
    my.alert({
      content: JSON.stringify(res),
    });
  }
});

唤起冻结注意事项#

status=INIT,表示用户授权中,可调用 alipay.fund.auth.operation.detail.query(资金授权操作查询接口)每隔 5 秒钟查询一次授权冻结的状态,如依然是用户授权中,则再等待5秒钟继续使用查询接口查询,直至 1 分钟后超时(推荐每隔 5 秒查询一次,共进行 12 次查询,具体根据商家业务情况决定)。
如超时前最后一次查询依然返回用户授权中,则马上调用 alipay.fund.auth.operation.cancel(资金授权撤销接口)将该笔预授权冻结交易撤销。
如接口返回系统异常,先通过查询接口查询授权冻结的状态,并根据查询结果进行后续操作。
返回错误码为 SYSTEM_ERROR 时,请调用查询接口确定授权状态,并根据状态确定下一步操作。
对于未消费的预授权订单(预授权成功,但未进行授权转支付),请使用定时任务做好解冻或撤销,避免影响用户信用额度,造成不必要的客诉。

授权异步通知#

当用户使用服务会在支付宝客户端唤起冻结页用户同意协议,输入密码之后会收到授权签约异步通知,平台通过 alipay.fund.auth.order.app.freeze(线上资金授权冻结接口)传入的 notify_url 主动以 POST 的方式推送给商户。

用户授权成功异步通知样例#

https://www.merchant.com/receive_notify.htm?gmt_create=2022-12-07 11%3A30%3A42&charset=utf-8&rest_credit_amount=0.01&operation_type=FREEZE&sign=$$$&rest_fund_amount=0.00&auth_no=20221207****************7851&notify_id=20221207***************6835&total_freeze_credit_amount=0.01&notify_type=fund_auth_freeze&gmt_trans=2022-12-07 11%3A31%3A43&operation_id=20221207*******1805&total_pay_fund_amount=0.00&out_request_no=20221207********0141&payer_user_id=2088********2180&app_id=20141********3222&sign_type=RSA2&amount=0.01&rest_amount=0.01&notify_time=2022-12-07 11%3A31%3A43&fund_amount=0.00&total_pay_credit_amount=0.00&payee_user_id=2088*******0335&credit_amount=0.01&pre_auth_type=CREDIT_AUTH&out_order_no=20221207*******0141&total_freeze_fund_amount=0.00&payee_logon_id=ali***%40alipay.com&version=1.0&total_unfreeze_fund_amount=0.00&total_pay_amount=0.00&total_freeze_amount=0.01&total_unfreeze_credit_amount=0.00&auth_app_id=20141********3222&total_unfreeze_amount=0.00&status=SUCCESS&payer_logon_id=156****8305

参数说明#

参数名参数说明
auth_no支付宝资金授权订单号
out_order_no商家的资金授权订单号
operation_id支付宝的资金操作流水号
out_request_no商家资金操作流水号
异步通知参数说明具体请参考 异步参数说明。

验签方法#

同步接口和异步通知验签,可查看 验签流程。

异步通知接收代码规范#

接收程序执行完后必须打印输出 success。如果商家反馈给支付宝的字符不是 success 这7个字符,服务器会不断重发通知,直到超过 24 小时 22 分钟。
一般情况下,25 小时以内完成 8 次通知(通知的间隔频率一般是 4m、10m、10m、1h、2h、6h、15h);接收程序执行完成后,该页面不能执行页面跳转。如果执行页面跳转,支付宝会接收不到 success 字符,会被支付宝服务器判定为该页面程序运行出现异常,而重发处理结果通知。

示例代码#

资金信用冻结转支付场景#

当商家获得用户授权完成 线上资金冻结 操作后,如果业务场景需要用户进行支付,而并不只是冻结押金,则需要调用 alipay.trade.pay(统一收单交易支付接口)完成扣款操作。
注意:
商家在进行冻结转支付时,若扣款金额大于冻结的押金,会出现扣款失败,在第一步资金冻结时需要商户根据自身业务合理评估出冻结金额。
冻结转支付使用 alipay.trade.pay(统一收单交易支付接口)为通用接口,在资金授权场景下:
授权码的参数为 auth_no 而非当面付中的 auth_code;授权码也没有 25-30 开头的限制。
资金授权过程无需传入scene 参数。
对于未消费的预授权订单(预授权成功,但未进行授权转支付),请使用定时任务做好解冻或撤销,避免影响用户信用额度,造成不必要的客诉。

示例代码#

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.AlipayTradeApi;
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 AlipayTradeApiPay {

    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);
        AlipayTradeApi api = new AlipayTradeApi();
        AlipayTradePayModel data = new AlipayTradePayModel();
        data.setAuthConfirmMode("COMPLETE");
        PromoParam promoParams = new PromoParam();
        promoParams.setActualOrderTime("2018-09-25 22:47:33");
        data.setPromoParams(promoParams);
        data.setProductCode("FACE_TO_FACE_PAYMENT");
        data.setUndiscountableAmount("8.88");
        data.setDiscountableAmount("80.00");
        BkAgentReqInfo bkagentReqInfo = new BkAgentReqInfo();
        bkagentReqInfo.setMerchCode("123412341234");
        bkagentReqInfo.setLocation("+37.28/-121.268");
        bkagentReqInfo.setDeviceType("02");
        bkagentReqInfo.setAcqCode("12345678901234");
        bkagentReqInfo.setSerialNum("123123123123");
        data.setBkagentReqInfo(bkagentReqInfo);
        data.setRequestOrgPid("2088201916734621");
        List<GoodsDetail> goodsDetail = new ArrayList<GoodsDetail>();
        GoodsDetail goodsDetail0 = new GoodsDetail();
        goodsDetail0.setQuantity(1);
        goodsDetail0.setPrice("2000");
        goodsDetail0.setGoodsCategory("34543238");
        goodsDetail0.setCategoriesTree("124868003|126232002|126252004");
        goodsDetail0.setGoodsId("apple-01");
        goodsDetail0.setShowUrl("http://www.alipay.com/xxx.jpg");
        goodsDetail0.setGoodsName("ipad");
        goodsDetail0.setOutItemId("outItem_01");
        goodsDetail0.setOutSkuId("outSku_01");
        goodsDetail.add(goodsDetail0);
        data.setGoodsDetail(goodsDetail);
        data.setTerminalId("NJ_T_001");
        SubMerchant subMerchant = new SubMerchant();
        subMerchant.setMerchantId("2088000603999128");
        subMerchant.setMerchantType("alipay");
        data.setSubMerchant(subMerchant);
        SettleInfo settleInfo = new SettleInfo();
        List<SettleDetailInfo> settleDetailInfos = new ArrayList<SettleDetailInfo>();
        SettleDetailInfo settleDetailInfos0 = new SettleDetailInfo();
        settleDetailInfos0.setTransInType("cardAliasNo");
        settleDetailInfos0.setAmount("0.1");
        settleDetailInfos0.setTransIn("A0001");
        settleDetailInfos0.setActualAmount("0.1");
        settleDetailInfos0.setSummaryDimension("A0001");
        settleDetailInfos0.setSettleEntityType("SecondMerchant");
        settleDetailInfos0.setSettleEntityId("2088xxxxx;ST_0001");
        settleDetailInfos.add(settleDetailInfos0);
        settleInfo.setSettleDetailInfos(settleDetailInfos);
        settleInfo.setSettlePeriodTime("7d");
        data.setSettleInfo(settleInfo);
        data.setSellerId("2088102146225135");
        data.setBody("Iphone6 16G");
        data.setAuthCode("28763443825664394");
        data.setScene("bar_code");
        AgreementParams agreementParams = new AgreementParams();
        agreementParams.setAgreementNo("20170322450983769228");
        agreementParams.setDeductPermission("2021571176714791277815457854545");
        agreementParams.setApplyToken("MDEDUCT0068292ca377d1d44b65fa24ec9cd89132f");
        agreementParams.setAuthConfirmNo("423979");
        data.setAgreementParams(agreementParams);
        data.setAuthNo("2016110310002001760201905725");
        data.setTimeoutExpress("90m");
        data.setStoreId("NJ_001");
        ExtendParams extendParams = new ExtendParams();
        extendParams.setTradeComponentOrderId("2023060801502300000008810000005657");
        extendParams.setSysServiceProviderId("2088511833207846");
        extendParams.setIndustryRefluxInfo("{\"scene_code\":\"metro_tradeorder\",\"channel\":\"xxxx\",\"scene_data\":{\"asset_name\":\"ALIPAY\"}}");
        extendParams.setSpecifiedSellerName("XXX的跨境小铺");
        extendParams.setRoyaltyFreeze("true");
        extendParams.setCardType("S0JP0000");
        data.setExtendParams(extendParams);
        PayParams payParams = new PayParams();
        payParams.setAsyncType("NORMAL_ASYNC");
        payParams.setRetryType("NONE");
        data.setPayParams(payParams);
        data.setBuyerId("2088202954065786");
        data.setOutTradeNo("20150320010101001");
        data.setAdvancePaymentType("ENJOY_PAY_V2");
        data.setOperatorId("yx_001");
        List<String> queryOptions = new ArrayList<String>();
        queryOptions.add("voucher_detail_list");
        data.setQueryOptions(queryOptions);
        data.setSubject("Iphone6 16G");
        data.setIsAsyncPay(false);
        data.setTimeExpire("2021-12-31 10:05:00");
        data.setTotalAmount("88.88");
        try {
            AlipayTradePayResponseModel response = api.pay(data);
        } catch (ApiException e) {
            AlipayTradePayDefaultResponse errorObject = (AlipayTradePayDefaultResponse) e.getErrorObject();
            System.out.println("调用失败:" + errorObject);
        }
    }
}

重要入参说明#

注意:请严格按照接口文档中的参数入参,传入非接口文档中的参数是无效的,并且可能会导致请求被拦截或其它异常。
参数名称参数说明
notify_url非必填,支付成功异步接收地址。
extend_params如果需返佣接入时还需要传入 "extend_params":{"sys_service_provider_id":"ISV签约账户的PID"} 参数用于计算返佣。
auth_confirm_mode非必填,预授权确认模式。当 auth_confirm_mode = COMPLETE 时无需调用解冻接口,支付宝端在扣款成功后会自动解冻剩余金额,同时该笔授权订单完成。
当 auth_confirm_mode = NOT_COMPLETE 时,商家收到支付成功通知后需要自行调用 alipay.fund.auth.order.unfreeze(资金授权解冻接口)将余额进行解冻。
如果需要从一笔授权中完成多笔订单支付,保持 auth_no 不变,不同订单根据 out_trade_no 进行标识,此时 auth_confirm_mode 不传或者传入 NOT_COMPLETE;进行到最后一笔转支付时,auth_confirm_mode 传入 COMPLETE 由支付宝完成剩余金额自动解冻,或者商家自行调用解冻接口将剩余金额解冻。
deduction_subject必填,扣款原因,扣款原因是扣押金需传入DEPOSIT ,扣后付服务费用(租金、房费等)需传入SERVICE_FEE 。扣款时需要满足校验规则,否则扣款将被拦截具体规则参考文档:https://opendocs.alipay.com/b/08tf3t?pathHash=d67d7545

出参处理#

response 中的 code=10000,表示接口调用成功,支付状态以异步通知为准。
auth_trade_pay_mode,预授权支付模式,该参数仅在信用预授权支付场景下返回。信用预授权支付: CREDIT_PREAUTH_PAY。
如果未收到异步通知,可以通过交易查询接口查询最新支付状态,如果返回处理中(如:trade_ status = WAIT_BUYER_PAY 或 ORDER SUCCESS PAY INPROGRESS)场景,商家可以调用预授权转支付(首次扣款 15天内都可重试),重新发起扣款(注意:商户订单号 out_trade_no 保持不变)。

支付异步通知#

资金授权转支付通知示例#

gmt_create=2022-12-07 16:38:26&charset=utf-8&seller_email=$$$&subject=资金信用转支付&sign=$$$&buyer_id=2088********2180&invoice_amount=0.01&notify_id=20221207*****************7576&fund_bill_list=[{"amount":"0.01","fundChannel":"ALIPAYACCOUNT"}]&notify_type=trade_status_sync&trade_status=TRADE_SUCCESS&receipt_amount=0.01&app_id=2014********3222&buyer_pay_amount=0.01&sign_type=RSA2&seller_id=2088********0335&gmt_payment=2022-12-07 16:38:28&notify_time=2022-12-07 16:38:29&version=1.0&out_trade_no=20221207********pay&total_amount=0.01&trade_no=20221207*****************0384&auth_app_id=2014********3222&buyer_logon_id=156****8305&point_amount=0.00

参数说明:#

参数名称参数说明
out_trade_no商户外部交易号
trade_no支付宝交易号
trade_status交易状态
receipt_amount实收金额
查看更多参数说明请参考 当面付异步通知。

其它业务接口#

除了主要业务接口外,小程序支付宝预授权还提供了如授权解冻,撤销等接口帮助商家完善业务拼图。

资金授权解冻#

当资金授权发生之后一段时间内,由于买家或者商家等其它原因需要要解冻资金,商家可通过 alipay.fund.auth.order.unfreeze(资金授权解冻接口)将授权资金进行解冻,支付宝将在收到解冻请求并验证成功后,按解冻规则将冻结资金按原路进行解冻并返回。
商家进行解冻后,用户的该笔订单则会变成 已守约 状态。

示例代码#

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.AlipayFundAuthOrderApi;
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 AlipayFundAuthOrderApiUnfreeze {

    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);
        AlipayFundAuthOrderApi api = new AlipayFundAuthOrderApi();
        AlipayFundAuthOrderUnfreezeModel data = new AlipayFundAuthOrderUnfreezeModel();
        data.setOutRequestNo("2016101200104001110081001");
        data.setRemark("2014-05期解冻200.00元");
        data.setExtraParam("{\"unfreezeBizInfo\": \"{\"bizComplete\":\"true\"}\"}");
        data.setAmount("20.11");
        data.setAuthNo("2016101210002001810258115912");
        try {
            AlipayFundAuthOrderUnfreezeResponseModel response = api.unfreeze(data);
        } catch (ApiException e) {
            AlipayFundAuthOrderUnfreezeDefaultResponse errorObject = (AlipayFundAuthOrderUnfreezeDefaultResponse) e.getErrorObject();
            System.out.println("调用失败:" + errorObject);
        }
    }
}
说明:
支持全额解冻和部分解冻。
当业务流程为商家冻结用户资金并且在用户完成业务后直接转为支付场景时该接口非必须调用,可查看 资金冻结转支付场景 。
冻结转支付时:
若 auth_confirm_mode = complete,无需调用解冻接口,支付宝端在扣款成功后会自动解冻剩余金额。
若 auth_confirm_mode = not_complete,在收到支付成功通知后,商家需自行调用解冻接口将余额进行解冻。
对于信用授权订单,扣款处理中或扣款失败(如:trade_ status=WAIT_BUYER_PAY 或 ORDER SUCCESS PAY INPROGRESS),若调用解冻接口,会中断支付宝扣款流程,请慎用。
extra_param 为选填字段,只对信用授权订单生效,若订单为 0 元订单,extra_param 传入 {"unfreezeBizInfo":"{\"bizComplete\":\"true\"}"},将为用户生成芝麻履约订单。

资金授权解冻通知示例#

notify_url?gmt_create=2022-10-20 11%3A45%3A09&charset=utf-8&rest_amount=0.00&amount=0.01&notify_time=2022-10-20 11%3A45%3A10&operation_type=UNFREEZE&sign=$$$&out_order_no=20221020v1223102110&version=1.0&auth_no=202210201000************3940&notify_id=202210200022211***********5729313&notify_type=fund_auth_unfreeze&total_pay_amount=0.00&total_freeze_amount=0.01&gmt_trans=2022-10-20 11%3A45%3A09&auth_app_id=201410******3222&operation_id=2022102086******1805&total_unfreeze_amount=0.01&out_request_no=20221020134646013unfree03&payer_user_id=2088********2180&app_id=201410******3222&sign_type=RSA2&status=SUCCESS&payer_logon_id=156****8305

参数说明#

参数名参数说明
operation_type资金操作类型。UNFREEZE:解冻。
auth_no支付宝资金授权订单号。
out_request_no商家资金操作流水号。
其它参数可查看 异步通知参数说明。

资金授权操作查询#

商家可以通过资金授权操作查询接口 alipay.fund.auth.operation.detail.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.AlipayFundAuthOperationDetailApi;
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 AlipayFundAuthOperationDetailApiQuery {

    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);
        AlipayFundAuthOperationDetailApi api = new AlipayFundAuthOperationDetailApi();
        AlipayFundAuthOperationDetailQueryModel data = new AlipayFundAuthOperationDetailQueryModel();
        data.setOutOrderNo("8077735255938023");
        data.setOperationType("FREEZE");
        data.setOutRequestNo("20140216001001");
        data.setOperationId("20140216010020006400");
        data.setAuthNo("2014021601002000640012345678");
        try {
            AlipayFundAuthOperationDetailQueryResponseModel response = api.query(data);
        } catch (ApiException e) {
            AlipayFundAuthOperationDetailQueryDefaultResponse errorObject = (AlipayFundAuthOperationDetailQueryDefaultResponse) e.getErrorObject();
            System.out.println("调用失败:" + errorObject);
        }
    }
}

响应示例#

{
    "gmt_create":"2014-01-01 20:00:00",
    "order_title":"0元购土豪金",
    "rest_credit_amount":0.01,
    "operation_type":"UNFREEZE",
    "remark":"2014-05期解冻200.00元",
    "credit_merchant_ext":"{\"1003190\":\"true\"}",
    "rest_fund_amount":0.01,
    "auth_no":"2014031600002001260000001000",
    "total_freeze_credit_amount":0.01,
    "order_status":"AUTHORIZED",
    "trans_currency":"USD",
    "gmt_trans":"2014-01-01 20:00:00",
    "operation_id":"20140216355864862002",
    "total_pay_fund_amount":0.01,
    "payer_user_id":"2088402019148643",
    "out_request_no":"20140216001001",
    "rest_amount":4600.00,
    "amount":200.00,
    "fund_amount":0.01,
    "total_pay_credit_amount":0.01,
    "pre_auth_type":"CREDIT_AUTH",
    "credit_amount":0.01,
    "out_order_no":"20140216001",
    "total_freeze_fund_amount":0.01,
    "total_pay_amount":0.00,
    "total_freeze_amount":4800.00,
    "extra_param":"{\"merchantExt\":\"key1=value1,key2=value2\"}",
    "payer_logon_id":"ali*@alipay.com",
    "status":"SUCCESS"
}

出参处理#

参数名称参数说明
status资金操作流水的状态:INIT:初始状态,表示已创建授权单,等待用户密码确认。CLOSED:关闭状态,超时未授权,支付宝将授权单关闭后的状态。SUCCESS:预授权成功。
order_status授权单状态:INIT:初始状态,已创建未授权。AUTHORIZED:已授权状态,授权成功,可以进行转支付或解冻操作。FINISH:完成状态,转支付完成且无剩余冻结资金。CLOSED:关闭状态,授权未完成超时关闭或冻结资金全额解冻。
pre_auth_typepre_auth_type=CREDIT_AUTH 时,表示存在信用冻结(全额信用冻结或部分信用冻结+部分资金冻结)。如果 pre_auth_type 不返回,或者返回值为空或不为 CREDIT_AUTH,则表示资金冻结,会冻结用户资金,不冻结用户信用。
total_freeze_amount订单累计的冻结金额。
rest_amount订单当前剩余冻结金额。
total_pay_amount订单累计用于支付的金额。

资金授权撤销#

商家通过 alipay.fund.auth.operation.cancel(资金授权撤销接口)撤销用户资金授权。
**注意:**只有商家由于业务系统处理超时需要终止后续业务处理或者授权结果未知时可调用撤销,其它正常授权冻结的操作如需实现相同功能请调用资金授权解冻服务。提交资金授权后调用资金授权操作查询,没有明确的授权结果再调用支付宝预授权撤销。

示例代码#

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.AlipayFundAuthOperationApi;
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 AlipayFundAuthOperationApiCancel {

    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);
        AlipayFundAuthOperationApi api = new AlipayFundAuthOperationApi();
        AlipayFundAuthOperationCancelModel data = new AlipayFundAuthOperationCancelModel();
        data.setOutOrderNo("4977164666634053");
        data.setOutRequestNo("2016100810000003551");
        data.setRemark("授权撤销");
        data.setOperationId("20161012405744018102");
        data.setAuthNo("2014070800002001550000014417");
        try {
            AlipayFundAuthOperationCancelResponseModel response = api.cancel(data);
        } catch (ApiException e) {
            AlipayFundAuthOperationCancelDefaultResponse errorObject = (AlipayFundAuthOperationCancelDefaultResponse) e.getErrorObject();
            System.out.println("调用失败:" + errorObject);
        }
    }
}

交易查询#

商家通过 alipay.trade.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.AlipayTradeApi;
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 AlipayTradeApiQuery {

    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);
        AlipayTradeApi api = new AlipayTradeApi();
        AlipayTradeQueryModel data = new AlipayTradeQueryModel();
        List<String> queryOptions = new ArrayList<String>();
        queryOptions.add("trade_settle_info");
        data.setQueryOptions(queryOptions);
        data.setOutTradeNo("20150320010101001");
        data.setTradeNo("2014112611001004680 073956707");
        data.setOrgPid("2088101117952222");
        try {
            AlipayTradeQueryResponseModel response = api.query(data);
        } catch (ApiException e) {
            AlipayTradeQueryDefaultResponse errorObject = (AlipayTradeQueryDefaultResponse) e.getErrorObject();
            System.out.println("调用失败:" + errorObject);
        }
    }
}

重要入参说明#

注意:请严格按照接口文档中的参数入参,传入非接口文档中的参数是无效的,并且可能会导致请求被拦截或其它异常。
outTradeNo:为授权转支付时传入的 outTradeNo。

出参处理#

如果查询返回处理中 trade_ status = WAIT_BUYER_PAY 或 ORDER SUCCESS PAY INPROGRESS,商家可以调用预授权转支付重新发起扣款,需注意商户订单号 out_trade_no 保持不变。

交易退款#

当交易发生之后一段时间内,由于买家或者卖家的原因需要退款时,卖家可以通过 alipay.trade.refund(统一收单交易退款接口)将支付款退还给买家,支付宝将在收到退款请求并且验证成功之后,按照退款规则将支付款按原路退到买家帐号上。
**注意:**交易超过约定时间(签约时设置的可退款时间)的订单无法进行退款。支付宝退款支持单笔交易分多次退款,多次退款需要提交原支付订单的商户订单号和设置不同的退款单号。一笔退款失败后重新提交,要采用原来的退款单号。总退款金额不能超过用户实际支付金额。

示例代码#

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.AlipayTradeApi;
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 AlipayTradeApiRefund {

    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);
        AlipayTradeApi api = new AlipayTradeApi();
        AlipayTradeRefundModel data = new AlipayTradeRefundModel();
        List<OpenApiRoyaltyDetailInfoPojo> refundRoyaltyParameters = new ArrayList<OpenApiRoyaltyDetailInfoPojo>();
        OpenApiRoyaltyDetailInfoPojo refundRoyaltyParameters0 = new OpenApiRoyaltyDetailInfoPojo();
        refundRoyaltyParameters0.setTransInType("userId");
        refundRoyaltyParameters0.setRoyaltyScene("达人佣金");
        refundRoyaltyParameters0.setAmount("0.1");
        refundRoyaltyParameters0.setTransOut("2088101126765726");
        refundRoyaltyParameters0.setRoyaltyType("transfer");
        refundRoyaltyParameters0.setTransIn("2088101126708402");
        refundRoyaltyParameters0.setDesc("分账给2088101126708402");
        refundRoyaltyParameters0.setTransInName("张三");
        refundRoyaltyParameters0.setTransOutType("userId");
        refundRoyaltyParameters.add(refundRoyaltyParameters0);
        data.setRefundRoyaltyParameters(refundRoyaltyParameters);
        data.setOutRequestNo("HZ01RF001");
        List<String> queryOptions = new ArrayList<String>();
        queryOptions.add("refund_detail_item_list");
        data.setQueryOptions(queryOptions);
        data.setOutTradeNo("20150320010101001");
        List<RefundGoodsDetail> refundGoodsDetail = new ArrayList<RefundGoodsDetail>();
        RefundGoodsDetail refundGoodsDetail0 = new RefundGoodsDetail();
        refundGoodsDetail0.setGoodsId("apple-01");
        refundGoodsDetail0.setOutItemId("outItem_01");
        refundGoodsDetail0.setOutSkuId("outSku_01");
        refundGoodsDetail0.setRefundAmount("19.50");
        refundGoodsDetail.add(refundGoodsDetail0);
        data.setRefundGoodsDetail(refundGoodsDetail);
        data.setTradeNo("2014112611001004680073956707");
        data.setRefundAmount("200.12");
        data.setRefundReason("正常退款");
        try {
            AlipayTradeRefundResponseModel response = api.refund(data);
        } catch (ApiException e) {
            AlipayTradeRefundDefaultResponse errorObject = (AlipayTradeRefundDefaultResponse) e.getErrorObject();
            System.out.println("调用失败:" + errorObject);
        }
    }
}

授权订单信息同步#

当预授权订单为全信用或者部分信用授权订单时,商家可通过 alipay.trade.orderinfo.sync(支付宝订单信息同步接口)同步订单相关业务信息,如履约和违约信息等;若商家使用芝麻分进行授权,对于违约的用户,支付宝会进行相应的芝麻分处罚。使用场景如下:
预授权订单为全信用或者部分信用授权订单。
针对授权转支付扣款失败的订单,请在首次授权转支付失败 T+N 之后调用该接口。
order_info 中的 status 包含:COMPLETE(用户已履约)。
COMPLETE(用户已履约):如果用户通过其它方式完成订单支付,请反馈该状态,芝麻将对用户形成一条良好履约记录。

示例代码#

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.AlipayTradeOrderinfoApi;
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 AlipayTradeOrderinfoApiSync {

    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);
        AlipayTradeOrderinfoApi api = new AlipayTradeOrderinfoApi();
        AlipayTradeOrderinfoSyncModel data = new AlipayTradeOrderinfoSyncModel();
        data.setBizType("CREDIT_AUTH");
        data.setOrderBizInfo("{\"status\":\"COMPLETE\"}");
        data.setOutRequestNo("HZ01RF001");
        data.setOrigRequestNo("HZ01RF001");
        data.setTradeNo("2018061021001004680073956707");
        try {
            AlipayTradeOrderinfoSyncResponseModel response = api.sync(data);
        } catch (ApiException e) {
            AlipayTradeOrderinfoSyncDefaultResponse errorObject = (AlipayTradeOrderinfoSyncDefaultResponse) e.getErrorObject();
            System.out.println("调用失败:" + errorObject);
        }
    }
}

重要入参说明#

注意:请严格按照接口文档中的参数入参,传入非接口文档中的参数是无效的,并且可能会导致请求被拦截或其它异常。
参数名称参数说明
biz_type固定为 CREDIT_AUTH。
trade_no为授权转支付返回的 trade_no。
out_request_no外部请求号,商家自定义。
order_info订单状态,需传入用户履约状态。status 用户履约状态,支持 COMPLETE(用户已履约)、CLOSED(同步履约已取消),例如:order_info={"status":"COMPLETE"}。

查询对账单下载地址#

商家通过 alipay.data.dataservice.bill.downloadurl.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.AlipayDataDataserviceBillDownloadurlApi;
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 AlipayDataDataserviceBillDownloadurlApiQuery {

    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);
        AlipayDataDataserviceBillDownloadurlApi api = new AlipayDataDataserviceBillDownloadurlApi();
        String billType = "trade";
        String billDate = "2016-04-05";
        String smid = "2088123412341234";
        try {
            AlipayDataDataserviceBillDownloadurlQueryResponseModel response = api.query(billType, billDate, smid);
        } catch (ApiException e) {
            AlipayDataDataserviceBillDownloadurlQueryDefaultResponse errorObject = (AlipayDataDataserviceBillDownloadurlQueryDefaultResponse) e.getErrorObject();
            System.out.println("调用失败:" + errorObject);
        }
    }
}

响应示例#

{
    "bill_download_url":"http://dwbillcenter.alipay.com/downloadBillFile.resource?bizType=X&pid=X&fileType=X&bizDates=X&downloadFileName=X&fileId=X",
    "bill_file_code":"EMPTY_DATA_WITH_BILL_FILE"
}

重要出参说明#

参数名称参数说明
billDownloadUrl对账单下载地址,下载地址有效时间为 30 秒,请尽快下载。
上一页
接入准备
下一页
常见问题
Built with