Class FinSepaStoBuilder

Namespace
Subsembly.FinTS
Assembly
Subsembly.FinTS.Core.dll

Base class for all builders for creating, modifying, and deleting plain and instant SEPA standing orders.

public abstract class FinSepaStoBuilder : FinSepaOrderBuilder
Inheritance
FinSepaStoBuilder
Derived
Inherited Members

Remarks

The set up a standing order, the base class Build methods cannot be used. Instead one of the Build methods of this class must be used.

Constructors

FinSepaStoBuilder(FinContact) 

protected FinSepaStoBuilder(FinContact aContact)

Parameters

aContact FinContact

Properties

AmtModifiable 

public bool AmtModifiable { get; }

Property Value

bool

ExecDayModifiable 

public bool ExecDayModifiable { get; }

Property Value

bool

ExecTimeModifiable 

public bool ExecTimeModifiable { get; }

Property Value

bool

FirstScheduledDateMod 

public bool FirstScheduledDateMod { get; }

Property Value

bool

LastScheduledDateModif 

public bool LastScheduledDateModif { get; }

Property Value

bool

MaxScheduledModifications

Max number of scheduled modifications. May be zero if no scheduling of modifications is supported.

public int MaxScheduledModifications { get; }

Property Value

int

MonthDaysAvailable

Allowed execution days of a month.

public string MonthDaysAvailable { get; }

Property Value

string

Remarks

The return value is a string of digits, two digits for each allowed execution day. The values "97", "98", and "99" indicate ultimo minus two, ultimo minus one, and ultimo. The value "31" is not allowed and is returned as "99" instead. For example, the string "011015202599" indicates that execution is alowed on the first, 10th, 15th, 20th, 25th and on the last day of a month.

The value is null, if this parameter is not applicable to the derived builder type.

OrderDataRequired

If true then the complete original order data must be submitted with the request.

public bool OrderDataRequired { get; }

Property Value

bool

PayeeAcctModifiable 

public bool PayeeAcctModifiable { get; }

Property Value

bool

PayeeNameModifiable 

public bool PayeeNameModifiable { get; }

Property Value

bool

PaymtPurposeModifiable 

public bool PaymtPurposeModifiable { get; }

Property Value

bool

PeriodLenInMonths

Allowed monthly periods.

public string PeriodLenInMonths { get; }

Property Value

string

Remarks

The return value is a string of digits, two digits for each allowed period length. For example, the string "01030612" indicates that a a period of one, three, six or twelve months is allowed.

The value is null, if this parameter is not applicable to the derived builder type.

PeriodLenInWeeks

Allowed weekly periods.

public string PeriodLenInWeeks { get; }

Property Value

string

PeriodLenModifiable 

public bool PeriodLenModifiable { get; }

Property Value

bool

PostdatedCancelPossible 

public bool PostdatedCancelPossible { get; }

Property Value

bool

ScheduledDateSupported

Is it allowed to set a scheduled date in the order segment?

public bool ScheduledDateSupported { get; }

Property Value

bool

TimeUnitModifiable 

public bool TimeUnitModifiable { get; }

Property Value

bool

WeekDaysAvailable

Allowed execution days of a week.

public string WeekDaysAvailable { get; }

Property Value

string

Methods

Build(FinAcct, SepaDocument, FinStoDetails)

Builds a SEPA standing order from the given SEPA document and details about the execution frequency.

public FinSepaOrder Build(FinAcct aOrderAcct, SepaDocument aSepaDoc, FinStoDetails aDetails)

Parameters

aOrderAcct FinAcct
aSepaDoc SepaDocument
aDetails FinStoDetails

Returns

FinSepaOrder

Build(FinSepaSto)

Builds a SEPA standing order from the given SEPA standing order data.

public FinSepaOrder Build(FinSepaSto aSepaSto)

Parameters

aSepaSto FinSepaSto

This must be a FinSepaSto instance with the standing order data to build the order from. This must not be null.

Returns

FinSepaOrder

The completely built and ready to execute FinSepaOrder.

GetPreferredExecTime(SwiftDate, SwiftTime)

Get the nearest preferred execution time after a given desired execution time.

public SwiftTime GetPreferredExecTime(SwiftDate tExecDate, SwiftTime tExecTime)

Parameters

tExecDate SwiftDate
tExecTime SwiftTime

Returns

SwiftTime