Class SepaPaymentInformation

Namespace
Subsembly.Sepa
Assembly
Subsembly.Sepa.dll

Abstract base class for all SEPA Payment Information instances.

public abstract class SepaPaymentInformation : SepaPaymentTypeBase
Inheritance
SepaPaymentInformation
Derived
Inherited Members

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

public SepaPaymentInformation(bool fIsMandatory)

Parameters

fIsMandatory bool

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.

public SepaTriState BatchBooking { get; set; }

Property Value

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.

public string ChargeBearer { get; set; }

Property Value

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.

public decimal ControlSum { get; }

Property Value

decimal

IsEmpty 

public override bool IsEmpty { get; }

Property Value

bool

IsSepaCompliant 

public override bool IsSepaCompliant { get; }

Property Value

bool

MessageType

The fundamental message type required by this payment information block.

public abstract SepaMessageType MessageType { get; }

Property Value

SepaMessageType

NumberOfTransactions

The total number of transactions in this element.

public int NumberOfTransactions { get; }

Property Value

int

OrderingParty 

public abstract SepaPartyIdentification OrderingParty { get; }

Property Value

SepaPartyIdentification

OrderingPartyAccount 

public abstract SepaAccount OrderingPartyAccount { get; }

Property Value

SepaAccount

OrderingPartyAgent 

public abstract SepaAgent OrderingPartyAgent { get; }

Property Value

SepaAgent

PaymentInformationIdentification

Unique identification of this Payment Information.

public string PaymentInformationIdentification { get; set; }

Property Value

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

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.

public string PaymentMethod { get; set; }

Property Value

string

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

RequestedDate

Provides the request date and time for this payment.

public abstract DateTime RequestedDate { get; }

Property Value

DateTime

TransactionInformations

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

public SepaTransactionInformations TransactionInformations { get; }

Property Value

SepaTransactionInformations

Methods

Clear() 

public override void Clear()

NewTransactionInformation()

Creates a new transaction object owned by this payment block.

public abstract SepaTransactionInformation NewTransactionInformation()

Returns

SepaTransactionInformation

OnAfterXmlRead(SepaMessageInfo) 

protected override void OnAfterXmlRead(SepaMessageInfo aMessageInfo)

Parameters

aMessageInfo SepaMessageInfo

OnValidate(ICollection<SepaException>, string) 

protected override void OnValidate(ICollection<SepaException> vErrors, string sPath)

Parameters

vErrors ICollection<SepaException>
sPath string