Class FinVopVerificationOrder

Namespace
Subsembly.FinTS
Assembly
Subsembly.FinTS.Core.dll

Common abstract base class for Verification of Payee Opt-In (HKVPP) and a Verification of Payee Opt-Out (HKVOO).

public abstract class FinVopVerificationOrder : FinVopOrder
Inheritance
FinVopVerificationOrder
Derived
Inherited Members

Constructors

FinVopVerificationOrder()

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

public FinVopVerificationOrder()

FinVopVerificationOrder(FinVopVerificationBuilder, FinSegment) 

public FinVopVerificationOrder(FinVopVerificationBuilder aBuilder, FinSegment aOrderSegment)

Parameters

aBuilder FinVopVerificationBuilder
aOrderSegment FinSegment

Properties

GroupStatusCode

The overall result of the Verification of Payee.

public VopGroupStatusCode GroupStatusCode { get; protected set; }

Property Value

VopGroupStatusCode

Remarks

This is either derived from the single VerificationResult, or the PaymentStatusReport.

For an Opt-Out operation, this value is always zero. Also, in an Opt-Out result, only a Narrative may be provided.

IsNotProvidedVopID

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

public bool IsNotProvidedVopID { get; }

Property Value

bool

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.

Narrative

The raw narrative string from the HIVPP/HIVOO segment. This may include HTML tags.

protected string Narrative { get; set; }

Property Value

string
See Also

NarrativeHTML

The narrative status text that shall be shown to the user for confirmation. If the server provides structured narrative text (see NarrativeStructured), then this text may contain HTML tags.

public string NarrativeHTML { get; }

Property Value

string
See Also

NarrativeStructured

Indicates whether the raw Narrative text may contain HTML tags (true) or not (false).

public bool NarrativeStructured { get; }

Property Value

bool
See Also

NarrativeText

The narrative status text that shall be shown to the user for confirmation. This is the plain narrative text, any HTML tags from a structured narrative text have been removed.

public string NarrativeText { get; }

Property Value

string
See Also

ValidUntil

Date and time until the VopID is valid.

public DateTime ValidUntil { get; protected set; }

Property Value

DateTime

Remarks

This may be DateTime.MinValue if not known.

VopID

Unique ID of this verification result.

public FinByteBuffer VopID { get; protected set; }

Property Value

FinByteBuffer

Remarks

This ID must be included when confirming the payment.

VopOption

Indicates whether the Verfication of Payee process was an OptIn, or an OptOut process.

public abstract VopOption VopOption { get; }

Property Value

VopOption

Methods

ReadXml(XmlReader) 

public override void ReadXml(XmlReader aXmlReader)

Parameters

aXmlReader XmlReader

WriteXml(XmlWriter) 

public override void WriteXml(XmlWriter aXmlWriter)

Parameters

aXmlWriter XmlWriter