支付宝
  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

订阅消息#

设置接收消息的应用网关地址#

支付宝会通过 From 蚂蚁消息服务使用 向商家自研应用或第三方应用设置的 应用网关 地址,POST 方式推送商家/服务商使用 小程序交易组件 的异步通知消息。
若商家/服务商 网络环境比较复杂,如:通过统一网关间连互联网,推荐使用网络兼容性更好的标准 http(s) 协议进行对接。

订阅消息接口#

商家/服务商 需根据 订阅消息 指引,为接入商家券的 自研应用 或 第三方应用 订阅如下消息接口。
注意:
仅完成订阅后才会收到支付宝发送的对应异步通知消息。
商家/服务商 可通过消息通知中 msg_method 参数判断消息类型。
消息接口英文名消息接口中文名作用
alipay.open.mini.order.changed订单结果通知同步订单的状态变更结果。
alipay.open.mini.order.settle.notify结算消息通知同步订单在履约账期结束后,资金结算到商家余额户的结果。

前端接入#

小程序前端需要完成以下步骤,将业务订单信息、商品/订单优惠信息获取并返回给服务端进行相应处理。

判断订单创建环境#

请在创建订单前调用 my.checkBeforeAddOrder(订单前置判断接口)来判断是否需要使用交易组件创建订单。

示例代码#

Page({
    checkBeforeAddOrder() {
      if (my.canIUse('checkBeforeAddOrder')) {
        my.checkBeforeAddOrder({
          success({ requireOrder }) { console.log(requireOrder) },
          fail({ error, errorMessage }) {},
          complete() {},
        })
      }
    }
  });

出参#

英文名称类型描述
requireOrderenum是否需要创建交易组件订单,生成order_id 传入支付单。1:需要0:不需要
sourceIdString跟踪ID,需要获取之后创建业务订单时传入
sceneIdString公域收费场景值

引入前置优惠组件#

小程序交易组件 提供组件帮助商家获取商品详情、订单下单页上的商品优惠信息,该组件在开通 小程序交易组件 时已经绑定完成,无需进行二次操作。
在引入组件之后,能够获取当前商品和订单的支付优惠,包括商家支付券、红包、会员积分优惠、消费金等;在组件接入中的商品参数请注意与商品库的商品信息一致。

声明组件#

在小程序项目的根目录 app.json 中声明 小程序交易组件 。
{
  "plugins": {
    "tradePay": {
      "version": "*", // 目前只支持设置 * ,自动选择版本
      "provider": "2021003178648009" // 组件Id,固定不变
    },
    "usingComponents": {
  "discount-card": "plugin://tradePay/discountCard"
}
  }
}
tradePay 指组件名,支持由用户自行定义,使用组件时以 自定义名称 为准。

在页面中初始化获取实例#

1.
requirePlugin 引入交易组件。
2.
在页面启动的生命周期 onLoad 中创建交易组件实例。
3.
.then 获取实例,通过全局变量保存起来后续使用。
注意:初始化需要传入订单咨询的参数。

实例方法#

方法名描述
getDiscountInfo获取优惠信息。详情可查看 前置优惠组件接入。

展示前置优惠#

下单页.axml
<view>
  <discount-card />
</view>
可以传入 style、class 来调整样式。
<view>
  <discount-card style="" class="" />
</view>

获取优惠信息#

可通过 getDiscountInfo 获取平台优惠信息。
注意:请确保 payInst 已经通过初始化函数 createEnhancedTradePay 赋值。
page({
  onLoad() {
      payInst.getDiscountInfo({
      success: (res) => {
        my.alert({ content: res });
      },
      error: ({errorMsg}) => {
        my.alert({ content: errorMsg });
      }
    })
  }
})

本地测试验证#

 <discount-card forceShow="true"/>
当咨询出 优惠金额大于0 时,优惠咨询组件才会展示出来为了方便在本地研发调试的时候,可以通过forceShow=true强制展示来调整组件的样式、位置。
注意:调试完成后请删除掉这个配置,否则无法展示出具体的金额。

服务端接入#

业务流转状态说明#

image

接口调用流程#

image

创单#

创建商家侧订单#

开发者可在小程序端调用 my.request 接口连接到商家服务端,发送用户订单数据至服务端。

示例代码#

