发起解约
收藏接口说明
可用该接口解约周期代扣。
- 签约单状态只有在 服务中（SERVING）才允许解约。
使用限制
无
基本信息
| 名称 | 描述 |
|---|---|
| HTTP URL | https://open.douyin.com/api/trade_auth/v1/developer/terminate_sign/ |
| HTTP Method | POST |
| Scope | trade_auth.developer.cycle |
| 权限要求 | 无 |
请求参数
请求头
access-token必填String
示例：clt.943da17996fb5cebfbc70c044c3fc25a57T54DcjT6HNKGqnUdxzy1KcxFnZ
content-type必填String
示例：application/json
固定值"application/json"
Body
auth_order_id必填String
示例："ad712312312313213"
平台侧签约单的单号，长度<=64byte，即调用tt.createSignOrder获取的签约单号
请求示例
curl --location --request POST 'https://open.douyin.com/api/trade_auth/v1/developer/terminate_sign' \ --header 'Content-Type: application/json' \ --header 'access-token: clt.xxx' \ --data-raw='{ "auth_order_id" : "ad712312312313213" }'
响应参数
Body
err_msg必填String
示例：success
错误提示
err_no必填Int32
示例：0
错误码
log_id必填String
示例：2023010128382726
抖音开平统一日志id
响应示例
正常响应示例异常响应示例
{ "err_no": 0, "err_msg": "success", "log_id": "2022092115392201020812109511046" }
切换单列布局错误码
| HTTP 状态码 | 错误码 | 错误码描述 | 排查建议 |
|---|---|---|---|
| 200 | 10000 | 参数错误 | 对照错误提示和接口字段定义，检查对应的参数 |
| 200 | 12001 | 操作过于频繁，请稍后再试 | 请等待2-3秒，再重试 |
| 200 | 13000 | 系统错误 | 请重试，若多次重试仍然报错，请联系oncall |
| 200 | 20000 | 订单不存在 | 查不到该订单，按以下步骤排查：
|
| 200 | 32002 | 订单状态不支持解约 | 签约单状态只有在 服务中 才允许解约，请通过 查询签约订单 确定签约单状态 |
