bLink API - order placement module (2.0.9.4-six_caas)

Download OpenAPI specification:Download

URL: https://www.six-group.com/en/products-services/banking-services/blink.html

This is the specification of the bLink 'order-placement' module API. This API is used to place orders and check on the order status.

orderplacement

Posts a new order.

header Parameters

X-Correlation-ID required	string <= 64 characters Unique ID (defined by the caller) which will be reflected back in the response.
Permission-ID required	string <uuid,> This contains the permission Id returned by the post permission, which was performed prior to any request.
User-Agent required	string Name and version of the of the Client software
X-CorAPI-Target-ID required	string ID that identifies the provider (e.g., a financial institution). (SCOPE: SIX required)
X-PSU-IP-Address required	string IP address of the user initiating the operation or AUTO for system triggered processes (SCOPE: SIX required)
X-PSU-User-Agent required	string User agent of the user initiating the operation or AUTO for system triggered processes (SCOPE: SIX required)
Authorization	string Bearer followed by a base64 encoded OAuth access token
X-Instance-ID	string <= 64 characters (Deprecated) Identifies an on-prem application instance which uses a legacy on-prem certificate in the mTLS connection. Do not use the header otherwise. (SCOPE: SIX_CAAS - optional, SIX_CAAS_INTERNAL - optional).

Request Body schema: application/json

clientOrderIdentification required	string <= 20 characters Unambiguous identifier for the bulk order, as assigned by the instructing party.
required	object (bulkOrderDetails)
required	Array of objects (requestedAllocation)

Responses

Request samples

Payload

Content type

application/json

{"clientOrderIdentification": "123123123",
"bulkOrderDetails": {"side": "buy",
"orderQuantity": {"amount": "300",
"type": "unitsNumber"
},
"displayQuantity": "12000",
"numberOfAllocations": 5,
"financialInstrumentDetails": {"financialInstrumentIdentification": {"identification": "CH0012005267",
"type": "isin"
}
},
"placeOfTrade": {"marketIdentificationCode": "XSWX",
"marketDescription": "OTC"
},
"currency": "CHF",
"executionType": "limit",
"limitPrice": "12.50",
"stopPrice": "10.05",
"timeInForce": "day",
"expiryDateTime": "2018-04-13T11:11:11Z"
},
"requestedAllocationList": [{"accounts": [{"identification": "876543219",
"type": "safekeepingAccount"
}
],
"clientAllocationIdentification": "321321321",
"amount": "100"
}
]
}

Response samples

Content type

application/json

{"statementDateTime": "2018-04-13T11:11:11Z",
"extendedOrder": {"clientOrderIdentification": "123123123",
"orderDateTime": "2018-04-13T11:11:11Z",
"orderIdentification": "321321321",
"bulkOrderDetails": {"side": "buy",
"orderQuantity": {"amount": "300",
"type": "unitsNumber"
},
"displayQuantity": "12000",
"numberOfAllocations": 5,
"financialInstrumentDetails": {"financialInstrumentIdentification": {"identification": "CH0012005267",
"type": "isin"
}
},
"placeOfTrade": {"marketIdentificationCode": "XSWX",
"marketDescription": "OTC"
},
"currency": "CHF",
"executionType": "limit",
"limitPrice": "12.50",
"stopPrice": "10.05",
"timeInForce": "day",
"expiryDateTime": "2018-04-13T11:11:11Z"
},
"allocationList": [{"requestedAllocation": {"accounts": [{"identification": "876543219",
"type": "safekeepingAccount"
}
],
"clientAllocationIdentification": "321321321",
"amount": "100"
},
"allocationCancellationReasonList": [{"code": "zeroQuantity",
"proprietary": "string"
}
],
"remainingAllocation": {"executedQuantity": "100",
"remainingQuantity": "20"
},
"completeAllocationList": [{"allocationIdentification": "123123123",
"executedQuantity": "100",
"averagePrice": "17.8",
"bookingDate": {"date": "2018-04-13"
},
"billingDetails": {"billingAmountList": [{"type": "grossTradeAmount",
"amount": "12000",
"currency": "CHF",
"creditDebitIndicator": "debit",
"foreignExchangeRate": {"sourceCurrency": null,
"rate": null,
"targetCurrency": null,
"fxType": null
}
}
],
"accruedInterests": {"numberDaysAccrued": 28,
"amount": "12000",
"currency": "CHF",
"creditDebitIndicator": "debit",
"foreignExchangeRate": {"sourceCurrency": "CHF",
"rate": "1.0963",
"targetCurrency": "CHF",
"fxType": "costPrice"
}
},
"feesOrTaxList": [{"feeType": "stampDuty",
"amount": "12000",
"currency": "CHF",
"creditDebitIndicator": "debit",
"foreignExchangeRate": {"sourceCurrency": null,
"rate": null,
"targetCurrency": null,
"fxType": null
}
}
]
}
}
]
}
]
},
"orderState": {"status": "partiallyFilled",
"statusDateTime": "2018-04-13T11:11:11Z",
"orderCancellationReasonList": [{"code": "endOfLife",
"proprietary": "string"
}
],
"executedQuantity": "100",
"remainingQuantity": "20",
"averagePrice": "17.85",
"dayOrderQuantity": "15",
"dayExecutedQuantity": "5",
"dayAveragePrice": "17.8",
"factor": "100",
"orderStatusHistoryList": [{"status": "partiallyFilled",
"statusDateTime": "2018-04-13T11:11:11Z"
}
]
},
"dateList": [{"date": "2018-04-13",
"dateType": "bookingDate"
}
]
}

