Class SepaRemittanceInformation

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

Inheritance
System.Object
SepaObject
SepaRemittanceInformation
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.Sepa
Assembly: Subsembly.Sepa.dll
Syntax
public sealed class SepaRemittanceInformation : SepaObject

Constructors

SepaRemittanceInformation()

Declaration
public SepaRemittanceInformation()

SepaRemittanceInformation(Boolean)

Creates a SepaRemittanceInformation with the default TagName "RmtInf".

Declaration
public SepaRemittanceInformation(bool fIsMandatory)
Parameters
Type Name Description
System.Boolean fIsMandatory

SepaRemittanceInformation(String)

Declaration
public SepaRemittanceInformation(string sTagName)
Parameters
Type Name Description
System.String sTagName

SepaRemittanceInformation(String, Boolean)

Declaration
public SepaRemittanceInformation(string sTagName, bool fIsMandatory)
Parameters
Type Name Description
System.String sTagName
System.Boolean fIsMandatory

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.

Declaration
public string CreditorReferenceInformation { get; set; }
Property Value
Type Description
System.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
Type Condition
System.ArgumentException

An attempt was made to set an invalid reference identification.

IsEmpty

Declaration
public override bool IsEmpty { get; }
Property Value
Type Description
System.Boolean
Overrides

Structured

Optional structured remittance information.

Declaration
public SepaStructuredRemittanceInformation Structured { get; }
Property Value
Type Description
SepaStructuredRemittanceInformation
Remarks

Currently only a single structured remittance information per Remittance Information is supported.

Unstructured

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

Declaration
public string Unstructured { get; set; }
Property Value
Type Description
System.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
Type Condition
System.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.

Declaration
public string[] UnstructuredLines { get; set; }
Property Value
Type Description
System.String[]
Exceptions
Type Condition
System.ArgumentException

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

Methods

Clear()

Declaration
public override void Clear()
Overrides

OnReadXml(XmlReader, SepaMessageInfo)

Declaration
protected override void OnReadXml(XmlReader aXmlReader, SepaMessageInfo aMessageInfo)
Parameters
Type Name Description
System.Xml.XmlReader aXmlReader
SepaMessageInfo aMessageInfo
Overrides

OnValidate(ICollection<SepaException>, String)

Declaration
protected override void OnValidate(ICollection<SepaException> vErrors, string sPath)
Parameters
Type Name Description
System.Collections.Generic.ICollection<SepaException> vErrors
System.String sPath
Overrides

OnWriteXml(XmlWriter, SepaMessageInfo)

Declaration
protected override void OnWriteXml(XmlWriter aXmlWriter, SepaMessageInfo aMessageInfo)
Parameters
Type Name Description
System.Xml.XmlWriter aXmlWriter
SepaMessageInfo aMessageInfo
Overrides