Class FinTanBuilder

Builder for a transaction number segment (HKTAN).

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()

Namespace: Subsembly.FinTS

Assembly: Subsembly.FinTS.Core.dll

Syntax

public class FinTanBuilder : FinOrderBuilder

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.

Declaration

public int BankSignatureProfile { get; }

Property Value

Type	Description
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.

Declaration

public bool MultipleTanOrdersAllowed { get; }

Property Value

Type	Description
bool

OrderHashMode

DEPRECATED: Please use OrderHashMode instead.

Declaration

public FinHash OrderHashMode { get; }

Property Value

Type	Description
FinHash

SingleStepTanAllowed

Declaration

public bool SingleStepTanAllowed { get; }

Property Value

Type	Description
bool

TanProcessCount

Total number of TAN processes that are available.

Declaration

public int TanProcessCount { get; }

Property Value

Type	Description
int

Methods

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

Builds a HKTAN segment.

Declaration

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

Parameters

Type	Name	Description
FinTanProcessParameters	aTanProc	The TAN process parameters that are in effect for the HKTAN segment to be built. Must not be null.
FinOrder	aAssocOrder	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.
FinTanProcessStep	nTanProcessStep	Indicates the TAN process step to build a HKTAN segment for.
FinTanInfo	aTanInfo	Provides the TAN information to be submitted in the HKTAN segment. Must not be null.
bool	fMoreTansFollow	Set to true to indicate that one or more TAN numbers will follow this one. Don't do this.

Returns

Type	Description
FinTan

FindTanProcessParameters(int)

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

Declaration

public FinTanProcessParameters FindTanProcessParameters(int nSecurityFunction)

Parameters

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

Returns

Type	Description
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

Type	Condition
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.

Declaration

public FinTanProcessParameters FindTanProcessParameters(string sTechnicalIdentification, bool fIgnoreCase)

Parameters

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

Returns

Type	Description
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

Type	Condition
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.

Declaration

public FinTanProcessParameters GetTanProcessParameters(int i)

Parameters

Type	Name	Description
int	i	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

Type	Description
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.

Declaration

public bool SupportsSCA(int nSecurityFunction)

Parameters

Type	Name	Description
int	nSecurityFunction

Returns

Type	Description
bool