Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Dialog

A dialog consisting of multiple related requests and responses.

Hierarchy

Index

Constructors

constructor

Properties

blz

blz: string

The banks identification number (Bankleitzahl).

connection

connection: Connection

dialogId

dialogId: string = "0"

A unique id for the dialog. Assigned by the server as response to the initial request. For the initial request a 0 needs to be sent.

hicdbVersion

hicdbVersion: number = 1

The server will only accept a certain version for the HICDB segment. This version defaults to the latest version (1). The server's maximum supported version can be parsed from the initial requests and is stored here.

hikazsVersion

hikazsVersion: number = 6

The server will only accept a certain version for the HIKAZS segment. This version defaults to the latest version (6). The server's maximum supported version can be parsed from the initial requests and is stored here.

hisalsVersion

hisalsVersion: number = 6

The server will only accept a certain version for the HISALS segment. This version defaults to the latest version (6). The server's maximum supported version can be parsed from the initial requests and is stored here.

hiupd

hiupd: HIUPD[]

hktanVersion

hktanVersion: number = 1

msgNo

msgNo: number = 1

All messages sent within a dialog are numbered. This counter is kept here.

name

name: string

The username or identification number.

painFormats

painFormats: string[] = []

A list of supported SEPA pain-formats as configured by the server.

pin

pin: string

The pin code or password used for authenticating with the fints server.

productId

productId: string = PRODUCT_NAME

The product ID that was assigned by ZKA

systemId

systemId: string

The system's id. This id needs to be stored across all dialogs and will be assigned by the server at the first request.

tanMethods

tanMethods: TanMethod[] = []

A list of allowed TAN methods as configured by the server.

Methods

end

  • end(): Promise<void>
  • End the currently open request.

    Returns Promise<void>

init

  • Send the initializing request to the server. The dialog is ready for performing custom requests afterwards.

    Returns Promise<Response>

send

  • Send a custom request to the fints server and return the received response.

    Parameters

    • request: Request

      The request to send to the server.

    Returns Promise<Response>

    The response received from the server.

sync

  • sync(): Promise<void>
  • Send a synchronization request to the server. Only one synchronization is needed per dialog. This is most likely the initial request sent. It will be answered with the system's id and a list of supported TAN methods. The supported HISALS and HIKAZS version can also be parsed from this request.

    Returns Promise<void>

    The response as received by the server.

Generated using TypeDoc