Settlements
Cancel a settlement order
Settlements
Cancel a settlement order
PATCH
/
orders
/
{cancelOrderId}
Headers
Content-Type
string
application/vnd.cancel-order+json
Path Parameters
cancelOrderId
string
requiredBody
application/vnd.cancel-order+json
reason
string
Response
200 - application/vnd.cancel-order+json
amount
string
requiredAmount of order in baseCurrency
baseCurrency
string
requiredBase currency of the order
createdAt
string
requiredOrder creation timestamp
externalOrderId
string
requiredThe order ID in the external system
orderId
string
requiredOrder ID
orderType
enum<string>
requiredOrder type. See details
Available options:
sell, buy, deposit, withdraw, multi-withdraw, retrieved-deposit, earn-reward portfolioId
string
requiredPortfolio ID
portfolioType
enum<string>
requiredPortfolio type. See details
Available options:
custody, trading-vault, trading, external, clearloop status
enum<string>
requiredOrder 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