my.request({
  url: '商家服务端地址',//须在小程序开发设置中加httpRequest域白名单
  method: 'POST',
  data: {//data里的key、value是开发者自定义的
    from: '支付宝',
    order: 'XXXXX',//订单信息
  },
  dataType: 'json',
  success: function(res) {
    my.alert({content: 'success'});
  },
  fail: function(res) {
    my.alert({content: 'fail'});
  },
  complete: function(res) {
    my.hideLoading();
    my.alert({content: 'complete'});
  }
});

创建业务订单#

在服务端调用 alipay.open.mini.order.create(订单创建),获得 小程序交易组件 业务订单号 order_id。数娱景旅类业务订单类型中 merchant_biz_type 为 VIRTUAL_RECHARGE。

示例代码#

 {
 "biz_content": {
 "out_order_id": "1686310238345",
"source_id":"MjA4ODMwMjg0ODI0MjA2NXwyMDIxMDA0MTc2NjAwMDEwfDE2ODY3MzAxOTc5MDB8dHJ1ZXxWQUxJRA==",
 "title": "虚拟商品订单标题",
 "buyer_id": "2088302848242065",
 "merchant_biz_type": "VIRTUAL_RECHARGE",+// 虚拟商品的订单类型
 "path": "/pages/index/index?orderId=10190608609185",
 "order_detail": {
 "item_infos": [{
                    "out_item_id":"asdasdasd111",+// 商品库上需要有对应的的商品库
                     "out_sku_id":"asdasdasd111",
                    "item_cnt":"1",
                    "sale_price":0.2,
                    "body":"测试商品",
                    "show_url":""
 }],
 "extend_params": {
 },
 "price_info": {
 "order_price": 0.2
 }
 },
            "delivery_detail":{
            "delivery_type":"VIRTUAL"
        }
 }
} {
 "biz_content": {
 "out_order_id": "1686310238345",
"source_id":"MjA4ODMwMjg0ODI0MjA2NXwyMDIxMDA0MTc2NjAwMDEwfDE2ODY3MzAxOTc5MDB8dHJ1ZXxWQUxJRA==",
 "title": "虚拟商品订单标题",
 "buyer_id": "2088302848242065",
 "merchant_biz_type": "VIRTUAL_RECHARGE",+// 虚拟商品的订单类型
 "path": "/pages/index/index?orderId=10190608609185",
 "order_detail": {
 "item_infos": [{
                    "out_item_id":"asdasdasd111",+// 商品库上需要有对应的的商品库
                     "out_sku_id":"asdasdasd111",
                    "item_cnt":"1",
                    "sale_price":0.2,
                    "body":"测试商品",
                    "show_url":""
 }],
 "extend_params": {
 },
 "price_info": {
 "order_price": 0.2
 }
 },
            "delivery_detail":{
            "delivery_type":"VIRTUAL"
        }
 }
}

重要入参说明#

英文名称类型描述
out_order_idString商家外部订单号。 需要和 alipay.trade.create(统一收单交易创建接口)中的 out_trade_no 保持一致
titleString商品的标题/交易标题/订单标题/订单关键字等。 不可使用特殊字符,如 /,=,& 等。
total_priceString必填,订单总金额,单位为元,精确到小数点后两位,取值范围 [0.01,100000000]。
buyer_idString小程序支付必填,付款用户的支付宝 user_id,获取详情可查看 用户授权文档。
seller_idString卖家支付宝用户ID。可登录 账户中心 > 主账号信息 > 账号 ID 获取。
merchant_biz_typeString订单类型,决定后续履约节点中的参数校验规则,必填。数娱景旅场景固定为VIRTUAL_RECHARGE
pathString商家小程序对应的订单详情页路径地址 value。仅需传入小程序页面路径即可。同一笔订单的链接必须与第一次传入的地址相同,且需是小程序内部页面路径,例如:/pages/index/index?orderId=10190608609185。
order_detail.item_infos.out_sku_idString商家商品 sku_id,若是提报到商品库的商品,order_detail.item_infos.out_sku_id 和 order_detail.item_infos.out_item_id 必传。
order_detail.item_infos.out_item_idString商家商品 ID,若是提报到商品库的商品,order_detail.item_infos.out_sku_id 和 order_detail.item_infos.out_item_id 必传。订单中的商品在商品库必须是虚拟商品类目。
source_idString追踪 ID,公域分发场景必传,会影响主播归因、分享员归因等。通过调用 my.checkBeforeAddOrder(订单前置判断接口)返回。
delivery_detail.delivery_typeString物流类型,虚拟商品字段为 VIRTUAL

