Create Settlement for a Trader
Create settlement for a trader. Learn more about Fireblocks Off Exchange in the following guide. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor.
POST
/
off_exchange
/
settlements
/
trader
TypeScript
const response: Promise<FireblocksResponse<SettlementResponse>> = fireblocks.offExchanges.settleOffExchangeTrades(offExchangesApiSettleOffExchangeTradesRequest);CompletableFuture<ApiResponse<SettlementResponse>> response = fireblocks.offExchanges().settleOffExchangeTrades(settlementRequestBody, idempotencyKey);response = fireblocks.off_exchanges.settle_off_exchange_trades(settlement_request_body, idempotency_key);curl --request POST \
--url https://api.fireblocks.io/v1/off_exchange/settlements/trader \
--header 'Content-Type: application/json' \
--data '
{
"mainExchangeAccountId": "<string>"
}
'const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({mainExchangeAccountId: '<string>'})
};
fetch('https://api.fireblocks.io/v1/off_exchange/settlements/trader', 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.fireblocks.io/v1/off_exchange/settlements/trader",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'mainExchangeAccountId' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.fireblocks.io/v1/off_exchange/settlements/trader"
payload := strings.NewReader("{\n \"mainExchangeAccountId\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}require 'uri'
require 'net/http'
url = URI("https://api.fireblocks.io/v1/off_exchange/settlements/trader")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"mainExchangeAccountId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"initiator": "<string>",
"exchangeReply": "<string>",
"fireblocksInitiatedTransactions": {},
"exchangeRequestedTransactions": {
"toExchange": [
{
"assetId": "<string>",
"amount": "<string>",
"dstAddress": "<string>",
"dstTag": "<string>"
}
],
"toCollateral": [
{
"asset": "<string>",
"amount": "<string>",
"srcAddress": "<string>",
"srcTag": "<string>",
"fee": "<string>"
}
]
}
}{
"message": "<string>",
"code": 123
}Headers
A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours.
Body
application/json
Was this page helpful?
Previous
Get Settlements TransactionsGet settlements transactions from exchange.
Learn more about Fireblocks Off Exchange in the following [guide](https://developers.fireblocks.com/docs/off-exchange).
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor.
Next
⌘I
TypeScript
const response: Promise<FireblocksResponse<SettlementResponse>> = fireblocks.offExchanges.settleOffExchangeTrades(offExchangesApiSettleOffExchangeTradesRequest);CompletableFuture<ApiResponse<SettlementResponse>> response = fireblocks.offExchanges().settleOffExchangeTrades(settlementRequestBody, idempotencyKey);response = fireblocks.off_exchanges.settle_off_exchange_trades(settlement_request_body, idempotency_key);curl --request POST \
--url https://api.fireblocks.io/v1/off_exchange/settlements/trader \
--header 'Content-Type: application/json' \
--data '
{
"mainExchangeAccountId": "<string>"
}
'const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({mainExchangeAccountId: '<string>'})
};
fetch('https://api.fireblocks.io/v1/off_exchange/settlements/trader', 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.fireblocks.io/v1/off_exchange/settlements/trader",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'mainExchangeAccountId' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.fireblocks.io/v1/off_exchange/settlements/trader"
payload := strings.NewReader("{\n \"mainExchangeAccountId\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}require 'uri'
require 'net/http'
url = URI("https://api.fireblocks.io/v1/off_exchange/settlements/trader")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"mainExchangeAccountId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"initiator": "<string>",
"exchangeReply": "<string>",
"fireblocksInitiatedTransactions": {},
"exchangeRequestedTransactions": {
"toExchange": [
{
"assetId": "<string>",
"amount": "<string>",
"dstAddress": "<string>",
"dstTag": "<string>"
}
],
"toCollateral": [
{
"asset": "<string>",
"amount": "<string>",
"srcAddress": "<string>",
"srcTag": "<string>",
"fee": "<string>"
}
]
}
}{
"message": "<string>",
"code": 123
}