Cancellation of a specific order.

Places the cancellation request for a specific order.

path Parameters

clientOrderId

required

string <= 20 characters

The security order id. This Id corresponds with the clientOrderIdentification.

header Parameters

X-Correlation-ID required	string <= 64 characters Unique ID (defined by the caller) which will be reflected back in the response.
Permission-ID required	string <uuid,> This contains the permission Id returned by the post permission, which was performed prior to any request.
User-Agent required	string Name and version of the of the Client software
X-CorAPI-Target-ID required	string ID that identifies the provider (e.g., a financial institution). (SCOPE: SIX required)
X-PSU-IP-Address required	string IP address of the user initiating the operation or AUTO for system triggered processes (SCOPE: SIX required)
X-PSU-User-Agent required	string User agent of the user initiating the operation or AUTO for system triggered processes (SCOPE: SIX required)
Authorization	string Bearer followed by a base64 encoded OAuth access token
X-Instance-ID	string <= 64 characters (Deprecated) Identifies an on-prem application instance which uses a legacy on-prem certificate in the mTLS connection. Do not use the header otherwise. (SCOPE: SIX_CAAS - optional, SIX_CAAS_INTERNAL - optional).

Responses

Response samples

Content type

application/json

{"statementDateTime": "2018-04-13T11:11:11Z",
"extendedOrder": {"clientOrderIdentification": "123123123",
"orderDateTime": "2018-04-13T11:11:11Z",
"orderIdentification": "321321321",
"bulkOrderDetails": {"side": "buy",
"orderQuantity": {"amount": "300",
"type": "unitsNumber"
},
"displayQuantity": "12000",
"numberOfAllocations": 5,
"financialInstrumentDetails": {"financialInstrumentIdentification": {"identification": "CH0012005267",
"type": "isin"
}
},
"placeOfTrade": {"marketIdentificationCode": "XSWX",
"marketDescription": "OTC"
},
"currency": "CHF",
"executionType": "limit",
"limitPrice": "12.50",
"stopPrice": "10.05",
"timeInForce": "day",
"expiryDateTime": "2018-04-13T11:11:11Z"
},
"allocationList": [{"requestedAllocation": {"accounts": [{"identification": "876543219",
"type": "safekeepingAccount"
}
],
"clientAllocationIdentification": "321321321",
"amount": "100"
},
"allocationCancellationReasonList": [{"code": "zeroQuantity",
"proprietary": "string"
}
],
"remainingAllocation": {"executedQuantity": "100",
"remainingQuantity": "20"
},
"completeAllocationList": [{"allocationIdentification": "123123123",
"executedQuantity": "100",
"averagePrice": "17.8",
"bookingDate": {"date": "2018-04-13"
},
"billingDetails": {"billingAmountList": [{"type": "grossTradeAmount",
"amount": "12000",
"currency": "CHF",
"creditDebitIndicator": "debit",
"foreignExchangeRate": {"sourceCurrency": null,
"rate": null,
"targetCurrency": null,
"fxType": null
}
}
],
"accruedInterests": {"numberDaysAccrued": 28,
"amount": "12000",
"currency": "CHF",
"creditDebitIndicator": "debit",
"foreignExchangeRate": {"sourceCurrency": "CHF",
"rate": "1.0963",
"targetCurrency": "CHF",
"fxType": "costPrice"
}
},
"feesOrTaxList": [{"feeType": "stampDuty",
"amount": "12000",
"currency": "CHF",
"creditDebitIndicator": "debit",
"foreignExchangeRate": {"sourceCurrency": null,
"rate": null,
"targetCurrency": null,
"fxType": null
}
}
]
}
}
]
}
]
},
"orderState": {"status": "partiallyFilled",
"statusDateTime": "2018-04-13T11:11:11Z",
"orderCancellationReasonList": [{"code": "endOfLife",
"proprietary": "string"
}
],
"executedQuantity": "100",
"remainingQuantity": "20",
"averagePrice": "17.85",
"dayOrderQuantity": "15",
"dayExecutedQuantity": "5",
"dayAveragePrice": "17.8",
"factor": "100",
"orderStatusHistoryList": [{"status": "partiallyFilled",
"statusDateTime": "2018-04-13T11:11:11Z"
}
]
},
"dateList": [{"date": "2018-04-13",
"dateType": "bookingDate"
}
]
}

