Class FinTanBuilder

Namespace: Subsembly.FinTS

Assembly: Subsembly.FinTS.Core.dll

Builder for a transaction number segment (HKTAN).

public class FinTanBuilder : FinOrderBuilder

Inheritance: object

FinOrderBuilder

FinTanBuilder

Inherited Members: FinOrderBuilder.Contact

FinOrderBuilder.IsSupported

FinOrderBuilder.SepaDomesticAcctAllowed

FinOrderBuilder.SepaOrderCustAcct

FinOrderBuilder.FinTSVersion

FinOrderBuilder.OrderSegmentType

FinOrderBuilder.ParamSegmentType

FinOrderBuilder.SegmentVersion

FinOrderBuilder.ParameterDEG

FinOrderBuilder.ParameterCount

FinOrderBuilder.BuildOrderSegment(FinAcct)

FinOrderBuilder.BuildOrderSegment()

FinOrderBuilder.GetStringParameter(int)

FinOrderBuilder.GetIntegerParameter(int)

FinOrderBuilder.GetBoolParameter(int)

FinOrderBuilder.GetAmountParameter(int)

FinOrderBuilder.OrderSegmentInfo

FinOrderBuilder.BankParamSegment

FinOrderBuilder.MaxOrders

FinOrderBuilder.MinSignatures

FinOrderBuilder.SecurityLevel

FinOrderBuilder.TanSecuritySupported

FinOrderBuilder.TanRequired

FinOrderBuilder.Init(FinOrderSegmentInfo[])

FinOrderBuilder.Init(FinOrderSegmentInfo, FinSegment)

FinOrderBuilder.FindParameterSegment(FinOrderSegmentInfo)

FinOrderBuilder.AugmentSubAcctCharacteristic(FinAcct)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

This class also provides convenient access to the various TAN modes defined in the HITANS segment.

Properties

BankSignatureProfile

Indicates whether and how the HITAN response will be signed.

public int BankSignatureProfile { get; }

Property Value

int: The value zero indicates that the HITAN will not be signed by the bank. This should hopefully always be the case.

MultipleTanOrdersAllowed

DEPRECATED: Please use MultipleTanOrdersAllowed instead.

public bool MultipleTanOrdersAllowed { get; }

Property Value

bool

OrderHashMode

DEPRECATED: Please use OrderHashMode instead.

public FinHash OrderHashMode { get; }

Property Value

FinHash

SingleStepTanAllowed

public bool SingleStepTanAllowed { get; }

Property Value

bool

TanProcessCount

Total number of TAN processes that are available.

public int TanProcessCount { get; }

Property Value

int

Methods

Build(FinTanProcessParameters, FinOrder, FinTanProcessStep, FinTanInfo, bool)

Builds a HKTAN segment.

public FinTan Build(FinTanProcessParameters aTanProc, FinOrder aAssocOrder, FinTanProcessStep nTanProcessStep, FinTanInfo aTanInfo, bool fMoreTansFollow)

Parameters

aTanProc FinTanProcessParameters: The TAN process parameters that are in effect for the HKTAN segment to be built. Must not be null.
aAssocOrder FinOrder: A reference to the actual order that is associated with this HKTAN. The response segments and the status segment of this order are updated according to the result of the HKTAN submission. This must be supplied when nTanProcess is 1. Otherwise it may be null.
nTanProcessStep FinTanProcessStep: Indicates the TAN process step to build a HKTAN segment for.
aTanInfo FinTanInfo: Provides the TAN information to be submitted in the HKTAN segment. Must not be null.
fMoreTansFollow bool: Set to true to indicate that one or more TAN numbers will follow this one. Don't do this.

Returns

FinTan

FindTanProcessParameters(int)

Retrieves the complete TAN process parameters for a particular TAN process, identified by its security function code.

public FinTanProcessParameters FindTanProcessParameters(int nSecurityFunction)

Parameters

nSecurityFunction int: The security function code that identifies the TAN process to retrieve the parameters for.

Returns

FinTanProcessParameters: If TAN process parameters have been found they will be returned. If no TAN process parameters have been found for the given security function code, then null is returned.

Exceptions

ArgumentOutOfRangeException: The parameter nSecurityFunction was outside the range from zero through 999.

FindTanProcessParameters(string, bool)

Retrieves the complete TAN process parameters for a particular TAN process, identified by its technical identification.

public FinTanProcessParameters FindTanProcessParameters(string sTechnicalIdentification, bool fIgnoreCase)

Parameters

sTechnicalIdentification string: The technical identification of the TAN-Process to retrieve the parameters for. This will match the TechnicalIdentification property of the returned FinTanProcessParameters instance.
fIgnoreCase bool: Indicates whether the upper/lower case shall be ignored when comparing.

Returns

FinTanProcessParameters: If TAN process parameters have been found they will be returned. If no TAN process parameters have been found for the given technical identification, then null is returned.

Exceptions

ArgumentNullException: The parameter sTechnicalIdentification was null.
ArgumentException: The parameter sTechnicalIdentification was an empty string.

GetTanProcessParameters(int)

Retrieves the complete TAN process parameters for one of the available TAN processes.

public FinTanProcessParameters GetTanProcessParameters(int i)

Parameters

i int: Selects the available TAN process by its index position. The first TAN process has the index position 1 and does always exist. Further TAN processes up to index position 98 may exist.

Returns

FinTanProcessParameters: Complete set of TAN process parameters or null if the indexed TAN process does not exist.

SupportsSCA(int)

Determines whether the given security function does support SCA.

public bool SupportsSCA(int nSecurityFunction)

Parameters

nSecurityFunction int

Returns

bool