Settlement Info Reporting [CH]
Set the subscription of a business partner
Sets the subscription (list of securities identified by their ISIN). The previous subscription is overwritten if and only if the operation is successful.
If the request body includes bad data (typically, one element in the array is an invalid ISIN), 400 is returned and the subscription is not updated.
post
Headers
X-Correlation-Idstring
Value of the correlation ID for the server, i.e., a UUID v4 (with or without the dash to separate the blocks), optionally followed by a ‘#’ and a positive integer.
Match pattern:^[0-9A-Fa-f]{8}-?[0-9A-Fa-f]{4}-?4[0-9A-Fa-f]{3}-?[89ABab][0-9A-Fa-f]{3}-?[0-9A-Fa-f]{12}(#[1-9][0-9]*)?$
Body
application/vnd.api+json
Body
application/vnd.api+json
SubscriptionRequestBody
List of securities (identified by ISIN) a business partner is subscribed to for the bulk service.
dataobjectrequired
List of securities (identified by ISIN) a business partner is subscribed to for the bulk service.
Example:{"type":"Subscription","attributes":{"subscription":["US0378331005","US5949181045"]}}
Show Child Parameters
Response
application/vnd.api+json
Response
application/vnd.api+json
No Content
post/bulk-subscription/securities/bulk-set
Headers
Body
{
"data": {
"type": "Subscription",
"attributes": {
"subscription": [
"US0378331005",
"US5949181045"
]
}
}
}
application/vnd.api+json
Add a security to the subscription
Addition of a security (identified by its ISIN) to the subscription of a business partner for the bulk service.
This operation is idempotent.
put
Path Parameters
isinstringrequired
The ISIN (International Securities Identification Number) uniquely identifies a financial instrument. See ISO 6166:2021: Financial services — International securities identification number (ISIN).
Match pattern:^[A-Z]{2}([A-Z0-9]){9}[0-9]$
Example:CH0038863350
Headers
X-Correlation-Idstring
Value of the correlation ID for the server, i.e., a UUID v4 (with or without the dash to separate the blocks), optionally followed by a ‘#’ and a positive integer.
Match pattern:^[0-9A-Fa-f]{8}-?[0-9A-Fa-f]{4}-?4[0-9A-Fa-f]{3}-?[89ABab][0-9A-Fa-f]{3}-?[0-9A-Fa-f]{12}(#[1-9][0-9]*)?$
Response
application/vnd.api+json
Response
application/vnd.api+json
No Content
put/bulk-subscription/securities/{isin}
Path Parameters
Headers
application/vnd.api+json
Delete a security from the subscription
Removal of a security (identified by its ISIN) from the subscription of a business partner for the bulk service.
delete
Path Parameters
isinstringrequired
The ISIN (International Securities Identification Number) uniquely identifies a financial instrument. See ISO 6166:2021: Financial services — International securities identification number (ISIN).
Match pattern:^[A-Z]{2}([A-Z0-9]){9}[0-9]$
Example:CH0038863350
Headers
X-Correlation-Idstring
Value of the correlation ID for the server, i.e., a UUID v4 (with or without the dash to separate the blocks), optionally followed by a ‘#’ and a positive integer.
Match pattern:^[0-9A-Fa-f]{8}-?[0-9A-Fa-f]{4}-?4[0-9A-Fa-f]{3}-?[89ABab][0-9A-Fa-f]{3}-?[0-9A-Fa-f]{12}(#[1-9][0-9]*)?$
Response
application/vnd.api+json
Response
application/vnd.api+json
No Content
delete/bulk-subscription/securities/{isin}
Path Parameters
Headers
application/vnd.api+json
Get the list of securities the business partner is subscribed to.
Get the subscription list of securities for a business partner.
get
Headers
X-Correlation-Idstring
Value of the correlation ID for the server, i.e., a UUID v4 (with or without the dash to separate the blocks), optionally followed by a ‘#’ and a positive integer.
Match pattern:^[0-9A-Fa-f]{8}-?[0-9A-Fa-f]{4}-?4[0-9A-Fa-f]{3}-?[89ABab][0-9A-Fa-f]{3}-?[0-9A-Fa-f]{12}(#[1-9][0-9]*)?$
If-None-Matchstring
The RFC7232 If-None-Match header field in a request requires the server to only operate on the resource if it does not match any of the provided entity-tags. If the provided entity-tag is *, it is required that the resource does not exist at all.
Example:7da7a728-f910-11e6-942a-68f728c1ba70
Response
application/vnd.api+json
Response
application/vnd.api+json
The list of securities a business partner is subscribed to for the bulk service.
ResponseSubscriptionQuery
HTTP 200 response (OK) for the query about the subscription of a business partner for the bulk service.
dataobjectrequired
Show Child Parameters
get/bulk-subscription/securities
Headers
application/vnd.api+json
BulkSubscriptionResults
Obtain the (basic) settlement information for securities included in the business partner’s subscription.