POST
/
orders
curl --request POST \
  --url https://api.copper.co/platform/orders \
  --header 'Content-Type: application/json' \
  --data '{
  "amount": "0.1",
  "baseCurrency": "BTC",
  "blockchainTransactionType": "send",
  "description": "Withdrawal to my wallet",
  "externalOrderId": "<string>",
  "mainCurrency": "<string>",
  "orderType": "withdraw",
  "portfolioId": "<string>"
}'
{
  "amount": "<string>",
  "baseCurrency": "<string>",
  "createdAt": "<string>",
  "createdBy": "<string>",
  "externalOrderId": "<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": {
      "estimatedTime": "<string>",
      "fee": "<string>",
      "feeCurrency": "<string>",
      "feePerByte": {},
      "gasLimit": {},
      "gasPriceGwei": "<string>",
      "reportingCurrencyRate": "<string>",
      "transactionBytes": "<string>"
    },
    "externalBroadcast": true,
    "feeLevel": "low",
    "fromAddresses": [
      "<string>"
    ],
    "fromCounterpartyId": "<string>",
    "fromCryptoAddress": {
      "_embedded": {
        "currencyConfigurations": [
          {
            "createdAt": "<string>",
            "createdBy": "<string>",
            "cryptoAddressId": "<string>",
            "currency": "<string>",
            "currencyConfigurationId": "<string>",
            "extra": {},
            "isWhitelist": true,
            "lastUsedAt": "<string>",
            "portfolioIds": [
              "<string>"
            ],
            "updatedAt": "<string>",
            "updatedBy": "<string>"
          }
        ]
      },
      "acceptTokens": true,
      "address": "<string>",
      "addressTags": [
        null
      ],
      "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"
      }
    ],
    "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>",
  "orderId": "<string>",
  "orderType": "sell",
  "organizationId": "<string>",
  "portfolioId": "<string>",
  "portfolioType": "custody",
  "quoteCurrency": "<string>",
  "quoteMainCurrency": "<string>",
  "status": "new",
  "terminatedAt": "<string>",
  "updatedAt": "<string>"
}

The blockchainTransactionType sets up the type of performed blockchain operation. Each currency has a set of available staking operations, which is shown in the table below.

CurrencyStaking operations
ADApool-creation, stake-delegation, take-reward
ALGOregister-offline, register-online
ATOMstake-delegation, stake-undelegation, take-reward
AVAXcomplete-withdrawal, stake-nomination, pool-creation, stake-complete-deposit, stake-delegation, stake-undelegation
AXLstake-delegation, stake-undelegation, take-reward
BLDstake-delegation, stake-undelegation, take-reward
BNBpool-creation, stake-delegation, stake-undelegation, unjail
CCDpool-creation, stake-delegation, stake-undelegation
DIVIstake-delegation
DOTchill, complete-withdrawal, stake-nomination, rebond-stake, stake-delegation, stake-undelegation
ETHpool-creation, stake-delegation
HNTpool-creation, stake-undelegation, transfer-stake
INJstake-delegation, stake-undelegation, take-reward, transfer-stake
KSMchill, complete-withdrawal, stake-nomination, rebond-stake, stake-delegation, stake-undelegation
NEARcomplete-withdrawal, stake-delegation, stake-undelegation
POKTstake-delegation, stake-undelegation
ROSEstake-delegation, stake-undelegation
SOLcomplete-withdrawal, stake-delegation, stake-undelegation
ZILcomplete-withdrawal, stake-delegation, stake-undelegation, take-reward

Body

application/json

Response

200
application/json

OK

The response is of type object.