信用订单撤销
接口说明
可用该接口撤销信用单。
- 信用单状态只有在 待服务(TOBESERVED)、服务中(SERVING)才允许撤销信用单。
- 已发起转支付的情况,无法撤销信用单。
使用限制
无
基本信息
名称 | 描述 |
---|---|
HTTP URL | https://open.douyin.com/api/trade_auth/v1/developer/cancel_auth_order/ |
HTTP Method | POST |
Scope | trade_auth.developer.trade_auth |
权限要求 | 无 |
请求参数
请求头
access-token必填String
示例:clt.943da17996fb5cebfbc70c044c3fc25a57T54DcjT6HNKGqnUdxzy1KcxFnZ
content-type必填String
示例:application/json
固定值"application/json"
Body
auth_order_id必填String
示例:"ad712312312313213"
进行信用下单之后,可获取信用单平台订单号(auth_order_id),此处传递该值即可。
请求示例
curl --location --request POST 'https://open.douyin.com/api/trade_auth/v1/developer/cancel_auth_order' \ --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 | 13000 | 系统错误 | 请重试,若多次重试仍然报错,请联系oncall |
200 | 20000 | 订单不存在 | 查不到该订单,请检查订单号是否传错,是否把 out_auth_order_no 当 auth_order_id 传入 |
200 | 32002 | 订单状态不支持撤销 | 信用单状态只有在 待服务、服务中 才允许撤销,请通过 信用额度订单查询接口 确定信用单状态 |
200 | 32003 | 已发起转支付,无法撤销 | 已发起转支付的情况下,无法撤销信用单 |