Class FinVopVerificationOptInOrder

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

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

public sealed class FinVopVerificationOptInOrder : FinVopVerificationOrder
Inheritance
FinVopVerificationOptInOrder
Inherited Members

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.

public FinVopVerificationOptInOrder(FinSepaOrder aSepaOrder)

Parameters

aSepaOrder FinSepaOrder

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) 

public FinVopVerificationOptInOrder(FinVopVerificationOptInBuilder aBuilder, FinSepaOrder aSepaOrder, FinSegment aOrderSegment)

Parameters

aBuilder FinVopVerificationOptInBuilder

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

aSepaOrder FinSepaOrder

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.

aOrderSegment FinSegment

Properties

PaymentStatusReport 

public SepaPaymentStatusReport PaymentStatusReport { get; }

Property Value

SepaPaymentStatusReport

VerificationResult

Provides the verification result of a single payee verification.

public FinVopVerificationResult VerificationResult { get; }

Property Value

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 

public override VopOption VopOption { get; }

Property Value

VopOption

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.

public int WaitSeconds { get; }

Property Value

int

Methods

InsertScrollRef(string) 

protected override bool InsertScrollRef(string sScrollRef)

Parameters

sScrollRef string

Returns

bool

OnExecuteComplete(FinDialog) 

protected override void OnExecuteComplete(FinDialog aDialog)

Parameters

aDialog FinDialog

ReadXml(XmlReader) 

public override void ReadXml(XmlReader aXmlReader)

Parameters

aXmlReader XmlReader

WriteXml(XmlWriter) 

public override void WriteXml(XmlWriter aXmlWriter)

Parameters

aXmlWriter XmlWriter