Class FinTanProcessParameters

Parameters of a particular TAN process as defined in the HITANS segment.

Inheritance

object

FinTanProcessParameters

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Namespace: Subsembly.FinTS

Assembly: Subsembly.FinTS.Core.dll

Syntax

public class FinTanProcessParameters

Fields

ActiveTanListCount

Number of active TAN lists that a user can have. If this is more than one, then the TAN list number must be provided in the HKTAN segment. Otherwise the TAN list number is an optional element.

Declaration

public int ActiveTanListCount

Field Value

Type	Description
int

ActiveTanMediaCount

Number of active TAN medias that a user can have.

Declaration

public int? ActiveTanMediaCount

Field Value

Type	Description
int?

Remarks

This is now an optional integer, so that the caller can distinguish whether the value was actually provided, or not.

CancelOrderAllowed

Indicates whether the order may be cancelled after the TAN was requested.

Declaration

public bool CancelOrderAllowed

Field Value

Type	Description
bool

ChallengeAmountReqd

Indicates whether the order amount must be included together with the TAN.

Declaration

public bool ChallengeAmountReqd

Field Value

Type	Description
bool

ChallengeClassReqd

Indicates whether a challenge class must be supplied together with the TAN.

Declaration

public bool ChallengeClassReqd

Field Value

Type	Description
bool

ChallengeLabel

Label to be shown next to the challenge when prompting the user for TAN entry. The max length of this field is 30 characters.

Declaration

public string ChallengeLabel

Field Value

Type	Description
string

ChallengeStructd

Indicates whether the challenge is structured with simple HTML markup. (HITANS version 4 or later only)

Declaration

public bool ChallengeStructd

Field Value

Type	Description
bool

DecoupledManualConfirmationPossible

(HITANS version 7 or later only)

Declaration

public bool DecoupledManualConfirmationPossible

Field Value

Type	Description
bool

DecoupledMaxPollsAllowed

(HITANS version 7 or later only)

Declaration

public int DecoupledMaxPollsAllowed

Field Value

Type	Description
int

DecoupledMinSecondsBeforePolling

(HITANS version 7 or later only)

Declaration

public int DecoupledMinSecondsBeforePolling

Field Value

Type	Description
int

DecoupledMinSecondsBetweenPolls

(HITANS version 7 or later only)

Declaration

public int DecoupledMinSecondsBetweenPolls

Field Value

Type	Description
int

MaxChallengeLength

Maximum length of the challenge value provided by the bank.

Declaration

public int MaxChallengeLength

Field Value

Type	Description
int

MaxTanLength

Maximum length of TAN. When prompting the user to enter the TAN, this length should be used to limit the user input. May be zero if not specified, or Decoupled procedure without TAN.

Declaration

public int MaxTanLength

Field Value

Type	Description
int

MultiTanAllowed

Indicates whether there may be orders that need multiple TANs for a full authorization.

Declaration

public bool MultiTanAllowed

Field Value

Type	Description
bool

MultipleTanOrdersAllowed

Indicates whether more than one order requiring a TAN can be sent in a single message. Tip: Never send more than one TAN requiring order in a message!

Declaration

public bool MultipleTanOrdersAllowed

Field Value

Type	Description
bool

Remarks

This value is extracted from the general data of the HITAN segment, and not from the actual TAN process parameters.

Name

Name of the TAN process. This name shall be shown when prompting the user for TAN entry.

Declaration

public string Name

Field Value

Type	Description
string

OrderHashMode

Hash algorithm to be applied to the order segment.

Declaration

public FinHash OrderHashMode

Field Value

Type	Description
FinHash	The value None indicates that no hash shall be computed and the HKTAN order hash field should not be set. In order to actually compute the hash value, the method ComputeOrderHash(FinTanProcessParameters) can be used.

Remarks

This value is extracted from the general data of the HITAN segment, and not from the actual TAN process parameters.

OrderingAcctReqd

Indicates whether the complete ordering account information must be included in the HKTAN. (HITANS version 5 or later only)

Declaration

public bool OrderingAcctReqd

Field Value

Type	Description
bool

PostponedTanAllowed

If MultiTanAllowed is true,then this indicates whether further TANs needed for authorization, can be sent in a separate, possibly later dialog.

Declaration

public bool PostponedTanAllowed

Field Value

Type	Description
bool

ResponseHHDUCReqd

