Class FinVopVerificationOrder

Very special order for performing a Verification of Payee (HKVPP), or a Verification of Payee Opt-Out (HKVOO).

Inheritance
System.Object
FinPersist
FinOrder
FinVopVerificationOrder
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)
System.Object.ToString()
Namespace: Subsembly.FinTS
Assembly: Subsembly.FinTS.Core.dll
Syntax
public class FinVopVerificationOrder : FinOrder
Remarks

This order cannot be sent as a stand-alone order, instead it must always be accompanied by a related payment order in the same message.

Constructors

FinVopVerificationOrder()

This ctor shall only be used when loading a previously persisted instance of this class.

Declaration
public FinVopVerificationOrder()

FinVopVerificationOrder(FinVopVerificationBuilder, FinSegment)

Declaration
public FinVopVerificationOrder(FinVopVerificationBuilder aBuilder, FinSegment aOrderSegment)
Parameters
Type Name Description
FinVopVerificationBuilder aBuilder

The builder that is creating this order. This is needed to properly process the order response. This must not be null.
FinSegment aOrderSegment

Properties

Narrative

The narrative status text that shall be shown to the user for confirmation.

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

The plain narrative text without any HTML tags.

See Also

NarrativeHTML

The narrative status text that shall be shown to the user for confirmation.

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

If the server provides structured narrative text (see NarrativeStructured), then this text may contain HTML tags.

See Also

PaymentStatusReport

Declaration
public SepaPaymentStatusReport PaymentStatusReport { get; }
Property Value
Type Description
SepaPaymentStatusReport

ValidUntil

Date and time until this result is valid for confirmation. After this date/time, the VopID is no longer valid and cannot used for confirmation anymore.

Declaration
public DateTime ValidUntil { get; }
Property Value
Type Description
System.DateTime

VerificationResult

Provides the verification result of a single payee verification.

Declaration
public FinVopVerificationResult VerificationResult { get; }
Property Value
Type Description
FinVopVerificationResult
Remarks

The FinTS server may provide this information through segment data elements, or through a PaymentStatusReport. Reading this property will return the segment data element values, if present, or information from the PaymentStatusReport, if it is available, and refers to as single payment only.

VopID

Unique ID of this verification result.

Declaration
public FinByteBuffer VopID { get; }
Property Value
Type Description
FinByteBuffer
Remarks

This ID must be included when confirming the payment.

VopIDNotProvided

Indicates whether the VopID contains the special value "notprovided".

Declaration
public bool VopIDNotProvided { get; }
Property Value
Type Description
System.Boolean
Remarks

If the VopID is null or empty, then this property is false. It is true, if, and only if, the VopID contains the text "notprovided" in upper or lower case.

If the bank returns the VopID "notprovided", then the Verification of Payee is implemented, but not effective, yet. In this case the client may complete the Verification of Payee process under the hood, without any user intervention.

WaitSeconds

If the Verification of Payee response is not complete, yet, then this provides the number of seconds that the client shall wait until it queries the status again.

Declaration
public int WaitSeconds { get; }
Property Value
Type Description
System.Int32

Methods

InsertScrollRef(String)

Declaration
protected override bool InsertScrollRef(string sScrollRef)
Parameters
Type Name Description
System.String sScrollRef
Returns
Type Description
System.Boolean
Overrides

OnExecuteComplete(FinDialog)

Declaration
protected override void OnExecuteComplete(FinDialog aDialog)
Parameters
Type Name Description
FinDialog aDialog
Overrides