Skip to main content
PATCH
/
orders
/
{cancelOrderId}
Cancel Order
curl --request PATCH \
  --url https://api.copper.co/platform/orders/{cancelOrderId} \
  --header 'Content-Type: application/vnd.cancel-order+json' \
  --data '
{
  "reason": "<string>"
}
'
{
  "amount": "<string>",
  "baseCurrency": "<string>",
  "createdAt": "<string>",
  "externalOrderId": "<string>",
  "orderId": "<string>",
  "portfolioId": "<string>",
  "createdBy": "<string>",
  "extra": {
    "availableCoSigners": [
      "<string>"
    ],
    "availableSnapshot": "<string>",
    "balanceSnapshot": "<string>",
    "clearLoop": true,
    "clearLoopExtra": {
      "clearLoopExternalNetted": true,
      "clearLoopSettlementId": "<string>"
    },
    "clientAccountId": "<string>",
    "coSigners": [
      "<string>"
    ],
    "coSignersNumber": "<string>",
    "confirmations": "<string>",
    "counterpartyPortfolioId": "<string>",
    "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,
    "fees": [
      {
        "fee": "<string>",
        "feeCurrency": "<string>",
        "baseFeePerGas": "<string>",
        "estimatedTime": "<string>",
        "feePerByte": {},
        "gasLimit": {},
        "gasPriceGwei": "<string>",
        "maxFeePerGas": "<string>",
        "maxPriorityFeePerGas": "<string>",
        "reportingCurrencyRate": "<string>",
        "transactionBytes": "<string>"
      }
    ],
    "fromAddresses": [
      "<string>"
    ],
    "fromCounterpartyId": "<string>",
    "fromCryptoAddress": {
      "address": "<string>",
      "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": [],
      "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": [
      {
        "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>"
  },
  "mainCurrency": "<string>",
  "organizationId": "<string>",
  "quoteCurrency": "<string>",
  "quoteMainCurrency": "<string>",
  "terminatedAt": "<string>",
  "updatedAt": "<string>"
}

Headers

​
Content-Type
string

application/vnd.cancel-order+json

Path Parameters

​
cancelOrderId
string
required

Body

application/vnd.cancel-order+json
​
reason
string

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. Note: When an order has completed processing, it enters one of the final states and returns a 'terminal' status. terminalStatuses are: EXECUTED, CANCELED, LIQUIDATED, ERROR, BLOCKED, DECLINED, SUSPENDED, REJECTED. 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