Class FinVopVerificationOptInOrder

Special order for performing a Verification of Payee Opt-In (HKVPP).

Inheritance
object
FinPersist
FinOrder
FinVopOrder
FinVopVerificationOrder
FinVopVerificationOptInOrder
Inherited Members
Namespace: Subsembly.FinTS
Assembly: Subsembly.FinTS.Core.dll
Syntax
public sealed class FinVopVerificationOptInOrder : FinVopVerificationOrder
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

FinVopVerificationOptInOrder(FinSepaOrder)

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

Declaration
public FinVopVerificationOptInOrder(FinSepaOrder aSepaOrder)
Parameters
Type Name Description
FinSepaOrder aSepaOrder

The original SEPA credit transfer order that is referred by this Verification of Payee Opt-In request. This may be null.

FinVopVerificationOptInOrder(FinVopVerificationOptInBuilder, FinSepaOrder, FinSegment)

Declaration
public FinVopVerificationOptInOrder(FinVopVerificationOptInBuilder aBuilder, FinSepaOrder aSepaOrder, FinSegment aOrderSegment)
Parameters
Type Name Description
FinVopVerificationOptInBuilder aBuilder

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

The actual SEPA payment order for which this Verification of Payee Opt-In is sent. This may be null, however, for better Verification of Payee results, this should be included.
FinSegment aOrderSegment

Properties

PaymentStatusReport

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

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.

The preferred way to get the result for all Verification of Payee is to use the method Subsembly.FinTS.FinVopVerificationOrder.GetVopResult(), which works with all kinds of payments.

VopOption

Declaration
public override VopOption VopOption { get; }
Property Value
Type Description
VopOption
Overrides

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
int

Methods

InsertScrollRef(string)

Declaration
protected override bool InsertScrollRef(string sScrollRef)
Parameters
Type Name Description
string sScrollRef
Returns
Type Description
bool
Overrides

OnExecuteComplete(FinDialog)

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

ReadXml(XmlReader)

Declaration
public override void ReadXml(XmlReader aXmlReader)
Parameters
Type Name Description
XmlReader aXmlReader
Overrides

WriteXml(XmlWriter)

Declaration
public override void WriteXml(XmlWriter aXmlWriter)
Parameters
Type Name Description
XmlWriter aXmlWriter
Overrides