Class FinSepaAcctInfoBuilder

Builder for a SEPA account information request segment (HKSPA).

Inheritance
System.Object
FinOrderBuilder
FinSepaAcctInfoBuilder
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 class FinSepaAcctInfoBuilder : FinOrderBuilder

Properties

DomesticAcctAllowed

Indicates whether a domestic account specification may be used in SEPA order segments.

Declaration
public bool DomesticAcctAllowed { get; }
Property Value
Type Description
System.Boolean
Remarks

Generally it is recommended to fill all SEPA order segments with IBAN and BIC instead of a domestic account specification.

MaxEntriesAllowed

True if the request parameter MaxEntries may be set.

Declaration
public bool MaxEntriesAllowed { get; }
Property Value
Type Description
System.Boolean

NumResrvdPurposeChars

Number of characters at the end of the remittance purpose info that is reserved to the bank.

Declaration
public int NumResrvdPurposeChars { get; }
Property Value
Type Description
System.Int32
Remarks

Generally the SEPA remittance purpose info may contain up to 140 characters. This property provides the number of characters that are reserved for the bank. For example: If this property is 20, then an application may only use up to 120 purpose characters. The maximum number of characters that may be reserved by the bank is 35.

This parameter only exists in HISPAS version 3 and later. In previous versions this propery is always zero.

SingleAcctInfoAllowed

Indicates whether a single SEPA account information may be queried.

Declaration
public bool SingleAcctInfoAllowed { get; }
Property Value
Type Description
System.Boolean
Remarks

As this is optional it is recommended to always query for all available accounts by setting the parameter aOrderAcct of the Build(FinAcct, Int32, String) method of this class to null.

StructRemittInfoAllowed

Indicates whether structured remittance information is allowed in SEPA transactions.

Declaration
public bool StructRemittInfoAllowed { get; }
Property Value
Type Description
System.Boolean
Remarks

The ZKA recommends to not use structured remittance information, but use unstructured remittance information only.

SupportedPainFormats

Returns an array of simple pain identifiers of the supported SEPA pain XML formats.

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

This method tries to extract the pain identifiers from the SupportedSepaFormats strings.

SupportedSepaFormats

Returns an array with the descriptors (URN) of the supported SEPA XML formats.

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

The data provided by actual banks is widely different and inconclusive. Thus this information is rather worthless and should be ignored. Use the processed SupportedPainFormats instead.

Methods

Build(FinAcct, Int32, String)

Builds a SEPA account information request from the given parameters.

Declaration
public FinSepaAcctInfo Build(FinAcct aOrderAcct, int nMaxNoEntries, string sScrollRef)
Parameters
Type Name Description
FinAcct aOrderAcct

Should be null, unless the parameter SingleAcctInfoAllowed is true.
System.Int32 nMaxNoEntries

Optional max number of entries to return. Must only be specified when MaxEntriesAllowed is true. Must be zero, otherwise.
System.String sScrollRef

Optional scroll reference from a previous inquiry.
Returns
Type Description
FinSepaAcctInfo

Initialised instance of FinSepaAcctInfo that is ready to be executed.