Class SepaPaymentStatusReport

Namespace: Subsembly.Sepa

Assembly: Subsembly.Sepa.dll

public class SepaPaymentStatusReport : SepaMessage, ISepaStatusAndReasonInformation

Inheritance: object

SepaObject

SepaMessage

SepaPaymentStatusReport

Implements: ISepaStatusAndReasonInformation

Inherited Members: SepaMessage.MessageType

SepaMessage.MessageName

SepaMessage.MessageIdentification

SepaMessage.CreationDateTime

SepaMessage.WriteGroupHeaderFields(XmlWriter, SepaMessageInfo)

SepaMessage.ReadGroupHeaderFields(XmlReader, SepaMessageInfo)

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()

Extension Methods: SepaStatusAndReasonInformationExtensions.GetReasonInformation(ISepaStatusAndReasonInformation)

SepaStatusAndReasonInformationExtensions.GetStatusCode(ISepaStatusAndReasonInformation)

VopPaymentStatusReport.GetVopGroupStatus(SepaPaymentStatusReport)

VopPaymentStatusReport.GetVopResult(SepaPaymentStatusReport, SepaCreditTransferPaymentInitiation, VopPaymentStatusReport.RepairPainOptions)

VopPaymentStatusReport.GetVopStatusNarrative(SepaPaymentStatusReport, VopStatusCode)

VopPaymentStatusReport.SetVopGroupStatus(SepaPaymentStatusReport, VopGroupStatusCode)

VopPaymentStatusReport.SetVopNumberOfTransactionsPerStatus(SepaPaymentStatusReport, VopStatusCode, int)

VopPaymentStatusReport.SetVopStatusNarrative(SepaPaymentStatusReport, VopStatusCode, string)

Constructors

SepaPaymentStatusReport(string)

public SepaPaymentStatusReport(string sMessageTag = "CstmrPmtStsRpt")

Parameters

sMessageTag string: Should always be "CstmrPmtStsRpt".

Properties

CreditorAgent

public SepaAgent CreditorAgent { get; }

Property Value

SepaAgent

See Also: DebtorAgent

DebtorAgent

The originating bank of this payment status report.

public SepaAgent DebtorAgent { get; }

Property Value

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: CreditorAgent

GroupStatus

The optional group status.

public string GroupStatus { get; set; }

Property Value

string

InitiatingParty

Optional originator of the message.

public SepaPartyIdentification InitiatingParty { get; }

Property Value

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

IsEmpty

public override bool IsEmpty { get; }

Property Value

bool

NumberOfTransactionsPerStatus

public SepaNumberOfTransactionsPerStatusCollection NumberOfTransactionsPerStatus { get; }

Property Value

SepaNumberOfTransactionsPerStatusCollection

OriginalControlSum

Original control sum

public decimal OriginalControlSum { get; set; }

Property Value

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.

public string OriginalMessageIdentification { get; set; }

Property Value

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

Remarks

The character set must match CheckCharset(string).

Exceptions

ArgumentNullException: An attempt was made to set this property with null.
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.

public string OriginalMessageNameIdentification { get; set; }

Property Value

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

OriginalMessageType

Convenience property that translates the OriginalMessageNameIdentification string to a SepaMessageType.

public SepaMessageType OriginalMessageType { get; set; }

Property Value

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

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

OriginalNumberOfTransactions

Optional original number of transactions.

public int OriginalNumberOfTransactions { get; set; }

Property Value

int: 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.

public SepaOriginalPaymentInformations OriginalPaymentInformations { get; }

Property Value

SepaOriginalPaymentInformations

Status

Returns GroupStatus.

public string Status { get; }

Property Value

string

StatusReasonInformations

The Status Reason Informations for this instance.

public SepaStatusReasonInformations StatusReasonInformations { get; }

Property Value

SepaStatusReasonInformations

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