重要出参说明#

英文名称描述
order_id交易组件订单号。可以把获取到的order_id作为alipay.trade.create(统一收单交易创建接口)extend_params.trade_component_order_id的入参进行关联。
out_order_id外部商户订单号

创建支付单#

商家服务端调用 alipay.trade.create(统一收单交易创建接口)得到支付宝交易号 trade_no 为小程序唤起收银台使用,其中 extend_params.trade_component_order_id 需要传入 创建业务订单 步骤中获取的订单号 order_id。
注意:在创建业务订单后,需在 1 分钟内创建支付单,并通过传入 trade_component_order_id 将业务订单和支付单进行关联。如一笔业务订单未关联支付单,24 小时后会自动关闭。

示例代码#

//实例化客户端
AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do", APP_ID, APP_PRIVATE_KEY, "json", CHARSET, ALIPAY_PUBLIC_KEY, "RSA2");
//实例化具体API对应的request类,类名称和接口名称对应,当前调用接口名称:alipay.trade.create.
AlipayTradeCreateRequest request = new AlipayTradeCreateRequest();
//SDK 已经封装掉了公共参数,这里只需要传入业务参数。
request.setBizContent(            "{" +
        "\"out_trade_no\": \"20171115010101001\"," +// 与out_order_id保持一致
        "\"total_amount\": 0.01," +
        "\"subject\": \"月卡充值\"," +
        "\"buyer_id\": \"用户uid\"," +// 小程序支付场景中该参数必传
        "\"op_app_id\": \"2014072300007148\"," +
        "\"extend_params\": {" +
        "\"trade_component_order_id\": \"2023060801502300000008810000005657\"" +// 小程序公域商品交易场景中该参数必传
        
        "}"
try {
    AlipayTradeCreateResponse response = alipayClient.execute(request);
    String trade_no = response.getTradeNo();// 获取返回的tradeNO。
} catch (AlipayApiException e) {
    e.printStackTrace();
}

重要入参说明#

英文名称类型描述
out_trade_noString必填,商户订单号。需要和 alipay.open.mini.order.create(订单创建)里面的 out_order_id 保持一致。
product_codeString必填,交易组件场景只支持产品码 JSAPI_PAY。
subjectString商品的标题/交易标题/订单标题/订单关键字等。 不可使用特殊字符,如 /,=,& 等。
total_amountString必填,订单总金额,单位为元,精确到小数点后两位,取值范围 [0.01,100000000]。
buyer_idString小程序支付必填,付款用户的支付宝 user_id,获取详情可查看 用户授权文档。
seller_idString卖家支付宝用户 ID。可登录 账户中心 > 主账号信息 > 账号 ID 获取。
notify_urlString接收的异步通知 http/https 路径地址。用户支付成功时,支付宝将向本地址发送异步通知。
out_trade_noString必填,商户订单号。由商家自定义,64个字符以内,仅支持字母、数字、下划线且需保证在商户端不重复。
extend_paramsStringextend_params.trade_component_order_id:小程序公域商品交易场景中该参数必传,即业务订单号 order_id。

重要出参说明#

英文名称描述
out_trade_no外部商户支付单号
trade_no支付宝交易号。小程序唤起收银台时入参 tradeNO 的值。

支付#

唤起收银台#

在小程序端使用 tradeNO,调用 my.tradePay 接口唤起支付宝收银台,引导用户完成支付。

示例代码#

// .js
my.tradePay({
  // 调用统一收单交易创建接口(alipay.trade.create),获得返回字段支付宝交易号trade_no
  tradeNO: '201711152100110410533667792',
  success: (res) => {
    my.alert({
      content: JSON.stringify(res),
    });
  },
  fail: (res) => {
    my.alert({
      content: JSON.stringify(res),
    });
  }
});

异步通知#

订单支付成功时,商家可以通过在 alipay.trade.create(统一收单交易创建接口)设置异步通知(notify_url)来获得支付宝服务端返回的支付结果,当异步通知中返回的 trade_status(交易状态)为 TRADE_SUCCESS 时,表示支付成功。
收到异步通知后需通过 PrintWriter 类打印输出 success。如果商家反馈给支付宝的字符不是 success 这 7 个字符,支付宝服务器会不断重发通知,直到超过 24 小时 22 分钟。一般情况下,25 小时以内完成 8 次通知(通知的间隔频率一般是:4m,10m,10m,1h,2h,6h,15h)。
注意:
开发者设置的 notify_url 需要为外部网络环境可正常访问的网址,且状态码为 200,支付结果请以异步通知或 alipay.trade.query(统一收单线下交易查询)返回值为准。
其他有关异步通知的问题可查看 异步通知说明 。
若未成功接收到异步通知,排查方法可查看 收不到异步通知。

履约#

交易组件提供订单状态推进和变更的接口,商家在订单状态关键节点变化时,调用本组接口实现对订单资金的结算,并向用户下发消息提醒召回用户,给予用户更好的体验。

订单发货/充值#

商家完成虚拟商品发货/充值动作之后,调用 alipay.open.mini.order.delivery.send(订单发货)同步订单发货。
**注意:**虚拟商品类型在发货时 delivery_list 无需传参。

示例代码#

package com.java.sdk.demo;

import com.alipay.v3.ApiClient;
import com.alipay.v3.ApiException;
import com.alipay.v3.ApiResponse;
import com.alipay.v3.Configuration;
import com.alipay.v3.util.GenericExecuteApi;
import com.alipay.v3.util.model.AlipayConfig;
import com.alipay.v3.util.model.CustomizedParams;
import com.alipay.v3.util.model.OpenApiGenericRequest;
import java.io.File;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

public class GenericExecute {

    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);
        GenericExecuteApi api = new GenericExecuteApi();
        OpenApiGenericRequest request = new OpenApiGenericRequest();
        // body参数
        Map<String, Object> bizParams = new HashMap<>();
        bizParams.put("order_id", "2015042321001004720200028594");
        bizParams.put("ship_done_time", "2023-04-27 10:05:00");
        bizParams.put("user_id", "2088***");
        bizParams.put("finish_all_delivery", 0);
        List<Map<String, Object>> deliveryList = new ArrayList<>();
        Map<String, Object> deliveryList0 = new HashMap<>();
        deliveryList0.put("delivery_id", "32");
        List<Map<String, Object>> itemInfoList = new ArrayList<>();
        Map<String, Object> itemInfoList0 = new HashMap<>();
        itemInfoList0.put("item_cnt", 5);
        itemInfoList0.put("goods_id", "1234567");
        itemInfoList0.put("out_item_id", "123");
        itemInfoList0.put("out_sku_id", "34567576565656");
        itemInfoList.add(itemInfoList0);
        deliveryList0.put("item_info_list", itemInfoList);
        deliveryList0.put("waybill_id", "2343455");
        deliveryList.add(deliveryList0);
        bizParams.put("delivery_list", deliveryList);
        bizParams.put("out_order_id", "6823789339978248");
        request.setBodyParams(bizParams);
        try {
            ApiResponse<Object> response = api.execute("/v3/alipay/open/mini/order/delivery/send", "POST", request);
            System.out.println(response.getData());
        } catch (ApiException e) {
            System.out.println("调用失败,code:" + e.getCode() + ",body:" + e.getResponseBody());
        }
    }
}

