Class VopStatusCodeExtensions

Namespace
Subsembly.Sepa.VerificationOfPayee
Assembly
Subsembly.Sepa.dll

Extensions for converting VopStatusCode to/from strings and more.

public static class VopStatusCodeExtensions
Inheritance
VopStatusCodeExtensions
Inherited Members

Fields

PDNG

PDNG: Pending (Pending)

public const string PDNG = "PDNG"

Field Value

string

RCVC

RCVC: Received Verification Completed (Match)

public const string RCVC = "RCVC"

Field Value

string

RVMC

RVMC: Received Verification Completed Match Closely (CloseMatch)

public const string RVMC = "RVMC"

Field Value

string

RVNA

RVNA: Received Verification Completed Not Applicable (NotApplicable)

public const string RVNA = "RVNA"

Field Value

string

RVNM

RVNM: Received Verification Completed No Match (NoMatch)

public const string RVNM = "RVNM"

Field Value

string

Methods

FromString(string)

Converts a four letter VOP result code to the corresponding VopStatusCode enumeration value.

public static VopStatusCode FromString(string sCode)

Parameters

sCode string

The code to convert. If this is null or an empty string, then a zero enumeration value is returned.

Returns

VopStatusCode

The VopStatusCode enumeration value or zero.

Exceptions

ArgumentException

GetAllStatusCodes() 

public static VopStatusCode[] GetAllStatusCodes()

Returns

VopStatusCode[]

GetCaption(VopStatusCode)

Provides a short caption for the VopStatusCode that may be used in a table.

public static string GetCaption(VopStatusCode nCode)

Parameters

nCode VopStatusCode

Returns

string

GetDescription(VopStatusCode, string)

Provides a long human readable sentence that describes the status result.

public static string GetDescription(VopStatusCode nCode, string sCdtrName = null)

Parameters

nCode VopStatusCode
sCdtrName string

Optional corrected creditor name. This is usually available only when nCode is CloseMatch.

Returns

string

Exceptions

ArgumentException

IsValid(VopStatusCode)

Indicates whether nCode is a known Verification of Payee status value.

public static bool IsValid(VopStatusCode nCode)

Parameters

nCode VopStatusCode

Returns

bool

ToString(VopStatusCode)

Converts the VopStatusCode to its corresponding four letter code string.

public static string ToString(VopStatusCode nCode)

Parameters

nCode VopStatusCode

Returns

string

The four letter code string, or null if the given VopStatusCode was zero.

Exceptions

ArgumentException