Undelegate (unlock) funds

POST

orders

curl --request POST \
  --url https://api.copper.co/platform/orders \
  --header 'Content-Type: application/json' \
  --data '{
  "amount": "0.1",
  "baseCurrency": "BTC",
  "description": "Withdrawal to my wallet",
  "externalOrderId": "<string>",
  "mainCurrency": "<string>",
  "orderType": "withdraw",
  "portfolioId": "<string>",
  "toPortfolioId": "<string>"
}'

{
  "amount": "<string>",
  "baseCurrency": "<string>",
  "createdAt": "<string>",
  "createdBy": "<string>",
  "externalOrderId": "<string>",
  "extra": {
    "availableCoSigners": [
      "<string>"
    ],
    "availableSnapshot": "<string>",
    "balanceSnapshot": "<string>",
    "blockchainTransactionType": "send",
    "clearLoop": true,
    "clientAccountId": "<string>",
    "coSigners": [
      "<string>"
    ],
    "coSignersNumber": "<string>",
    "confirmations": "<string>",
    "counterpartyPortfolioId": "<string>",
    "deliveryType": "free-of-payment",
    "depositOrderId": "<string>",
    "depositTargetId": "<string>",
    "description": "<string>",
    "estimatedFees": {
      "estimatedTime": "<string>",
      "fee": "<string>",
      "feeCurrency": "<string>",
      "feePerByte": {},
      "gasLimit": {},
      "gasPriceGwei": "<string>",
      "reportingCurrencyRate": "<string>",
      "transactionBytes": "<string>"
    },
    "externalBroadcast": true,
    "feeLevel": "low",
    "fromAddresses": [
      "<string>"
    ],
    "fromCounterpartyId": "<string>",
    "fromCryptoAddress": {
      "acceptTokens": true,
      "address": "<string>",
      "addressType": "externally-owned-account",
      "category": "smart-contract",
      "createdAt": "<string>",
      "createdBy": "<string>",
      "cryptoAddressId": "<string>",
      "currency": "<string>",
      "extra": {},
      "isWhitelist": true,
      "lastUsedAt": "<string>",
      "mainCurrency": "<string>",
      "memo": "<string>",
      "name": "<string>",
      "organizationId": "<string>",
      "portfolioIds": [
        "<string>"
      ],
      "updatedAt": "<string>",
      "updatedBy": "<string>"
    },
    "fromCryptoAddressId": "<string>",
    "fromPortfolioId": "<string>",
    "includeFeeInWithdraw": true,
    "invoiceId": "<string>",
    "marketPrice": "<string>",
    "memo": "<string>",
    "nextTransferTo": [
      {
        "cryptoAddressId": "<string>",
        "portfolioId": "<string>",
        "targetType": "external"
      }
    ],
    "partSigned": {},
    "payload": "<string>",
    "payloads": [
      "<string>"
    ],
    "reportingCurrencyRate": "<string>",
    "reportingQuoteCurrencyRate": "<string>",
    "signed": {},
    "spenderAddress": "<string>",
    "terminatedReportingCurrencyRate": "<string>",
    "toAddress": "<string>",
    "toCounterpartyId": "<string>",
    "toCryptoAddress": {
      "acceptTokens": true,
      "address": "<string>",
      "addressType": "externally-owned-account",
      "category": "smart-contract",
      "createdAt": "<string>",
      "createdBy": "<string>",
      "cryptoAddressId": "<string>",
      "currency": "<string>",
      "extra": {},
      "isWhitelist": true,
      "lastUsedAt": "<string>",
      "mainCurrency": "<string>",
      "memo": "<string>",
      "name": "<string>",
      "organizationId": "<string>",
      "portfolioIds": [
        "<string>"
      ],
      "updatedAt": "<string>",
      "updatedBy": "<string>"
    },
    "toCryptoAddressId": "<string>",
    "toInvoiceId": "<string>",
    "toLendingInvoiceId": "<string>",
    "toPortfolioId": "<string>",
    "totalQuoteAmount": "<string>",
    "transactionId": "<string>",
    "transactionRequest": {},
    "transferChainId": "<string>",
    "withdrawFee": "<string>",
    "withdrawOrderId": "<string>"
  },
  "limitType": "otc",
  "mainCurrency": "<string>",
  "orderId": "<string>",
  "orderType": "sell",
  "organizationId": "<string>",
  "portfolioId": "<string>",
  "portfolioType": "custody",
  "quoteCurrency": "<string>",
  "quoteMainCurrency": "<string>",
  "status": "new",
  "terminatedAt": "<string>",
  "updatedAt": "<string>"
}

