取消
最近搜索
清空历史

关闭订单

1. 接口描述

https://dev.kdlapi.com/api/closeorder 英文代号:close order

关闭指定订单。
此接口只对按量付费(后付费)订单有效,调用成功后订单状态变更为“已关闭(待结算)”,订单冻结的金额会在下一次结算时自动解冻。

  • 必须使用订单API密钥调用本接口
  • 接口最快调用频率:1秒1次

2. 参数说明

参数 是否必填 参数说明 取值说明
secret_id 订单SecretId 查看订单API密钥信息
sign_type 签名验证方式。目前支持token和hmacsha1。 默认值:token
signature 请求签名,用来验证此次请求的合法性。 支持2种签名验证方式,签名计算方法参见API 授权与验证
timestamp 当前 UNIX 时间戳(秒级),可记录发起 API 请求的时间。
sign_type=hmacsha1时此参数为必填项。
例如1557546010,如果与当前时间相差过大,会引起签名过期错误。
nonce 随机正整数,与 timestamp 联合起来,用于防止重放攻击。建议携带此参数进一步提升API安全性。
sign_type=hmacsha1时此参数有效。
客户自行生成随机正整数,如random.randint(1, 100000000)

3. 调用示例

在会员中心API密钥管理页得到订单的SecretId和SecretKey:

  • SecretId:o1fjh1re9o28876h7c08
  • SecretKey:jd1gzm6ant2u7pojhbtl0bam0xpzsm1c

以密钥令牌验证为例,调用获取密钥令牌接口得到密钥令牌:

  • SecretToken:oxf0n0g59h7wcdyvz2uo68ph2s

调用示例

https://dev.kdlapi.com/api/closeorder?secret_id=o1fjh1re9o28876h7c08
&signature=oxf0n0g59h7wcdyvz2uo68ph2s

使用说明

点击查看关于API授权与验证的介绍

4. 返回结果

接口返回json格式,样例:

{
  "msg": "order closed",
  "code": 0,
  "data": ""
}

异常返回格式样例:

{"code": -1, "msg": "参数错误", "data": ""}

5. 错误码一览

错误码 说明
-2 订单状态错误
-3 订单类型错误
-4 API密钥类型错误,请使用账户API密钥

6. SDK

快代理提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

SDK下载

联系我们