POST
/
orders

Body

application/json
baseCurrency
string
required

The currency of the order amount

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:
sell,
buy,
deposit,
withdraw,
multi-withdraw,
retrieved-deposit,
earn-reward,
cross-chain-deposit,
cross-chain-withdraw
portfolioId
string
required

The id of the portfolio where the order should be placed

amount
string

The amount of order in baseCurrency

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
deliveryType
enum<string>

Settlement order type only applicable for settle orders. See details

Available options:
free-of-payment,
payment-vs-payment
description
string

The description of the order

externalBroadcast
boolean
default: false

Sets broadcast mode. If true: manual broadcast. If false: automatic broadcast. Copper automatically broadcasts transactions to the network after fully signing

feeLevel
enum<string>

The fee level for the withdrawal. See details

Available options:
low,
medium,
high
includeFeeInWithdraw
boolean
default: false

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

limitType
enum<string>

The limit type of the order. Used to create settle orders. See details

Available options:
otc,
rfq
mainCurrency
string

The main currency of the base currency

nextTransferTo
object[]

The list of next transfer targets for chained transfer orders

payload
string

Serialised data payload for a smart contract

payloads
string[]

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

priceLimit
string

The price of the order in quote currency, only applicable for settle orders

quoteAmount
string

The amount of order in quoteCurrency

quoteCurrency
string

The currency of the quote amount

quoteMainCurrency
string

The main currency of the quote currency

toCounterpartyId
string

The id of the counterparty to transfer money to

toCryptoAddressId
string

In case of a withdrawal, the destination crypto address id from an Address Book

toPortfolioId
string

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

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,
retrieved-deposit,
earn-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,
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

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