Is the HHD_UC response required? (HITANS version 5 or later only)

Declaration

public bool ResponseHHDUCReqd

Field Value

Type	Description
bool

Remarks

Field is mandatory inside HITANS v6.

SecurityFunction

Identifies the particular TAN process. The value must be in the range from 900 through 997.

Declaration

public int SecurityFunction

Field Value

Type	Description
int

SegmentVersion

The HITANS segment version from which these parameters have been extracted.

Declaration

public int SegmentVersion

Field Value

Type	Description
int

SmsChargingAcctReqd

Indicates whether an account to be charged for sending the SMS must be provided. (HITANS version 4 or later only)

Declaration

public bool SmsChargingAcctReqd

Field Value

Type	Description
bool

TanFormat

Indicates whether the entered TAN is numeric (1) or alfanumeric (2). When prompting the user to enter the TAN, this should be used to limit the user input. May be zero if not specified, or Decoupled procedure without TAN.

Declaration

public int TanFormat

Field Value

Type	Description
int

TanListNoReqd

Indicates whether a TAN list number must be supplied.

Declaration

public bool TanListNoReqd

Field Value

Type	Description
bool

TanMediaInitMode

The template string for the TAN media initialisation mode.

Declaration

public string TanMediaInitMode

Field Value

Type	Description
string

TanMediaNameReqd

Provides the actual numerical value of the "TAN media name required" data element. Indicates whether the TAN media name should be included with the TAN.

Declaration

public int TanMediaNameReqd

Field Value

Type	Description
int

Remarks

This used to be a boolean value which was true, whenever the actual value is 2.

TanProcess

Selects either TAN process type 1 or TAN process type 2.

Declaration

public int TanProcess

Field Value

Type	Description
int

TechnicalIdentification

Technical identification of TAN process. This is for internal identification of a TAN process inside an application and should not be shown to the user.

Declaration

public string TechnicalIdentification

Field Value

Type	Description
string

ZkaTanProc

ZKA TAN procedure identification. (HITANS version 4 or later only)

Declaration

public string ZkaTanProc

Field Value

Type	Description
string

ZkaTanProcVersion

ZKA TAN procedure version. (HITANS version 4 or later only)

Declaration

public string ZkaTanProcVersion

Field Value

Type	Description
string

Properties

DecoupledPollingAllowed

(HITANS version 7 or later only)

Declaration

public bool DecoupledPollingAllowed { get; set; }

Property Value

Type	Description
bool

IsDecoupled

Declaration

public bool IsDecoupled { get; }

Property Value

Type	Description
bool

Methods

GetDecoupledMaxPollsAllowed()

Returns DecoupledMaxPollsAllowed, or a suitable default value, if the parameter was not set.

Declaration

public int GetDecoupledMaxPollsAllowed()

Returns

Type	Description
int

GetDecoupledMinSecondsBeforePolling()

Returns DecoupledMinSecondsBeforePolling, or a suitable default value, if the parameter was not set.

Declaration

public int GetDecoupledMinSecondsBeforePolling()

Returns

Type	Description
int

Remarks

If the parameter DecoupledMinSecondsBeforePolling is less than one second, then the value one will be returned. If the parameter DecoupledMinSecondsBeforePolling is greater than ten seconds, then the value ten will be returned.

GetDecoupledMinSecondsBetweenPolls()

Returns DecoupledMinSecondsBetweenPolls, or a suitable default value, if the parameter was not set.

Declaration

public int GetDecoupledMinSecondsBetweenPolls()

Returns

Type	Description
int

Remarks

If the parameter DecoupledMinSecondsBetweenPolls is less than one second, then the value one will be returned. If the parameter DecoupledMinSecondsBetweenPolls is greater than ten seconds, then the value ten will be returned.

GetTanMediaClass()

Tries to determine the TAN media class for this TAN process.

Declaration

public string GetTanMediaClass()

Returns

Type	Description
string	If a TAN media class could be determined, then either "G" for a TAN Generator (chipTAN, SmartTAN) or "M" for Mobile-TAN (smsTAN) will be returned. If the TAN media class could not be determined, then `null` is returned.

Remarks

The TAN media class may be required when choosing a TAN media through a FinTanMediaList. Each FinTanMedia in the list has a TanMediaClass property which indicates the type of TAN media.

ToString()

Declaration

public override string ToString()

Returns

Type	Description
string

Overrides

object.ToString()