Create Deposit Target
curl --request POST \
--url https://api.copper.co/platform/deposit-targets \
--header 'Content-Type: application/json' \
--data '
{
"currency": "<string>",
"externalId": "<string>",
"mainCurrency": "<string>",
"portfolioId": "<string>",
"activationCode": "<string>",
"address": "<string>",
"memo": "<string>",
"name": "<string>"
}
'import requests
url = "https://api.copper.co/platform/deposit-targets"
payload = {
"currency": "<string>",
"externalId": "<string>",
"mainCurrency": "<string>",
"portfolioId": "<string>",
"activationCode": "<string>",
"address": "<string>",
"memo": "<string>",
"name": "<string>"
}
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({
currency: '<string>',
externalId: '<string>',
mainCurrency: '<string>',
portfolioId: '<string>',
activationCode: '<string>',
address: '<string>',
memo: '<string>',
name: '<string>'
})
};
fetch('https://api.copper.co/platform/deposit-targets', 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.copper.co/platform/deposit-targets",
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([
'currency' => '<string>',
'externalId' => '<string>',
'mainCurrency' => '<string>',
'portfolioId' => '<string>',
'activationCode' => '<string>',
'address' => '<string>',
'memo' => '<string>',
'name' => '<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.copper.co/platform/deposit-targets"
payload := strings.NewReader("{\n \"currency\": \"<string>\",\n \"externalId\": \"<string>\",\n \"mainCurrency\": \"<string>\",\n \"portfolioId\": \"<string>\",\n \"activationCode\": \"<string>\",\n \"address\": \"<string>\",\n \"memo\": \"<string>\",\n \"name\": \"<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))
}HttpResponse<String> response = Unirest.post("https://api.copper.co/platform/deposit-targets")
.header("Content-Type", "application/json")
.body("{\n \"currency\": \"<string>\",\n \"externalId\": \"<string>\",\n \"mainCurrency\": \"<string>\",\n \"portfolioId\": \"<string>\",\n \"activationCode\": \"<string>\",\n \"address\": \"<string>\",\n \"memo\": \"<string>\",\n \"name\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.copper.co/platform/deposit-targets")
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 \"currency\": \"<string>\",\n \"externalId\": \"<string>\",\n \"mainCurrency\": \"<string>\",\n \"portfolioId\": \"<string>\",\n \"activationCode\": \"<string>\",\n \"address\": \"<string>\",\n \"memo\": \"<string>\",\n \"name\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"acceptAllTokens": true,
"createdAt": "<string>",
"createdBy": "<string>",
"depositTargetId": "<string>",
"externalId": "<string>",
"mainCurrency": "<string>",
"requireTokensActivation": true,
"updatedAt": "<string>",
"updatedBy": "<string>",
"activatedTokens": [
{}
],
"address": "<string>",
"currency": "<string>",
"memo": "<string>",
"metadata": {},
"name": "<string>",
"organizationId": "<string>",
"portfolioId": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}deposit-targets
Create Deposit Target
Create a new deposit target
POST
/
deposit-targets
Create Deposit Target
curl --request POST \
--url https://api.copper.co/platform/deposit-targets \
--header 'Content-Type: application/json' \
--data '
{
"currency": "<string>",
"externalId": "<string>",
"mainCurrency": "<string>",
"portfolioId": "<string>",
"activationCode": "<string>",
"address": "<string>",
"memo": "<string>",
"name": "<string>"
}
'import requests
url = "https://api.copper.co/platform/deposit-targets"
payload = {
"currency": "<string>",
"externalId": "<string>",
"mainCurrency": "<string>",
"portfolioId": "<string>",
"activationCode": "<string>",
"address": "<string>",
"memo": "<string>",
"name": "<string>"
}
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({
currency: '<string>',
externalId: '<string>',
mainCurrency: '<string>',
portfolioId: '<string>',
activationCode: '<string>',
address: '<string>',
memo: '<string>',
name: '<string>'
})
};
fetch('https://api.copper.co/platform/deposit-targets', 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.copper.co/platform/deposit-targets",
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([
'currency' => '<string>',
'externalId' => '<string>',
'mainCurrency' => '<string>',
'portfolioId' => '<string>',
'activationCode' => '<string>',
'address' => '<string>',
'memo' => '<string>',
'name' => '<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.copper.co/platform/deposit-targets"
payload := strings.NewReader("{\n \"currency\": \"<string>\",\n \"externalId\": \"<string>\",\n \"mainCurrency\": \"<string>\",\n \"portfolioId\": \"<string>\",\n \"activationCode\": \"<string>\",\n \"address\": \"<string>\",\n \"memo\": \"<string>\",\n \"name\": \"<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))
}HttpResponse<String> response = Unirest.post("https://api.copper.co/platform/deposit-targets")
.header("Content-Type", "application/json")
.body("{\n \"currency\": \"<string>\",\n \"externalId\": \"<string>\",\n \"mainCurrency\": \"<string>\",\n \"portfolioId\": \"<string>\",\n \"activationCode\": \"<string>\",\n \"address\": \"<string>\",\n \"memo\": \"<string>\",\n \"name\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.copper.co/platform/deposit-targets")
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 \"currency\": \"<string>\",\n \"externalId\": \"<string>\",\n \"mainCurrency\": \"<string>\",\n \"portfolioId\": \"<string>\",\n \"activationCode\": \"<string>\",\n \"address\": \"<string>\",\n \"memo\": \"<string>\",\n \"name\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"acceptAllTokens": true,
"createdAt": "<string>",
"createdBy": "<string>",
"depositTargetId": "<string>",
"externalId": "<string>",
"mainCurrency": "<string>",
"requireTokensActivation": true,
"updatedAt": "<string>",
"updatedBy": "<string>",
"activatedTokens": [
{}
],
"address": "<string>",
"currency": "<string>",
"memo": "<string>",
"metadata": {},
"name": "<string>",
"organizationId": "<string>",
"portfolioId": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}Body
application/json
Response
OK
This parameter defines if this target is able to accept all tokens
Available options:
custody, trading-vault, trading, external, clearloop This parameter defines if this target is able to accept all tokens
Available options:
new, pending, approval-pending, enabled, disabled, error, portfolio-archived Available options:
proxy, direct, external-wallet If tokens of a blockchain should be activated prior to any operation, this parameter includes a list of currencies to be activated with corresponding status - otherwise, the field is set as null
Additional metadata you want to store with a new Deposit Target
Was this page helpful?
⌘I