Retrieve transfer rules
curl --request POST \
--url https://api.custody.api-zodia.io/v3/api/transfer-rule/wallets \
--header 'Content-Type: application/json' \
--header 'submitter-id: <submitter-id>' \
--data '
{
"ids": [
"<string>"
],
"walletIds": [
"ZTEST-NOBENF-W5NZ2XCZMF"
],
"statuses": [],
"companyIds": [
"ZTEST"
],
"enforcingCompanyIds": [
"<string>"
],
"transferRuleTypes": [
"DESTINATION"
],
"createdBy": [
"api-maker@zodia.io"
],
"updatedAt": "2021-05-11T04:43:43Z",
"paginationLimit": 10,
"paginationOffset": 123
}
'import requests
url = "https://api.custody.api-zodia.io/v3/api/transfer-rule/wallets"
payload = {
"ids": ["<string>"],
"walletIds": ["ZTEST-NOBENF-W5NZ2XCZMF"],
"statuses": [],
"companyIds": ["ZTEST"],
"enforcingCompanyIds": ["<string>"],
"transferRuleTypes": ["DESTINATION"],
"createdBy": ["api-maker@zodia.io"],
"updatedAt": "2021-05-11T04:43:43Z",
"paginationLimit": 10,
"paginationOffset": 123
}
headers = {
"submitter-id": "<submitter-id>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'submitter-id': '<submitter-id>', 'Content-Type': 'application/json'},
body: JSON.stringify({
ids: ['<string>'],
walletIds: ['ZTEST-NOBENF-W5NZ2XCZMF'],
statuses: [],
companyIds: ['ZTEST'],
enforcingCompanyIds: ['<string>'],
transferRuleTypes: ['DESTINATION'],
createdBy: ['api-maker@zodia.io'],
updatedAt: '2021-05-11T04:43:43Z',
paginationLimit: 10,
paginationOffset: 123
})
};
fetch('https://api.custody.api-zodia.io/v3/api/transfer-rule/wallets', 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/transfer-rule/wallets",
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([
'ids' => [
'<string>'
],
'walletIds' => [
'ZTEST-NOBENF-W5NZ2XCZMF'
],
'statuses' => [
],
'companyIds' => [
'ZTEST'
],
'enforcingCompanyIds' => [
'<string>'
],
'transferRuleTypes' => [
'DESTINATION'
],
'createdBy' => [
'api-maker@zodia.io'
],
'updatedAt' => '2021-05-11T04:43:43Z',
'paginationLimit' => 10,
'paginationOffset' => 123
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"submitter-id: <submitter-id>"
],
]);
$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/transfer-rule/wallets"
payload := strings.NewReader("{\n \"ids\": [\n \"<string>\"\n ],\n \"walletIds\": [\n \"ZTEST-NOBENF-W5NZ2XCZMF\"\n ],\n \"statuses\": [],\n \"companyIds\": [\n \"ZTEST\"\n ],\n \"enforcingCompanyIds\": [\n \"<string>\"\n ],\n \"transferRuleTypes\": [\n \"DESTINATION\"\n ],\n \"createdBy\": [\n \"api-maker@zodia.io\"\n ],\n \"updatedAt\": \"2021-05-11T04:43:43Z\",\n \"paginationLimit\": 10,\n \"paginationOffset\": 123\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("submitter-id", "<submitter-id>")
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/transfer-rule/wallets")
.header("submitter-id", "<submitter-id>")
.header("Content-Type", "application/json")
.body("{\n \"ids\": [\n \"<string>\"\n ],\n \"walletIds\": [\n \"ZTEST-NOBENF-W5NZ2XCZMF\"\n ],\n \"statuses\": [],\n \"companyIds\": [\n \"ZTEST\"\n ],\n \"enforcingCompanyIds\": [\n \"<string>\"\n ],\n \"transferRuleTypes\": [\n \"DESTINATION\"\n ],\n \"createdBy\": [\n \"api-maker@zodia.io\"\n ],\n \"updatedAt\": \"2021-05-11T04:43:43Z\",\n \"paginationLimit\": 10,\n \"paginationOffset\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.custody.api-zodia.io/v3/api/transfer-rule/wallets")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["submitter-id"] = '<submitter-id>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"ids\": [\n \"<string>\"\n ],\n \"walletIds\": [\n \"ZTEST-NOBENF-W5NZ2XCZMF\"\n ],\n \"statuses\": [],\n \"companyIds\": [\n \"ZTEST\"\n ],\n \"enforcingCompanyIds\": [\n \"<string>\"\n ],\n \"transferRuleTypes\": [\n \"DESTINATION\"\n ],\n \"createdBy\": [\n \"api-maker@zodia.io\"\n ],\n \"updatedAt\": \"2021-05-11T04:43:43Z\",\n \"paginationLimit\": 10,\n \"paginationOffset\": 123\n}"
response = http.request(request)
puts response.read_body[
{
"total": 123,
"items": [
{
"id": "<string>",
"walletId": "<string>",
"walletName": "<string>",
"walletType": "<string>",
"companyId": "<string>",
"isTrading": true,
"enforcingCompanyId": "<string>",
"transferRuleType": "DESTINATION",
"updatedAt": "2021-05-11 04:43:43",
"updatedBy": "<string>",
"walletOwner": "<string>",
"transferRuleDefinition": [
{
"allowedDestinations": [
{
"value": "<string>",
"name": "<string>",
"address": "<string>",
"type": "WALLET_ID"
}
]
}
],
"currencyId": "<string>",
"currency": "<string>",
"expiresAt": "2021-05-11 04:43:43",
"tradingVenueId": "<string>"
}
]
}
]{
"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"
}
]
}Network-V3
Retrieve transfer rules
POST
/
v3
/
api
/
transfer-rule
/
wallets
Retrieve transfer rules
curl --request POST \
--url https://api.custody.api-zodia.io/v3/api/transfer-rule/wallets \
--header 'Content-Type: application/json' \
--header 'submitter-id: <submitter-id>' \
--data '
{
"ids": [
"<string>"
],
"walletIds": [
"ZTEST-NOBENF-W5NZ2XCZMF"
],
"statuses": [],
"companyIds": [
"ZTEST"
],
"enforcingCompanyIds": [
"<string>"
],
"transferRuleTypes": [
"DESTINATION"
],
"createdBy": [
"api-maker@zodia.io"
],
"updatedAt": "2021-05-11T04:43:43Z",
"paginationLimit": 10,
"paginationOffset": 123
}
'import requests
url = "https://api.custody.api-zodia.io/v3/api/transfer-rule/wallets"
payload = {
"ids": ["<string>"],
"walletIds": ["ZTEST-NOBENF-W5NZ2XCZMF"],
"statuses": [],
"companyIds": ["ZTEST"],
"enforcingCompanyIds": ["<string>"],
"transferRuleTypes": ["DESTINATION"],
"createdBy": ["api-maker@zodia.io"],
"updatedAt": "2021-05-11T04:43:43Z",
"paginationLimit": 10,
"paginationOffset": 123
}
headers = {
"submitter-id": "<submitter-id>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'submitter-id': '<submitter-id>', 'Content-Type': 'application/json'},
body: JSON.stringify({
ids: ['<string>'],
walletIds: ['ZTEST-NOBENF-W5NZ2XCZMF'],
statuses: [],
companyIds: ['ZTEST'],
enforcingCompanyIds: ['<string>'],
transferRuleTypes: ['DESTINATION'],
createdBy: ['api-maker@zodia.io'],
updatedAt: '2021-05-11T04:43:43Z',
paginationLimit: 10,
paginationOffset: 123
})
};
fetch('https://api.custody.api-zodia.io/v3/api/transfer-rule/wallets', 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/transfer-rule/wallets",
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([
'ids' => [
'<string>'
],
'walletIds' => [
'ZTEST-NOBENF-W5NZ2XCZMF'
],
'statuses' => [
],
'companyIds' => [
'ZTEST'
],
'enforcingCompanyIds' => [
'<string>'
],
'transferRuleTypes' => [
'DESTINATION'
],
'createdBy' => [
'api-maker@zodia.io'
],
'updatedAt' => '2021-05-11T04:43:43Z',
'paginationLimit' => 10,
'paginationOffset' => 123
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"submitter-id: <submitter-id>"
],
]);
$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/transfer-rule/wallets"
payload := strings.NewReader("{\n \"ids\": [\n \"<string>\"\n ],\n \"walletIds\": [\n \"ZTEST-NOBENF-W5NZ2XCZMF\"\n ],\n \"statuses\": [],\n \"companyIds\": [\n \"ZTEST\"\n ],\n \"enforcingCompanyIds\": [\n \"<string>\"\n ],\n \"transferRuleTypes\": [\n \"DESTINATION\"\n ],\n \"createdBy\": [\n \"api-maker@zodia.io\"\n ],\n \"updatedAt\": \"2021-05-11T04:43:43Z\",\n \"paginationLimit\": 10,\n \"paginationOffset\": 123\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("submitter-id", "<submitter-id>")
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/transfer-rule/wallets")
.header("submitter-id", "<submitter-id>")
.header("Content-Type", "application/json")
.body("{\n \"ids\": [\n \"<string>\"\n ],\n \"walletIds\": [\n \"ZTEST-NOBENF-W5NZ2XCZMF\"\n ],\n \"statuses\": [],\n \"companyIds\": [\n \"ZTEST\"\n ],\n \"enforcingCompanyIds\": [\n \"<string>\"\n ],\n \"transferRuleTypes\": [\n \"DESTINATION\"\n ],\n \"createdBy\": [\n \"api-maker@zodia.io\"\n ],\n \"updatedAt\": \"2021-05-11T04:43:43Z\",\n \"paginationLimit\": 10,\n \"paginationOffset\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.custody.api-zodia.io/v3/api/transfer-rule/wallets")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["submitter-id"] = '<submitter-id>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"ids\": [\n \"<string>\"\n ],\n \"walletIds\": [\n \"ZTEST-NOBENF-W5NZ2XCZMF\"\n ],\n \"statuses\": [],\n \"companyIds\": [\n \"ZTEST\"\n ],\n \"enforcingCompanyIds\": [\n \"<string>\"\n ],\n \"transferRuleTypes\": [\n \"DESTINATION\"\n ],\n \"createdBy\": [\n \"api-maker@zodia.io\"\n ],\n \"updatedAt\": \"2021-05-11T04:43:43Z\",\n \"paginationLimit\": 10,\n \"paginationOffset\": 123\n}"
response = http.request(request)
puts response.read_body[
{
"total": 123,
"items": [
{
"id": "<string>",
"walletId": "<string>",
"walletName": "<string>",
"walletType": "<string>",
"companyId": "<string>",
"isTrading": true,
"enforcingCompanyId": "<string>",
"transferRuleType": "DESTINATION",
"updatedAt": "2021-05-11 04:43:43",
"updatedBy": "<string>",
"walletOwner": "<string>",
"transferRuleDefinition": [
{
"allowedDestinations": [
{
"value": "<string>",
"name": "<string>",
"address": "<string>",
"type": "WALLET_ID"
}
]
}
],
"currencyId": "<string>",
"currency": "<string>",
"expiresAt": "2021-05-11 04:43:43",
"tradingVenueId": "<string>"
}
]
}
]{
"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"
}
]
}Headers
Email of API user submitting the request
Example:
"api-maker@zodia.io"
Body
application/json
Search by transfer rule IDs
Search by wallet IDs on which transfer rules are applied
Search by status
Available options:
ACTIVE, DEACTIVATED, EXPIRED Search by company IDs
Search by enforcing company IDs
Search by transfer rule types
Available options:
DESTINATION Search by transfer rule creator
Search by time of last update
Example:
"2021-05-11T04:43:43Z"
Number of items in response (default is 10)
Example:
10
⌘I