Swiss Bank Master API v2

metaData
required

BankMasterMetaData

entries
required

< BankMasterJsonResponseEntry > array

validForClearingDay
required

Date (according to ISO 8601) for which the entries are valid.
Example : "2023-01-23"

string (date)

createdStamp
required

Date and time (according to ISO 8601) at which this response was created.
Example : "2023-01-21T10:52:05.1904957+01:00"

string (date-time)

group
required

The banks/financial institutions are divided into so-called bank groups. At present these are made up of the following:
01 = Swiss National Bank
02 = UBS Group
03 = Reserve
04 = Credit Suisse Group
05 = Credit Suisse Group
06 = Entris Banks
07 = Cantonal Banks
08 = Raiffeisen Banks and individual institutions
09 = PostFinance
Length : 2
Example : "01"

string

iid
required

Each bank/financial institution is identified by way of an IID (institution identification) made up of 3 to 5 digits.
Example : 9703

integer

branchId
required

Together with the IID the branch ID provides a conclusive key for each entry. Each IID has a main branch with the branch ID "0000"; the branch IDs from "0001" are assigned to this IID.
Length : 4
Example : "0004"

string

newIid
optional

If this field contains a number, the IID is no longer valid (e.g. due to a merger) and is to be replaced by the "New IID" (so-called concatenation). A concatenation is always carried out with the branch ID "0000" of the new IID. All other record fields and the original information remain unchanged until the cancellation of the concatenation.
Example : 9950

integer

sicIid
required

This is always a 6-digit number and may be used only by SIC and euroSIC participants.
Length : 6
Example : "097031"

string

headOffice
required

IID of the head office (headquarters)
Example : 9703

integer

iidType
required

Provides information as to the respective type of entry.
Example : "HEADQUARTERS"

enum (HEADQUARTERS, MAIN_BRANCH, BRANCH)

validSince
required

Date (according to ISO 8601) from which the information in a record is valid. The date is adjusted as soon as an amendment has been made in one or several fields or in the case of a record which is for the first time included in the file.
Example : "2023-01-23"

string (date)

sicParticipation
required

This code provides information regarding participation in the services SIC and LSV+/BDD in CHF.
NO_PARTICIPATION: no participation in SIC
SIC_PARTICIPATION_AND_LSV_AS_DEBTOR_FI: participation in SIC and in LSV+/BDD as DEB-FI but without IP customer payments. Direct debits payments in CHF debitable to an IID not indicated with this code will be rejected (DEB-FI = direct debit payers financial institution).
SIC_PARTICIPATION: participation in SIC but without IP customer payments
SIC_PARTICIPATION_WITH_QR_IID: participation in SIC with QR-IID for payments with QR reference but without IP customer payments
SIC_PARTICIPATION_NO_CUSTOMER_PAYMENT_AND_NO_LSV_AS_DEBTOR_FI: participation in SIC without RTGS/IP customer payments and without LSV+/BDD as DEB-FI
SIC_PARTICIPATION_WITH_IP_CUSTOMER_PAYMENT_AND_QR_IID_AND_NO_LSV_AS_DEBTOR_FI: participation in SIC with RTGS/IP customer payments, QR-IID for payments with QR reference and without LSV+/BDD as DEB-FI
SIC_PARTICIPATION_WITH_IP_CUSTOMER_PAYMENT_AND_LSV_AS_DEBTOR_FI: participation in SIC with RTGS/IP customer payments and with LSV+/BDD as DEB-FI
SIC_PARTICIPATION_WITH_IP_CUSTOMER_PAYMENT_AND_NO_LSV_AS_DEBTOR_FI: participation in SIC with RTGS/IP customer payments and without LSV+/BDD as DEB-FI
Example : "SIC_PARTICIPATION"

enum (NO_PARTICIPATION, SIC_PARTICIPATION_AND_LSV_AS_DEBTOR_FI, SIC_PARTICIPATION, SIC_PARTICIPATION_WITH_QR_IID, SIC_PARTICIPATION_NO_CUSTOMER_PAYMENT_AND_NO_LSV_AS_DEBTOR_FI, SIC_PARTICIPATION_WITH_IP_CUSTOMER_PAYMENT_AND_QR_IID_AND_NO_LSV_AS_DEBTOR_FI, SIC_PARTICIPATION_WITH_IP_CUSTOMER_PAYMENT_AND_LSV_AS_DEBTOR_FI, SIC_PARTICIPATION_WITH_IP_CUSTOMER_PAYMENT_AND_NO_LSV_AS_DEBTOR_FI)

euroSicParticipation
required

