Class SepaCreditTransferTransactionInformation

Spezialized Transaction Information for credit transfers.

Inheritance
System.Object
SepaObject
SepaPaymentTypeBase
SepaTransactionInformation
SepaCreditTransferTransactionInformation
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 SepaCreditTransferTransactionInformation : SepaTransactionInformation

Constructors

SepaCreditTransferTransactionInformation()

Creates a new SepaCreditTransferTransactionInformation object which can be added to the transaction object collection of a SepaCreditTransferPaymentInformation object.

Declaration
public SepaCreditTransferTransactionInformation()

Properties

AmountType

The type of the transfer Amount.

Declaration
public SepaCreditTransferAmountType AmountType { get; set; }
Property Value
Type Description
SepaCreditTransferAmountType
Remarks

This may be InstructedAmount, or EquivalentAmount. The default value is InstructedAmount.

ChargeBearer

For international non-SEPA payments this must be set to select the bearer of charges.

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

Must be either of "DEBT", "CRED", "SHAR", or "SLEV".
See Also

ChequeInstruction

For cheque based international non-SEPA payments this can be used to provide additional instructions on how to handle the cheque.

Declaration
public SepaChequeInstruction ChequeInstruction { get; }
Property Value
Type Description
SepaChequeInstruction

CounterParty

Returns Creditor.

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

CounterPartyAccount

Returns CreditorAccount.

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

CounterPartyAgent

Returns CreditorAgent.

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

Creditor

The creditor of this transaction.

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

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

CreditorAccount

Mandatory creditor account of this transaction.

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

CreditorAccountIBAN

Shortcut to the IBAN of the creditor account of this transaction.

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

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

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

This is initially a null BIC value and should be initialized before a XML document is 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.

CreditorAgentFinancialInstitutionIdentification

Shortcut to CreditorAgent.FinancialInstitutionIdentification.

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

EquivalentAmountCurrencyOfTransfer

With an equivalent amount credit transfer, this provides the actual currency of transfer. This is only used when the AmountType was set to EquivalentAmount.

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

With an equivalent amount credit transfer, the AmountCurrency must match the currency of the ordering account.

Exceptions
Type Condition
System.ArgumentException

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

InstructionForCreditorAgentCollection

Declaration
public SepaInstructionForCreditorAgentCollection InstructionForCreditorAgentCollection { get; }
Property Value
Type Description
SepaInstructionForCreditorAgentCollection

InstructionForDebtorAgent

Optional instruction for debtor agent.

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

Initially null, may be arbitrary text with up tp 140 characters.
Remarks

Further information related to the processing of the payment instruction that may need to be acted upon by the debtor agent, depending on agreement between debtor and the debtor agent. Usage: The instruction can relate to a level of service, can be an instruction to be executed by the debtor's agent, or can be information required by the debtor's agent to process the instruction.

Exceptions
Type Condition
System.ArgumentException

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

IsEmpty

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

IsSepaCompliant

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

RegulatoryReporting

If the regulatory requirements (in particular those of the recipient country) require certain information, this should be provided here.

Holds up to 10 regulatory reporting items (see SEPA-spec. for details)

Declaration
public SepaRegulatoryReporting[] RegulatoryReporting { get; }
Property Value
Type Description
SepaRegulatoryReporting[]
Remarks

For

  • cross-boder payments (e.g. pain.001.001.09)
  • pain.001.001.03 (Sweden)

UltimateCreditor

Optional name of the ultimate creditor. Rarely needed.

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

Only the Name property of this SepaPartyIdentification may be used.

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 may be used.
Remarks

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

Methods

AddRegulatoryReporting(SepaRegulatoryReporting)

If the regulatory requirements(in particular those of the recipient country) require certain information, this should be provided here.

Up to 10 regulatory reporting items can be added (see SEPA-spec. for details)

Declaration
public void AddRegulatoryReporting(SepaRegulatoryReporting aRegulatoryReporting)
Parameters
Type Name Description
SepaRegulatoryReporting aRegulatoryReporting
Remarks

For

  • cross-boder payments (e.g. pain.001.001.09)
  • pain.001.001.03 (Sweden)

Clear()

Declaration
public override void Clear()
Overrides

ClearRegulatoryReporting()

Declaration
public void ClearRegulatoryReporting()

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