Class VopResult
- Namespace
- Subsembly.Sepa.VerificationOfPayee
- Assembly
- Subsembly.Sepa.dll
Provides the details of the Verification of Payee result for a payment that may consist of one or more transactions.
public class VopResult
- Inheritance
-
VopResult
- Inherited Members
Properties
GroupStatusCode
The overall, combined status code for all individual TransactionResults.
public VopGroupStatusCode GroupStatusCode { get; set; }
Property Value
Remarks
Persisted with JSON field name vopGroupStatus and the string value from
ToString(VopGroupStatusCode).
HaveInformation
Indicates whether any information is available for the user.
public bool HaveInformation { get; }
Property Value
Remarks
This is true whenever any of HaveNarrative,
HaveStatusSummaries, or HaveTransactionResults, is
true.
HaveNarrative
Indicates whether there is an explicitly set Narrative text available.
public bool HaveNarrative { get; }
Property Value
HaveStatusSummaries
Indicates whether there are any StatusSummaries available.
public bool HaveStatusSummaries { get; }
Property Value
HaveTransactionResults
Indicates whether there are any TransactionResults available.
public bool HaveTransactionResults { get; }
Property Value
Narrative
An explicit narrative text that must be presented to the user for confirmation.
public string Narrative { get; set; }
Property Value
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.
public int StatusCount { get; }
Property Value
StatusSummaries
Provides the VopResultStatusCodeSummary for all status codes, for which a result was returned.
public VopResultStatusCodeSummary[] StatusSummaries { get; }
Property Value
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.
public VopTransactionResults TransactionResults { get; }
Property Value
Methods
FromJson(JsonObject)
public static VopResult FromJson(JsonObject js)
Parameters
jsJsonObject
Returns
GetStatusCount(VopStatusCode)
public int GetStatusCount(VopStatusCode nStatusCode)
Parameters
nStatusCodeVopStatusCode
Returns
GetStatusSummary(VopStatusCode)
Gets the summary information for a specific status code.
public VopResultStatusCodeSummary GetStatusSummary(VopStatusCode nStatusCode)
Parameters
nStatusCodeVopStatusCode
Returns
SetStatusSummary(VopResultStatusCodeSummary)
public void SetStatusSummary(VopResultStatusCodeSummary aSummary)
Parameters
aSummaryVopResultStatusCodeSummary
ToJson()
public JsonObject ToJson()