Search
K
Swiss Bank Master API [CH]

IbanResponse

object

IBAN validation result and IID if available.

validationResultstringrequired

Validation result. Possible values:

  • OK # This IBAN is formally correct
  • INVALID_COUNTRY_CODE # This IBAN has an invalid country code
  • INVALID_LENGTH # This IBAN has an invalid length
  • INVALID_FORMAT, # This IBAN is formally incorrect according to ISO-13616-1
  • INVALID_CHECKSUM # This IBAN has an invalid checksum
  • INVALID_IID # This IBAN has an invalid CH or LI institution identification (IID)
iidinteger

Each bank / financial institution is identified by an IID (institution identification). IIDs are three to five digits long. QR-IIDs consist exclusively of numbers from 30000 to 31999.

Example:9703

Example

IbanValidationResult

string

Validation result. Possible values:

  • OK # This IBAN is formally correct
  • INVALID_COUNTRY_CODE # This IBAN has an invalid country code
  • INVALID_LENGTH # This IBAN has an invalid length
  • INVALID_FORMAT, # This IBAN is formally incorrect according to ISO-13616-1
  • INVALID_CHECKSUM # This IBAN has an invalid checksum
  • INVALID_IID # This IBAN has an invalid CH or LI institution identification (IID)

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:2023-01-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