Class DtazvBuilder

Namespace

Subsembly.Dtazv

Assembly

Subsembly.Sepa.dll

Simple utility class for easy building of German DTA files and records.

public class DtazvBuilder : DtazvBase

Inheritance

object

DtazvBase

DtazvBuilder

Inherited Members

DtazvBase.TotalValue

DtazvBase.TotalCount

DtazvBase.ResetCount()

DtazvBase.AddCount(decimal)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Constructors

DtazvBuilder(int)

Contructs a DtazvBuilder instance with a suggested initial capacity.

public DtazvBuilder(int nCapacity)

Parameters

nCapacity int

The suggested initial capacity. This should be chosen according to the expected resulting data size.

Exceptions

ArgumentOutOfRangeException

The parameter nCapacity is less than zero.

Properties

Size

Provides the byte size of the DTA data collected so far.

public int Size { get; }

Property Value

int

Methods

AppendRecordQ(string, string, DtazvNameAndAddress, DateTime, int, DateTime)

Appends a complete DTAZV record Q to this DTA data buffer.

public void AppendRecordQ(string sBankCode, string sCustomerNumber, DtazvNameAndAddress aInitiator, DateTime tBuildDate, int nDailySeqNo, DateTime tScheduleDate)

Parameters

sBankCode string

The bank code of the bank that shall receive the DTAZV.

sCustomerNumber string

The customer number, usually the 10 digit account number of the ordering customer account.

aInitiator DtazvNameAndAddress

The name of the initiator of this DTAZV order, perhaps including the address in additional lines. This must not be null or an empty string.

tBuildDate DateTime

nDailySeqNo int

tScheduleDate DateTime

Exceptions

ArgumentNullException

The parameter aOrderingCustAcct or sOrderingCustName was null.

ArgumentException

The parameter sOrderingCustName was an empty string, or a required property of the given aOrderingCustAcct was not set.

AppendRecordT(SepaCreditTransferPaymentInformation, SepaCreditTransferTransactionInformation)

Appends a complete DTAZV record T for a simple international remittance.

public void AppendRecordT(SepaCreditTransferPaymentInformation aPmtInf, SepaCreditTransferTransactionInformation aTxInf)

Parameters

aPmtInf SepaCreditTransferPaymentInformation

aTxInf SepaCreditTransferTransactionInformation

AppendRecordZ()

Adds the final DTAZV record Z.

public void AppendRecordZ()

Remarks

The required check values are taken from the current values of the properties TotalValue and TotalCount.

GenerateDTAZV(SepaDocument, string, string)

Generates a complete DTAZV from a SEPA PAIN 001 document.

public static DtazvBuilder GenerateDTAZV(SepaDocument aSepaDoc, string sBankCode, string sCustomerNumber)

Parameters

aSepaDoc SepaDocument

The SEPA PAIN 001 document.

sBankCode string

The bank code of the bank that shall receive the DTAZV.

sCustomerNumber string

The customer number, usually the 10 digit account number of the ordering customer account.

Returns

DtazvBuilder

A new DtazvBuilder instance that holds the complete DTAZV including a header record Q, a remittance record T for each payment, and a final record Z.

Exceptions

ArgumentNullException

The parameter aSepaDoc was null.

ArgumentException

The given SEPA document was not a CreditTransferPaymentInitiation.

• or - The SEPA document did not contain any payments.

ToBytes()

Convert the collected DTA data to a byte array.

public byte[] ToBytes()

Returns

byte[]

This method returns the complete collected data as a DTA conforming byte array.

ToString()

public override string ToString()

Returns

string