Class FinAcctBalResp

Namespace: Subsembly.FinTS

Assembly: Subsembly.FinTS.Core.dll

Wraps a single account balance inquiry response segment (HISAL) for read access.

public class FinAcctBalResp

Inheritance: object

FinAcctBalResp

Inherited Members: object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

FinAcctBalResp(FinSegment)

Contructs an instance of this wrapper for the given account balance (HISAL) segment.

public FinAcctBalResp(FinSegment aHISAL)

Parameters

aHISAL FinSegment: The account balance (HISAL) segment to be wrapped. This must be a HISAL segment with a segment version between 3 (HBCI 2.0.1) and 8 (FinTS 3.0, SEPA).

Exceptions

ArgumentNullException: If a null reference is given for the aHISAL parameter, then an ArgumentNullException is thrown.
ArgumentOutOfRangeException: If the given FinSegment is not of type HISAL or the segment version is not in the range from 3 to 8 inclusive, then an ArgumentOutOfRangeException is thrown.

Properties

Account

The account specification itself.

public FinAcct Account { get; }

Property Value

FinAcct

AcctCcy

Account currency.

public string AcctCcy { get; }

Property Value

string: This is a required field that contains a three letter ISO currency code.

AcctName

Descriptive name of the type of this account.

public string AcctName { get; }

Property Value

string: This is a required field with up to 30 characters.

AcctNo

The account number.

public string AcctNo { get; }

Property Value

string

AlreadyDrawnOnAmt

Amount that was already drawn from the account.

public SwiftAmt AlreadyDrawnOnAmt { get; }

Property Value

SwiftAmt: This is an optional data element group (DEG) of the account balance response. If the data is not included in the HISAL segment, then a null amount is returned through this property. Use IsNull to check whether the returned amount is null.

AvailableFunds

Total amount available from the account.

public SwiftAmt AvailableFunds { get; }

Property Value

SwiftAmt: This is an optional data element group (DEG) of the account balance response. If the data is not included in the HISAL segment, then a null amount is returned through this property. Use IsNull to check whether the returned amount is null.

BalBookingDate

The balance booking date.

public SwiftDate BalBookingDate { get; }

Property Value

SwiftDate: The balance booking date actually is an optional field. However, if it is not provided, then this property will return the balance date from the current balance. Thus this property should never return a null date.

BalBookingTime

The balance booking time.

public SwiftTime BalBookingTime { get; }

Property Value

SwiftTime: The balance booking time actually is an optional field. However, if it is not provided, then this property will return the balance time from the current balance. Only if the current balance does not have a time field, too, then a null FinTime is returned.

CurrentBal

Currently booked balance of the account.

public SwiftBalance CurrentBal { get; }

Property Value

SwiftBalance: This is a required data element group (DEG) of the account balance response.

IncludingPendingTransBal

Future balance after all pending transactions have been booked.

public SwiftBalance IncludingPendingTransBal { get; }

Property Value

SwiftBalance: This is an optional data element group (DEG) of the account balance response. If the data is not included in the HISAL segment, then a null reference is returned through this property.

MaturityDate

Optional maturity date for credit card accounts

public SwiftDate MaturityDate { get; }

Property Value

SwiftDate

OverdraftLim

Optional overdraft limit for the account.

public SwiftAmt OverdraftLim { get; }

Property Value

SwiftAmt: This is an optional data element group (DEG) of the account balance response. If the data is not included in the HISAL segment, then a null amount is returned through this property. Use IsNull to check whether the returned amount is null.