Class SepaStatusReasonInformation

Namespace: Subsembly.Sepa

Assembly: Subsembly.Sepa.dll

A Status Reason Information from a Payment Status Report message.

public class SepaStatusReasonInformation : SepaObject

Inheritance: object

SepaObject

SepaStatusReasonInformation

Inherited Members: SepaObject.TagName

SepaObject.IsMandatory

SepaObject.WriteXml(XmlWriter, SepaMessageInfo)

SepaObject.WriteXml(XmlWriter, SepaMessageInfo, string)

SepaObject.ReadXml(XmlReader, SepaMessageInfo)

SepaObject.ReadXml(XmlReader, SepaMessageInfo, string)

SepaObject.IsValid

SepaObject.Validate(ICollection<SepaException>, string)

SepaObject.OnWriteObjectXml(XmlWriter, SepaMessageInfo, string)

SepaObject.OnReadObjectXml(XmlReader, SepaMessageInfo, string)

SepaObject.OnAfterXmlRead(SepaMessageInfo)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

SepaStatusReasonInformation()

public SepaStatusReasonInformation()

Properties

AdditionalInformation

Optional additional information for status reason.

public string AdditionalInformation { get; set; }

Property Value

string: If no additional information is provided, this property is null, which is also its default value. Status reasons may contain multiple additional information (AddtlInf) elements. If so, the elements are concatenated with an Environment.NewLine separator. Empty elements are empty strings. Each line of additional information must not be longer than 105 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.

For Verification of Payee the additional information is used to convey narrative text about the result of the Verification of Payee which shall be presented to the user.

Exceptions

ArgumentException: An attempt was made to set a string longer than 105 characters.

See Also: AdditionalInformationLines

AdditionalInformationLines

public string[] AdditionalInformationLines { get; set; }

Property Value

string[]

See Also: AdditionalInformation

IsEmpty

public override bool IsEmpty { get; }

Property Value

bool

StatusOriginator

Optional originator of this status information.

public SepaPartyIdentification StatusOriginator { get; }

Property Value

SepaPartyIdentification

Remarks

Only either the Name or the BIC property (and not both) of the party identification may be set.

For producing an EBICS HAC protocol the OtherIdentifications are abused to hold additional information about the protocol entry.

StatusReasonCode

Status reason code.

public string StatusReasonCode { get; set; }

Property Value

string

Remarks

All codes are four alphanumeric characters. See other documentation for individual possible values.

Only one of StatusReasonCode and StatusReasonProprietary may be set.

Exceptions

ArgumentException: An attempt was made to set a syntactically invalid code.

StatusReasonProprietary

Status reason proprietary text.

public string StatusReasonProprietary { get; set; }

Property Value

string

Remarks

Up to 35 characters proprietary status reason information.

Exceptions

ArgumentException: An attempt was made to set a string longer than 35 characters.

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