orderstatus

Returns a list of open security orders.

Returns all open orders to which the user of the API has access to. Paging is done based on the order object, i.e. if limit is set to 1, then 1 order will be returned per page.

query Parameters

cursor	string An opaque string value used for pagination
limit	integer <int32> >= 1 Maximum number of items to return.

header Parameters

X-Correlation-ID required	string <= 64 characters Unique ID (defined by the caller) which will be reflected back in the response.
Permission-ID required	string <uuid,> This contains the permission Id returned by the post permission, which was performed prior to any request.
User-Agent required	string Name and version of the of the Client software
X-CorAPI-Target-ID required	string ID that identifies the provider (e.g., a financial institution). (SCOPE: SIX required)
X-PSU-IP-Address required	string IP address of the user initiating the operation or AUTO for system triggered processes (SCOPE: SIX required)
X-PSU-User-Agent required	string User agent of the user initiating the operation or AUTO for system triggered processes (SCOPE: SIX required)
Authorization	string Bearer followed by a base64 encoded OAuth access token
X-Instance-ID	string <= 64 characters (Deprecated) Identifies an on-prem application instance which uses a legacy on-prem certificate in the mTLS connection. Do not use the header otherwise. (SCOPE: SIX_CAAS - optional, SIX_CAAS_INTERNAL - optional).

Responses

Response samples

Content type

application/json

[{"statementDateTime": "2018-04-13T11:11:11Z",
"extendedOrder": {"clientOrderIdentification": "123123123",
"orderDateTime": "2018-04-13T11:11:11Z",
"orderIdentification": "321321321",
"bulkOrderDetails": {"side": "buy",
"orderQuantity": {"amount": "300",
"type": "unitsNumber"
},
"displayQuantity": "12000",
"numberOfAllocations": 5,
"financialInstrumentDetails": {"financialInstrumentIdentification": {"identification": "CH0012005267",
"type": "isin"
}
},
"placeOfTrade": {"marketIdentificationCode": "XSWX",
"marketDescription": "OTC"
},
"currency": "CHF",
"executionType": "limit",
"limitPrice": "12.50",
"stopPrice": "10.05",
"timeInForce": "day",
"expiryDateTime": "2018-04-13T11:11:11Z"
},
"allocationList": [{"requestedAllocation": {"accounts": [{"identification": "876543219",
"type": "safekeepingAccount"
}
],
"clientAllocationIdentification": "321321321",
"amount": "100"
},
"allocationCancellationReasonList": [{"code": "zeroQuantity",
"proprietary": "string"
}
],
"remainingAllocation": {"executedQuantity": "100",
"remainingQuantity": "20"
},
"completeAllocationList": [{"allocationIdentification": "123123123",
"executedQuantity": "100",
"averagePrice": "17.8",
"bookingDate": {"date": "2018-04-13"
},
"billingDetails": {"billingAmountList": [{"type": null,
"amount": null,
"currency": null,
"creditDebitIndicator": null,
"foreignExchangeRate": null
}
],
"accruedInterests": {"numberDaysAccrued": 28,
"amount": "12000",
"currency": "CHF",
"creditDebitIndicator": "debit",
"foreignExchangeRate": {"sourceCurrency": null,
"rate": null,
"targetCurrency": null,
"fxType": null
}
},
"feesOrTaxList": [{"feeType": null,
"amount": null,
"currency": null,
"creditDebitIndicator": null,
"foreignExchangeRate": null
}
]
}
}
]
}
]
},
"orderState": {"status": "partiallyFilled",
"statusDateTime": "2018-04-13T11:11:11Z",
"orderCancellationReasonList": [{"code": "endOfLife",
"proprietary": "string"
}
],
"executedQuantity": "100",
"remainingQuantity": "20",
"averagePrice": "17.85",
"dayOrderQuantity": "15",
"dayExecutedQuantity": "5",
"dayAveragePrice": "17.8",
"factor": "100",
"orderStatusHistoryList": [{"status": "partiallyFilled",
"statusDateTime": "2018-04-13T11:11:11Z"
}
]
},
"dateList": [{"date": "2018-04-13",
"dateType": "bookingDate"
}
]
}
]

