Class SepaOriginalTransactionInformation
Transaction Information and Status (TxInfAndSts) element of a Payment Status Report (pain.002) document.
Inherited Members
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
CreditorReferenceInformation
Optional RF Creditor Reference (ISO 11649) assigned by the creditor, to unambiguously refer to the payment transaction.
Declaration
public string CreditorReferenceInformation { get; set; }
Property Value
Type | Description |
---|---|
System.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
Type | Condition |
---|---|
System.ArgumentException | An attempt was made to set an invalid reference identification. |
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
|
RemittanceInformation
Original unstructured remittance information.
Declaration
public string RemittanceInformation { get; set; }
Property Value
Type | Description |
---|---|
System.String | If no unstructured remittance information is provided, this property is
|
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. |
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 |
See Also
RemittanceInformationObject
Optional single Remittance Information.
Declaration
public SepaRemittanceInformation RemittanceInformationObject { get; }
Property Value
Type | Description |
---|---|
SepaRemittanceInformation |
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 |