SIC Clearing Day Calendar API V1 [CH]

ScheduledClearingDayChange

object

Used if a clearing day change is scheduled for the calendar date. Depending on the service certain child-elements are available:

a) clearing stops (SIC RTGS and euroSIC RTGS service)
b) cut-offs for euroSIC RTGS service
c) the next clearing day scheduled

The date-time fields are structured according to RFC3339, section 5.6 in ISO 8601 with timezone and milliseconds.

scheduledClearingStop1string(date-time)

Clearing stop 1 date and time.

Example:2024-12-23T17:00:00+01:00

scheduledClearingStop2string(date-time)

Clearing stop 2 date and time.

Example:2024-12-23T18:00:00+01:00

scheduledClearingStop3string(date-time)

Clearing stop 3 date and time.

Example:2024-12-23T18:15:00+01:00

scheduledCutOff1string(date-time)

Cut off 1 date and time.

Example:2024-12-23T16:30:00+01:00

scheduledCutOff2string(date-time)

Cut off 2 date and time.

Example:2024-12-23T17:30:00+01:00

nextClearingDaystring(date)required

The clearing day that starts after day end processing (SIC and euroSIC RTGS service) or after day change (SIC IP service).

Example:2024-12-24

Example

Duration

object

A duration composed of start and end. The date-time fields are structured according to RFC3339, section 5.6 in ISO 8601 with timezone and milliseconds.

startDateTimestring(date-time)required

Start date and time of the duration.

Example:2024-12-23T12:00:00+01:00

endDateTimestring(date-time)required

End date and time of the duration.

Example

Problem

object
typestring(uri)

An absolute URI that identifies the problem type.
We may provide human-readable documentation for the problem type in the future, when the URI is dereferenced.

Default:about:blank

Example:/problems/REQUEST_PARAMETER_VALIDATION_FAILED

titlestringrequired

A short, human readable summary of the problem type.

Example:Request parameter has missing or invalid values

statusinteger(int32)required

The HTTP status code generated by the origin server for this occurrence
of the problem.

>= 100< 600

Example:400

detailstringrequired

A human readable explanation specific to this occurrence of the
problem.

Example:The submitted request contains invalid or missing request parameters which cannot be processed.

instancestring(uri)

An absolute URI that identifies the specific occurrence of the problem.
It may or may not yield further information if dereferenced.

Example:/api/epcd/bankmaster/v3/public/errors/EPCD0090000001/provided-D

metadataobject

Structured type that contains an object and its type.

Example:When associated with a 'Problem', it typically contains values which caused the failure and similar. May not contain sensitive CID.

Show Child Parameters
Example

GenericObject

object

Structured type that contains an object and its type.

@typestringrequired

The field “@type” contains a URI/name identifying the type. Example: “@type”: “types.example.com/standard/id”.

dataobjectrequired

An object of type @type containing custom fields.

Example

HealthCheckResponse

object
messagestringrequired

Response message from health check.

<= 100 characters

Example:The health check GET request was successfully received and processed.

requestDateTimestring(date-time)required

According to RFC3339, section 5.6 in ISO 8601 with timezone and milliseconds.

Example:2024-12-21T10:52:05.1904957+01:00

receivedHeadersarray[object]required
Show Child Parameters
environmentStagestringrequired

The instance to which the request was sent to.

Example:X1

applicationVersionstringrequired

The version of the API backend.

Example:4.5.0-julia

apiVersionstringrequired

The version of the API.

Example:1.0.23

Example