---
title: "Reclaim order 
回收订单"
method: POST
path: "/v1/reclaim/{id}"
tags: ["API SERVICE"]
---

# Reclaim order 
回收订单

`POST /v1/reclaim/{id}`

## Path parameters

- `id` string, required

## Headers

- `CF-ACCESS-KEY` string, required
- `CF-ACCESS-SIGN` string, required
- `CF-ACCESS-TIMESTAMP` string, required

## Response `200`

OK

- XOrderPayload
  - `code` integer — 成功返回0，其他均为错误
  - `msg` string — 发生错误时候返回的消息
  - `sub_code` string
  - `sub_msg` string
  - `data` OrderPayload
    - `id` string — Order ID, you can get order details by id 订单ID,接口订单详情(/api/v1/order/{id})的必要参数
    - `client_order_id` string — Custom order id 客户自定义订单ID
    - `resource_type` 'ENERGY' | 'BANDWIDTH' — Resource type ENERGY or BANDWIDTH 类型：能量(ENERGY) 或 带宽(BANDWIDTH)
    - `billing_type` 'TRANSFER' | 'DAPP' | 'BALANCE' | 'API' | 'BOT' — Billing type NORMAL | SUBSCRIBE | PERMISSION 订单类型：NORMAL | SUBSCRIBE | PERMISSION
    - `source_type` 'TRANSFER' | 'DAPP' | 'BALANCE' | 'API' | 'BOT' — Source type TRANSFER | DAPP | BALANCE | API | BOT 订单来源类型：TRANSFER | DAPP | BALANCE | API | BOT
    - `pay_timestamp` integer — Payment timestamp 订单付款的时间戳
    - `receiver` string — Resource receiving address 能量接收地址
    - `delegate_hash` string — Delegation hash 代理能量的HASH值
    - `delegate_timestamp` integer — Delegation timestamp 代理能量的时间戳
    - `reclaim_hash` string — Reclaim hash 回收能量的HASH值
    - `reclaim_timestamp` integer — Reclaim timestamp 回收能量的时间戳
    - `pay_amount_sun` integer — Payment amount(unit:sun) 支付金额(SUN)
    - `activate_amount_sun` integer — Activate amount(unit:sun) 激活费用(SUN)
    - `quantity` integer — Resource quantity 购买的能量数量
    - `staked_sun` integer — Resource staked amount(unit:sun) 获取资源需要质押的金额(SUN)
    - `duration` integer — Delegation duration(minute) 代理最大可用时长(分钟)
    - `expired_timestamp` integer — Resource expired timestamp 过期时间戳，过期自动回收
    - `status` 'PAYMENT_SUCCESS' | 'DELEGATE_SUCCESS' | 'DELEGATE_FAIL' | 'INSUFFICIENT_BALANCE' | 'QUANTITY_TOO_HIGH' | 'QUANTITY_TOO_LOW' | 'ADDRESS_NOT_ACTIVATED' | 'INVALID_ADDRESS' | 'UNKNOWN' — Order status 订单状态
    - `activate_status` 'DEACTIVATE' | 'ACTIVATE' | 'ACTIVATED' | 'ALREADY_ACTIVATED' — Activate status 激活状态
    - `confirm_status` 'UNCONFIRMED' | 'DELEGATION_CONFIRMED' | 'DELEGATION_CONFIRMED_FAIL' — Confirmation status 链上确认状态
    - `balance` integer — Current user balance(unit:SUN) 用户余额(单位SUN)

---

[API](https://skmtc.net/catfee/apis/auction-api.md) · [All operations](https://skmtc.net/catfee/apis/auction-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/catfee/auction-api/revisions/09a793a37d89/schema)