Skip to main content

bLink API - order placement module (2.0.9.4-six_caas)

Download OpenAPI specification:Download

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.

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

Content type
application/json
{
  • "clientOrderIdentification": "123123123",
  • "bulkOrderDetails": {
    },
  • "requestedAllocationList": [
    ]
}

Response samples

Content type
application/json
{
  • "statementDateTime": "2018-04-13T11:11:11Z",
  • "extendedOrder": {
    },
  • "orderState": {
    },
  • "dateList": [
    ]
}

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": {
    },
  • "orderState": {
    },
  • "dateList": [
    ]
}

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
[
  • {
    }
]

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": {
    },
  • "orderState": {
    },
  • "dateList": [
    ]
}

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
[
  • {
    }
]

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

Content type
application/json
{
  • "requestDateTime": "2018-04-13T11:11:11Z",
  • "receivedHeaders": [
    ],
  • "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

Content type
application/json
"string"

Response samples

Content type
application/json
{
  • "requestDateTime": "2018-04-13T11:11:11Z",
  • "receivedHeaders": [
    ],
  • "receivedPayload": "... as received ..."
}