Class SepaOriginalPaymentInformation

Namespace

Subsembly.Sepa

Assembly

Subsembly.Sepa.dll

Original Payment Information and Status (OrgnlPmtInfAndSts) element of a Payment Status Report (pain.002) document.

public class SepaOriginalPaymentInformation : SepaObject, ISepaStatusAndReasonInformation

Inheritance

object

SepaObject

SepaOriginalPaymentInformation

Implements

ISepaStatusAndReasonInformation

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

Extension Methods

SepaStatusAndReasonInformationExtensions.GetReasonInformation(ISepaStatusAndReasonInformation)

SepaStatusAndReasonInformationExtensions.GetStatusCode(ISepaStatusAndReasonInformation)

VopOriginalPaymentInformation.SetVopNumberOfTransactionsPerStatus(SepaOriginalPaymentInformation, VopStatusCode, int)

VopOriginalPaymentInformation.SetVopPaymentInformationStatus(SepaOriginalPaymentInformation, VopGroupStatusCode)

VopOriginalPaymentInformation.VopMerge(SepaOriginalPaymentInformation, SepaOriginalPaymentInformation)

Constructors

SepaOriginalPaymentInformation()

public SepaOriginalPaymentInformation()

Properties

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.

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.

OriginalPaymentInformationIdentification

Unique identification of the original Payment Information.

public string OriginalPaymentInformationIdentification { get; set; }

Property Value

string

OriginalTransactionInformations

Collection of all Original Transaction Information and Status of this original payment information.

public SepaOriginalTransactionInformations OriginalTransactionInformations { get; }

Property Value

SepaOriginalTransactionInformations

PaymentInformationStatus

The optional payment information status.

public string PaymentInformationStatus { get; set; }

Property Value

string

Status

Returns PaymentInformationStatus.

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

SetUncheckedOriginalPaymentInformationIdentification(string)

Set the element value of the OriginalPaymentInformationIdentification without validating the character set or length of the given value.

public void SetUncheckedOriginalPaymentInformationIdentification(string sOrgnlPmtInfId)

Parameters

sOrgnlPmtInfId string

Remarks

Alas, this method is needed to support creating the pain.002 for an EBICS HAC protcol, where the OriginalPaymentInformationIdentification is specified to contain values such as "FILE_UPLOAD" or "ORDER_HAC_FINAL_NEG". All these values contain the underscore "_" character, which is not allowed in an identification.