Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Request

A single request holding multiple segments. Will likely embedded in a dialog.

Hierarchy

Index

Constructors

constructor

  • Parameters

    Returns Request

Properties

blz

blz: string

The banks identification number (Bankleitzahl).

dialogId

dialogId: string

The unique id of the message's dialog.

msgNo

msgNo: number

All messages sent within a dialog are numbered. This requests number.

name

name: string

The username or identification number.

pin

pin: string

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

secRef

secRef: number

A unique identifier for linking a signature header to its footer. Needs to be randomly generated and unique per dialog. All references in all segments need to be equal per message.

segments

segments: Segment<any>[] = []

All segments that should be transmitted in the HNVSD segment of the request.

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.

tan

tan: string

An optional TAN for performing this request. Can be omitted if no TAN is needed to perform the request.

tanMethods

tanMethods: TanMethod[] = []

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

Accessors

debugString

  • get debugString(): string
  • Generate a textual representation for debug purposes.

    Returns string

Private fullSegments

  • An array of all segments, including the HNVSD segment wrapping the user payload segments.

    Returns (HNHBK | HNHBS | HNVSD | HNVSK)[]

Private hasNo999SecurityFunction

  • get hasNo999SecurityFunction(): boolean
  • Determines if a TAN method with a "999" security function is available. This determines whether profile version 2 can be used.

    Returns boolean

Private profileVersion

  • get profileVersion(): 1 | 2
  • Use security profile version 2 if the server supports it. Will be 1 or 2, depending on the server's capabilities.

    Returns 1 | 2

Private securityFunction

  • get securityFunction(): string
  • Determines the security function to use. Will default to the first one if the "999" security function is unavailable.

    Returns string

Private segmentCount

  • get segmentCount(): number
  • Returns the total number of segments in this request, including all header meta segments.

    Returns number

Methods

toString

  • toString(): string
  • Serialize the whole request into a string that can be sent to the server.

    Returns string

Generated using TypeDoc