SEPA

Definiert in: sdk/cosmolink.SDK.SEPA.ts:817

Enthält eine Funktionssammlung für die Erstellung von SEPA-XML-Daten.

Implementiert

• Disposable

Eigenschaften

hasError

Abfragesignatur

get hasError(): boolean;

Definiert in: sdk/cosmolink.SDK.SEPA.ts:831

Gibt an, ob während des letzten Funktionsaufrufes ein Fehler aufgetreten ist.

Rückgabewert

boolean

---

hasWarning

Abfragesignatur

get hasWarning(): boolean;

Definiert in: sdk/cosmolink.SDK.SEPA.ts:840

Gibt an, ob während des letzten Funktionsaufrufes eine Warnung aufgetreten ist.

Rückgabewert

boolean

---

lastError

Abfragesignatur

get lastError(): SepaLastError;

Definiert in: sdk/cosmolink.SDK.SEPA.ts:849

Die letzte Fehlermeldung.

Rückgabewert

SepaLastError

---

lastWarning

Abfragesignatur

get lastWarning(): SepaLastWarning;

Definiert in: sdk/cosmolink.SDK.SEPA.ts:866

Die letzte Warnungsmeldung.

Rückgabewert

SepaLastWarning

---

writeToTempFirst

Abfragesignatur

get writeToTempFirst(): boolean;

Definiert in: sdk/cosmolink.SDK.SEPA.ts:883

Gibt an, ob eine erstellte Datei erst in das Temp Verzeichnis geschrieben werden soll

Rückgabewert

boolean

Änderungssignatur

set writeToTempFirst(val): void;

Definiert in: sdk/cosmolink.SDK.SEPA.ts:891

Gibt an, ob eine erstellte Datei erst in das Temp Verzeichnis geschrieben werden soll

Parameter

Parameter	Type
val	boolean

Rückgabewert

void

Konstruktoren

Konstruktor

new SEPA(): SEPA;

Definiert in: sdk/cosmolink.SDK.SEPA.ts:903

Initialisiert die SEPA Klasse.

Rückgabewert

SEPA

Methoden

[dispose]()

dispose: void;

Definiert in: sdk/cosmolink.SDK.SEPA.ts:1263

Standardimplementierung des Dispose Symbols

Rückgabewert

void

Implementierung von

Disposable.[dispose]

---

checkCI()

checkCI(ci): boolean;

Definiert in: sdk/cosmolink.SDK.SEPA.ts:1084

Über diese Funktion kann eine Gläubiger-Identifikations-Nummer (CI) auf ihre Richtigkeit geprüft werden.

Parameter

Parameter	Type	Description
ci	string	Die Gläubiger-Identifikations-Nummer (CI) die geprüft werden soll

Rückgabewert

boolean

---

checkIBAN()

checkIBAN(iban): boolean;

Definiert in: sdk/cosmolink.SDK.SEPA.ts:1025

Über diese Funktion kann eine IBAN auf ihre Richtigkeit geprüft werden.

Parameter

Parameter	Type	Description
iban	string	Die IBAN, die geprüft werden soll.

Rückgabewert

boolean

---

checkIBANLand()

checkIBANLand(land, sepaCountrysOnly?): boolean;

Definiert in: sdk/cosmolink.SDK.SEPA.ts:1098

Über diese Funktion kann festgestellt werden, ob ein Land eine IBAN hat und/oder ob das Land an SEPA teilnimmt.

Parameter

Parameter	Type	Description
land	string	Der 2-stellige ISO-Code des zu prüfenden Landes (z.B. DE oder IT)
sepaCountrysOnly?	boolean	Definiert, ob die Prüfung auf alle Länder, die eine IBAN haben, angewendet wird, oder nur auf die Länder, die auch am SEPA-Zahlungsverkehr teilnehmen. true : Die Suche erfolgt in der Tabelle aller Länder, die eine IBAN haben. false : Die Suche erfolgt in der Tabelle nur nach den Ländern, die eine IBAN haben und auch am SEPA-Zahlungsverkehr teilnehmen. Default: true

Rückgabewert

boolean

---

checkIBANStrong()

checkIBANStrong(iban): boolean;

Definiert in: sdk/cosmolink.SDK.SEPA.ts:1036

Über diese Funktion kann eine IBAN auf ihre Richtigkeit geprüft werden. Im Gegensatz zur Funktion checkIBAN(iban: string) , werden hier keine ungültigen Zeichen aus der IBAN vor der Berechnung entfernt.
Bei ungültigen Zeichen (auch bei Kleinbuchstaben) liefert die Funktion einen negativen Fehlercode.

Parameter

Parameter	Type	Description
iban	string	Die IBAN, die geprüft werden soll.

Rückgabewert

boolean

---

checkSEPATeilnahme()

checkSEPATeilnahme(bic): number;

Definiert in: sdk/cosmolink.SDK.SEPA.ts:1074

