抖音
  1. 结算
抖音
  • 简介
  • 签名算法
  • 接口调用凭证
    • 经营能力调用凭证
      • BusinessToken 生成
      • BusinessToken 刷新
      • 经营能力当前状态查询
    • 非用户授权调用凭证
      • 获取应用授权调用凭证
      • getAccessToken
    • 用户授权调用凭证
      • 获取用户授权调用凭证
      • 刷新用户授权调用凭证
      • 刷新授权调用凭证
  • 登录
    • code2Session
      POST
  • 小程序码与小程序链接
    • Schema 链接
      • 生成SchemaV2
      • 查询SchemaV2
      • 查询Schema配额V2
    • Link链接
      • 生成 Link V2
      • 查询 Link 配额V2
      • 查询 Link V2
    • 二维码
      • 生成QRCodeV2
  • 私域经营
    • 私信管理
      • IM主动授权webhook
      • 主动发送私信
    • 群聊管理
      • 粉丝群webhook
        • 用户加群申请 webhook
        • 用户加群webhook
      • 查询群信息
      • 设置进群问候语&群公告
      • 创建粉丝群
      • 取消进群问候语&群公告配置
      • 变更用户入群申请状态
      • 查询用户剩余建群额度
      • 查询群主所在群的用户入群申请状态
    • 经营工具
      • 小程序引导卡片
        • 创建/更新小程序引导卡片模板
        • 查询小程序引导卡片模板
        • 删除小程序引导卡片模板
      • 图片上传
  • 线索组建
    • 创建线索组件
    • 查询已创建的线索组件
    • 更新线索组件
    • 删除线索组件
  • 视频能力
    • 视频数据查询
      • 查询特定视频的视频数据
    • 近 30 天用户视频数据
      • 获取视频基础数据
      • 获取视频点赞数据
      • 获取视频评论数据
      • 获取视频播放数据
      • 获取视频分享数据
    • 视频评论数据
      • 置顶评论
      • 评论回复列表
      • 评论列表
      • 回复视频评论
    • videoid转换itemid
    • itemid转换encryptid
  • 搜索能力
    • 创建抖音搜索直达子服务
    • 查询已创建的抖音搜索直达子服务列表
    • 删除抖音搜索直达子服务
    • 校验是否有搜索直达服务的创建权限
  • 电商
    • 注册小程序积分阈值
    • 注册小程序预览图
    • 查询订单的定制完成状态
    • 定制类小程序开发者注册信息
    • 退会
  • 生活服务
    • 店铺接入
      • 商铺同步
      • 查询店铺
      • 获取抖音POI ID
      • 店铺匹配任务结果查询
      • 店铺匹配状态查询
      • 提交门店匹配任务
      • 查询全部店铺信息接口(天级别请求5次)
      • 查询店铺全部信息任务返回内容
    • 商品库接入
      • (老版本)SKU同步
      • (老版本)sku拉取(该接口由接入方实现)
      • (老版本)多门店SPU同步
      • (老版本)多门店SPU状态同步
      • (老版本)多门店SPU库存同步
      • (老版本)多门店SPU信息查询
      • 创建/修改团购商品
      • 免审修改商品
      • 上下架商品
      • 同步库存
      • 查询商品模板
      • 查询商品草稿数据
      • 查询商品线上数据
      • 查询商品线上数据列表
      • 查询商品草稿数据列表
      • 用于创建多 SKU 商品。
      • 查询商品品类
    • 端内消息同步
      • 订单同步
    • poi数据接入
      • 获取POI基础数据
      • POI用户数据
      • POI服务基础数据
      • POI服务成交用户数据
      • POI热度榜
      • POI认领列表
    • poi基础能力
      • 通过高德POI ID获取抖音POI ID
    • 优惠卷接入
      • 优惠券同步
      • 优惠券更新
    • CPS佣金设置与查询
      • 通用佣金计划查询带货数据
      • 通用佣金计划查询达人带货数据
      • 通用佣金计划查询带货达人列表
      • 通用佣金计划查询达人带货详情
      • 查询通用佣金计划
      • 发布/修改通用佣金计划
      • 修改通用佣金计划状态
      • 发布/修改直播间定向佣金计划
      • 发布/修改短视频定向佣金计划
      • 修改定向佣金计划状态
      • 取消定向佣金计划指定的达人
      • 查询达人的定向佣金计划带货数据
      • 通过商品 ID 查询定向佣金计划
      • 查询定向佣金计划带货汇总数据
  • 用户信息
    • 用户抖音主页数据
      • 获取用户视频情况
      • 获取用户粉丝数
      • 获取用户点赞数
      • 获取用户评论数
      • 获取用户分享数
      • 获取用户主页访问数
  • 分享
    • 拍抖音任务
      • 拍抖音任务变更推送
      • 创建任务
      • 查询用户任务进度
    • 拍抖音互动任务
      • 拍抖音互动任务变更推送
      • 创建任务
      • 查询用户任务进度
    • 分享任务
      • 创建任务
      • 查询用户任务进度
  • 客服
    • CustomerServiceUrl
  • 小程序卷
    • 「小程序券」直播玩法接入指南
    • 小程序券API列表
    • 更新日志
    • 用户卷管理
      • 查询用户可用券信息
      • 用户领券结果回调通知
      • 用户撤销核销券
      • 用户手机号授权结果回调通知
      • 用户核销券
    • 主播授权管理
      • 查询主播发券配置信息
      • 修改主播发券权限状态
      • 更新主播发券库存上限
      • 主播发券权限配置
    • 卷模版管理
      • 查询授权用户发放的活动信息
      • 创建券模板
      • 修改券模板
      • 删除券模板
      • 修改券模板库存
      • 修改券模板状态
      • 查询券模板发放统计数据
      • 查询券模板
      • 查询对账单
    • 接口发放管理
      • 创建开发者接口发券活动
      • 开发者接口发券
      • 删除开发者接口发券活动
  • 交易系统
    • 通用交易系统
      • 通用参数
      • 进件
        • 接口进件
          • 图片上传
          • 发起进件
          • 进件查询
        • 获取进件页面链接
          • 开发者获取小程序收款商户/合作方进件页面
          • 服务商获取小程序收款商户进件页面
          • 服务商获取服务商进件页面
          • 服务商获取合作方进件页面
      • 标签
        • 查询标签组信息
      • 订单
        • 查询CPS信息
        • 查询订单信息
        • 支付结果回调
      • 退款
        • 发起退款
        • 查询退款
        • 同步退款审核结果
        • 退款申请回调扩展点
        • 退款结果通知
      • 履约
        • 推送履约状态
      • 结算
        • 发起分账
          POST
        • 查询分账
          POST
        • 通知分账结果
          POST
      • 提现
        • 接口提现
          • 商户余额查询
          • 商户提现
          • 商户提现结果查询
        • 获取提现页面链接
          • 开发者获取小程序收款商户/合作方提现页面
          • 服务商获取小程序收款商户提现页面
          • 服务商获取服务商提现页面
          • 服务商获取合作方提现页面
      • 获取对账单
        • 获取资金账单
        • 获取交易账单
    • 生活服务交易系统(金融合板)
      • 通用参数
      • 错误码和返回码
      • 查询接口
        • 查询订单信息
        • 查询券状态信息
        • 查询 CPS 信息
      • 预下单
        • 预下单扩展点
        • 开发者发起下单
      • 营销算价
        • 营销算价扩展点介绍
        • 查询营销算价扩展点
      • 支付
        • 支付结果通知
      • 核销
        • 抖音码
          • 验券准备
          • 验券
          • 撤销核销
          • 券码核销通知
          • 撤销核销通知
        • 三方码
          • 推送核销状态
          • 撤销核销
      • 分账
        • 查询分账
      • 退货退款
        • 开发者发起退款
        • 同步退款审核结果
        • 查询退款
        • 退款扩展点
        • 退款结果通知
    • 生活服务交易系统(账号融合版)
      • 错误码和返回码
      • 通用参数
      • 预约
        • 创建预约单
        • 预约接单结果回调
        • 商家取消预约
        • 用户取消预约
        • 查询预约单信息
        • 预约接单超时回调
        • 预约取消/完成通知
      • 查询接口
        • 查询订单信息
        • 查询券状态信息
        • 查询CPS信息
      • 预下单
        • 预下单回调
        • 关闭订单
        • 发起下单
      • 营销算价
        • 营销算价扩展点介绍
        • 查询营销信息扩展点
        • 算价扩展点
        • 营销查询算价二合一
      • 支付
        • 通知支付结果
      • 核销
        • 抖音码
          • 验券准备
          • 验券
        • 三方码
          • 推送核销状态
        • 核销工具
          • 查询用户券列表
          • 查询订单可用门店
          • 券核销消息通知
          • 撤销核销消息通知
          • 设置商家展示信息
          • 查询商家配置文案
          • 设置订单详情页按钮白名单接口
          • 设置小程序跳转path
      • 分账
        • 发起分账
        • 查询分账
        • 通知分账结果
      • 退货退款
        • 发起退款
        • 同步退款审核结果
        • 查询退款
        • 退款申请回调
        • 通知退款结果
    • 行业交易系统
      • API 调用
        • 通用参数
        • 错误码和返回码
      • 回调设置
        • 设置回调地址
        • 查询回调地址
      • 预下单
        • 查询 CPS 信息
        • 查询订单信息
        • 预下单回调
        • 开发者发起下单
      • 营销算价
        • 营销算价扩展点介绍
        • 查询营销信息扩展点
        • 设置扩展点
        • 算价扩展点
    • 支付
      • 通知支付结果
    • 核销
      • 抖音码
        • 验券准备
        • 验券
        • 查询劵状态信息
      • 三方码
        • 推送核销状态
      • 分账
        • 发起分账
        • 查询分账
        • 通知分账结果
    • 提货退款
      • 开发者发起退款
      • 同步退款审核结果
      • 查询退款
      • 退款申请回调
      • 通知退款结果
  • 内容安全
    • 内容安全检测
    • 图片检测V2
    • 图片检测V3
  • 泛知识
    • 角色系统
      • 错误码
      • 上传材料
      • 代运营服务商帮老师或代运营模式机构入驻
      • 自营机构/服务商入驻
      • 新增角色
      • 查询基础认证资质
      • 更新基础认证资质
      • 查询类目认证资质
      • 更新类目认证资质
      • 添加类目认证资质
      • 获取审核任务详情
      • 小程序绑定角色
      • 小程序解除绑定角色
      • 查询小程序已绑定的角色
      • 角色授权小程序
      • 解除授权小程序
      • 查询授权小程序
      • 更新授权小程序授权信息
      • 查询抖音号绑定、能力授权
      • 新增抖音号绑定、能力授权
      • 解除抖音号绑定、解除能力授权
      • 查询实体ID
      • 查询实体已绑定抖音号列表
    • 课程库
      • 【泛知识】回调通知
      • 【泛知识】课程库 FAQ
      • 【泛知识】错误码
      • 【泛知识】上传课程资源
      • 【泛知识】查询课程资源上传状态
      • 【泛知识】查询资质
      • 【泛知识】添加课程
      • 【泛知识】修改课程
      • 【泛知识】修改课程状态
      • 【泛知识】查询课程
      • 【泛知识】修改课程免审
      • 【泛知识】查询免审课程
      • 【泛知识】修改商品退款规则
      • 【泛知识】查询可选退款规则
      • 【泛知识】查询课程类目信息
  • 担任支付
    • 进件
      • 进件状态回调
      • 发起进件请求
      • 图片上传接口
      • 进件状态查询
    • 支付
      • 支付结果回调
      • 支付常见问题
      • 预下单接口
      • 唤起收银台
      • 支付结果查询
    • 退款
      • 退款结果回调
      • 退款常见问题
      • 发起退款
      • 退款结果查询
    • 结算及分账
      • 收费规则
      • 结算及分账常见问题
      • 自动结算
        • 自动结算接入说明
        • 自动结算结果回调
        • 自动结算结果查询
      • 发起结算及分账
      • 结算及分账结果查询
      • 结算及分账结果回调
      • 可分账余额查询
    • 退分账
      • 发起退分账
      • 查询分账回退结果
    • 提现
      • 商户余额查询
      • 商户提现
      • 商户提现结果查询
      • 商户提现回调
    • 获取对账单
      • 获取交易账单
      • 获取资金账单
    • 接口获取页面链接
      • 进件
        • 开发者获取小程序收款商户/合作方进件页面
        • 服务商获取小程序收款商户进件页面
        • 服务商获取服务商进件页面
        • 服务商获取合作方进件页面
      • 提取
        • 开发者获取小程序收款商户/合作方提现页面
        • 服务商获取小程序收款商户提现页面
        • 服务商获取服务商提现页面
        • 服务商获取合作方提现页面
    • 订单推送
      • 订单同步
  • 评价
    • 获取评价数据
  • 其他
    • 用户登录态签名
    • 抖音开放平台与小程序视频打通能力
      • 抖音开放平台与小程序视频打通能力
      • 视频使用能力能力
    • 开放能力配置接口
      • 开放能力配置接口
      • 配置开放能力实现接口
      • 查询生效中配置接口
    • 解决方案测试实体管理接口
      • 解决方案测试实体管理接口
      • 新增测试实体接口
      • 查询测试实体接口
      • 删除测试实体接口
    • 直播间自定义封面
    • 上传资源
    • 能力申请
    • 查询能力申请状态
  • 订阅消息
    • 查询订阅消息模版库
    • 发送订阅消息
    • 查询小程序的模版列表
    • 添加模板
    • 删除已添加的模版
    • 查询新建订阅消息模板列表
    • 新建订阅消息模板
  • 小程序推广计划
    • 短视频任务
      • 创建任务
        • 小程序任务台能力
        • 创建任务
      • 查询任务台任务投稿视频数据(明细)
      • 查询任务台任务投稿视频数据
      • 查询小程序任务台任务 ID
      • 更新任务状态
      • 重新提交任务基础信息
      • 查询任务详情
      • 更新专属任务达人
      • 查询视频任务相关实时汇总数据
    • 直播间任务
      • 创建直播间任务
      • 更新直播间任务
  • 挂载
    • 自主挂载
      • 获取作者视频列表
      • 自主挂载存量视频绑定锚点
      • 自主挂载存量视频解绑锚点
    • 小程序直播挂载黑白名单管理能力
    • 拍抖音黑白名单管理能力
    • 申请短视频自主挂载能力
    • 查询短视频自主挂载能力申请状态
    • 申请直播自主挂载能力
    • 查询直播自主挂载能力申请状态
    • 申请短视频达人推广挂载能力
    • 查询短视频达人推广挂载能力申请状态
    • 查询直播达人推广挂载能力申请状态
    • 申请直播达人推广挂载能力
    • 短视频/直播自主挂载能力绑定抖音号
    • 获取短视频/直播自主挂载抖音号绑定二维码
    • 查询短视频/直播自主挂载能力绑定抖音号列表
    • 解除短视频/直播自主挂载能力抖音号绑定
    • 挂载权限校验
    • 修改短视频锚点配置
    • 查询短视频锚点配置
    • 查询短视频锚点配置修改记录及状态
    • 图片上传
    • 图片审核状态查询
    • 图片删除
    • 设置全局默认配置
    • 设置指定页面配置
    • 查询全局默认配置
    • 查询指定页面配置
    • 删除指定页面配置
    • 讲解卡动态更新
  • 分发
    • 添加小程序别名
    • 查询小程序别名
    • 修改小程序别名
    • 删除小程序别名
    • 设置小程序搜索标签
    • 查询小程序搜索标签列表
  • 引导关注抖音号
    • 绑定抖音号
    • 获取抖音号绑定二维码
    • 获取绑定抖音号列表
    • 解除抖音号绑定
  • 数据分析
    • 用户分析
      • 行为分析
      • 实时分析
      • 留存分析
      • 来源分析
      • 用户画像
      • 终端分析
      • 页面分析
    • 交易分析
      • 总览分析
      • 流量转化
      • 短视频交易分析
      • 获取直播房间数据
      • 直播数据分析
      • 直播交易分析
      • 商品分析
    • 短视频分析
      • 短视频投稿数据
      • 短视频总览数据
      • 短视频详细数据
      • 流量来源
    • 直播分析
      • 直播间详细数据
        • 接口 1
        • 接口 2
      • 直播间总览数据
      • 主播分析
    • 小房子直播分析
      • 小房子直播间总览数据
      • 小房子直播间详细数据
      • 小房子直播间订单数据
    • 留资分析
      • 组件使用数据
      • 流量来源
      • 组件详细数据
      • 组件使用对比
  • 服务类目
    • 获取已设置的服务类目
  • 直播间能力
    • 查询跳转抖音直播间能力申请状态
    • 申请跳转抖音直播间能力
    • 查询直播间状态组件能力申请状态
    • 申请直播间状态组件能力
  • 抖音开放能力
    • 查询抖音开放能力列表
    • 申请开通抖音开放能力
    • 查询scope配额详情
    • scope申请提额
    • 查询视频关键词列表
    • 新增视频关键词
    • 删除视频关键词
  • 页面结构自定义
    • 查询页面结构自定义能力申请状态
    • 申请页面结构自定义能力
  • 普通二维码绑定
    • 查询普通二维码绑定列表
    • 新增绑定二维码
    • 更新绑定二维码链接
    • 更新绑定二维码状态
    • 删除绑定二维码链接
  • 抖音号绑定
    • 获取抖音号绑定所需的资质模版列表
    • 获取抖音号绑定所需的资质模版信息
    • 输入抖音号绑定
    • 获取抖音号绑定二维码
    • 查询抖音号绑定列表及状态
    • 解除抖音号绑定
  • 流量主
    • 查询流量主开通状态
    • 开通流量主
    • 查询广告位列表
    • 新增广告位
    • 更新广告位状态
    • 查询广告收入
    • 查询广告结算单列表
  • 抖店绑定
    • 绑定抖店开放平台账号
    • 查询绑定的抖店开放平台账号信息
    • 配置抖店开放平台应用
    • 查询配置的抖店开放平台应用信息
    • 获取绑定抖店账号信息
  1. 结算

