Class VopOriginalTransactionInformation
- Namespace
- Subsembly.Sepa.VerificationOfPayee
- Assembly
- Subsembly.Sepa.dll
Extensions for SepaOriginalTransactionInformation in order to support the German Verification of Payee implementation.
public static class VopOriginalTransactionInformation
- Inheritance
-
VopOriginalTransactionInformation
- Inherited Members
Methods
GetVopCloseMatchName(SepaOriginalTransactionInformation)
In case of a VoP status code RVMC, this provides the correct name of the account owner.
public static string GetVopCloseMatchName(this SepaOriginalTransactionInformation aTxInfAndSts)
Parameters
aTxInfAndStsSepaOriginalTransactionInformation
Returns
- string
If the VoP status code is not CloseMatch, then this method returns
null. Otherwise an attempt is made to extract to correct name from Subsembly.Sepa.SepaStatusReasonInformations.SepaStatusReasonInformations()[0]. AdditionalInformation.
Exceptions
- ArgumentNullException
The parameter
aTxInfAndStswasnull.
GetVopNotApplicableReasonCode(SepaOriginalTransactionInformation)
In case of a VoP status code RVNA, this provides the reason code.
public static VopNotApplicableReasonCode GetVopNotApplicableReasonCode(this SepaOriginalTransactionInformation aTxInfAndSts)
Parameters
aTxInfAndStsSepaOriginalTransactionInformation
Returns
- 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
- ArgumentNullException
The parameter
aTxInfAndStswasnull.
GetVopNotApplicableReasonText(SepaOriginalTransactionInformation)
In case of a VoP status code RVNA, and reason code AG03, this provides additional information for the reason code.
public static string GetVopNotApplicableReasonText(this SepaOriginalTransactionInformation aTxInfAndSts)
Parameters
aTxInfAndStsSepaOriginalTransactionInformation
Returns
Exceptions
GetVopStatusCode(SepaOriginalTransactionInformation)
The TransactionStatus converted to a VoP status code.
public static VopStatusCode GetVopStatusCode(this SepaOriginalTransactionInformation aTxInfAndSts)
Parameters
aTxInfAndStsSepaOriginalTransactionInformation
Returns
Remarks
If the TransactionStatus does not contain a valid VoP status code, then this method returns zero.
Exceptions
- ArgumentNullException
The parameter
aTxInfAndStswasnull.
GetVopTransactionResult(SepaOriginalTransactionInformation, SepaCreditTransferTransactionInformation)
public static VopTransactionResult GetVopTransactionResult(this SepaOriginalTransactionInformation aTxInfAndSts, SepaCreditTransferTransactionInformation aOrgnlTxnInf = null)
Parameters
aTxInfAndStsSepaOriginalTransactionInformationaOrgnlTxnInfSepaCreditTransferTransactionInformationIf 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
null, then only the information available in this SepaOriginalTransactionInformation will be returned in the VopTransactionResult.
Returns
Exceptions
SetVopStatusCode(SepaOriginalTransactionInformation, VopStatusCode)
Sets the TransactionStatus with the string value from a VopStatusCode.
public static void SetVopStatusCode(this SepaOriginalTransactionInformation aTxInfAndSts, VopStatusCode nStatusCode)
Parameters
aTxInfAndStsSepaOriginalTransactionInformationnStatusCodeVopStatusCode
Remarks
SetVopStatusCode(SepaOriginalTransactionInformation, VopStatusCode, string, VopNotApplicableReasonCode, string)
Sets the TransactionStatus with the string value from a VopStatusCode and an optional close match name.
public static void SetVopStatusCode(this SepaOriginalTransactionInformation aTxInfAndSts, VopStatusCode nStatusCode, string sCloseMatchName, VopNotApplicableReasonCode nNotApplicableReasonCode, string sNotApplicableReasonText)
Parameters
aTxInfAndStsSepaOriginalTransactionInformationnStatusCodeVopStatusCodesCloseMatchNamestringOptionally a close match name may be set together with the
nStatusCodeCloseMatch. If asCloseMatchNameis provided with another status, then an exception will be thrown. This may not be longer than VOP_CLOSEMATCHNAME_MAXLENGTH (209 characters).nNotApplicableReasonCodeVopNotApplicableReasonCodesNotApplicableReasonTextstringOptional additional information that further describes the reason why the Verification of Payee was not applicable. This should only be provided when
nNotApplicableReasonCodeis TransactionNotSupported. This may not be longer than VOP_NOTAPPLICABLEREASONTEXT_MAXLENGTH (105 characters).
Exceptions
- ArgumentNullException
The parameter
aTxInfAndStswasnull.