关闭扣款
收藏接口说明
因某种情况，扣款一直未成功或商家想取消扣款，可以调用该接口关闭未扣款成功的扣款单。
- 仅支持扣款单在处理中（PROCESSING）状态下关单，扣款单已经扣款成功或失败的情况，无法关单。
使用限制
无
基本信息
| 名称 | 描述 |
|---|---|
| HTTP URL | https://open.douyin.com/api/trade_auth/v1/developer/close_pay_order/ |
| HTTP Method | POST |
| Scope | trade_auth.developer.trade_pay |
| 权限要求 | 无 |
请求参数
请求头
access-token必填String
示例：clt.943da17996fb5cebfbc70c044c3fc25a57T54DcjT6HNKGqnUdxzy1KcxFnZ
content-type必填String
示例：application/json
固定值"application/json"
Body
pay_order_id必填String
示例："ad712312662434"
调用发起扣款接口后，会得到扣款单平台订单号（pay_order_id），此处关闭扣款的接口需要传递该订单号，用来关闭对应的订单。
请求示例
curl --location --request POST 'https://open.douyin.com/api/trade_auth/v1/developer/close_pay_order' \ --header 'Content-Type: application/json' \ --header 'access-token: clt.xxx' \ --data-raw='{ "pay_order_id": "ad712312662434" }'
响应参数
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 | 32005 | 扣款单状态不支持关单 | 扣款单只有在处理中，才允许关单 |