Über diese Funktion kann ermittelt werden, an welchen SEPA-Verfahren eine Bank teilnimmt.

Parameter

Parameter	Type	Description
bic	string	Der BIC für den die Verfahren ermittelt werden sollen.

Rückgabewert

number

---

closeXML()

closeXML(): XMLClose;

Definiert in: sdk/cosmolink.SDK.SEPA.ts:1205

Mit dieser Funktion wird die eigentliche XMÖ-Datei aus der von writeXMLExt(writeExt: XMLWriteExt) erzeugten temporären Datei erzeugt und in die definierte Datei geschrieben.

Rückgabewert

XMLClose

---

convertBLZKonto()

convertBLZKonto(blz, konto): XMLConvert;

Definiert in: sdk/cosmolink.SDK.SEPA.ts:1141

Über diese Funktion kann aus einer Bankleitzahl und der Kontonummer eine IBAN und ein BIC ermittelt werden.
Da nicht alle Kreditinstitute ihre Berechnungsregeln offen gelegt haben, kann es hier auch zu Fehlern kommen.

Parameter

Parameter	Type	Description
blz	string	Die zu verwendende Bankleitzahl
konto	string	Die zu verwendende Kontonummer.

Rückgabewert

XMLConvert

---

createXMLExt()

createXMLExt(xmlCreateExt): boolean;

Definiert in: sdk/cosmolink.SDK.SEPA.ts:1177

Mit dieser Funktion wird die Ausgabe von XML-Dateien initialisiert. Die entsprechenden Werte werden in der Struktur als Parameter übergeben.

Parameter

Parameter	Type	Description
xmlCreateExt	XMLCreateExt	Das Objekt mit den Informationen zur XML Erstellung

Rückgabewert

boolean

---

dispose()

dispose(): void;

Definiert in: sdk/cosmolink.SDK.SEPA.ts:1251

Freigabe der Objekte

Rückgabewert

void

---

Dispose()

Dispose(): void;

Definiert in: sdk/cosmolink.SDK.SEPA.ts:1257

Standardimplementierung des Dispose

Rückgabewert

void

---

getBankInfo()

getBankInfo(bic): XMLBankInfo;

Definiert in: sdk/cosmolink.SDK.SEPA.ts:1159

Über diese Funktion können Informationen über die an SEPA teilnehmenden Banken abgerufen werden.

Parameter

Parameter	Type	Description
bic	string	Der BIC für den die Informationen abgerufen werden sollen. Der BIC hat eine Länge von 8 oder 11 Stellen.

Rückgabewert

XMLBankInfo

---

getBIC()

getBIC(blz): string;

Definiert in: sdk/cosmolink.SDK.SEPA.ts:1064

Über diese Funktion kann aufgrund einer deutschen Bankleitzahl der dazugehörende BIC ermittelt werden.

Parameter

Parameter	Type	Description
blz	string	Eine 8 stellige Bankleitzahl (für Deutschland) oder eine 5 stellige Bankleitzahl (für Österreich).

Rückgabewert

string

---

getBLZKonto()

getBLZKonto(iban): BLZKonto;

Definiert in: sdk/cosmolink.SDK.SEPA.ts:1046

Diese Funktion ermittelt aus einer übergebenen IBAN die Bankleitzahl und die Kontonummer, sowie den BIC und den Namen der Bank. Die Funktion kann für Deutsche, Österreichische, Niederländische, Schweizer und Liechtensteiner IBANs angewendet werden.

Parameter

Parameter	Type	Description
iban	string	Die IBAN aus der die Informationen gewonnen werden sollen.

Rückgabewert

BLZKonto

---

getTargetDatum()

getTargetDatum(
   date, 
   days, 
   skip): Date;

Definiert in: sdk/cosmolink.SDK.SEPA.ts:1230

Liefert den nächsten gültigen Target-Tag

Parameter

Parameter	Type	Description
date	Date	Das Datum welches als Ursprungsdatum verwendet werden soll.
days	number	Anzahl der Tage, um die das Ursprungsdatum verlängert werden soll. Gültige Eingaben liegen zwischen 0 und 1000. Wird der Wert 0 übergeben, liefert die Funktion unabhängig vom Wert Skip das gleiche Ergebnis.
skip	number	Definiert ob bei der Zählung der Zusatztage die "Nicht Target-Tage" übersprungen werden. 0 "Nicht Target Tage" werden nicht übersprungen 1 "Nicht Target Tage" werden übersprungen 2 "Nicht Target Tage" werden übersprungen und falls das übergebene Datum auf einen "Nicht Target Tag" fällt (t.B. Sonntag), so wird das Datum auf den nächsten Target-Tag hochgerechnet.

Rückgabewert

Date

Throws

Exception -

---

info()

info(): XMLInfo;

Definiert in: sdk/cosmolink.SDK.SEPA.ts:953

