Class SepaGermanBankTransactionCode

Helper class to parse and generate the German SepaBankTransactionCode. ProprietaryCode.

Inheritance

System.Object

SepaGermanBankTransactionCode

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)

Namespace: Subsembly.Sepa

Assembly: Subsembly.Sepa.dll

Syntax

public class SepaGermanBankTransactionCode

Remarks

A German bank transaction code consists of a sequence of fields separated by plus signs. Every field in the sequence is optional. The sequence has the format:

[SwiftTxCode]+[GVCode]+[PrimaNotaNo]+[TextKeyExt]

For example:

NCHG+808+7040+000

Properties

GVCode

Three digit German transaction code.

Declaration

public string GVCode { get; set; }

Property Value

Type	Description
System.String

PrimaNotaNo

Declaration

public string PrimaNotaNo { get; set; }

Property Value

Type	Description
System.String

SwiftTransactionCode

Four character swift transaction code.

Declaration

public string SwiftTransactionCode { get; set; }

Property Value

Type	Description
System.String

TextKeyExtension

Three digit German text key extension.

Declaration

public string TextKeyExtension { get; set; }

Property Value

Type	Description
System.String

Methods

Clear()

Clear the current content.

Declaration

public void Clear()

DeriveGVCodeFromSwiftTransactionCode(String, SepaCreditDebitIndicator)

Declaration

public static string DeriveGVCodeFromSwiftTransactionCode(string sSwiftTxCode, SepaCreditDebitIndicator nCdtDbtInd)

Parameters

Type	Name	Description
System.String	sSwiftTxCode
SepaCreditDebitIndicator	nCdtDbtInd

Returns

Type	Description
System.String

IsEmpty()

Checks whether this object is completely empty, such that it won't write anything.

Declaration

public bool IsEmpty()

Returns

Type	Description
System.Boolean

Parse(String)

Parses the proprietary content of a SepaBankTransactionCode. ProprietaryCode from a German CAMT file.

Declaration

public static SepaGermanBankTransactionCode Parse(string sBkTxCd)

Parameters

Type	Name	Description
System.String	sBkTxCd	The content from SepaBankTransactionCode.ProprietaryCode to be parsed. If this is null, then an empty SepaGermanBankTransactionCode is returned.

Returns

Type	Description
SepaGermanBankTransactionCode

Remarks

This method throws an exception, when the given bank transaction code string is not valid.

Exceptions

Type	Condition
System.ArgumentException	The given sBkTxCd is not a valid German bank transaction code.

SetupBankTransactionCode(SepaCreditDebitIndicator, String, SepaBankTransactionCode)

Setup a SepaBankTransactionCode element with the data from this SepaGermanBankTransactionCode.

Declaration

public void SetupBankTransactionCode(SepaCreditDebitIndicator nCdtDbtInd, string sPurpCd, SepaBankTransactionCode aBkTxCd)

Parameters

Type	Name	Description
SepaCreditDebitIndicator	nCdtDbtInd
System.String	sPurpCd
SepaBankTransactionCode	aBkTxCd

Remarks

In addition to the obvious ProprietaryCode and ProprietaryIssuer, this will also setup DomainCode, FamilyCode, and SubFamilyCode, with values derived from GVCode or SwiftTransactionCode.

This method will always setup the SepaBankTransactionCode with mandatory values, even if this SepaGermanBankTransactionCode IsEmpty(). If the worst case, the DomainCode, FamilyCode, and SubFamilyCode, are set up with "PMNT", "OTHR", and "OTHR", and the proprietary fields are null.

ToString()

Generates the proprietary string for the SepaBankTransactionCode. ProprietaryCode.

Declaration

public override string ToString()

Returns

Type	Description
System.String

Overrides

System.Object.ToString()

TryParse(String)

Tries to parses the proprietary content of a SepaBankTransactionCode. ProprietaryCode from a German CAMT file.

Declaration

public static SepaGermanBankTransactionCode TryParse(string sBkTxCd)

Parameters

Type	Name	Description
System.String	sBkTxCd	The content from SepaBankTransactionCode.ProprietaryCode to be parsed. If this is null, then an empty SepaGermanBankTransactionCode is returned.

Returns

Type	Description
SepaGermanBankTransactionCode

Remarks

This method does never throw an exception. Instead it just skips invalid fields.