Undelegate funds from a ClearLoop exchange using the Copper user interface or API.

When funds are undelegated, they are withdrawn from the exchange and released back into the Copper Trading Account. Two orders are created as a result:

Deposit order in the Trading portfolio, containing isClearLoopUnDelegation under order extra.
Withdrawal order in the ClearLoop portfolio.

Both orders are linked under order extra by withdrawOrderId and depositOrderId.

Note that the terms “account” and “transaction” in the user interface correspond to the terms “portfolio” and “order” in the API and codebase.

To undelegate funds from a ClearLoop exchange, create an order with the following parameters:

Body

application/json

amount

string

required

The amount of order in baseCurrency

Example:

"0.1"

baseCurrency

string

required

The currency of the order amount

Example:

"BTC"

externalOrderId

string

required

Unique order identifier from client (should be unique for the portfolio)

orderType

enum<string>

required

The order type. See details

Available options:

withdraw

portfolioId

string

required

The id of the portfolio where the order should be placed

toPortfolioId

string

required

In case of a withdrawal on a different portfolio, the portfolio id of the destination account

description

string

The description of the order

Example:

"Withdrawal to my wallet"

mainCurrency

string

The main currency of the base currency

Response

200

application/json

amount

string

required

Amount of order in baseCurrency

baseCurrency

string

required

Base currency of the order

createdAt

string

required

Order creation timestamp

externalOrderId

string

required

The order ID in the external system

orderId

string

required

Order ID

orderType

enum<string>

required

Order type. See details

Available options:

sell,

buy,

deposit,

withdraw,

multi-withdraw,

wallet-message,

retrieved-deposit,

earn-reward,

earn-shared-reward,

claim-shared-reward,

cross-chain-deposit,

cross-chain-withdraw

portfolioId

string

required

Portfolio ID

portfolioType

enum<string>

required

Portfolio type. See details

Available options:

custody,

trading-vault,

trading,

external,

clearloop

status

enum<string>

required

Order status. See details

Available options:

new,

waiting-funds,

reserved,

working,

waiting-approve,

co-sign-require,

approved,

processing,

executed,

canceled,

rejecting,

rejected,

declining,

declined,

blocked,

action-required,

require-initializer-approve,

waiting-counterparty-approve,

require-counterparty-approve,

ready-for-settlement,

settled,

part-signed-tx-added,

full-signed-tx-added,

rejected-part-signed-tx-added,

rejected-full-signed-tx-added,

awaiting-settlement,

master-password-required,

manual-resolving,

error,

pending-atomic-settlement-confirmation,

atomic-settlement-reservation-completed

createdBy

string

Creator user id

extra

object

Additional order information

extra.availableCoSigners

string[]

The ids of user who can approve an order. If not set, anybody with Approver permission can approve

extra.availableSnapshot

string

Snapshot of a wallet available balance at the moment of order termination

extra.balanceSnapshot

string

Snapshot of a wallet balance at the moment of order termination

extra.blockchainTransactionType

enum<string>

Blockchain transaction type. See details

Available options:

send,

multi-withdraw,

account-set,

allowance,

smart-call,

multi-smart-call,

activate,

stake-delegation,

stake-nomination,

stake-undelegation,

complete-withdrawal,

stake-complete-deposit,

take-reward,

pool-creation,

edit-pool,

governance-vote,

unjail,

importance-transfer,

transfer-stake,

rebond-stake,

chill,

cross-chain-send

extra.clearLoop

boolean

Indicates whether the order is a part of a ClearLoop

extra.clientAccountId

string

Unique client exchange's account identifier used for ClearLoop

extra.coSigners

string[]

The ids of user who has approved an order

extra.coSignersNumber

string