Die Funktion liefert Informationen über die Aktualität der Datenbanken Sepa.dat und BLZ.dat.

Rückgabewert

XMLInfo

---

init()

init(databasePath, options?): boolean;

Definiert in: sdk/cosmolink.SDK.SEPA.ts:918

Initialisiert die SEPA API mit dem angegebenen Datenbankpfad und den Optionen.

Parameter

Parameter	Type	Description
databasePath	string	Verzeichnis, in dem die SEPA-Datenbank-Dateien liegen (BLZ.DAT, BLZ.IDX, Sepa.dat, Sepa.idx).
options?	{ configPath?: string; tempPath?: string; userPath?: string; }	Optionen zur Steuerung weiterer Funktionen
options.configPath?	string	Optional: Verzeichnis der Konfigurationsdatei. Wird hier ein Leerstring übergeben, wird der Assembly Pfad als Verzeichnis für die Konfigurationsdatei genommen.
options.tempPath?	string	Optional: Verzeichnispfad der für die Erzeugung von temporären Dateien genutzt wird.
options.userPath?	string	Optional: Verzeichnispfad der für die Speicherung von Nutzer-Daten wie z.B.benutzerdefinierte BIC und IBAN benutzt wird.

Rückgabewert

boolean

---

isTargetDatum()

isTargetDatum(date): boolean;

Definiert in: sdk/cosmolink.SDK.SEPA.ts:1242

Diese Funktion prüft, ob das übergebene Datum ein gültiges Target-Datum ist.

Parameter

Parameter	Type	Description
date	Date	Das Datum, welches als gültiges Target-Datum geprüft werden soll.

Rückgabewert

boolean

Throws

Exception -

---

setLogFile()

setLogFile(logFilePath, options?): boolean;

Definiert in: sdk/cosmolink.SDK.SEPA.ts:974

Diese Funktion kann vor allen anderen Funktionen aufgerufen werden. Damit wird die Erstellung
einer Log-Datei initiiert. Die Log-Datei wird in eine Textdatei geschrieben.
Innerhalb des Programmablaufes kann ein mehrfacher Aufruf dieser Funktion mit unterschiedlichen Parametern erfolgen.

Parameter

Parameter	Type	Description
logFilePath	string	Der Pfad (Verzeichnis und Dateiname) an dem die Datei erzeugt werden soll.
options?	{ action?: LogFileAction; content?: LogFileContent; flush?: LogFileFlush; }	Die Optionen zur Steuerung des Log-Datei Inhalt.
options.action?	LogFileAction	Einstellung für die möglichen Aktionen
options.content?	LogFileContent	Einstellung für die möglichen Log Datei Inhalte
options.flush?	LogFileFlush	Einstellung für die möglichen Flush Optionen

Rückgabewert

boolean

---

setLogFileInhalt()

setLogFileInhalt(content): boolean;

Definiert in: sdk/cosmolink.SDK.SEPA.ts:1011

In Verbindung mit der Funktion setLogFile kann über diese Funktion innerhalb des
Programmablaufs der Umfang der Meldungen gesteuert werden. Für bestimmte Programmabschnitte kann damit die Ausgabe unterschiedlich gesteuert oder auch unterbunden werden.

Parameter

Parameter	Type	Description
content	LogFileContent	Der Inhalt, der in die Log Datei geschrieben werden soll.

Rückgabewert

boolean

---

setVersionUndLand()

setVersionUndLand(version, land): boolean;

Definiert in: sdk/cosmolink.SDK.SEPA.ts:1121

Mit dieser Funktion können die XML-Version und das Einreicherland für die XML-Datei festgelegt werden.
Als Einreicherland stehen Deutschland, Österreich und Schweiz zur Verfügung.
Der Dateiaufbau unterscheidet sich geringfügig

Parameter

Parameter	Type	Description
version	XMLFileStructure	Die zu verwendende Version der XML
land	CountryOfSubmission	Das Einreicherland

Rückgabewert

boolean

Remarks

Wenn Sie diese Funktion nicht aufrufen, so ist standardmäßig ZKA-Version 3.3 für Deutschland eingestellt.

---

writeXMLExt()

writeXMLExt(writeExt): boolean;

Definiert in: sdk/cosmolink.SDK.SEPA.ts:1192

Über jeden Aufruf dieser Funktion wird genau ein Datensatz für einen Zahlungsauftrag übergeben.
Es werden umfangreiche Plausibilitätsprüfungen durchgeführt.

Parameter

Parameter	Type	Description
writeExt	XMLWriteExt

Rückgabewert

boolean

---

[hasInstance]()

static hasInstance: boolean;

Definiert in: sdk/cosmolink.SDK.SEPA.ts:1271

Symbol.hasInstance welches eine benutzerdefinierte Überprüfung der 'instanceof'-Operation für Objekte ermöglicht.

Parameter

Parameter	Type
value	any

Rückgabewert

boolean