Class VopResult

Provides the details of the Verification of Payee result for a payment that may consist of one or more transactions.

Inheritance
object
VopResult
Inherited Members
Namespace: Subsembly.Sepa.VerificationOfPayee
Assembly: Subsembly.Sepa.dll
Syntax
public class VopResult

Properties

GroupStatusCode

The overall, combined status code for all individual TransactionResults.

Declaration
public VopGroupStatusCode GroupStatusCode { get; set; }
Property Value
Type Description
VopGroupStatusCode
Remarks

Persisted with JSON field name vopGroupStatus and the string value from ToString(VopGroupStatusCode).

HaveInformation

Indicates whether any information is available for the user.

Declaration
public bool HaveInformation { get; }
Property Value
Type Description
bool
Remarks

This is true whenever any of HaveNarrative, HaveStatusSummaries, or HaveTransactionResults, is true.

HaveNarrative

Indicates whether there is an explicitly set Narrative text available.

Declaration
public bool HaveNarrative { get; }
Property Value
Type Description
bool

HaveStatusSummaries

Indicates whether there are any StatusSummaries available.

Declaration
public bool HaveStatusSummaries { get; }
Property Value
Type Description
bool

HaveTransactionResults

Indicates whether there are any TransactionResults available.

Declaration
public bool HaveTransactionResults { get; }
Property Value
Type Description
bool

Narrative

An explicit narrative text that must be presented to the user for confirmation.

Declaration
public string Narrative { get; set; }
Property Value
Type Description
string
Remarks

This Narrative property is only set when the VoP result was provided through FinTS. It is never set, when this VopResult is solely created from a pain.002 document.

StatusCount

The total sum of all Count properties of all StatusSummaries.

Declaration
public int StatusCount { get; }
Property Value
Type Description
int

StatusSummaries

Provides the VopResultStatusCodeSummary for all status codes, for which a result was returned.

Declaration
public VopResultStatusCodeSummary[] StatusSummaries { get; }
Property Value
Type Description
VopResultStatusCodeSummary[]

TransactionResults

Provides the result for the individual transactions of a payment. If this is the result of a single payment, then the returned collection contains only a single entry.

Declaration
public VopTransactionResults TransactionResults { get; }
Property Value
Type Description
VopTransactionResults

Methods

FromJson(JsonObject)

Declaration
public static VopResult FromJson(JsonObject js)
Parameters
Type Name Description
JsonObject js
Returns
Type Description
VopResult

GetStatusCount(VopStatusCode)

Declaration
public int GetStatusCount(VopStatusCode nStatusCode)
Parameters
Type Name Description
VopStatusCode nStatusCode
Returns
Type Description
int

GetStatusSummary(VopStatusCode)

Gets the summary information for a specific status code.

Declaration
public VopResultStatusCodeSummary GetStatusSummary(VopStatusCode nStatusCode)
Parameters
Type Name Description
VopStatusCode nStatusCode
Returns
Type Description
VopResultStatusCodeSummary

SetStatusSummary(VopResultStatusCodeSummary)

Declaration
public void SetStatusSummary(VopResultStatusCodeSummary aSummary)
Parameters
Type Name Description
VopResultStatusCodeSummary aSummary

ToJson()

Declaration
public JsonObject ToJson()
Returns
Type Description
JsonObject