• API Overview
  • EBICS API
  • FinTS API
  • XS2A API
  • SEPA API

    Class SepaAccount

    Represents an Acct or RltdAcct element as it occurs in a SepaStatement.

    Inheritance
    System.Object
    SepaObject
    SepaAccount
    Inherited Members
    SepaObject.TagName
    SepaObject.IsMandatory
    SepaObject.WriteXml(XmlWriter, SepaMessageInfo)
    SepaObject.WriteXml(XmlWriter, SepaMessageInfo, String)
    SepaObject.ReadXml(XmlReader, SepaMessageInfo)
    SepaObject.ReadXml(XmlReader, SepaMessageInfo, String)
    SepaObject.IsValid
    SepaObject.Validate(ICollection<SepaException>, String)
    SepaObject.OnAfterXmlRead(SepaMessageInfo)
    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 SepaAccount : SepaObject
    Remarks

    The usual account properties can be found at the following object properties.

    IBANIBAN
    Domestic account number, BBAN or credit card number.OtherId
    BICServicer.BIC
    Domestic bank codeServicer.ClearingSystemMemberIdentification
    Currency CodeCurrency
    Account product nameName
    Account holder nameOwner.Name

    Constructors

    SepaAccount()

    Declaration
    public SepaAccount()

    SepaAccount(Boolean)

    Creates a SepaAccount with the default TagName "Acct".

    Declaration
    public SepaAccount(bool fIsMandatory)
    Parameters
    Type Name Description
    System.Boolean fIsMandatory

    SepaAccount(String)

    Declaration
    public SepaAccount(string sTagName)
    Parameters
    Type Name Description
    System.String sTagName

    SepaAccount(String, Boolean)

    Declaration
    public SepaAccount(string sTagName, bool fIsMandatory)
    Parameters
    Type Name Description
    System.String sTagName
    System.Boolean fIsMandatory

    Properties

    AccountType

    Declaration
    public SepaAccountType AccountType { get; set; }
    Property Value
    Type Description
    SepaAccountType

    AcctNo

    The domestic account number.

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

    This is either GermanAcctNo or OtherId.

    BankCode

    The domestic bank ocde.

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

    This is either GermanBankCode, or Servicer.ClearingSystemMemberIdentification, or Servicer.OtherId.

    Currency

    Optional currency of account.

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

    The initial value of this property is null. It is possible to set this property to null.

    Exceptions
    Type Condition
    System.ArgumentException

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

    GermanAcctNo

    If this is a German bank account, then this provides the domestic account number, if it is available.

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

    GermanBankCode

    If this is a German bank account, then this provides the German Bankleitzahl, if it is available.

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

    IBAN

    The account IBAN.

    Declaration
    public SepaIBAN IBAN { get; set; }
    Property Value
    Type Description
    SepaIBAN
    Remarks

    This may be NullIBAN if there is no IBAN for the account. In such case. the OtherId must be used instead.

    IsEmpty

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

    Name

    Optional account product name. NOT the name of the account holder.

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

    The initial value of this property is null. Must not be longer than MaxNmLen 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 70 characters.

    See Also
    Owner

    OtherId

    Some other proprietary account number.

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

    This property shall only be used if there is no IBAN available.

    For a German domestic account number this should be 000000001111111111, where 00000000 is the BLZ and 1111111111 is the domestic account number filled with leading zeroes. In addition the OtherSchemeNameCode shall be "BBAN".

    For credit cards this field may be used to hold the PAN (primary account number) of the credit card. In addition the OtherSchemeNameCode may be set to the special value "CPAN" to indicate that this holds a credit card PAN.

    OtherSchemeNameCode

    The scheme name code of the OtherId.

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

    Owner

    The name and further information about the account owner.

    Declaration
    public SepaPartyIdentification Owner { get; }
    Property Value
    Type Description
    SepaPartyIdentification
    Remarks

    Only the property Name shall be used. This element does not occur in a Related Account element.

    Servicer

    The financial institute servicing the account.

    Declaration
    public SepaFinancialInstitutionIdentification Servicer { get; }
    Property Value
    Type Description
    SepaFinancialInstitutionIdentification
    Remarks

    At least the BIC must be set. This element does not occur in a Related Account element.

    TypeCode

    Optional type of account.

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

    This must be null or one of the defined code values. Use "CACC" for current accounts.

    Methods

    Clear()

    Declaration
    public override void Clear()
    Overrides
    SepaObject.Clear()

    OnReadXml(XmlReader, SepaMessageInfo)

    Declaration
    protected override void OnReadXml(XmlReader aXmlReader, SepaMessageInfo aMessageInfo)
    Parameters
    Type Name Description
    System.Xml.XmlReader aXmlReader
    SepaMessageInfo aMessageInfo
    Overrides
    SepaObject.OnReadXml(XmlReader, SepaMessageInfo)

    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
    SepaObject.OnValidate(ICollection<SepaException>, String)

    OnWriteXml(XmlWriter, SepaMessageInfo)

    Declaration
    protected override void OnWriteXml(XmlWriter aXmlWriter, SepaMessageInfo aMessageInfo)
    Parameters
    Type Name Description
    System.Xml.XmlWriter aXmlWriter
    SepaMessageInfo aMessageInfo
    Overrides
    SepaObject.OnWriteXml(XmlWriter, SepaMessageInfo)
    Back to top Copyright 2009-2023 Subsembly GmbH