Returns a single security order.

Returns a specific security order.

path Parameters

clientOrderId

required

string <= 20 characters

The security order id. This Id corresponds with the clientOrderIdentification.

header Parameters

X-Correlation-ID required	string <= 64 characters Unique ID (defined by the caller) which will be reflected back in the response.
Permission-ID required	string <uuid,> This contains the permission Id returned by the post permission, which was performed prior to any request.
User-Agent required	string Name and version of the of the Client software
X-CorAPI-Target-ID required	string ID that identifies the provider (e.g., a financial institution). (SCOPE: SIX required)
X-PSU-IP-Address required	string IP address of the user initiating the operation or AUTO for system triggered processes (SCOPE: SIX required)
X-PSU-User-Agent required	string User agent of the user initiating the operation or AUTO for system triggered processes (SCOPE: SIX required)
Authorization	string Bearer followed by a base64 encoded OAuth access token
X-Instance-ID	string <= 64 characters (Deprecated) Identifies an on-prem application instance which uses a legacy on-prem certificate in the mTLS connection. Do not use the header otherwise. (SCOPE: SIX_CAAS - optional, SIX_CAAS_INTERNAL - optional).

Responses

Response samples

Content type

application/json

{"statementDateTime": "2018-04-13T11:11:11Z",
"extendedOrder": {"clientOrderIdentification": "123123123",
"orderDateTime": "2018-04-13T11:11:11Z",
"orderIdentification": "321321321",
"bulkOrderDetails": {"side": "buy",
"orderQuantity": {"amount": "300",
"type": "unitsNumber"
},
"displayQuantity": "12000",
"numberOfAllocations": 5,
"financialInstrumentDetails": {"financialInstrumentIdentification": {"identification": "CH0012005267",
"type": "isin"
}
},
"placeOfTrade": {"marketIdentificationCode": "XSWX",
"marketDescription": "OTC"
},
"currency": "CHF",
"executionType": "limit",
"limitPrice": "12.50",
"stopPrice": "10.05",
"timeInForce": "day",
"expiryDateTime": "2018-04-13T11:11:11Z"
},
"allocationList": [{"requestedAllocation": {"accounts": [{"identification": "876543219",
"type": "safekeepingAccount"
}
],
"clientAllocationIdentification": "321321321",
"amount": "100"
},
"allocationCancellationReasonList": [{"code": "zeroQuantity",
"proprietary": "string"
}
],
"remainingAllocation": {"executedQuantity": "100",
"remainingQuantity": "20"
},
"completeAllocationList": [{"allocationIdentification": "123123123",
"executedQuantity": "100",
"averagePrice": "17.8",
"bookingDate": {"date": "2018-04-13"
},
"billingDetails": {"billingAmountList": [{"type": "grossTradeAmount",
"amount": "12000",
"currency": "CHF",
"creditDebitIndicator": "debit",
"foreignExchangeRate": {"sourceCurrency": null,
"rate": null,
"targetCurrency": null,
"fxType": null
}
}
],
"accruedInterests": {"numberDaysAccrued": 28,
"amount": "12000",
"currency": "CHF",
"creditDebitIndicator": "debit",
"foreignExchangeRate": {"sourceCurrency": "CHF",
"rate": "1.0963",
"targetCurrency": "CHF",
"fxType": "costPrice"
}
},
"feesOrTaxList": [{"feeType": "stampDuty",
"amount": "12000",
"currency": "CHF",
"creditDebitIndicator": "debit",
"foreignExchangeRate": {"sourceCurrency": null,
"rate": null,
"targetCurrency": null,
"fxType": null
}
}
]
}
}
]
}
]
},
"orderState": {"status": "partiallyFilled",
"statusDateTime": "2018-04-13T11:11:11Z",
"orderCancellationReasonList": [{"code": "endOfLife",
"proprietary": "string"
}
],
"executedQuantity": "100",
"remainingQuantity": "20",
"averagePrice": "17.85",
"dayOrderQuantity": "15",
"dayExecutedQuantity": "5",
"dayAveragePrice": "17.8",
"factor": "100",
"orderStatusHistoryList": [{"status": "partiallyFilled",
"statusDateTime": "2018-04-13T11:11:11Z"
}
]
},
"dateList": [{"date": "2018-04-13",
"dateType": "bookingDate"
}
]
}