The number of required approves for an order

extra.confirmations

string

Number of confirmations for a blockchain transaction

extra.counterpartyPortfolioId

string

extra.deliveryType

enum<string>

Settlement order type only applicable for settle orders. See details

Available options:

free-of-payment,

payment-vs-payment

extra.depositOrderId

string

The id of a deposit order where a withdraw was made to

extra.depositTargetId

string

The id of a deposit target where an order was made to

extra.description

string

The description of the order

extra.estimatedFees

object

The estimated fees for an order

extra.externalBroadcast

boolean

Withdraw is requested to be processed by external system. In that case we don't broadcast it to blockchain

extra.feeLevel

enum<string>

The fee level for the withdrawal. See details

Available options:

low,

medium,

high

extra.fromAddresses

string[]

List of addresses from which the deposit was made. This is an array because, on some blockchains like Bitcoin (BTC), the sending address can include multiple input UTXO addresses

extra.fromCounterpartyId

string

The id of a counterparty where an order was made from

extra.fromCryptoAddress

object

The object of a crypto address where an order was made from. Will be removed in the future. Use fromCryptoAddressId instead

extra.fromCryptoAddressId

string

The id of a crypto address where an order was made from

extra.fromPortfolioId

string

The id of a portfolio where an order was made from

extra.includeFeeInWithdraw

boolean

Indicates whether the fee should be included in the withdrawal amount or added on top of it

extra.invoiceId

string

The id of an invoice where an order was made to

extra.marketPrice

string

extra.memo

string

Withdraw memo (destination tag for XRP)

extra.nextTransferTo

object[]

The remain list of next transfer targets

extra.partSigned

object

Partly-signed data

extra.payload

string

Serialized data payload for a smart contract

extra.payloads

string[]

Serialized list of unsigned transactions. For Ethereum only type 0 (legacy) transactions are supported

extra.reportingCurrencyRate

string

The snapshot of a base currency rate at the moment of order creation

extra.reportingQuoteCurrencyRate

string

The snapshot of a quote currency rate at the moment of order creation

extra.signed

object

Fully-signed data

extra.spenderAddress

string

For ETH Approve transaction store spender address

extra.terminatedReportingCurrencyRate

string

The snapshot of a base currency rate at the moment of order termination

extra.toAddress

string

The address where the funds should be transferred

extra.toCounterpartyId

string

The id of a counterparty where an order was made to

extra.toCryptoAddress

object

The object of a crypto address where an order was made to. Will be removed in the future. Use toCryptoAddressId instead

extra.toCryptoAddressId

string

The id of a crypto address where an order was made to

extra.toInvoiceId

string

The id of an invoice where an order was made to

extra.toLendingInvoiceId

string

The id of an lending invoice where an order was made to

extra.toPortfolioId

string

The id of a portfolio where an order was made to

extra.totalQuoteAmount

string

The amount of a quote currency in an order

extra.transactionId

string

The blockchain transaction id on an order

extra.transactionRequest

object

Data which needs to be passed to Copper Unlimited to sign the transaction

extra.transferChainId

string

The id to identify orders, created as a part of the same order chain

extra.withdrawFee

string

The amount of fees for the order

extra.withdrawOrderId

string

The id of a withdraw order where a deposit was made from

limitType

enum<string>

Limit type of the order. See details

Available options:

otc,

rfq

mainCurrency

string

Blockchain network of a baseCurrency

organizationId

string

Organization id

quoteCurrency

string

The quote currency of the order (in case of a settle order)

quoteMainCurrency

string

Blockchain network of a quoteCurrency

terminatedAt

string

Order termination timestamp

updatedAt

string

Order update timestamp

Delegate (lock) funds Fetch delegated balances

curl --request POST \
  --url https://api.copper.co/platform/orders \
  --header 'Content-Type: application/json' \
  --data '{
  "amount": "0.1",
  "baseCurrency": "BTC",
  "description": "Withdrawal to my wallet",
  "externalOrderId": "<string>",
  "mainCurrency": "<string>",
  "orderType": "withdraw",
  "portfolioId": "<string>",
  "toPortfolioId": "<string>"
}'

