Trading

Get Order

get
/trading/order/{orderId}

Get single order

Authorizations
OAuth2clientCredentialsRequired
Token URL:
Path parameters
orderIdstring · uuidRequired
Responses
200

OK

application/json
orderIdstring · uuidRequired
exAnteIdstring · uuidRequired
createdOnstring · date-timeRequired

The date on which the order was created

modifiedOnstring · date-timeRequired

The date on which the order was modified the last time

statusstring · enumRequiredPossible values:
messagestringOptional
depositoryCustomerProductIdstring · uuidRequired

The identifier of the depository customer product instance

cashCustomerProductIdstring · uuidRequired

Cash customer product used for the order.

tradeSidestring · enumRequiredPossible values:
isinstring · min: 12 · max: 12Required

ISIN of the asset

Example: US38259P5089Pattern: ^[A-Z]{2}[A-Z0-9]{10}$
quantitynumberRequired

Number of shares

orderTypestring · enumRequiredPossible values:
quantityTypestring · enumRequiredPossible values:
limitPricenumberOptional

The limit price for orders of the type 'limit'.

stopPricenumberOptional

The stop price for orders of the type 'stop'.

expiryDatestring · dateOptional

'The order expiration date (last day the order can trade) in the YYYY-MM-DD format. Default value is T+1 year'

externalIdstringRequired

Order id in partner's system. This value has to be unique.

asset_experience_fitbooleanOptional

Only applicable if the user has failed the asset fit check for the asset type being ordered. True if the user has acknowledged their willingness to trade.

exchangeCodestring · enumRequiredPossible values:
get
/trading/order/{orderId}

Cancel order

delete
/trading/order/{orderId}

Cancel a single trading order. Please note that Market orders have a low probability of being canceled.

Authorizations
OAuth2clientCredentialsRequired
Token URL:
Path parameters
orderIdstring · uuidRequired
Header parameters
Requestor-IDstring · uuidRequired

Unique requestor identification in UUID format

Responses
delete
/trading/order/{orderId}

No content

Update Order

patch
/trading/order/{orderId}

Update Order

Authorizations
OAuth2clientCredentialsRequired
Token URL:
Path parameters
orderIdstring · uuidRequired
Header parameters
Requestor-IDstring · uuidRequired

Unique requestor identification in UUID format

Body
quantityTypestring · enumOptionalPossible values:
quantitynumberOptional

Number of shares or order amount

currencystring · enumOptional

Currency of the product's balance. Currency code in ISO 4217

Possible values:
orderTypestring · enumOptionalPossible values:
limitPricenumberOptional

The limit price for orders of the type 'limit'.

stopPricenumberOptional

The stop price for orders of the type 'stop'.

expiryDatestring · dateOptional

The order expiration date (last day the order can trade) in the YYYY-MM-DD format. Default value is T+1 year.

Responses
patch
/trading/order/{orderId}

No content

Create Market Order

post
/trading/order/market

Create a single security market order

Authorizations
OAuth2clientCredentialsRequired
Token URL:
Header parameters
Requestor-IDstring · uuidRequired

Unique requestor identification in UUID format

Body
depositoryCustomerProductIdstring · uuidRequired

The identifier of the depository customer product instance

cashCustomerProductIdstring · uuidRequired

Cash customer product used for the order.

tradeSidestring · enumRequiredPossible values:
quantityTypestring · enumRequiredPossible values:
exchangeCodestring · enumRequiredPossible values:
isinstring · min: 12 · max: 12Required

ISIN of the asset

Example: US38259P5089Pattern: ^[A-Z]{2}[A-Z0-9]{10}$
quantitynumberRequired

Number of shares

externalIdstringRequired

Order id in partner's system. This value has to be unique.

Responses
200

OK

application/json
orderIdstring · uuidRequired
createdOnstring · date-timeRequired
post
/trading/order/market

Create Limit Order

post
/trading/order/limit

Create a single security limit order

Authorizations
OAuth2clientCredentialsRequired
Token URL:
Header parameters
Requestor-IDstring · uuidRequired

Unique requestor identification in UUID format

Body
depositoryCustomerProductIdstring · uuidRequired

The identifier of the depository customer product instance

cashCustomerProductIdstring · uuidRequired

Cash customer product used for the order.

tradeSidestring · enumRequiredPossible values:
quantityTypestring · enumRequiredPossible values:
exchangeCodestring · enumRequiredPossible values:
isinstring · min: 12 · max: 12Required

ISIN of the asset

Example: US38259P5089Pattern: ^[A-Z]{2}[A-Z0-9]{10}$
quantitynumberRequired

Number of shares

limitPricenumberRequired

The limit price for orders of the type 'limit'.

expiryDatestring · dateRequired

'The order expiration date (last day the order can trade) in the YYYY-MM-DD format. Default value is T+1 year'

externalIdstringRequired

Order id in partner's system. This value has to be unique.

Responses
200

OK

application/json
orderIdstring · uuidRequired
createdOnstring · date-timeRequired
post
/trading/order/limit

Create Stop Order

post
/trading/order/stop

Create a single security stop order

Authorizations
OAuth2clientCredentialsRequired
Token URL:
Header parameters
Requestor-IDstring · uuidRequired

Unique requestor identification in UUID format

Body
depositoryCustomerProductIdstring · uuidRequired

The identifier of the depository customer product instance

cashCustomerProductIdstring · uuidRequired

Cash customer product used for the order.

tradeSidestring · enumRequiredPossible values:
quantityTypestring · enumRequiredPossible values:
exchangeCodestring · enumRequiredPossible values:
isinstring · min: 12 · max: 12Required

ISIN of the asset

Example: US38259P5089Pattern: ^[A-Z]{2}[A-Z0-9]{10}$
quantitynumberRequired

Number of shares

stopPricenumberRequired

The stop price for orders of the type 'stop'.

expiryDatestring · dateRequired

'The order expiration date (last day the order can trade) in the YYYY-MM-DD format. Default value is T+1 year'

externalIdstringRequired

Order id in partner's system. This value has to be unique.

Responses
200

OK

application/json
orderIdstring · uuidRequired
createdOnstring · date-timeRequired
post
/trading/order/stop

Last updated