Class SepaRemittanceInformation

Namespace
Subsembly.Sepa
Assembly
Subsembly.Sepa.dll

Represents a Remittance Information element, as it occurs in SepaTransactionInformation, SepaOriginalTransactionInformation, and SepaTransactionDetails.

public sealed class SepaRemittanceInformation : SepaObject
Inheritance
SepaRemittanceInformation
Inherited Members

Constructors

SepaRemittanceInformation() 

public SepaRemittanceInformation()

SepaRemittanceInformation(bool)

Creates a SepaRemittanceInformation with the default TagName "RmtInf".

public SepaRemittanceInformation(bool fIsMandatory)

Parameters

fIsMandatory bool

SepaRemittanceInformation(string) 

public SepaRemittanceInformation(string sTagName)

Parameters

sTagName string

SepaRemittanceInformation(string, bool) 

public SepaRemittanceInformation(string sTagName, bool fIsMandatory)

Parameters

sTagName string
fIsMandatory bool

Properties

CreditorReferenceInformation

Convenience property for getting and setting a RF Creditor Reference (ISO 11649) assigned by the creditor, to unambiguously refer to the payment transaction.

public string CreditorReferenceInformation { get; set; }

Property Value

string

Remarks

Setting this property will setup the complete nested Structured element, to only hold the given creditor reference and nothing else. It will set the value to the CreditorReference property and also the value SCOR to the CreditorReferenceTypeCode property. All all other values from the nested SepaStructuredRemittanceInformation will be cleared! Setting this property to null, or an empty string, will completely clear the nested SepaStructuredRemittanceInformation.

Reading this property will return the value from the CreditorReference property of the nested SepaStructuredRemittanceInformation, if, and only if, the value of the CreditorReferenceTypeCode property contains the value SCOR.

Exceptions

ArgumentException

An attempt was made to set an invalid reference identification.

IsEmpty 

public override bool IsEmpty { get; }

Property Value

bool

Structured

Optional structured remittance information.

public SepaStructuredRemittanceInformation Structured { get; }

Property Value

SepaStructuredRemittanceInformation

Remarks

Currently only a single structured remittance information per Remittance Information is supported. This os never null, but may be an empty object.

Unstructured

Unstructured remittance information as a single string, combined with NewLine sequences.

public string Unstructured { get; set; }

Property Value

string

If no unstructured remittance information is provided, this property is null, which is also its default value. An unstructured remittance information string must not be longer than MaxRmtInfLen (140) characters.

Remarks

Only latin characters should be used. It is up to the caller to ensure that the provided string contains only characters accepted by the recipient of the SEPA document.

Exceptions

ArgumentException

An attempt was made to set a string longer than 140 characters.

See Also

UnstructuredLines

Provides the optional unstructured remittance information as an array of lines.

public string[] UnstructuredLines { get; set; }

Property Value

string[]

Remarks

The returned value may be null, if there is/was no unstructured remittance information.

Exceptions

ArgumentException

An array was set that contained null string entries, or entries with strings longer than 140 characters.

See Also

Methods

Clear() 

public override void Clear()

OnReadXml(XmlReader, SepaMessageInfo) 

protected override void OnReadXml(XmlReader aXmlReader, SepaMessageInfo aMessageInfo)

Parameters

aXmlReader XmlReader
aMessageInfo SepaMessageInfo

OnValidate(ICollection<SepaException>, string) 

protected override void OnValidate(ICollection<SepaException> vErrors, string sPath)

Parameters

vErrors ICollection<SepaException>
sPath string

OnWriteXml(XmlWriter, SepaMessageInfo) 

protected override void OnWriteXml(XmlWriter aXmlWriter, SepaMessageInfo aMessageInfo)

Parameters

aXmlWriter XmlWriter
aMessageInfo SepaMessageInfo