Class SepaPaymentInformation

Abstract base class for all SEPA Payment Information instances.

Inheritance
System.Object
SepaObject
SepaPaymentTypeBase
SepaPaymentInformation
SepaCreditTransferPaymentInformation
SepaDirectDebitPaymentInformation
Inherited Members
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 SepaPaymentInformation : SepaPaymentTypeBase
Remarks

The structure and content of a SEPA Payment Information depends on the actual kind of payment. There are two derived classes of this abstract base class. The SepaCreditTransferPaymentInformation contains a sequence of Credit Transfer Transaction Informations. The other class, the SepaDirectDebitPaymentInformation holds a sequence of Direct Debit Transaction Informations.

Constructors

SepaPaymentInformation(Boolean)

Declaration
public SepaPaymentInformation(bool fIsMandatory)
Parameters
Type Name Description
System.Boolean fIsMandatory

Properties

BatchBooking

Selects whether all the transactions in the SEPA payment information element are booked as a single batch payment or as individual payment entries.

Declaration
public SepaTriState BatchBooking { get; set; }
Property Value
Type Description
SepaTriState
Remarks

This element was added (actually moved from the SEPA payment initiation message's group header) in (Rulebook) version "3" of SEPA credit transfer payment initiation message (and version "2" of SEPA direct debit payment initiation message).

ChargeBearer

Optional charge bearer code.

Declaration
public string ChargeBearer { get; set; }
Property Value
Type Description
System.String

Four letter code. The default value is "SLEV". If set to null, then no ChrgBr element will be produced.

ControlSum

The computed sum over all transaction amounts.

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

IsEmpty

Declaration
public override bool IsEmpty { get; }
Property Value
Type Description
System.Boolean
Overrides

IsSepaCompliant

Declaration
public override bool IsSepaCompliant { get; }
Property Value
Type Description
System.Boolean
Overrides

MessageType

The fundamental message type required by this payment information block.

Declaration
public abstract SepaMessageType MessageType { get; }
Property Value
Type Description
SepaMessageType

NumberOfTransactions

The total number of transactions in this element.

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

OrderingParty

Declaration
public abstract SepaPartyIdentification OrderingParty { get; }
Property Value
Type Description
SepaPartyIdentification

OrderingPartyAccount

Declaration
public abstract SepaAccount OrderingPartyAccount { get; }
Property Value
Type Description
SepaAccount

OrderingPartyAgent

Declaration
public abstract SepaAgent OrderingPartyAgent { get; }
Property Value
Type Description
SepaAgent

PaymentInformationIdentification

Unique identification of this Payment Information.

Declaration
public string PaymentInformationIdentification { get; set; }
Property Value
Type Description
System.String

An arbitrary text with a maximum length of MaxIdLen (35) characters. This property is initially set to an internally generated unique ID. This property is optional in "pain.001.001.02" and "pain.008.001.01" messages, and mandatory in "pain.001.002.03" and "pain.008.002.02" messages.
Exceptions
Type Condition
System.ArgumentException

An attempt was made to set a string longer than 35 characters, or a string that contains invalid characters.

PaymentMethod

The Payment Method of the transactions.

Declaration
public string PaymentMethod { get; set; }
Property Value
Type Description
System.String

This usually is either TRF for Credit Transfers, DD for Direct Debits, or CHK for cheque payments.

RequestedDate

Declaration
public abstract DateTime RequestedDate { get; }
Property Value
Type Description
System.DateTime

TransactionInformations

Offers access to the associated transaction information items. There should be at least one transaction information item in the returned collection.

Declaration
public SepaTransactionInformations TransactionInformations { get; }
Property Value
Type Description
SepaTransactionInformations

Methods

Clear()

Declaration
public override void Clear()
Overrides

NewTransactionInformation()

Creates a new transaction object owned by this payment block.

Declaration
public abstract SepaTransactionInformation NewTransactionInformation()
Returns
Type Description
SepaTransactionInformation

OnAfterXmlRead(SepaMessageInfo)

Declaration
protected override void OnAfterXmlRead(SepaMessageInfo aMessageInfo)
Parameters
Type Name Description
SepaMessageInfo aMessageInfo
Overrides

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