POST
/
orders

Travel Rule
Financial regulations require us to collect information under the Travel Rule. Therefore, all outgoing withdrawal orders are only allowed to be made to addresses from the Address Book that have passed the Travel Rule checks. Use the Copper Platform to create a new address and pass the Travel Rule checks before making a withdrawal.

To create a withdrawal to an address book address, send the following parameters:

Body

application/json
amount
string
required

The amount of order in baseCurrency

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:
withdraw
portfolioId
string
required

The id of the portfolio where the order should be placed

toCryptoAddressId
string
required

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

description
string

The description of the order

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

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