充值完成/确认收货#

商家基于线上系统触发虚拟商品充值成功或者发送完成后,可调用 alipay.open.mini.order.delivery.receive(订单确认收货)对该笔订单更新履约状态,在确认收货时,用户将收到消息提醒。

示例代码#

package com.java.sdk.demo;

import com.alipay.v3.ApiClient;
import com.alipay.v3.ApiException;
import com.alipay.v3.ApiResponse;
import com.alipay.v3.Configuration;
import com.alipay.v3.util.GenericExecuteApi;
import com.alipay.v3.util.model.AlipayConfig;
import com.alipay.v3.util.model.CustomizedParams;
import com.alipay.v3.util.model.OpenApiGenericRequest;
import java.io.File;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

public class GenericExecute {

    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);
        GenericExecuteApi api = new GenericExecuteApi();
        OpenApiGenericRequest request = new OpenApiGenericRequest();
        // body参数
        Map<String, Object> bizParams = new HashMap<>();
        bizParams.put("order_id", "2015042321001004720200028594");
        bizParams.put("user_id", "2088***");
        bizParams.put("out_order_id", "6823789339978248");
        request.setBodyParams(bizParams);
        try {
            ApiResponse<Object> response = api.execute("/v3/alipay/open/mini/order/delivery/receive", "POST", request);
            System.out.println(response.getData());
        } catch (ApiException e) {
            System.out.println("调用失败,code:" + e.getCode() + ",body:" + e.getResponseBody());
        }
    }
}
注意:
在确认收货这个履约节点时,商家需要调用交易组件的确认收货接口进行业务处理。
充值完成和订单发货/充值是有前后依赖的接口,如果对一笔订单没有调用发货接口,则调用充值完成/确认收货接口会失败。

