Class SepaPaymentInitiation

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

Inheritance
object
SepaObject
SepaMessage
SepaPaymentInitiation
SepaCreditTransferPaymentInitiation
SepaDirectDebitPaymentInitiation
Inherited Members
Namespace: Subsembly.Sepa
Assembly: Subsembly.Sepa.dll
Syntax
public abstract class SepaPaymentInitiation : SepaMessage
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)

Declaration
public SepaPaymentInitiation(string sPainTag, SepaMessageType nMessageType)
Parameters
Type Name Description
string sPainTag
SepaMessageType nMessageType

Properties

ControlSum

The computed sum over all transaction amounts.

Declaration
public decimal ControlSum { get; }
Property Value
Type Description
decimal

InitiatingParty

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

Declaration
public int NumberOfTransactions { get; }
Property Value
Type Description
int

PaymentInformations

The Payment Informations sequence of this SEPA document.

Declaration
public SepaPaymentInformations PaymentInformations { get; }
Property Value
Type Description
SepaPaymentInformations

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

Methods

Clear()

Declaration
public override void Clear()
Overrides

New(string)

Declaration
public static SepaPaymentInitiation New(string sPaymentMethod)
Parameters
Type Name Description
string sPaymentMethod
Returns
Type Description
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.

Declaration
public abstract SepaPaymentInformation NewPaymentInformation()
Returns
Type Description
SepaPaymentInformation

OnAfterXmlRead(SepaMessageInfo)

Declaration
protected override void OnAfterXmlRead(SepaMessageInfo aMessageInfo)
Parameters
Type Name Description
SepaMessageInfo aMessageInfo
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