Class SepaPaymentStatusReport

Inheritance
System.Object
SepaObject
SepaMessage
SepaPaymentStatusReport
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 class SepaPaymentStatusReport : SepaMessage

Constructors

SepaPaymentStatusReport(String)

Declaration
public SepaPaymentStatusReport(string sMessageTag = "CstmrPmtStsRpt")
Parameters
Type Name Description
System.String sMessageTag

Should always be "CstmrPmtStsRpt".

Properties

CreditorAgent

Declaration
public SepaAgent CreditorAgent { get; }
Property Value
Type Description
SepaAgent
See Also

DebtorAgent

The originating bank of this payment status report.

Declaration
public SepaAgent DebtorAgent { get; }
Property Value
Type Description
SepaAgent
Remarks

In case of a payment status report for a credit transfer this is the debitor agent, in the case of a payment status report for a direct debit this is the creditor agent. The property OriginalMessageNameIdentification can be used to distinguish both cases, if needed.

See Also

GroupStatus

The optional group status.

Declaration
public string GroupStatus { get; set; }
Property Value
Type Description
System.String

InitiatingParty

Optional originator of the message.

Declaration
public SepaPartyIdentification InitiatingParty { get; }
Property Value
Type Description
SepaPartyIdentification

Instance of a SepaPartyIdentification that is owned by this class. Initial this instance is empty.

IsEmpty

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

OriginalControlSum

Original control sum

Declaration
public decimal OriginalControlSum { get; set; }
Property Value
Type Description
System.Decimal

If this is zero, then the OrgnlCtrlSum is not included in the XML. Value must not be negative.

OriginalMessageIdentification

Unique identification of the original message that this report refers to.

Declaration
public string OriginalMessageIdentification { get; set; }
Property Value
Type Description
System.String

An arbitrary text with a maximum length of MaxIdLen (35) characters.
Remarks

The character set must match CheckCharset(String).

Exceptions
Type Condition
System.ArgumentNullException

An attempt was made to set this property with null.
System.ArgumentException

An attempt was made to set an empty string, or a string longer than 35 characters, or a string that contains invalid characters.

OriginalMessageNameIdentification

The message name of the original message.

Declaration
public string OriginalMessageNameIdentification { get; set; }
Property Value
Type Description
System.String

If the original message was a credit transfer, then is "pain.001". If the original message was a direct debit, then this is "pain.008". If the original message type was not set, yet, then this is null.
See Also

OriginalMessageType

Convenience property that translates the OriginalMessageNameIdentification string to a SepaMessageType.

Declaration
public SepaMessageType OriginalMessageType { get; set; }
Property Value
Type Description
SepaMessageType

If the original message was a credit transfer, then this must be CreditTransferPaymentInitiation. If the original message was a direct debit, then this must be DirectDebitPaymentInitiation. Is returned as Null if the message type could not be derived from the OriginalMessageNameIdentification.
Exceptions
Type Condition
System.ArgumentException

An attempt was made to set another value than CreditTransferPaymentInitiation or DirectDebitPaymentInitiation.

OriginalNumberOfTransactions

Optional original number of transactions.

Declaration
public int OriginalNumberOfTransactions { get; set; }
Property Value
Type Description
System.Int32

If this is zero, then the OrgnlNbOfTxs is not included in the XML. Value must not be negative.

OriginalPaymentInformations

Collection of Original Payment Information and Status objects conatined in this status report.

Declaration
public SepaOriginalPaymentInformations OriginalPaymentInformations { get; }
Property Value
Type Description
SepaOriginalPaymentInformations

StatusReasonInformations

The Status Reason Informations for this instance.

Declaration
public SepaStatusReasonInformations StatusReasonInformations { get; }
Property Value
Type Description
SepaStatusReasonInformations

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