Class SepaCreditTransferPaymentInformation

Namespace
Subsembly.Sepa
Assembly
Subsembly.Sepa.dll

Specialized Payment Information for credit transfers.

public sealed class SepaCreditTransferPaymentInformation : SepaPaymentInformation
Inheritance
SepaCreditTransferPaymentInformation
Inherited Members

Constructors

SepaCreditTransferPaymentInformation()

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

public SepaCreditTransferPaymentInformation()

Properties

ChargesAccount

Optional different account for charges.

public SepaAccount ChargesAccount { get; }

Property Value

SepaAccount

Debtor

The debtor of the transactions in this payment block.

public SepaPartyIdentification Debtor { get; }

Property Value

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.

public SepaAccount DebtorAccount { get; }

Property Value

SepaAccount

DebtorAccountCurrency

Shortcut to the currency of the DebtorAccount.

public string DebtorAccountCurrency { get; set; }

Property Value

string

DebtorAccountIBAN

Shortcut to the IBAN of the DebtorAccount.

public SepaIBAN DebtorAccountIBAN { get; set; }

Property Value

SepaIBAN

DebtorAgent 

public SepaAgent DebtorAgent { get; }

Property Value

SepaAgent

DebtorAgentBIC

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

public SepaBIC DebtorAgentBIC { get; set; }

Property Value

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.

public SepaFinancialInstitutionIdentification DebtorAgentFinancialInstitutionIdentification { get; }

Property Value

SepaFinancialInstitutionIdentification

IsEmpty 

public override bool IsEmpty { get; }

Property Value

bool

MessageType

Returns CreditTransferPaymentInitiation

public override SepaMessageType MessageType { get; }

Property Value

SepaMessageType

OrderingParty

Returns Debtor.

public override SepaPartyIdentification OrderingParty { get; }

Property Value

SepaPartyIdentification

OrderingPartyAccount

Returns DebtorAccount.

public override SepaAccount OrderingPartyAccount { get; }

Property Value

SepaAccount

OrderingPartyAgent

Returns DebtorAgent.

public override SepaAgent OrderingPartyAgent { get; }

Property Value

SepaAgent

RequestedDate

Provides the RequestedExecutionDateTime.

public override DateTime RequestedDate { get; }

Property Value

DateTime

RequestedExecutionDate

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

public DateTime RequestedExecutionDate { get; set; }

Property Value

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

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.

public DateTime RequestedExecutionDateTime { get; set; }

Property Value

DateTime

Remarks

Before version 8 of the pain.001 format, the ReqdExctnDt did only contain a date without time specification. If such a version is generated, then the time portion of the value given in this property will be ignored.

Starting with version 8, the generated XML may contain a DtTm element instead of a Dt element. However, a DtTm element will only be generated, when the time portion of this property is not zero. In order to enforce a DtTm element for midnight, use a DateTime that is one millisecond after midnight. The millisecond will not be included in the DtTm element, which is only specified with second accuracy, but it will ensure that a DtTm element and no Dt element is generated.

See Also

UltimateDebtor

Optional name of the ultimate debtor. Rarely needed.

public SepaPartyIdentification UltimateDebtor { get; }

Property Value

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

public override void Clear()

NewTransactionInformation()

Creates a new SepaCreditTransferTransactionInformation object.

public override SepaTransactionInformation NewTransactionInformation()

Returns

SepaTransactionInformation

A new SepaTransactionInformation which is owned by this payment information.

OnReadXml(XmlReader, SepaMessageInfo) 

protected override void OnReadXml(XmlReader aXmlReader, SepaMessageInfo aMessageInfo)

Parameters

aXmlReader XmlReader
aMessageInfo SepaMessageInfo

OnValidate(ICollection<SepaException>, string) 

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

Parameters

vErrors ICollection<SepaException>
sPath string

OnWriteXml(XmlWriter, SepaMessageInfo) 

protected override void OnWriteXml(XmlWriter aXmlWriter, SepaMessageInfo aMessageInfo)

Parameters

aXmlWriter XmlWriter
aMessageInfo SepaMessageInfo