Settlement Info Reporting [CH]
Get the (basic) settlement information for all securities in the business partner's subscription as a gzipped file.
Get the basic settlement information for all securities defined by the business partner in its subscription as a gzipped file.
Settlement information is previous business day and the subscription list taken into account is the one available on the server before midnight.
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/gzip
Response
application/gzip
The basic settlement information for all securities defined in the business partner’s subscription.
The format of the file is given by the type ‘ResponseSubscriptionBasicSettlementInfoQuery’; see ‘SampleResultsFileContents’ as an example.
string
get/bulk-subscription/resultsFile
Headers
application/gzip
XCorrelationIdType
stringValue 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]*)?$
Isin
stringThe 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
ApiGwError
objectDescription of an error as provided by the API GW to help remediation.
messagestringrequired
A human-readable explanation specific to this error.
Example:Unauthorized
Example
Error
objectDescription of an error to help remediation.
messagestringrequired
A human-readable explanation specific to this error.
Example:Unauthorized
errorDetailobject
Additional information about the error.
Show Child Parameters
Example