Class FinSepaDirectDebitIndication

Contains the details about a direct debit transaction booked or advised against a customers account. (HIDSB)

Inheritance
object
FinPersist
FinSepaDirectDebitIndication
Inherited Members
Namespace: Subsembly.FinTS
Assembly: Subsembly.FinTS.Core.dll
Syntax
public class FinSepaDirectDebitIndication : FinPersist
Remarks

This class is used by FinSepaDirectDebitIndicationList and FinSepaDirectDebitRejectBuilder.

Constructors

FinSepaDirectDebitIndication()

Declaration
public FinSepaDirectDebitIndication()

Properties

Amount

The amount and currency of the direct debit.

Declaration
public SwiftAmt Amount { get; set; }
Property Value
Type Description
SwiftAmt
Remarks

As this is only for SEPA direct debits, the currency should always be EUR.

Exceptions
Type Condition
ArgumentException

An attempt was made to set a zero or negative amount value.

CreditorAcct

Account details of the creditor that issued the direct debit against the customers account.

Declaration
public FinAcct CreditorAcct { get; set; }
Property Value
Type Description
FinAcct

CreditorId

The official, registered creditor ID of the creditor that issued the direct debit against the customers account.

Declaration
public string CreditorId { get; set; }
Property Value
Type Description
string
Remarks

The creditor ID uniquely identifies every direct debit creditor with the entire SEPA direct debit scheme.

Exceptions
Type Condition
ArgumentException

An attempt was made to set an invalid creditor ID. Creditor IDs are validated against the required syntax and their contained check digits.

CreditorName

Name of the creditor that issued the direct debit against the customers account.

Declaration
public string CreditorName { get; set; }
Property Value
Type Description
string
Exceptions
Type Condition
ArgumentException

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

CustAcct

The customers account that will be debitted.

Declaration
public FinAcct CustAcct { get; set; }
Property Value
Type Description
FinAcct
Remarks

In the return of a FinSepaDirectDebitIndicationList this should specify the same acount as was given to the FinSepaDirectDebitIndicationListBuilder.

EndToEndId

Optional SEPA end-to-end-ID.

Declaration
public string EndToEndId { get; set; }
Property Value
Type Description
string
Exceptions
Type Condition
ArgumentException

An attempt was made to set an end-to-end-ID longer than 35 characters.

EntryDate

Provides the date when this direct debit was received by the bank.

Declaration
public SwiftDate EntryDate { get; }
Property Value
Type Description
SwiftDate
See Also

EntryTime

Provides the time when this direct debit was received by the bank.

Declaration
public SwiftTime EntryTime { get; }
Property Value
Type Description
SwiftTime
Remarks

If an entry time is set, then the EntryDate must be set, too.

See Also

MandateId

Optional SEPA mandate ID.

Declaration
public string MandateId { get; set; }
Property Value
Type Description
string
Remarks

Although the FinTS specification declares this field as optional in the return of a HKDSB (FinSepaDirectDebitIndicationListBuilder) request, it really must always be present in order to fully specify the direct debit booking.

Exceptions
Type Condition
ArgumentException

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

OrderID

Optional order ID of this direct debit that may be used by the bank to identify the direct debit when issuing a reject (FinSepaDirectDebitRejectBuilder).

Declaration
public string OrderID { get; set; }
Property Value
Type Description
string
Exceptions
Type Condition
ArgumentException

An attempt was made to set an order ID longer than 99 characters.

PaymtPurpose

Optional payment purpose text.

Declaration
public string PaymtPurpose { get; set; }
Property Value
Type Description
string
Exceptions
Type Condition
ArgumentException

An attempt was made to set an payment purpose text longer than 140 characters.

Rejected

Indicates whether this direct debit was already rejected by the customer.

Declaration
public bool Rejected { get; set; }
Property Value
Type Description
bool

RejectedDate

Optional date when this direct debit was rejected by the customer.

Declaration
public SwiftDate RejectedDate { get; set; }
Property Value
Type Description
SwiftDate
Remarks

If a rejected date was set, then Rejected should be true, too.

ValueDate

The requested collection date of the direct debit.

Declaration
public SwiftDate ValueDate { get; set; }
Property Value
Type Description
SwiftDate

ZkaCodes

Special codes that provide additional information to classify and identify the transaction. (Code zur Identifizierung des Geschäfts)

Declaration
public SepaGermanBankTransactionCode ZkaCodes { get; set; }
Property Value
Type Description
SepaGermanBankTransactionCode

Methods

ReadXml(XmlReader)

Declaration
public override void ReadXml(XmlReader aXmlReader)
Parameters
Type Name Description
XmlReader aXmlReader
Overrides

SetEntryDateTime(SwiftDate, SwiftTime)

Sets the EntryDate and EntryTime that specify when this direct debit was received by the bank.

Declaration
public void SetEntryDateTime(SwiftDate tEntryDate, SwiftTime tEntryTime)
Parameters
Type Name Description
SwiftDate tEntryDate
SwiftTime tEntryTime

WriteXml(XmlWriter)

Declaration
public override void WriteXml(XmlWriter aXmlWriter)
Parameters
Type Name Description
XmlWriter aXmlWriter
Overrides