发起分账

开发环境
http://dev-cn.your-api-server.com
开发环境
http://dev-cn.your-api-server.com
POST
https://open.douyin.com/api/trade_basic/v1/developer/settle_create
一笔订单到达结算周期后,开发者可以通过分账接口将这笔订单产生的资金结算给各个分账方。

使用限制#

无

接口说明#

接入前准备#

接入接口前请先查看接入前准备是否完成

分账规则#

按小程序维度进行配置,一般有两类:
核销 D+N。例如核销 D+3,如果按整单分账,则要求整单到达“终态”3 个自然日后可以分账;如果按券分账,则要求券到达终态3个自然日后可以分账。“终态”表示所有的券/商品已核销或已退款。
支付D+N。例如支付D+7,表示订单支付成功7个自然日后可以分账。
CPS 订单比较特殊,统一结算规则是核销 D+3。
如对上述结算规则有特殊需求,请联系对应行业技术支持人员。
如果是次卡订单,则每次发起请求会将已经履约的金额进行分账。
举个例子
小程序 A 是核销 D+3 分账,用户的一笔订单 X 买了 5 张团购券
按整单分账时,对于订单 X,其中 3 张先核销,剩余 2 张再退款,最终退款完成的时间就是订单到达终态的时间。订单到达终态 3 天后,则可以发起分账
按券分账时,对于订单 X,其中 1 张券先核销,核销 3 天后可以发起这张券的分账
如果是次卡订单,对于订单 X,履约了第 1、2 次发起分账,则本次分账会将第 1、2 次对应的金额进行结算

