Skip to main content
POST
/
deposit-targets
Create Deposit Target
curl --request POST \
  --url https://api.copper.co/platform/deposit-targets \
  --header 'Content-Type: application/json' \
  --data '{
  "activationCode": "<string>",
  "address": "<string>",
  "currency": "<string>",
  "externalId": "<string>",
  "mainCurrency": "<string>",
  "memo": "<string>",
  "name": "<string>",
  "portfolioId": "<string>"
}'
{
  "acceptAllTokens": true,
  "activatedTokens": [
    {}
  ],
  "address": "<string>",
  "createdAt": "<string>",
  "createdBy": "<string>",
  "currency": "<string>",
  "depositTargetId": "<string>",
  "externalId": "<string>",
  "mainCurrency": "<string>",
  "memo": "<string>",
  "metadata": {},
  "name": "<string>",
  "organizationId": "<string>",
  "portfolioId": "<string>",
  "portfolioType": "custody",
  "requireTokensActivation": true,
  "status": "new",
  "targetType": "proxy",
  "updatedAt": "<string>",
  "updatedBy": "<string>"
}

Body

application/json
​
currency
string
required
​
externalId
string
required
​
mainCurrency
string
required
​
portfolioId
string
required
​
activationCode
string
​
address
string
​
memo
string
​
name
string

Response

OK

​
acceptAllTokens
boolean
required

This parameter defines if this target is able to accept all tokens

​
createdAt
string
required
​
createdBy
string
required
​
depositTargetId
string
required
​
externalId
string
required
​
mainCurrency
string
required
​
portfolioType
enum<string>
required

See details

Available options:
custody,
trading-vault,
trading,
external,
clearloop
​
requireTokensActivation
boolean
required

This parameter defines if this target is able to accept all tokens

​
status
enum<string>
required

See details

Available options:
new,
pending,
approval-pending,
enabled,
disabled,
error,
portfolio-archived
​
targetType
enum<string>
required

See details

Available options:
proxy,
direct,
external-wallet
​
updatedAt
string
required
​
updatedBy
string
required
​
activatedTokens
object[]

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

​
address
string
​
currency
string
​
memo
string
​
metadata
object

Additional metadata you want to store with a new Deposit Target

​
name
string
​
organizationId
string
​
portfolioId
string