Retrieve settlements
curl --request POST \
--url https://api.custody.api-zodia.io/v3/api/interchange/settlements \
--header 'Content-Type: application/json' \
--data '
{
"settlementRequestIds": [
"<string>"
],
"fromDate": "<string>",
"toDate": "<string>",
"statuses": [
"SETTLEMENT_INITIATED"
],
"paginationLimit": 123,
"paginationOffset": 123
}
'import requests
url = "https://api.custody.api-zodia.io/v3/api/interchange/settlements"
payload = {
"settlementRequestIds": ["<string>"],
"fromDate": "<string>",
"toDate": "<string>",
"statuses": ["SETTLEMENT_INITIATED"],
"paginationLimit": 123,
"paginationOffset": 123
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
settlementRequestIds: ['<string>'],
fromDate: '<string>',
toDate: '<string>',
statuses: ['SETTLEMENT_INITIATED'],
paginationLimit: 123,
paginationOffset: 123
})
};
fetch('https://api.custody.api-zodia.io/v3/api/interchange/settlements', 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.custody.api-zodia.io/v3/api/interchange/settlements",
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([
'settlementRequestIds' => [
'<string>'
],
'fromDate' => '<string>',
'toDate' => '<string>',
'statuses' => [
'SETTLEMENT_INITIATED'
],
'paginationLimit' => 123,
'paginationOffset' => 123
]),
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.custody.api-zodia.io/v3/api/interchange/settlements"
payload := strings.NewReader("{\n \"settlementRequestIds\": [\n \"<string>\"\n ],\n \"fromDate\": \"<string>\",\n \"toDate\": \"<string>\",\n \"statuses\": [\n \"SETTLEMENT_INITIATED\"\n ],\n \"paginationLimit\": 123,\n \"paginationOffset\": 123\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))
}HttpResponse<String> response = Unirest.post("https://api.custody.api-zodia.io/v3/api/interchange/settlements")
.header("Content-Type", "application/json")
.body("{\n \"settlementRequestIds\": [\n \"<string>\"\n ],\n \"fromDate\": \"<string>\",\n \"toDate\": \"<string>\",\n \"statuses\": [\n \"SETTLEMENT_INITIATED\"\n ],\n \"paginationLimit\": 123,\n \"paginationOffset\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.custody.api-zodia.io/v3/api/interchange/settlements")
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 \"settlementRequestIds\": [\n \"<string>\"\n ],\n \"fromDate\": \"<string>\",\n \"toDate\": \"<string>\",\n \"statuses\": [\n \"SETTLEMENT_INITIATED\"\n ],\n \"paginationLimit\": 123,\n \"paginationOffset\": 123\n}"
response = http.request(request)
puts response.read_body{
"items": [
{
"header": {
"status": "SETTLEMENT_INITIATED",
"venueId": "<string>",
"errors": "<string>",
"settlementRequestId": "<string>",
"requestDateTime": "<string>",
"receivableAddresses": [
{
"address": "<string>",
"ledger": "<string>",
"destinationTag": 2147483647,
"memo": "<string>"
}
],
"instructionCount": 123
},
"settlements": [
{
"counterparty": {
"type": "WALLET_ID",
"value": "<string>"
},
"currencyId": "eth-USDC",
"currency": "USDC",
"ledger": "ETH",
"amount": "<string>",
"externalSettlementId": "<string>",
"transferId": "<string>",
"transactionHash": "<string>",
"status": "<string>"
}
],
"netSettlements": [
{
"counterparty": {
"type": "WALLET_ID",
"value": "<string>"
},
"currency": "USDC",
"ledger": "ETH",
"transferAmount": {
"amount": "6482,14",
"amountLedger": "648.214.000.000",
"amountFiat": "32,41"
},
"transferId": "<string>",
"transactionHash": "<string>",
"status": "<string>",
"currencyId": "eth-USDC"
}
]
}
],
"total": 123
}{
"timestamp": "2021-10-27T14:30:13.912Z",
"title": "Method Not Allowed",
"status": 415,
"details": [
{
"message": "Available methods : GET,POST",
"code": "ER-204"
}
]
}{
"timestamp": "2021-10-27T14:30:13.912Z",
"title": "Method Not Allowed",
"status": 415,
"details": [
{
"message": "Available methods : GET,POST",
"code": "ER-204"
}
]
}{
"timestamp": "2021-10-27T14:30:13.912Z",
"title": "Method Not Allowed",
"status": 415,
"details": [
{
"message": "Available methods : GET,POST",
"code": "ER-204"
}
]
}Interchange-V3
Retrieve settlements
POST
/
v3
/
api
/
interchange
/
settlements
Retrieve settlements
curl --request POST \
--url https://api.custody.api-zodia.io/v3/api/interchange/settlements \
--header 'Content-Type: application/json' \
--data '
{
"settlementRequestIds": [
"<string>"
],
"fromDate": "<string>",
"toDate": "<string>",
"statuses": [
"SETTLEMENT_INITIATED"
],
"paginationLimit": 123,
"paginationOffset": 123
}
'import requests
url = "https://api.custody.api-zodia.io/v3/api/interchange/settlements"
payload = {
"settlementRequestIds": ["<string>"],
"fromDate": "<string>",
"toDate": "<string>",
"statuses": ["SETTLEMENT_INITIATED"],
"paginationLimit": 123,
"paginationOffset": 123
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
settlementRequestIds: ['<string>'],
fromDate: '<string>',
toDate: '<string>',
statuses: ['SETTLEMENT_INITIATED'],
paginationLimit: 123,
paginationOffset: 123
})
};
fetch('https://api.custody.api-zodia.io/v3/api/interchange/settlements', 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.custody.api-zodia.io/v3/api/interchange/settlements",
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([
'settlementRequestIds' => [
'<string>'
],
'fromDate' => '<string>',
'toDate' => '<string>',
'statuses' => [
'SETTLEMENT_INITIATED'
],
'paginationLimit' => 123,
'paginationOffset' => 123
]),
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.custody.api-zodia.io/v3/api/interchange/settlements"
payload := strings.NewReader("{\n \"settlementRequestIds\": [\n \"<string>\"\n ],\n \"fromDate\": \"<string>\",\n \"toDate\": \"<string>\",\n \"statuses\": [\n \"SETTLEMENT_INITIATED\"\n ],\n \"paginationLimit\": 123,\n \"paginationOffset\": 123\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))
}HttpResponse<String> response = Unirest.post("https://api.custody.api-zodia.io/v3/api/interchange/settlements")
.header("Content-Type", "application/json")
.body("{\n \"settlementRequestIds\": [\n \"<string>\"\n ],\n \"fromDate\": \"<string>\",\n \"toDate\": \"<string>\",\n \"statuses\": [\n \"SETTLEMENT_INITIATED\"\n ],\n \"paginationLimit\": 123,\n \"paginationOffset\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.custody.api-zodia.io/v3/api/interchange/settlements")
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 \"settlementRequestIds\": [\n \"<string>\"\n ],\n \"fromDate\": \"<string>\",\n \"toDate\": \"<string>\",\n \"statuses\": [\n \"SETTLEMENT_INITIATED\"\n ],\n \"paginationLimit\": 123,\n \"paginationOffset\": 123\n}"
response = http.request(request)
puts response.read_body{
"items": [
{
"header": {
"status": "SETTLEMENT_INITIATED",
"venueId": "<string>",
"errors": "<string>",
"settlementRequestId": "<string>",
"requestDateTime": "<string>",
"receivableAddresses": [
{
"address": "<string>",
"ledger": "<string>",
"destinationTag": 2147483647,
"memo": "<string>"
}
],
"instructionCount": 123
},
"settlements": [
{
"counterparty": {
"type": "WALLET_ID",
"value": "<string>"
},
"currencyId": "eth-USDC",
"currency": "USDC",
"ledger": "ETH",
"amount": "<string>",
"externalSettlementId": "<string>",
"transferId": "<string>",
"transactionHash": "<string>",
"status": "<string>"
}
],
"netSettlements": [
{
"counterparty": {
"type": "WALLET_ID",
"value": "<string>"
},
"currency": "USDC",
"ledger": "ETH",
"transferAmount": {
"amount": "6482,14",
"amountLedger": "648.214.000.000",
"amountFiat": "32,41"
},
"transferId": "<string>",
"transactionHash": "<string>",
"status": "<string>",
"currencyId": "eth-USDC"
}
]
}
],
"total": 123
}{
"timestamp": "2021-10-27T14:30:13.912Z",
"title": "Method Not Allowed",
"status": 415,
"details": [
{
"message": "Available methods : GET,POST",
"code": "ER-204"
}
]
}{
"timestamp": "2021-10-27T14:30:13.912Z",
"title": "Method Not Allowed",
"status": 415,
"details": [
{
"message": "Available methods : GET,POST",
"code": "ER-204"
}
]
}{
"timestamp": "2021-10-27T14:30:13.912Z",
"title": "Method Not Allowed",
"status": 415,
"details": [
{
"message": "Available methods : GET,POST",
"code": "ER-204"
}
]
}Body
application/json
Starting from date of request
Up until date of request
Status of settlement request
Available options:
SETTLEMENT_RECEIVED, SETTLEMENT_INITIATED, SETTLEMENT_AWAITING_FUNDS, SETTLEMENT_PAY_IN, SETTLEMENT_PAY_OUT, SETTLEMENT_COMPLETE, SETTLEMENT_REJECTED, SETTLEMENT_FAILED Number of items in response (default is 10)
⌘I