分账类型#

整单分账
按券分账
分账规则和整单一致,如果整单是按核销D+3,按券结算也需要满足券核销D+3。
整单分账和券分账互斥,即一笔订单如果有1张券已经分账了,则不再允许发起整单分账,其他券都要按券发起结算。
支付D+N结算的小程序不允许发起券分账,只能整单分账

分账发起方#

开发者,即主动分账
平台,即自动分账
配置了自动分账后,不允许开发者再发起主动分账

错误码#

HTTP 状态码错误码描述排查建议
40010000param error请根据返回错误信息,修正传参。
40023000system error内部错误,可以原参重新请求
40023024item_order_id not existitem_order_id对应订单不存在,请检查传参是否正确
40023025item_order_id not match out_order_noitem_order_id对应订单与out_order_no对应订单不匹配
40023101order does not exist对应的订单不存在,请检查传参
40023102order not pay订单未支付成功,无法分账
40023107order not finish订单未完成,当前无法分账(配置了核销后分账,当前订单未核销)
40023111out_settle_no has existed该分账单已存在,请用查询接口查询分账结果
40023112no money to settle已无可分账金额
40023113order not allow settle订单不允许分账,当前无可分账子单
40023117this appID is configured with automatic settlement该订单属于自动结算单,无需开发者请求分账
40023118not allow entire settle不允许整单结算,当前已存在子单券结算,不再允许整单结算
40023124partial settle is grayscale部分分账功能灰度中,请联系运营开通
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://open.douyin.com/api/trade_basic/v1/developer/settle_create' \
--header 'Content-Type: application/json' \
--data-raw '{
    "out_order_no":"out_order_example_1",
    "out_settle_no":"out_settle_example_1",
    "settle_desc":"分账描述",
    "settle_params":"[{\"merchant_uid\":\"分账方商户号1\",\"amount\":100}]",
    "ext":"test",
    "notify_url":"https://www.xxxx.com"
}'
响应示例响应示例
200 - 示例 1
{
  "err_msg": "string",
  "err_no": 0,
  "log_id": "string",
  "data": {
    "wallet_settle_id": "string",
    "settle_id": "string"
  }
}

请求参数

Body 参数application/json
out_order_no
string 
必需

开发者侧订单 id,长度 <= 64 字节,与唯一 order_id 关联

out_settle_no
string 
必需

开发者侧分账单 id,分账请求的唯一标识,长度 <= 64 字节

settle_desc
string 
必需

分账描述,长度 <= 512 字节

settle_params
string 
可选

其他分账方(除卖家之外的),长度 <= 512 字节

ext
string 
可选

开发者自定义透传字段,不支持二进制,会在查询分账接口cp_extra字段原样返回,长度 <= 2048 字节

notify_url
string 
可选

分账结果通知地址,若不填,默认使用在行业模板配置-消息通知中指定的回调地址 必须是 HTTPS 类型 长度 <= 512 字节

示例

返回响应

🟢200成功
application/json
Body
err_msg
string 
必需
err_no
integer 
必需
错误码,详见文档底部错误码列表
log_id
string 
必需
日志ID,平台咨询时可提供方便快速定位问题
data
object 
接口数据详情
可选
wallet_settle_id
string 
小程序底层分账单号
必需
settle_id
string 
小程序侧分账单号
必需
🟠400请求有误
上一页
推送履约状态
下一页
查询分账
Built with