This code provides information regarding participation in the services euroSIC and LSV+/BDD in EUR:
NO_PARTICIPATION: no participation in euroSIC
EURO_SIC_PARTICIPATION_AND_LSV_AS_DEBTOR_FI: participation in euroSIC and in LSV+/BDD as DEB-FI. Direct debits in EUR debitable to an IID not indicated with this code will be rejected (DEB-FI = direct debit payers financial institution).
EURO_SIC_PARTICIPATION: participation in euroSIC
EURO_SIC_PARTICIPATION_WITH_QR_IID: participation in euroSIC with QR-IID for payments with QR reference
Example : "EURO_SIC_PARTICIPATION"

enum (NO_PARTICIPATION, EURO_SIC_PARTICIPATION_AND_LSV_AS_DEBTOR_FI, EURO_SIC_PARTICIPATION, EURO_SIC_PARTICIPATION_WITH_QR_IID)

language
required

The fields entitled "shortName" and "BankOrInstitutionName" for each record are supplied in the respective languages. DE = German, FR = French, IT = Italian
Length : 2
Example : "DE"

string

shortName
required

Short name of the bank or financial institution
Length : 1 - 15
Example : "SNB"

string

bankOrInstitutionName
required

Name of the bank or financial institution
Notice:
+ in the first position of the name of the bank/institution = in liquidation
++ in the first position of the name of the bank/institution = alternation of purpose
Length : 1 - 60
Example : "Schweizerische Nationalbank"

string

domicileAddress
optional

Address of domicile
Maximal length : 35
Example : "Bundesplatz 1"

string

postalAddress
optional

Postal address
Maximal length : 35
Example : "Postfach 2800"

string

zipCode
required

Postal/Zip code
Length : 1 - 10
Example : "3003"

string

place
required

Place
Length : 1 - 35
Example : "Bern"

string

phone
optional

Phone number. Formatted representation (with blanks).
Maximal length : 18
Example : "012 345 67 89"

string

fax
optional

Fax number. Formatted representation (with blanks).
Maximal length : 18
Example : "012 345 67 89"

string

diallingCode
optional

International dialling code for telephone and fax (foreign entries only).
Maximal length : 5
Example : "+49"

string

countryCode
optional

2-digit alphabetical country code according to the ISO standard 3166 (foreign entries only).
Maximal length : 2
Example : "DE"

string

postalAccount
optional

Postal account number.
A * in the first position points out that the listed postal account number is part of a higher-level
IID (e.g. main branch).
Maximal length : 12
Example : "*30-5-5"

string

bic
optional

BIC of the bank or financial institution.
Formated representation (XXXXXXXXXXX) (= 11 characters).
(The SWIFT/BIC addresses used in this directory are the property of SWIFT SCRL,
1310 La Hulpe / Belgium and have been made available by SIX Interbank Clearing Ltd
on behalf of the bank or financial institution.)
Maximal length : 11
Example : "SNBZCHZZXXX"

string

links
required

< BankMasterDownloadLink > array

filename
required

name of the bank master data file available for download
Length : 1 - 100
Example : "bcbankenstamm_d.xls"

string

contentType
required

content type of the file
Length : 1 - 100
Example : "application/vnd.ms-excel"

string

link
required

relative link to download this bank master data file
Length : 1 - 100
Example : "/public/downloads/bcbankenstamm_d.xls"

string

description
required

short description of the file format of this bank master data file
Minimum length : 1
Example : "Bank master data file in Excel format with german headers"

string

type
optional

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"

string (uri)

title
optional

A short, human readable summary of the problem type.
Example : "Request parameter has missing or invalid values"

string

status
optional

The HTTP status code generated by the origin server for this occurrence
of the problem.
Minimum value : 100
Maximum value (exclusive) : 600
Example : 400

integer (int32)

detail
optional

A human readable explanation specific to this occurrence of the
problem.
Example : "The submitted request contains invalid or missing request parameters which can not be processed."

string

instance
optional

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/v2/public/errors/EPCD0090000001/provided-D"

string (uri)

technicalReason
optional

The Technical Description/Reason for engineers might contain addition system information on the problem.
Example : "Some field validations failed"

string

fieldErrors
optional

< fieldErrors > array

fieldName
optional

The name of the field with the error.
Example : "parameter1"

string

message
optional

The message describing the error
Example : "size must be between 1 and 35"

string

rejectedValue
optional

the provided value which was rejected if available
Example : "Very Long Invalid Request Parameter Name Which Is Rejected"

string

message
required

response message from health check
Maximal length : 100
Example : "The health check GET request was successfully received and processed"

string

requestDateTime
required

according to RFC3339, section 5.6 in ISO 8601 with timezone and milliseconds
Example : "2023-01-21T10:52:05.1904957+01:00"

string (date-time)

receivedHeaders
required

< receivedHeaders > array

environmentStage
required

the instance which the request was sent to
Example : "X1"

string

applicationVersion
required

the version of the EPCD infrastructure
Example : "4.5.0-julia"

string

apiVersion
required

the version of the EPCD public api
Example : "1.0.23"

string

headerName
optional

the name of the provided header
Example : "Accept"

string

headerValue
optional

As received
Example : "application/json"

string