Class VopOriginalTransactionInformation
Extensions for SepaOriginalTransactionInformation in order to support the German Verification of Payee implementation.
Inherited Members
Namespace: Subsembly.Sepa.VerificationOfPayee
Assembly: Subsembly.Sepa.dll
Syntax
public static class VopOriginalTransactionInformation
Methods
GetVopCloseMatchName(SepaOriginalTransactionInformation)
In case of a VoP status code RVMC, this provides the correct name of the account owner.
Declaration
public static string GetVopCloseMatchName(this SepaOriginalTransactionInformation aTxInfAndSts)
Parameters
Type | Name | Description |
---|---|---|
SepaOriginalTransactionInformation | aTxInfAndSts |
Returns
Type | Description |
---|---|
string | If the VoP status code is not CloseMatch, then this
method returns |
Exceptions
Type | Condition |
---|---|
ArgumentNullException | The parameter |
GetVopNotApplicableReasonCode(SepaOriginalTransactionInformation)
In case of a VoP status code RVNA, this provides the reason code.
Declaration
public static VopNotApplicableReasonCode GetVopNotApplicableReasonCode(this SepaOriginalTransactionInformation aTxInfAndSts)
Parameters
Type | Name | Description |
---|---|---|
SepaOriginalTransactionInformation | aTxInfAndSts |
Returns
Type | Description |
---|---|
VopNotApplicableReasonCode | If the VoP status code is not NotApplicable, then this method returns zero. Otherwise an attempt is made to extract to reason code from Subsembly.Sepa.SepaStatusReasonInformations.SepaStatusReasonInformations()[0]. |
Exceptions
Type | Condition |
---|---|
ArgumentNullException | The parameter |
GetVopNotApplicableReasonText(SepaOriginalTransactionInformation)
In case of a VoP status code RVNA, and reason code AG03, this provides additional information for the reason code.
Declaration
public static string GetVopNotApplicableReasonText(this SepaOriginalTransactionInformation aTxInfAndSts)
Parameters
Type | Name | Description |
---|---|---|
SepaOriginalTransactionInformation | aTxInfAndSts |
Returns
Type | Description |
---|---|
string |
Exceptions
Type | Condition |
---|---|
ArgumentNullException |
GetVopStatusCode(SepaOriginalTransactionInformation)
The TransactionStatus converted to a VoP status code.
Declaration
public static VopStatusCode GetVopStatusCode(this SepaOriginalTransactionInformation aTxInfAndSts)
Parameters
Type | Name | Description |
---|---|---|
SepaOriginalTransactionInformation | aTxInfAndSts |
Returns
Type | Description |
---|---|
VopStatusCode |
Remarks
If the TransactionStatus does not contain a valid VoP status code, then this method returns zero.
Exceptions
Type | Condition |
---|---|
ArgumentNullException | The parameter |
GetVopTransactionResult(SepaOriginalTransactionInformation, SepaCreditTransferTransactionInformation)
Declaration
public static VopTransactionResult GetVopTransactionResult(this SepaOriginalTransactionInformation aTxInfAndSts, SepaCreditTransferTransactionInformation aOrgnlTxnInf = null)
Parameters
Type | Name | Description |
---|---|---|
SepaOriginalTransactionInformation | aTxInfAndSts | |
SepaCreditTransferTransactionInformation | aOrgnlTxnInf | If the original transaction information for the transaction is available, then it
shall be passed in this parameter in order to augment the produced
VopTransactionResult with further transaction details, not available
in this SepaOriginalTransactionInformation. If this is |
Returns
Type | Description |
---|---|
VopTransactionResult |
Exceptions
Type | Condition |
---|---|
ArgumentNullException |
SetVopStatusCode(SepaOriginalTransactionInformation, VopStatusCode)
Sets the TransactionStatus with the string value from a VopStatusCode.
Declaration
public static void SetVopStatusCode(this SepaOriginalTransactionInformation aTxInfAndSts, VopStatusCode nStatusCode)
Parameters
Type | Name | Description |
---|---|---|
SepaOriginalTransactionInformation | aTxInfAndSts | |
VopStatusCode | nStatusCode |
Remarks
SetVopStatusCode(SepaOriginalTransactionInformation, VopStatusCode, string, VopNotApplicableReasonCode, string)
Sets the TransactionStatus with the string value from a VopStatusCode and an optional close match name.
Declaration
public static void SetVopStatusCode(this SepaOriginalTransactionInformation aTxInfAndSts, VopStatusCode nStatusCode, string sCloseMatchName, VopNotApplicableReasonCode nNotApplicableReasonCode, string sNotApplicableReasonText)
Parameters
Type | Name | Description |
---|---|---|
SepaOriginalTransactionInformation | aTxInfAndSts | |
VopStatusCode | nStatusCode | |
string | sCloseMatchName | Optionally a close match name may be set together with the |
VopNotApplicableReasonCode | nNotApplicableReasonCode | |
string | sNotApplicableReasonText | Optional additional information that further describes the reason why the
Verification of Payee was not applicable. This should only be provided
when |
Exceptions
Type | Condition |
---|---|
ArgumentNullException | The parameter |