Skip to main content
POST
/
orders
Create Order
curl --request POST \
  --url https://api.copper.co/platform/orders \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": "<string>",
  "baseCurrency": "<string>",
  "externalOrderId": "<string>",
  "orderType": "withdraw",
  "portfolioId": "<string>",
  "toPortfolioId": "<string>",
  "description": "<string>",
  "mainCurrency": "<string>"
}
'
{
  "amount": "<string>",
  "baseCurrency": "<string>",
  "createdAt": "<string>",
  "externalOrderId": "<string>",
  "orderId": "<string>",
  "orderType": "sell",
  "portfolioId": "<string>",
  "portfolioType": "custody",
  "status": "new",
  "createdBy": "<string>",
  "extra": {
    "availableCoSigners": [
      "<string>"
    ],
    "availableSnapshot": "<string>",
    "balanceSnapshot": "<string>",
    "blockchainTransactionType": "send",
    "clearLoop": true,
    "clearLoopExtra": {
      "clearLoopExternalNetted": true,
      "clearLoopSettlementId": "<string>"
    },
    "clientAccountId": "<string>",
    "coSigners": [
      "<string>"
    ],
    "coSignersNumber": "<string>",
    "confirmations": "<string>",
    "counterpartyPortfolioId": "<string>",
    "deliveryType": "free-of-payment",
    "depositOrderId": "<string>",
    "depositTargetId": "<string>",
    "description": "<string>",
    "estimatedFees": {
      "fee": "<string>",
      "feeCurrency": "<string>",
      "baseFeePerGas": "<string>",
      "estimatedTime": "<string>",
      "feePerByte": {},
      "gasLimit": {},
      "gasPriceGwei": "<string>",
      "maxFeePerGas": "<string>",
      "maxPriorityFeePerGas": "<string>",
      "reportingCurrencyRate": "<string>",
      "transactionBytes": "<string>"
    },
    "externalBroadcast": true,
    "feeLevel": "low",
    "fromAddresses": [
      "<string>"
    ],
    "fromCounterpartyId": "<string>",
    "fromCryptoAddress": {
      "address": "<string>",
      "addressType": "externally-owned-account",
      "createdAt": "<string>",
      "createdBy": "<string>",
      "cryptoAddressId": "<string>",
      "currency": "<string>",
      "isWhitelist": true,
      "name": "<string>",
      "_embedded": {
        "currencyConfigurations": [
          {
            "createdAt": "<string>",
            "createdBy": "<string>",
            "cryptoAddressId": "<string>",
            "currency": "<string>",
            "currencyConfigurationId": "<string>",
            "isWhitelist": true,
            "extra": {},
            "lastUsedAt": "<string>",
            "portfolioIds": [
              "<string>"
            ],
            "updatedAt": "<string>",
            "updatedBy": "<string>"
          }
        ]
      },
      "acceptTokens": true,
      "addressTags": [
        null
      ],
      "category": "smart-contract",
      "extra": {},
      "lastUsedAt": "<string>",
      "mainCurrency": "<string>",
      "memo": "<string>",
      "organizationId": "<string>",
      "portfolioIds": [
        "<string>"
      ],
      "updatedAt": "<string>",
      "updatedBy": "<string>"
    },
    "fromCryptoAddressId": "<string>",
    "fromPortfolioId": "<string>",
    "includeFeeInWithdraw": true,
    "invoiceId": "<string>",
    "marketPrice": "<string>",
    "memo": "<string>",
    "nextTransferTo": [
      {
        "targetType": "external",
        "cryptoAddressId": "<string>",
        "portfolioId": "<string>"
      }
    ],
    "originalDepositAmount": "<string>",
    "partSigned": {},
    "payload": "<string>",
    "payloads": [
      "<string>"
    ],
    "reportingCurrencyRate": "<string>",
    "reportingQuoteCurrencyRate": "<string>",
    "signed": {},
    "spenderAddress": "<string>",
    "terminatedReportingCurrencyRate": "<string>",
    "toAddress": "<string>",
    "toCounterpartyId": "<string>",
    "toCryptoAddressId": "<string>",
    "toInvoiceId": "<string>",
    "toLendingInvoiceId": "<string>",
    "toPortfolioId": "<string>",
    "totalQuoteAmount": "<string>",
    "transactionId": "<string>",
    "transactionRequest": {},
    "transferAmount": "<string>",
    "transferChainId": "<string>",
    "transferDepositTargetId": "<string>",
    "transferFees": "<string>",
    "transferFeesCurrency": "<string>",
    "transferTransactionId": "<string>",
    "withdrawFee": "<string>",
    "withdrawOrderId": "<string>"
  },
  "limitType": "otc",
  "mainCurrency": "<string>",
  "organizationId": "<string>",
  "quoteCurrency": "<string>",
  "quoteMainCurrency": "<string>",
  "terminatedAt": "<string>",
  "updatedAt": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://developer.copper.co/llms.txt

Use this file to discover all available pages before exploring further.

Delegate funds to a ClearLoop exchange using the Copper user interface or API. When funds are delegated, they are locked in the client’s Copper Trading Account and credited to the exchange account. Two orders are created as a result:
  • Withdrawal order in the Trading portfolio, containing isClearLoopDelegation under order extra.
  • Deposit order in the ClearLoop portfolio.
For example: ClearLoop delegation transactions 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 delegate funds to a ClearLoop exchange, create an order with the following parameters, where:
  • portfolioId is the ID of the Trading Account.
  • toPortfolioId is the ID of a ClearLoop Main (or Settlement) Account that is bound to the exchange.
Your delegated funds are automatically credited to your main exchange account. From there, you can transfer funds to other exchange sub-accounts. In that case, portfolioId is the ID of the main exchange account and toPortfolioId is the ID of the sub-account. For an example of a ClearLoop accounts structure, see Connect Exchange Account.

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

OK

​
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,
reserving,
reserved,
queued,
validating-funds,
working,
waiting-approve,
co-sign-require,
approved,
processing,
executed,
canceled,
rejecting,
rejected,
declining,
declined,
suspending,
suspended,
blocked,
action-required,
accepting,
accepted,
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,
accepted-part-signed-tx-added,
accepted-full-signed-tx-added,
awaiting-settlement,
master-password-required,
manual-resolving,
error,
pending-atomic-settlement-confirmation,
atomic-settlement-reservation-completed,
require-finalize,
waiting-accept-deposit,
waiting-reject-deposit
​
createdBy
string

Creator user id

​
extra
object

Additional order information

​
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