Class SepaPaymentInitiation

Namespace

Subsembly.Sepa

Assembly

Subsembly.Sepa.dll

Abstract base class for all SEPA Payment Initiation (pain) XML messages.

public abstract class SepaPaymentInitiation : SepaMessage

Inheritance

object

SepaObject

SepaMessage

SepaPaymentInitiation

Derived

SepaCreditTransferPaymentInitiation

SepaDirectDebitPaymentInitiation

Inherited Members

SepaMessage.MessageType

SepaMessage.MessageName

SepaMessage.MessageIdentification

SepaMessage.CreationDateTime

SepaMessage.IsEmpty

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)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

A SepaPaymentInitiation consists of a single group header and a sequence of PaymentInformations. In most cases the Payment Informations sequence will contain a single Payment Information.

A concrete SEPA Payment Initiation is only fully defined by its XML tag, the applicable XML namespace and a version number. Therefore all properties must be given when the object is constructed.

Constructors

SepaPaymentInitiation(string, SepaMessageType)

public SepaPaymentInitiation(string sPainTag, SepaMessageType nMessageType)

Parameters

sPainTag string

nMessageType SepaMessageType

Properties

ControlSum

The computed sum over all transaction amounts.

public decimal ControlSum { get; }

Property Value

decimal

InitiatingParty

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. The Initiating Party is a required element and the Name property of the Party Identification must always be set.

NumberOfTransactions

The (calculated) total number of transactions.

public int NumberOfTransactions { get; }

Property Value

int

PaymentInformations

The Payment Informations sequence of this SEPA document.

public SepaPaymentInformations PaymentInformations { get; }

Property Value

SepaPaymentInformations

This property is never null, but the SepaPaymentInformations instance may be empty.

Methods

Clear()

public override void Clear()

New(string)

public static SepaPaymentInitiation New(string sPaymentMethod)

Parameters

sPaymentMethod string

Returns

SepaPaymentInitiation

NewPaymentInformation()

Creates an associated payment information object. Use the Add method of the PaymentInformations property to include this single SEPA payment information into the SEPA message object.

public abstract SepaPaymentInformation NewPaymentInformation()

Returns

SepaPaymentInformation

OnAfterXmlRead(SepaMessageInfo)

protected override void OnAfterXmlRead(SepaMessageInfo aMessageInfo)

Parameters

aMessageInfo SepaMessageInfo

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