Class SepaOriginalTransactionInformation

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

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

Constructors

SepaOriginalTransactionInformation()

Declaration
public SepaOriginalTransactionInformation()

Properties

Amount

The original instructed amount of this transaction.

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

The value must be in the range from 0.00 through 999,999,999.99. The initial value is zero.
Exceptions
Type Condition
System.ArgumentOutOfRangeException

An attempt was made to set a negative value.
System.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.

Declaration
public string AmountCurrency { get; set; }
Property Value
Type Description
System.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
Type Condition
System.ArgumentException

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

Creditor

The original creditor of this transaction.

Declaration
public SepaPartyIdentification Creditor { get; }
Property Value
Type Description
SepaPartyIdentification
See Also

CreditorAccount

Original creditor account of this transaction.

Declaration
public SepaAccount CreditorAccount { get; }
Property Value
Type Description
SepaAccount
See Also

CreditorAccountCurrency

Shortcut to the currency of the creditor account.

Declaration
public string CreditorAccountCurrency { get; set; }
Property Value
Type Description
System.String
See Also

CreditorAccountIBAN

Shortcut to IBAN of the creditor account.

Declaration
public SepaIBAN CreditorAccountIBAN { get; set; }
Property Value
Type Description
SepaIBAN
See Also

CreditorAgent

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

CreditorAgentBIC

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

Declaration
public SepaBIC CreditorAgentBIC { get; set; }
Property Value
Type Description
SepaBIC
See Also

CreditorReferenceCode

The creditor reference document type code

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

This is initialized with "SCOR" but can be changed to any valid code. Setting a valid code will clear CreditorReferenceProprietary. The Code tag is written only if CreditorReferenceProprietary is null.
Exceptions
Type Condition
System.ArgumentException

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

CreditorReferenceInformation

Optional creditor reference information from a structured remittance information element.

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

This property is extracted from a structured remittance information that uses the following format: 

<Strd>
    <CdtrRefInf>
        <Tp>
            <CdOrPrtry>
                <Cd>SCOR</Cd>
            </CdOrPrtry>
        </Tp>
        <Ref>RFXXXX</Ref>
    </CdtrRefInf>
</Strd>
Any other structured remittance information elements are ignored and discarded when reading. Also, it is not possible to generate any other strcutured remittance information than this.

Only either this CreditorReferenceInformation or the RemittanceInformation may be set, but not both.

Exceptions
Type Condition
System.ArgumentException

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

CreditorReferenceProprietary

The creditor reference document type proprietary

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

The Proprietary tag is written only if this string is set. Else the Code tag will be written. Setting this string will clear CreditorReferenceCode.
Exceptions
Type Condition
System.ArgumentException

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

CreditorSchemeIdentification

Original identifier of the creditor (CI).

Declaration
public string CreditorSchemeIdentification { get; set; }
Property Value
Type Description
System.String
Exceptions
Type Condition
System.ArgumentException

An invalid value was set.
See Also

Debtor

The original debtor of this transaction.

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

DebtorAccount

Original debtor account of the transaction.

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

DebtorAccountCurrency

Shortcut to currency of the debtor account.

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

DebtorAccountIBAN

Shortcut to IBAN of the debtor account.

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

DebtorAgent

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

DebtorAgentBIC

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

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

IsEmpty

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

MandateDateOfSignature

Original date of signing of the mandate.

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

MandateIdentification

Original unique mandate reference.

Declaration
public string MandateIdentification { get; set; }
Property Value
Type Description
System.String
See Also

OriginalEndToEndId

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

OriginalInstructionIdentification

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

PaymentMethod

Optional Payment Method of the transaction.

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

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

RemittanceInformation

Original unstructured remittance information.

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

If no remittance information is provided, this property is null, which is also its default value. A 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
Type Condition
System.ArgumentException

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

RemittanceInformationLines

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

Declaration
public string[] RemittanceInformationLines { get; set; }
Property Value
Type Description
System.String[]
Exceptions
Type Condition
System.ArgumentException

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

RequestedDate

The original requested date for the transaction.

Declaration
public DateTime RequestedDate { get; set; }
Property Value
Type Description
System.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.

StatusIdentification

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

StatusReasonInformations

The status reason informations for this instance.

Declaration
public SepaStatusReasonInformations StatusReasonInformations { get; }
Property Value
Type Description
SepaStatusReasonInformations

TransactionStatus

The optional payment information status.

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

Methods

Clear()

Declaration
public override void Clear()
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