抖音开放平台Logo
开发者文档
“/”唤起搜索
控制台

组件列表

组件
描述
前端模板提供了一个入口组件pay-button,该组件是小程序基础库内置组件,通过这个组件实现从小程序跳转到交易模板页面,可直接使用。
前端模板提供了一个组件consume-card,开发者通过使用该组件展现抖音码,用户通过抖音码可到店核销。

JSAPI 列表

模块
JSAPI
描述
预下单
提供开发者交易系统中预下单能力,开发者通过调用该方法生成订单后,会调起小程序收银台进行支付。
支付
通过继续支付方法调起小程序收银台,引导用户支付未成功支付的订单。
逆向交易
通过申请退款方法可退款指定份数/指定金额的商品。

OpenAPI 列表

模块
OpenAPI
描述
回调设置
抖音开放平台交易系统在下单、退款、分账等流程中需要与开发者系统同步信息,这个接口为抖音开放平台交易系统同步信息给开发者提供回调地址。
查询开发者设置的回调地址,本接口会一次返回开发者所设置的全部回调地址。
预下单
查询订单 CPS 信息。可用于判断订单是否为 CPS 订单。返回数据包含订单的支付、CPS、退款、核销等信息。
​
查询订单基本信息。
​
通过模板组件发起下单时,抖音开平交易系统会请求开发者服务,将下单信息传递给开发者服务。
​
如果用户抖音版本过低,无法使用前端 JSAPI 下单,开发者可用该接口替用户发起下单。
营销算价
模板组件提单页通过本接口从开发者的服务获取可用的相关营销信息,展示给用户。
​
当用户在模板组件提单页下单时,抖音开平交易系统会携带用户选择营销信息,向开发者的服务发起请求,获取基于用户所选营销信息的算价结果。
​
用于配置营销信息查询扩展点和算价扩展点。设置结果可通过交易回调查询接口获取。
支付
订单支付成功/取消时,抖音开平交易系统会给向开发者的服务发起请求,将支付结果通知到开发者服务端。
核销
抖音码订单的核销,需要调用两个接口。先调用验券准备接口,获得加密券码等信息后,再调用验券实现核销。 验券准备接口会返回可用券列表。开发者自行选择需要核销的券数据传入验券接口进行核销。
​
请求验券准备接口后,开发者自行选择需要核销的可用券信息传入此验券接口,完成核销操作。
​
批量查询一个订单中的券的相关状态信息,比如已核销、已退款等状态。
​
该接口用于同步订单的核销状态到开放平台。
分账
一笔订单到达结算周期后,开发者可以通过分账接口将这笔订单产生的资金结算给各个分账方。
​
开发者可通过此接口查询订单的分账记录。
​
分账处理完成后,抖音开平交易系统会给向开发者的服务发起请求,将分账结果通知到开发者服务端。
退货退款
当开发者需要替用户发起退款时,可用该接口替用户发起退款。
​
开发者使用该接口回传退款单的退款审核结果。
​
开发者可通过此接口查询退款单的详情。适用场景举例:查询是否发起退款,查询退款单状态。
​
当用户从交易的模板组件发起退款后,抖音开平交易系统会给向开发者的服务发起请求,用于通知开发者用户发起退款,开发者响应时需要返回必填的信息。
​
退款处理完成后,抖音开平交易系统会给向开发者的服务发起请求,将退款结果通知到开发者服务端。
​