accountaccess

Returns list of accounts the requestor has access to.

Returns list of accounts the requestor has access to with the type of access the requestor has. Paging is done based on the accountaccess object, i.e. if limit is set to 1, then 1 accountaccess object will be returned per page.

query Parameters

cursor	string An opaque string value used for pagination
limit	integer <int32> >= 1 Maximum number of items to return.

header Parameters

X-Correlation-ID required	string <= 64 characters Unique ID (defined by the caller) which will be reflected back in the response.
Permission-ID required	string <uuid,> This contains the permission Id returned by the post permission, which was performed prior to any request.
User-Agent required	string Name and version of the of the Client software
X-CorAPI-Target-ID required	string ID that identifies the provider (e.g., a financial institution). (SCOPE: SIX required)
X-PSU-IP-Address required	string IP address of the user initiating the operation or AUTO for system triggered processes (SCOPE: SIX required)
X-PSU-User-Agent required	string User agent of the user initiating the operation or AUTO for system triggered processes (SCOPE: SIX required)
Authorization	string Bearer followed by a base64 encoded OAuth access token
X-Instance-ID	string <= 64 characters (Deprecated) Identifies an on-prem application instance which uses a legacy on-prem certificate in the mTLS connection. Do not use the header otherwise. (SCOPE: SIX_CAAS - optional, SIX_CAAS_INTERNAL - optional).

Responses

Response samples

Content type

application/json

[{"account": {"identification": "876543219",
"type": "safekeepingAccount"
},
"accessType": "read"
}
]

diagnostics

Returns all specified request headers and additional diagnostic information

header Parameters

X-Correlation-ID	string <= 64 characters Unique ID (defined by the caller) which will be reflected back in the response.
Authorization	string Bearer followed by a base64 encoded OAuth access token
User-Agent	string Name and version of the of the client software
X-CorAPI-Target-ID required	string ID that identifies the provider (e.g., a financial institution). (SCOPE: SIX required)
X-PSU-IP-Address	string IP address of the user initiating the operation (SCOPE: FI - optional)
X-PSU-User-Agent	string User of the client software (SCOPE: FI - optional)
X-Instance-ID	string <= 64 characters (Deprecated) Identifies an on-prem application instance which uses a legacy on-prem certificate in the mTLS connection. Do not use the header otherwise. (SCOPE: SIX_CAAS - optional, SIX_CAAS_INTERNAL - optional).

Responses

Response samples

200

Content type

application/json

{"requestDateTime": "2018-04-13T11:11:11Z",
"receivedHeaders": [{"headerName": "X-Correlation-ID",
"headerValue": "string"
}
],
"receivedPayload": "... as received ..."
}

Returns all specified request headers, the request body and additional diagnostic information

header Parameters

X-Correlation-ID	string <= 64 characters Unique ID (defined by the caller) which will be reflected back in the response.
Authorization	string Bearer followed by a base64 encoded OAuth access token
User-Agent	string Name and version of the of the client software
X-CorAPI-Target-ID required	string ID that identifies the provider (e.g., a financial institution). (SCOPE: SIX required)
X-PSU-IP-Address	string IP address of the user initiating the operation (SCOPE: FI - optional)
X-PSU-User-Agent	string User of the client software (SCOPE: FI - optional)
X-Instance-ID	string <= 64 characters (Deprecated) Identifies an on-prem application instance which uses a legacy on-prem certificate in the mTLS connection. Do not use the header otherwise. (SCOPE: SIX_CAAS - optional, SIX_CAAS_INTERNAL - optional).

Request Body schema: application/json
required

string

Responses

Request samples

Payload

Content type

application/json

"string"

Response samples

200

Content type

application/json

{"requestDateTime": "2018-04-13T11:11:11Z",
"receivedHeaders": [{"headerName": "X-Correlation-ID",
"headerValue": "string"
}
],
"receivedPayload": "... as received ..."
}

bLink API - order placement module (2.0.9.4-six_caas)

orderplacement

Posts a new order.

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Cancellation of a specific order.

path Parameters

header Parameters

Responses

Response samples

orderstatus

Returns a list of open security orders.

query Parameters

header Parameters

Responses

Response samples

Returns a single security order.

path Parameters

header Parameters

Responses

Response samples

accountaccess

Returns list of accounts the requestor has access to.

query Parameters

header Parameters

Responses

Response samples

diagnostics

Returns all specified request headers and additional diagnostic information

header Parameters

Responses

Response samples

Returns all specified request headers, the request body and additional diagnostic information

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Request Body schema: application/json
required