Class SepaOriginalTransactionInformation

Namespace
Subsembly.Sepa
Assembly
Subsembly.Sepa.dll

Transaction Information and Status (TxInfAndSts) element of a Payment Status Report (pain.002) document.

public class SepaOriginalTransactionInformation : SepaPaymentTypeBase, ISepaStatusAndReasonInformation
Inheritance
SepaOriginalTransactionInformation
Implements
Inherited Members
Extension Methods

Constructors

SepaOriginalTransactionInformation() 

public SepaOriginalTransactionInformation()

Properties

Amount

The original instructed amount of this transaction.

public decimal Amount { get; set; }

Property Value

decimal

The value must be in the range from 0.00 through 999,999,999.99. The initial value is zero.

Exceptions

ArgumentOutOfRangeException

An attempt was made to set a negative value.

ArgumentException

An attempt was made to set a decimal value with more than two significant fractional digits.

AmountCurrency

The original currency of the original instructed amount.

public string AmountCurrency { get; set; }

Property Value

string

This is initialized with "EUR" and must be "EUR" for all SEPA payments. However, it is possible to set any valid currency code.

Exceptions

ArgumentException

An attempt was made to set a value that is not a syntactically valid currency code.

Creditor

The original creditor of this transaction.

public SepaPartyIdentification Creditor { get; }

Property Value

SepaPartyIdentification
See Also

CreditorAccount

Original creditor account of this transaction.

public SepaAccount CreditorAccount { get; }

Property Value

SepaAccount
See Also

CreditorAccountCurrency

Shortcut to the currency of the creditor account.

public string CreditorAccountCurrency { get; set; }

Property Value

string
See Also

CreditorAccountIBAN

Shortcut to IBAN of the creditor account.

public SepaIBAN CreditorAccountIBAN { get; set; }

Property Value

SepaIBAN
See Also

CreditorAgent 

public SepaAgent CreditorAgent { get; }

Property Value

SepaAgent

CreditorAgentBIC

Original BIC of the creditor agent (financial institution) of this transaction.

public SepaBIC CreditorAgentBIC { get; set; }

Property Value

SepaBIC
See Also

CreditorReferenceInformation

Optional RF Creditor Reference (ISO 11649) assigned by the creditor, to unambiguously refer to the payment transaction.

public string CreditorReferenceInformation { get; set; }

Property Value

string

Remarks

This is a shortcut for accessing the RemittanceInformationObject CreditorReferenceInformation property.

Setting this property will setup the complete nested SepaStructuredRemittanceInformation element, to only hold the given creditor reference and nohting else. It will set the value to the CreditorReference property and also the value SCOR to the CreditorReferenceTypeCode property. All all other values from the nested SepaStructuredRemittanceInformation will be cleared! Setting this property to null, or an empty string, will completely clear the nested SepaStructuredRemittanceInformation.

Reading this property will return the value from the CreditorReference property of the nested SepaStructuredRemittanceInformation, if, and only if, the value of the CreditorReferenceTypeCode property contains the value SCOR.

Exceptions

ArgumentException

An attempt was made to set an invalid reference identification.

CreditorSchemeIdentification

Original identifier of the creditor (CI).

public string CreditorSchemeIdentification { get; set; }

Property Value

string

Exceptions

ArgumentException

An invalid value was set.

See Also

CreditorSchemeIdentificationObject 

public SepaCreditorSchemeIdentification CreditorSchemeIdentificationObject { get; }

Property Value

SepaCreditorSchemeIdentification
See Also

Debtor

The original debtor of this transaction.

public SepaPartyIdentification Debtor { get; }

Property Value

SepaPartyIdentification
See Also

DebtorAccount

Original debtor account of the transaction.

public SepaAccount DebtorAccount { get; }

Property Value

SepaAccount
See Also

DebtorAccountCurrency

Shortcut to currency of the debtor account.

public string DebtorAccountCurrency { get; set; }

Property Value

string
See Also

DebtorAccountIBAN

Shortcut to IBAN of the debtor account.

public SepaIBAN DebtorAccountIBAN { get; set; }

Property Value

SepaIBAN
See Also

DebtorAgent 

public SepaAgent DebtorAgent { get; }

Property Value

SepaAgent

DebtorAgentBIC

Original BIC of the debtor agent (financial institution) of the transaction.

public SepaBIC DebtorAgentBIC { get; set; }

Property Value

SepaBIC
See Also

IsEmpty 

public override bool IsEmpty { get; }

Property Value

bool

MandateDateOfSignature

Original date of signing of the mandate.

public DateTime MandateDateOfSignature { get; set; }

Property Value

DateTime
See Also

MandateIdentification

Original unique mandate reference.

public string MandateIdentification { get; set; }

Property Value

string
See Also

OriginalEndToEndId 

public string OriginalEndToEndId { get; set; }

Property Value

string

OriginalInstructionIdentification 

public string OriginalInstructionIdentification { get; set; }

Property Value

string

PaymentMethod

Optional Payment Method of the transaction.

public string PaymentMethod { get; set; }

Property Value

string

This must be either TRF for Credit Transfer or DD for Direct Debit, or null if not used.

RemittanceInformation

Original unstructured remittance information.

public string RemittanceInformation { get; set; }

Property Value

string

If no unstructured remittance information is provided, this property is null, which is also its default value. An unstructured remittance information string must not be longer than MaxRmtInfLen (140) characters.

Remarks

Only latin characters should be used. It is up to the caller to ensure that the provided string contains only characters accepted by the recipient of the SEPA document.

Exceptions

ArgumentException

An attempt was made to set a string longer than 140 characters.

RemittanceInformationLines

Provides the optional unstructured remittance information as an array of lines.

public string[] RemittanceInformationLines { get; set; }

Property Value

string[]

Exceptions

ArgumentException

An array was set that contained null string entries, or entries with strings longer than 140 characters.

See Also

RemittanceInformationObject

Optional single Remittance Information.

public SepaRemittanceInformation RemittanceInformationObject { get; }

Property Value

SepaRemittanceInformation

RequestedDate

The original requested date for the transaction.

public DateTime RequestedDate { get; set; }

Property Value

DateTime

By default this is initialized with DateTime.MinValue which means that no date was set.

Remarks

This is either the original RequestedExecutionDate or the original RequestedCollectionDate.

Status

Returns TransactionStatus.

public string Status { get; }

Property Value

string

StatusIdentification 

public string StatusIdentification { get; set; }

Property Value

string

StatusReasonInformations

The status reason informations for this instance.

public SepaStatusReasonInformations StatusReasonInformations { get; }

Property Value

SepaStatusReasonInformations

TransactionStatus

The optional transaction status.

public string TransactionStatus { get; set; }

Property Value

string

Methods

Clear() 

public override void Clear()

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