Class VopPaymentStatusReport

Extensions for SepaPaymentStatusReport in order to support the German Verification of Payee implementation.

Inheritance

object

VopPaymentStatusReport

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Subsembly.Sepa.VerificationOfPayee

Assembly: Subsembly.Sepa.dll

Syntax

public static class VopPaymentStatusReport

Fields

VOP_CLOSEMATCHNAME_MAXLENGTH

Maximum length of close match creditor name that may be passed to SetVopStatusCode(SepaOriginalTransactionInformation, VopStatusCode, string, VopNotApplicableReasonCode, string).

Declaration

public const int VOP_CLOSEMATCHNAME_MAXLENGTH = 209

Field Value

Type	Description
int

VOP_NOTAPPLICABLEREASONTEXT_MAXLENGTH

Maximum length of narrative that may be passed to SetVopStatusCode(SepaOriginalTransactionInformation, VopStatusCode, string, VopNotApplicableReasonCode, string).

Declaration

public const int VOP_NOTAPPLICABLEREASONTEXT_MAXLENGTH = 105

Field Value

Type	Description
int

VOP_STATUSNARRATIVE_MAXLENGTH

Maximum length of narrative that may be passed to SetVopStatusNarrative(SepaPaymentStatusReport, VopStatusCode, string).

Declaration

public const int VOP_STATUSNARRATIVE_MAXLENGTH = 500

Field Value

Type	Description
int

Methods

GetVopGroupStatus(SepaPaymentStatusReport)

Gets the VoP Group Status from the SepaPaymentStatusReport.

Declaration

public static VopGroupStatusCode GetVopGroupStatus(this SepaPaymentStatusReport aPaymentStatusReport)

Parameters

Type	Name	Description
SepaPaymentStatusReport	aPaymentStatusReport

Returns

Type	Description
VopGroupStatusCode

Remarks

If the SepaPaymentStatusReport does not contain a GroupStatus, then this method attempts to derived a VoP Group Status from the content of the NumberOfTransactionsPerStatus collection.

GetVopResult(SepaPaymentStatusReport, SepaCreditTransferPaymentInitiation, RepairPainOptions)

Compile and provide elaborate Verification of Payee result information, optionally fixing the original SepaCreditTransferPaymentInitiation to contain solely Verification of Payee matches.

Declaration

public static VopResult GetVopResult(this SepaPaymentStatusReport aPaymentStatusReport, SepaCreditTransferPaymentInitiation aCreditTransferPain, VopPaymentStatusReport.RepairPainOptions nRepairOptions = RepairPainOptions.None)

Parameters

Type	Name	Description
SepaPaymentStatusReport	aPaymentStatusReport
SepaCreditTransferPaymentInitiation	aCreditTransferPain	The original Credit Transfer Payment Initiation for which the Verfication of Payee result is provided through aPaymentStatusReport. This may be null, however, if it is provided, then the returned VopResult contains additional information.
VopPaymentStatusReport.RepairPainOptions	nRepairOptions	If this parameter is not None, then the given aCreditTransferPain instance will be modified according to the selected VopPaymentStatusReport.RepairPainOptions. On return, the repaired instance only contains transactions that will pass the Verification of Payee with a Match result. This parameter is ignored if aCreditTransferPain is null.

Returns

Type	Description
VopResult

Remarks

In order to facilitate proper matching of the Verification of Payee result with the transactions in the SepaCreditTransferPaymentInitiation, each transaction must have a unique EndToEndId.

Exceptions

Type	Condition
ArgumentNullException	The parameter aPaymentStatusReport was null.

GetVopStatusNarrative(SepaPaymentStatusReport, VopStatusCode)

Returns the multi-line narrative text that was provided for the status report for a given VopStatusCode.

Declaration

public static string GetVopStatusNarrative(this SepaPaymentStatusReport aPaymentStatusReport, VopStatusCode nVopStatusCode)

Parameters

Type	Name	Description
SepaPaymentStatusReport	aPaymentStatusReport
VopStatusCode	nVopStatusCode

Returns

Type	Description
string	If a narrative text was provided, then it is returned. If no narrative was provided for the requested status code, then null is returned.

Exceptions

Type	Condition
ArgumentNullException	The parameter aPaymentStatusReport was null.
ArgumentException	The parameter nVopStatusCode was not a valid status code.

SetVopGroupStatus(SepaPaymentStatusReport, VopGroupStatusCode)

Declaration

public static void SetVopGroupStatus(this SepaPaymentStatusReport aPaymentStatusReport, VopGroupStatusCode nStatusCode)

Parameters

Type	Name	Description
SepaPaymentStatusReport	aPaymentStatusReport
VopGroupStatusCode	nStatusCode

Exceptions

Type	Condition
ArgumentNullException

SetVopNumberOfTransactionsPerStatus(SepaPaymentStatusReport, VopStatusCode, int)

Declaration

public static void SetVopNumberOfTransactionsPerStatus(this SepaPaymentStatusReport aPaymentStatusReport, VopStatusCode nVopStatusCode, int nNumberOfTransactions)

Parameters

Type	Name	Description
SepaPaymentStatusReport	aPaymentStatusReport
VopStatusCode	nVopStatusCode
int	nNumberOfTransactions

Exceptions

Type	Condition
ArgumentNullException	The parameter aPaymentStatusReport was null.
ArgumentException	The parameter nVopStatusCode was not a valid status code.

SetVopStatusNarrative(SepaPaymentStatusReport, VopStatusCode, string)

Declaration

public static void SetVopStatusNarrative(this SepaPaymentStatusReport aPaymentStatusReport, VopStatusCode nVopStatusCode, string sVopStatusNarrative)

Parameters

Type	Name	Description
SepaPaymentStatusReport	aPaymentStatusReport
VopStatusCode	nVopStatusCode
string	sVopStatusNarrative

Exceptions

Type	Condition
ArgumentNullException	The parameter aPaymentStatusReport was null.
ArgumentException	The parameter nVopStatusCode was not a valid status code.