关闭订单

开发环境

http://dev-cn.your-api-server.com

POST

/api/apps/trade/v2/order/close_order

可用于关闭用户待支付订单。
请注意仅支持待支付订单关单，已支付、超时未支付订单无法关闭订单，已支付订单请走退款逻辑。

请求示例

Shell

JavaScript

Java

Swift

curl --location --request POST 'http://dev-cn.your-api-server.com/api/apps/trade/v2/order/close_order' \
--header 'access-token: clt.xxx' \
--header 'Content-Type: application/json' \
--data-raw '{
    "order_id" : "ots1230123132123"
}'

响应示例

200 - 成功示例

{
  "extra": {
    "sub_error_code": 0,
    "sub_description": "success",
    "logid": "2022092115392201020812109511046",
    "now": 1663745962686,
    "error_code": 0,
    "description": "success"
  }
}

请求参数

Header 参数

Content-Type

string

必需

示例值:

application/json

access-token

string

必需

示例值:

clt.xxx

Body 参数application/json

order_id

string

可选

抖音开平内部交易订单号，通过预下单回调传给开发者服务，长度 < 64byte

示例

返回响应

🟢200成功

application/json

Body

extra

object

必需

额外信息，参见通用参数

sub_error_code

integer

必需

sub_description

string

必需

logid

string

必需

now

integer

必需

error_code

integer

必需

description

string

必需

🟠400请求有误

预下单回调

发起下单