Class SepaStatusReasonInformation

A Status Reason Information from a Payment Status Report message.

Inheritance
object
SepaObject
SepaStatusReasonInformation
Inherited Members
Namespace: Subsembly.Sepa
Assembly: Subsembly.Sepa.dll
Syntax
public class SepaStatusReasonInformation : SepaObject

Constructors

SepaStatusReasonInformation()

Declaration
public SepaStatusReasonInformation()

Properties

AdditionalInformation

Optional additional information for status reason.

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

An attempt was made to set a string longer than 105 characters.
See Also

AdditionalInformationLines

Declaration
public string[] AdditionalInformationLines { get; set; }
Property Value
Type Description
string[]
See Also

IsEmpty

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

StatusOriginator

Optional originator of this status information.

Declaration
public SepaPartyIdentification StatusOriginator { get; }
Property Value
Type Description
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.

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

An attempt was made to set a syntactically invalid code.

StatusReasonProprietary

Status reason proprietary text.

Declaration
public string StatusReasonProprietary { get; set; }
Property Value
Type Description
string
Remarks

Up to 35 characters proprietary status reason information.

Exceptions
Type Condition
ArgumentException

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

Methods

Clear()

Declaration
public override void Clear()
Overrides

OnReadXml(XmlReader, SepaMessageInfo)

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

OnValidate(ICollection<SepaException>, string)

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

OnWriteXml(XmlWriter, SepaMessageInfo)

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