Swiss Bank Master API [CH]

BankMaster

iidintegerrequired

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

validOnstring(date)required

Date to which the information in a record applies. This date (written as per ISO8601 standard) is identical for all records.

Example:2023-01-23

entryTypestringrequired

“New IID/QR-IID” must be used instead of “IID / QR-IID” if entryType is BankMasterConcatenated.

Allowed values:BankMasterConcatenatedBankMaster

sicIidstring

This is always a 6-digit number and may be used only by SIC and euroSIC participants.

>= 6 characters<= 6 characters

Example:097031

headQuartersinteger

IID of the headquarters of this participant. If this is the record of the headquarters itself, then this field contains the same value as the field IID.

Example:9703

iidTypestring

Provides information as to the respective type of entry.

Allowed values:HEADQUARTERSMAIN_BRANCHQR_IID

Example:HEADQUARTERS

qrIidBelongsTointeger

IID of the bank/financial institution to which this QR IID is assigned to. It only contains a value, if the field iidType contains a QR_IID. Otherwise the field is empty.

Example:9950

bankOrInstitutionNamestringrequired

Name of participant
Notice:

  • at the beginning of the name of the bank/institution = in liquidation
    ++ at the beginning of the name of the bank/institution = alternation of purpose

>= 1 characters<= 60 characters

Example:Schweizerische Nationalbank

streetNamestring

Street of domicile address

<= 35 characters

Example:Bundesplatz

buildingNumberstring

Building number of domicile address

<= 16 characters

Example:55a

postCodestring

Zip code/postcode

>= 1 characters<= 16 characters

Example:3003

townNamestring

City

>= 1 characters<= 35 characters

Example:Bern

countrystring

2-digit alphabetical country code according to the ISO standard 3166.

<= 2 characters

Example:DE

bicstring

BIC Formatted (XXXXXXXXXXX) (= 11-digit)

>= 11 characters<= 11 characters

Example:SNBZCHZZXXX

sicParticipationbooleanrequired

Participation in SIC.

rtgsCustomerPaymentsChfbooleanrequired

Available for RTGS customer payments.

ipCustomerPaymentsChfbooleanrequired

Available for IP customer payments.

euroSicParticipationbooleanrequired

Participation in euroSIC.

lsvBddChfParticipationbooleanrequired

Participation in LSV+/BDD in CHF (as debtor FI).

lsvBddEurParticipationbooleanrequired

Participation in LSV+/BDD in EUR (as debtor FI).

Example

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