• API Overview
  • EBICS API
  • FinTS API
  • XS2A API
  • SEPA API
Search Results for

    Class SepaPaymentInitiation

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

    Inheritance
    System.Object
    SepaObject
    SepaMessage
    SepaPaymentInitiation
    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)
    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 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
    System.String sPainTag
    SepaMessageType nMessageType

    Properties

    ControlSum

    The computed sum over all transaction amounts.

    Declaration
    public decimal ControlSum { get; }
    Property Value
    Type Description
    System.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 an 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
    System.Int32

    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
    SepaMessage.Clear()

    New(String)

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

    OnReadXml(XmlReader, SepaMessageInfo)

    Declaration
    protected override void OnReadXml(XmlReader aXmlReader, SepaMessageInfo aMessageInfo)
    Parameters
    Type Name Description
    System.Xml.XmlReader aXmlReader
    SepaMessageInfo aMessageInfo
    Overrides
    SepaObject.OnReadXml(XmlReader, SepaMessageInfo)

    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
    SepaMessage.OnValidate(ICollection<SepaException>, String)

    OnWriteXml(XmlWriter, SepaMessageInfo)

    Declaration
    protected override void OnWriteXml(XmlWriter aXmlWriter, SepaMessageInfo aMessageInfo)
    Parameters
    Type Name Description
    System.Xml.XmlWriter aXmlWriter
    SepaMessageInfo aMessageInfo
    Overrides
    SepaObject.OnWriteXml(XmlWriter, SepaMessageInfo)
    In This Article
    Back to top Copyright 2009-2025 Subsembly GmbH