Orders
Reclaim Order
Take back an order’s bandwidth before its term ends
POST
/
v1
/
orders
/
{order_id}
/
reclaim
Reclaim Order
curl --request POST \
--url https://api.tronrental.com/v1/orders/{order_id}/reclaimimport requests
url = "https://api.tronrental.com/v1/orders/{order_id}/reclaim"
response = requests.post(url)
print(response.text)const options = {method: 'POST'};
fetch('https://api.tronrental.com/v1/orders/{order_id}/reclaim', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.tronrental.com/v1/orders/{order_id}/reclaim",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.tronrental.com/v1/orders/{order_id}/reclaim"
req, _ := http.NewRequest("POST", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.tronrental.com/v1/orders/{order_id}/reclaim")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.tronrental.com/v1/orders/{order_id}/reclaim")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
response = http.request(request)
puts response.read_bodyReclaim Order
Undelegates the bandwidth of your order right away — for example, once the address has made the transfer it was rented for — instead of waiting for the end of the term. The unused time is not refunded. Only bandwidth orders can be reclaimed early.Path parameters
Response
Returns the order object, the same as Get Order.status tells what happened:
| Status | Meaning |
|---|---|
reclaimed | The bandwidth was undelegated while this request waited (it waits up to about 10 seconds); undelegate_txid is the on-chain transaction |
filled | The undelegation did not finish within the request; the next reclaim cycle completes it, usually within 30 seconds. The result arrives in the order.updated webhook, or poll Get Order |
reclaiming | A reclaim of this order is already running |
reclaim_failed | The undelegation did not go through on our side after retries. Nothing for you to do |
reclaiming, reclaimed or reclaim_failed returns the order unchanged, so retries are safe. The API key needs the buy_bandwidth scope.
Errors
| Code | Status | When |
|---|---|---|
ORDER_NOT_FOUND | 404 | No such order on your account |
ORDER_NOT_RECLAIMABLE | 409 | The order is not delivered (filled) yet, or it failed |
BAD_REQUEST | 400 | Not a bandwidth order |
FORBIDDEN | 403 | The API key lacks the buy_bandwidth scope |
Example
curl -X POST https://api.tronrental.com/v1/orders/12345/reclaim \
-H "X-API-Key: your_api_key"
Response
{
"id": 12345,
"type": "bandwidth",
"target_address": "TRecipientAddress...",
"volume": 350,
"duration": "1h",
"price_trx": "0.42",
"fixed_fee_trx": "0.2",
"status": "reclaimed",
"delegate_txid": "a1b2c3d4e5f6...",
"undelegate_txid": "f6e5d4c3b2a1...",
"reclaim_at": "2026-11-11T11:00:00Z",
"source": "api",
"activation_id": null,
"activation_cost_trx": null,
"fail_reason": null,
"refunded_trx": null,
"created_at": "2026-11-11T10:00:00Z"
}
⌘I
Reclaim Order
curl --request POST \
--url https://api.tronrental.com/v1/orders/{order_id}/reclaimimport requests
url = "https://api.tronrental.com/v1/orders/{order_id}/reclaim"
response = requests.post(url)
print(response.text)const options = {method: 'POST'};
fetch('https://api.tronrental.com/v1/orders/{order_id}/reclaim', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.tronrental.com/v1/orders/{order_id}/reclaim",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.tronrental.com/v1/orders/{order_id}/reclaim"
req, _ := http.NewRequest("POST", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.tronrental.com/v1/orders/{order_id}/reclaim")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.tronrental.com/v1/orders/{order_id}/reclaim")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
response = http.request(request)
puts response.read_body