订单结算通知#

当交易完成后,根据不同的商品交易类型,由商家通过发货、确认收货完成订单的履约状态之后,根据不同商品类目的结算周期,对订单资金进行结算。在结算完成时将通过 alipay.open.mini.order.settle.notify(结算消息通知)向商家发送结算消息通知 。

辅助接口#

支付单退款#

当交易发生之后一段时间内,由于买家或者商家的原因需要退款时,商家可以调用 alipay.trade.refund(统一收单交易退款接口)通过商家网站唯一订单号 out_trade_no 或支付宝交易号 trade_no,将对应订单支付款退还给买家,支付宝将在收到退款请求并且验证成功之后,按照退款规则将支付款按原路退到买家账号上。
注意:
交易超过约定时间(签约时设置的可退款时间)的订单无法进行退款。
一笔退款失败后重新提交,要采用原来的退款单号。
refund(需要退款的金额),该金额不能大于订单金额,单位为元,支持两位小数。
同一笔订单如需分多次退款,需传入 out_request_id 标识一次退款请求,同一笔交易多次退款需保证该值唯一(即分次退款需保证 order_id 不变,每次退款请求都需传入不同 out_refund_id)。
交易单全额退款后,业务订单也会随之关闭。

支付单关单#

当交易创建后,用户如果在一定时间内未进行支付,商家可调用 alipay.trade.close(统一收单交易关闭接口)通过商家网站唯一订单号 out_trade_no 或支付宝支付单号 trade_no 关闭,将对应未付款的交易进行关闭。

查询支付单信息#

商家可调用 alipay.trade.query(统一收单线下交易查询接口),通过商家网站唯一订单号 out_trade_no 或支付宝支付单号 trade_no 查询对应订单支付情况。

查询订单信息#

商家可调用 alipay.open.mini.order.query(查询订单),通过商家网站唯一订单号 out_order_id 或支付宝支付单号 order_id 查询对应订单支付情况。

示例代码#

package com.java.sdk.demo;

import com.alipay.v3.ApiClient;
import com.alipay.v3.ApiException;
import com.alipay.v3.ApiResponse;
import com.alipay.v3.Configuration;
import com.alipay.v3.util.GenericExecuteApi;
import com.alipay.v3.util.model.AlipayConfig;
import com.alipay.v3.util.model.CustomizedParams;
import com.alipay.v3.util.model.OpenApiGenericRequest;
import java.io.File;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

public class GenericExecute {

    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);
        GenericExecuteApi api = new GenericExecuteApi();
        OpenApiGenericRequest request = new OpenApiGenericRequest();
        // query参数
        Map<String, Object> queryParams = new HashMap<>();
        queryParams.put("user_id", "2088***");
        queryParams.put("out_order_id", "6823789339978248");
        queryParams.put("order_id", "2015042321001004720200028594");
        request.setQueryParams(queryParams);
        try {
            ApiResponse<Object> response = api.execute("/v3/alipay/open/mini/order/query/query", "GET", request);
            System.out.println(response.getData());
        } catch (ApiException e) {
            System.out.println("调用失败,code:" + e.getCode() + ",body:" + e.getResponseBody());
        }
    }
}

查询订单对账列表信息#

商家可调用 alipay.open.mini.order.itembill.batchquery(查询小程序订单对账列表信息),通过小程序app_id 批量查询对应订单支付情况。
上一页
数字零售场景开发接入
下一页
扩展组件介绍
Built with