Skip to main content
API docs by Redocly

bLink API - order placement module (2.2.1.6-nr)

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. (as implemented by service users who offer a notification endpoint to providers and as used by SIX) This API is used to place orders and check on the order status.

event-notification-webhook

Event notification webhook operations.

Push notification towards TPP

Push notifications for subscribed event notifications.

header Parameters
X-CorApi-API-Version
required
string
Example: 1.0.0

The API Version

X-CorApi-Event-Type
required
string
Example: order:trade

The Event-Type

X-CorApi-Event-ID
required
string
Example: 7c5f40fc-1b29-4263-a2dd-e127a22a947f

The Event-ID

X-CorApi-Event-Created-At
required
string <date-time>
Example: 2024-05-28T13:44:53Z

The Event-Created Date

X-CorApi-Event-Subscription-ID
required
string
Example: 7c5f40fc-1b29-4263-a2dd-e127a22a947f

The ID of the Subscription the event was created for

X-Correlation-ID
required
string <= 64 characters

Unique ID (defined by the caller) which will be reflected back in the response.

User-Agent
required
string

Name and version of the of the Client software

X-CorAPI-Client-ID
required
string

ID of the client forwarded to the target. (SCOPE: FI / NOTIFICATION_RECIPIENT)

X-CorAPI-Target-ID
string

ID of the target, e.g., a financial institution. (SCOPE: FI / NOTIFICATION_RECIPIENT - optional)

X-PSU-IP-Address
string

IP address of the user initiating the operation (SCOPE: FI / NOTIFICATION_RECIPIENT - optional)

X-PSU-User-Agent
string

User of the client software (SCOPE: FI / NOTIFICATION_RECIPIENT - optional)

Request Body schema: application/json
eventSubscriptionId
string (eventSubscriptionId) [ 1 .. 40 ] characters

Unique identification as assigned by the API exposing party to uniquely identify the callback URL resource.

version
string (version)
Enum: "v1" "v2" "v3"

Indicates to which version of the respective API the notification is belonging to.

eventType
string (eventType)
Enum: "heartbeat" "order:doneForDay" "order:orderStatusUpdated" "order:pendingReplace" "order:replaced" "order:restated" "order:suspended" "order:trade" "order:tradeCancel" "order:tradeCorrect"

Event type the subscription should apply to AND reason why a notification is sent.

resourceLink
string

Link to resource that triggered the event notification.

created
string <date-time> (DateTime)
id
string (notificationId)

Identification of the notification.

predecessorId
string (notificationId)

Identification of the notification.

orderStatus
string (orderStatus)
Enum: "acknowledged" "accepted" "customerRelease" "placed" "partiallyFilled" "filled" "executed" "cancelled" "partiallyCancelled" "marketCancelled" "pendingCancel" "rejected" "partiallyRejected" "marketRejected" "expired" "partiallyExpired" "marketExpired"

Shows in which stage of its life cycle an order is.

executedQuantity
string (executedQuantity) <= 22 characters ^[0-9]{1,12}([.][0-9]{1,9})?$

Total quantity (e.g. number of shares) filled.

averagePrice
string (averagePrice) <= 22 characters ^[0-9]{1,12}([.][0-9]{1,9})?$

Calculated average price of all fills on this order.

remainingQuantity
string (remainingQuantity) <= 22 characters ^[0-9]{1,12}([.][0-9]{1,9})?$

Quantity open for further execution. If the status is cancelled, expired, or rejected (in which case the order is no longer active) then remainingQuantity could be 0, otherwise remainingQuantity = orderQuantity - executedQuantity.

dayExecutedQuantity
string (dayExecutedQuantity) <= 22 characters ^[0-9]{1,12}([.][0-9]{1,9})?$

Quantity on an order that has traded today.

dayAveragePrice
string (dayAveragePrice) <= 22 characters ^[0-9]{1,12}([.][0-9]{1,9})?$

Calculated average price of all fills on this order.

lastQuantity
string (lastQuantity) <= 22 characters ^[0-9]{1,12}([.][0-9]{1,9})?$

Quantity (e.g. shares) bought/sold on this (last) fill.

lastPrice
string (lastPrice) <= 22 characters ^[0-9]{1,12}([.][0-9]{1,9})?$

Price of this (last) fill.

Responses

Request samples

Content type
application/json
{
  • "eventSubscriptionId": "3v3n7subscr1p70n",
  • "version": "v2",
  • "eventType": "order:orderStatusUpdated",
  • "resourceLink": "/api/openwealth/order-placement/v2/orders/abcd1234",
  • "created": "2018-04-13T16:00:00+01:00",
  • "id": "120066c9-58a1-432b-aa60-712fae7f143e",
  • "predecessorId": "120066c9-58a1-432b-aa60-712fae7f143e",
  • "orderStatus": "partiallyFilled",
  • "executedQuantity": "100",
  • "averagePrice": "17.8",
  • "remainingQuantity": "20",
  • "dayExecutedQuantity": "5",
  • "dayAveragePrice": "17.8",
  • "lastQuantity": "30",
  • "lastPrice": "17.8"
}

Response samples

Content type
application/problem+json
{
  • "type": "/problems/TECHNICAL_ERROR",
  • "title": "This is the general problem description",
  • "detail": "Detailed problem description with respect to the current request",
  • "instance": "path/to/corresponding/resource"
}