{
  "amount": "<string>",
  "baseCurrency": "<string>",
  "createdAt": "<string>",
  "createdBy": "<string>",
  "externalOrderId": "<string>",
  "extra": {
    "availableCoSigners": [
      "<string>"
    ],
    "availableSnapshot": "<string>",
    "balanceSnapshot": "<string>",
    "blockchainTransactionType": "send",
    "clearLoop": true,
    "clientAccountId": "<string>",
    "coSigners": [
      "<string>"
    ],
    "coSignersNumber": "<string>",
    "confirmations": "<string>",
    "counterpartyPortfolioId": "<string>",
    "deliveryType": "free-of-payment",
    "depositOrderId": "<string>",
    "depositTargetId": "<string>",
    "description": "<string>",
    "estimatedFees": {
      "estimatedTime": "<string>",
      "fee": "<string>",
      "feeCurrency": "<string>",
      "feePerByte": {},
      "gasLimit": {},
      "gasPriceGwei": "<string>",
      "reportingCurrencyRate": "<string>",
      "transactionBytes": "<string>"
    },
    "externalBroadcast": true,
    "feeLevel": "low",
    "fromAddresses": [
      "<string>"
    ],
    "fromCounterpartyId": "<string>",
    "fromCryptoAddress": {
      "acceptTokens": true,
      "address": "<string>",
      "addressType": "externally-owned-account",
      "category": "smart-contract",
      "createdAt": "<string>",
      "createdBy": "<string>",
      "cryptoAddressId": "<string>",
      "currency": "<string>",
      "extra": {},
      "isWhitelist": true,
      "lastUsedAt": "<string>",
      "mainCurrency": "<string>",
      "memo": "<string>",
      "name": "<string>",
      "organizationId": "<string>",
      "portfolioIds": [
        "<string>"
      ],
      "updatedAt": "<string>",
      "updatedBy": "<string>"
    },
    "fromCryptoAddressId": "<string>",
    "fromPortfolioId": "<string>",
    "includeFeeInWithdraw": true,
    "invoiceId": "<string>",
    "marketPrice": "<string>",
    "memo": "<string>",
    "nextTransferTo": [
      {
        "cryptoAddressId": "<string>",
        "portfolioId": "<string>",
        "targetType": "external"
      }
    ],
    "partSigned": {},
    "payload": "<string>",
    "payloads": [
      "<string>"
    ],
    "reportingCurrencyRate": "<string>",
    "reportingQuoteCurrencyRate": "<string>",
    "signed": {},
    "spenderAddress": "<string>",
    "terminatedReportingCurrencyRate": "<string>",
    "toAddress": "<string>",
    "toCounterpartyId": "<string>",
    "toCryptoAddress": {
      "acceptTokens": true,
      "address": "<string>",
      "addressType": "externally-owned-account",
      "category": "smart-contract",
      "createdAt": "<string>",
      "createdBy": "<string>",
      "cryptoAddressId": "<string>",
      "currency": "<string>",
      "extra": {},
      "isWhitelist": true,
      "lastUsedAt": "<string>",
      "mainCurrency": "<string>",
      "memo": "<string>",
      "name": "<string>",
      "organizationId": "<string>",
      "portfolioIds": [
        "<string>"
      ],
      "updatedAt": "<string>",
      "updatedBy": "<string>"
    },
    "toCryptoAddressId": "<string>",
    "toInvoiceId": "<string>",
    "toLendingInvoiceId": "<string>",
    "toPortfolioId": "<string>",
    "totalQuoteAmount": "<string>",
    "transactionId": "<string>",
    "transactionRequest": {},
    "transferChainId": "<string>",
    "withdrawFee": "<string>",
    "withdrawOrderId": "<string>"
  },
  "limitType": "otc",
  "mainCurrency": "<string>",
  "orderId": "<string>",
  "orderType": "sell",
  "organizationId": "<string>",
  "portfolioId": "<string>",
  "portfolioType": "custody",
  "quoteCurrency": "<string>",
  "quoteMainCurrency": "<string>",
  "status": "new",
  "terminatedAt": "<string>",
  "updatedAt": "<string>"
}

Welcome

Guides

Body

Response