Class SepaCreditTransferPaymentInformation

Specialized Payment Information for credit transfers.

Inheritance
System.Object
SepaObject
SepaPaymentTypeBase
SepaPaymentInformation
SepaCreditTransferPaymentInformation
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 sealed class SepaCreditTransferPaymentInformation : SepaPaymentInformation

Constructors

SepaCreditTransferPaymentInformation()

Creates a new SepaCreditTransferPaymentInformation object which can be added to the payment information collection of a SepaCreditTransferPaymentInitiation message.

Declaration
public SepaCreditTransferPaymentInformation()

Properties

ChargesAccount

Optional different account for charges.

Declaration
public SepaAccount ChargesAccount { get; }
Property Value
Type Description
SepaAccount

Debtor

The debtor of the transactions in this payment block.

Declaration
public SepaPartyIdentification Debtor { get; }
Property Value
Type Description
SepaPartyIdentification

The Debtor is a required element, therefore at least the Name property of this SepaPartyIdentification must be set before a XML document can be generated.

DebtorAccount

The debtor account of all transactions in this payment block.

Declaration
public SepaAccount DebtorAccount { get; }
Property Value
Type Description
SepaAccount

DebtorAccountCurrency

Shortcut to the currency of the DebtorAccount.

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

DebtorAccountIBAN

Shortcut to the IBAN of the DebtorAccount.

Declaration
public SepaIBAN DebtorAccountIBAN { get; set; }
Property Value
Type Description
SepaIBAN

DebtorAgent

Declaration
public SepaAgent DebtorAgent { get; }
Property Value
Type Description
SepaAgent

DebtorAgentBIC

BIC of the debtor agent (financial institution) of all transactions in this payment block.

Declaration
public SepaBIC DebtorAgentBIC { get; set; }
Property Value
Type Description
SepaBIC

This is initially a null BIC value and should be initialized before a XML document can be generated for this transaction.
Remarks

This field is mandatory prior to ZKA_Pain_001_003_03. In order to create an always valid SEPA output, it is highly recommended to always set this field with a valid BIC.

DebtorAgentFinancialInstitutionIdentification

Shortcut to DebtorAgent.FinancialInstitutionIdentification.

Declaration
public SepaFinancialInstitutionIdentification DebtorAgentFinancialInstitutionIdentification { get; }
Property Value
Type Description
SepaFinancialInstitutionIdentification

IsEmpty

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

MessageType

Returns CreditTransferPaymentInitiation

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

OrderingParty

Returns Debtor.

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

OrderingPartyAccount

Returns DebtorAccount.

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

OrderingPartyAgent

Returns DebtorAgent.

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

RequestedDate

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

RequestedExecutionDate

The mandatory requested execution date for the transactions in this payment block.

Declaration
public DateTime RequestedExecutionDate { get; set; }
Property Value
Type Description
System.DateTime

By default this is initialized with today's date. When setting this property, any date, except DateTime.MinValue may be given.
Remarks

NOTE: For compatibility, when setting this property, only the Date portion of the given DateTime will be stored. If a specific time shall be set in order to generate a DtTm element, the new property RequestedExecutionDateTime must be used.

ATTENTION: The German FinTS specification requires, that for immediate payments this date is initialized with the special value 1999-01-01!

Exceptions
Type Condition
System.ArgumentException

An attempt was made to set this property to DateTime.MinValue. The value DateTime.MinValue is often used to indicate a logical Null-DateTime and therefore is not permitted here.
See Also

RequestedExecutionDateTime

The mandatory requested execution date and time for the transactions in this payment block.

Declaration
public DateTime RequestedExecutionDateTime { get; set; }
Property Value
Type Description
System.DateTime
See Also

UltimateDebtor

Optional name of the ultimate debtor. Rarely needed.

Declaration
public SepaPartyIdentification UltimateDebtor { get; }
Property Value
Type Description
SepaPartyIdentification

Only the Name property of this SepaPartyIdentification must be used.
Remarks

The ultimate debtor may be set here, or at the transaction level UltimateDebtor property. It must not be set at both levels.

Methods

Clear()

Declaration
public override void Clear()
Overrides

NewTransactionInformation()

Creates a new SepaCreditTransferTransactionInformation object.

Declaration
public override SepaTransactionInformation NewTransactionInformation()
Returns
Type Description
SepaTransactionInformation

A new SepaTransactionInformation which is owned by this payment information.
Overrides

OnReadXml(XmlReader, SepaMessageInfo)

Declaration
protected override void OnReadXml(XmlReader aXmlReader, SepaMessageInfo aMessageInfo)
Parameters
Type Name Description
System.Xml.XmlReader aXmlReader
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

OnWriteXml(XmlWriter, SepaMessageInfo)

Declaration
protected override void OnWriteXml(XmlWriter aXmlWriter, SepaMessageInfo aMessageInfo)
Parameters
Type Name Description
System.Xml.XmlWriter aXmlWriter
SepaMessageInfo aMessageInfo
Overrides