基础能力

触达与营销

支付

交易系统

担保支付（即将下线）

评价

抖店绑定

交易工具

信用免押

周期代扣

通用参数

签约授权

代扣

退款

结算

运营

生活服务

垂直行业

其它

通用参数

我的收藏

注意
此功能处于内测阶段，如需使用，请联系客服或已对接的运营申请

所有 OpenAPI 接口均需要设置这几个字段，API 文档中将不再重复解释。

字段名	类型	位置	是否必填	字段说明
Content-Type	string	Header	是	固定值：application/json
access-token	string	Header	是	调用/oauth/client_token/生成的token，此token不需要用户授权。示例: clt.xxx 注意生成token的返回值access_token 和请求信用免押接口的access-token值是同一个概念，字段名有差异。

平台请求开发者公共参数

注意：这里是平台调用开发者系统的时候请求头中携带的内容

字段名	类型	位置	是否必填	字段说明	取值范例
Content-Type	string	Header	是	固定值：application/json	application/json
Byte-Identifyname	string	Header	是	开平扩展点/消息的标识符	/order/create_order_callback_url
Byte-Logid	string	Header	是	抖音开平统一日志id，当出现问题时可以提供此id给抖音研发人员协助定位问题	20230504163800ABA7347CE4F5
Byte-Nonce-Str	string	Header	是	随机字符串，由字母、数字、下划线组成，区分大小写，len(Byte-Nonce-Str) <= 128，请参考-签名算法	Bhw73xUDN91kova0f3KkVegl0WPpz9BZ
Byte-Signature	string	Header	是	请求包签名，请参考-签名算法	mx0xMwumjHScvSjFHjKTvSlBJu1G2aw==
Byte-Timestamp	string	Header	是	请求时间戳，精度：秒，请参考-签名算法	1683189481

签名算法

•

外部开发者请求抖音开放平台交易系统接口

如上面的请求公共参数说明，抖音开放平台交易系统的 OpenAPI 接口均使用 access-token 参数鉴权，如无特殊说明则不需要添加额外的签名参数。

•

抖音开放平台交易系统请求外部开发者的接口

当抖音开放平台交易系统需要回调开发者接口时，比如预下单回调、支付完成通知等场景，抖音开放平台交易系统会在 header 中添加签名参数，开发者需要对签名参数进行校验。

具体的签名算法请参考-签名算法-签名验证。

字段和格式约定

重要 ID 字段说明

ID 字段	说明
auth_order_id	在发起签约(tt.createSignOrder)后，平台生成的周期代扣签约单的单号，开发者可以用该单号唤起签约页面(tt.sign)。
pay_order_id	在调用发起代扣接口后，平台生成的代扣单的单号。
pay_refund_id	在调用发起退款接口后，平台生成的退款单的单号。

重要字段的格式和约束说明

•

对于系统涉及到的订单号类 ID，如果没有特殊说明则默认合法格式如下：

◦

<= 64 byte

◦

由 ASCII 英文字符、数字、下划线组成，区分大小写

•

用户、商户、商家等身份类id标志，如果没有特殊说明则默认合法格式如下：

◦

<= 32 byte

◦

由 ASCII 英文字符、数字组成，区分大小写

•

金额的单位，统一为：分。

•

URL 类字段长度必须 <= 512 byte，支持 UTF-8 字符集，不支持 Unicode 字符。

•

时间类型的相关字段有 string 和 int 两种类型：

◦

string 类型时间如无特殊说明，则格式为 yyyy-MM-dd HH:mm:ss。

◦

int 型时间则为系统时间戳，单位为毫秒，即 1970 年 1 月 1 日到当前时间所走过的毫秒数。

•

所有接口默认支持字符集为 UTF-8，不支持 Unicode 字符集，所有字段都不支持二进制数据传递（非二进制安全）。