Class FinSepaMultInstPaymtStatusBuilder

Builder for SEPA Instant Multiple Payments Status Inquiries (HKISS).

Inheritance
System.Object
FinOrderBuilder
FinSepaInstPaymtStatusBuilder
FinSepaMultInstPaymtStatusBuilder
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Subsembly.FinTS
Assembly: Subsembly.FinTS.Core.dll
Syntax
public sealed class FinSepaMultInstPaymtStatusBuilder : FinSepaInstPaymtStatusBuilder

Constructors

FinSepaMultInstPaymtStatusBuilder(FinContact)

Declaration
public FinSepaMultInstPaymtStatusBuilder(FinContact aContact)
Parameters
Type Name Description
FinContact aContact

Properties

MinWaitingTime

Declaration
public override int MinWaitingTime { get; }
Property Value
Type Description
System.Int32
Overrides
Remarks

Although the FinTS parameter value is given in minutes, this property returns the minimum waiting time in seconds by multiplying the FinTS value with 60. Thus the common base class property always returns a value given in seconds.

SupportedSepaFormats

Declaration
public override string[] SupportedSepaFormats { get; }
Property Value
Type Description
System.String[]
Overrides

SupportedStatusFormats

Array of supported pain.002 Payment Status Report formats.

Declaration
public string[] SupportedStatusFormats { get; }
Property Value
Type Description
System.String[]

This may be null, if no such paramater is available.
Remarks

When building an order, one of the supported Payment Status Report formats must be chosen.

Methods

Build(FinAcct, String, String[], String[])

Declaration
public FinSepaInstPaymt Build(FinAcct aOrderAcct, string sOrderID, string[] vsSupportedStatusFormats = null, string[] vsSupportedSepaFormats = null)
Parameters
Type Name Description
FinAcct aOrderAcct
System.String sOrderID

The OrderID returned from the original FinSepaMultInstPaymtBuilder submission. Must not be null or empty.
System.String[] vsSupportedStatusFormats

Optional list of acceptable Payment Status Report formats for the returned order data. If this is null, then the request is built to accept all Payment Status Report formats supported by the bank.
System.String[] vsSupportedSepaFormats

Optional list of acceptable SEPA PAIN formats for the returned order data. If this is null, then the request is built to accept all SEPA formats supported by the bank.
Returns
Type Description
FinSepaInstPaymt

Build(FinSepaInstPaymt)

Prepare a status inquiry order for a previously sent FinSepaInstPaymt.

Declaration
public override FinSepaInstPaymt Build(FinSepaInstPaymt aInstPaymt)
Parameters
Type Name Description
FinSepaInstPaymt aInstPaymt
Returns
Type Description
FinSepaInstPaymt
Overrides
Remarks

This method will create a new FinSepaInstPaymt order that performs a status inquiry for the given original aInstPaymt. The result of executing the returned status inquiry order will be propagated to the original aInstPaymt provided here.

Exceptions
Type Condition
System.ArgumentNullException

The parameter aInstPaymt was null.
System.ArgumentException

The OrderID of the parameter aInstPaymt was null or empty.