LOC plug-in financial transactions

LOC plug-in financial transactions

Payment plug-ins can perform payment actions differently. The following table describes how the LOC plug-in performs financial transactions (payment actions). This information might be useful to plug-in writers who are modeling plug-ins after the LOC plug-in. In summary, the payment actions performed by the LOC plug-in involve checking the presence of data in the payment instruction.

Financial transaction Description
checkPaymentInstruction The plug-in checks to see if all of the required parameters for the specified payment instruction are present.
If the parameters are present, the checkPaymentInstruction transaction returns successfully. If one or more parameters are missing, the plug-in throws an invalid payment instruction exception.
validatePaymentInstruction The plug-in checks to see if all of the required parameters for the specified payment instruction are present.
If the parameters are present, the validatePaymentInstruction transaction returns successfully. If one or more parameters are missing, the plug-in throws an invalid payment instruction exception.
approve The plug-in receives the approve request and checks to see if all of the required parameters for the specified payment instruction are present.
If the parameters are present, the approve transaction returns successfully. The ReferenceNumber, ResponseCode, ReasonCode, and TrackingId are set in the financial transaction.
If one or more parameters are missing, the plug-in throws an invalid payment instruction exception.
If the LOC plug-in is extended to connect to an external accounts receivable system, the plug-in should connect to the accounts receivable system to check the active status and adjust the requested amount from the spending balance of the credit line. It should also process the response from the accounts receivable system and set this information in the financial transaction.
approveAndDeposit The plug-in receives the approveAndDeposit request and checks to see if all of the required parameters for the specified payment instruction are present.
If the parameters are present, the approveAndDeposit transaction returns successfully. The ReferenceNumber, ResponseCode, ReasonCode, and TrackingId are set in the financial transaction.
If one or more parameters are missing, the plug-in throws an invalid payment instruction exception.
If the LOC plug-in is extended to connect to an external accounts receivable system, the plug-in should connect to the accounts receivable system to check the active status and adjust the requested amount from the spending balance of the credit line. It should also process the response from the accounts receivable system and set this information in the financial transaction.
deposit The plug-in receives the deposit request and checks to see if all of the required parameters for the specified payment instruction are present.
If the parameters are present, the deposit transaction returns successfully. The ReferenceNumber, ResponseCode, ReasonCode, and TrackingId are set in the financial transaction.
If one or more parameters are missing, the plug-in throws an invalid payment instruction exception.
If the LOC plug-in is extended to connect to an external accounts receivable system, the plug-in should connect to the accounts receivable system to check the active status and adjust the requested amount from the spending balance of the credit line. It should also process the response from the accounts receivable system and set this information in the financial transaction.
credit The plug-in receives the credit request and checks to see if all of the required parameters for the specified payment instruction are present.
If the parameters are present, the credit transaction returns successfully. The ReferenceNumber, ResponseCode, ReasonCode, and TrackingId are set in the financial transaction.
If one or more parameters are missing, the plug-in throws an invalid payment instruction exception.
If the LOC plug-in is extended to connect to an external accounts receivable system, the plug-in should connect to the accounts receivable system to check the active status and adjust the requested amount from the spending balance of the credit line. It should also process the response from the accounts receivable system and set this information in the financial transaction.
The credit can be a dependent credit or independent credit transaction. For more information about dependent and independent credits, see the Payment plug-in specification.
reverseApproval The plug-in receives the reverseApproval request and checks to see if all of the required parameters for the specified payment instruction are present.
If the parameters are present, the reverseApproval transaction returns successfully. The ReferenceNumber, ResponseCode, ReasonCode, and TrackingId are set in the financial transaction.
If one or more parameters are missing, the plug-in throws an invalid payment instruction exception.
If the LOC plug-in is extended to connect to an external accounts receivable system, the plug-in should connect to the accounts receivable system to check the active status and adjust the requested amount from the spending balance of the credit line. It should also process the response from the accounts receivable system and set this information in the financial transaction.
reverseDeposit The plug-in receives the reverseDeposit request and checks to see if all of the required parameters for the specified payment instruction are present.
If the parameters are present, the reverseDeposit transaction returns successfully. The ReferenceNumber, ResponseCode, ReasonCode, and TrackingId are set in the financial transaction.
If one or more parameters are missing, the plug-in throws an invalid payment instruction exception.
If the LOC plug-in is extended to connect to an external accounts receivable system, the plug-in should connect to the accounts receivable system to check the active status and adjust the requested amount from the spending balance of the credit line. It should also process the response from the accounts receivable system and set this information in the financial transaction.
reverseCredit The plug-in receives the reverseCredit request and checks to see if all of the required parameters for the specified payment instruction are present.
If the parameters are present, the reverseCredit transaction returns successfully. The ReferenceNumber, ResponseCode, ReasonCode, and TrackingId are set in the financial transaction.
If one or more parameters are missing, the plug-in throws an invalid payment instruction exception.
If the LOC plug-in is extended to connect to an external accounts receivable system, the plug-in should connect to the accounts receivable system to check the active status and adjust the requested amount from the spending balance of the credit line. It should also process the response from the accounts receivable system and set this information in the financial transaction.
The credit can be a dependent credit or independent credit transaction.

Related concepts
Financial transactions
LOC (Line of credit) plug-in

Related tasks
Configure the LOC plug-in
Enable a credit line for a B2B store

Financial transaction	Description
checkPaymentInstruction	The plug-in checks to see if all of the required parameters for the specified payment instruction are present. If the parameters are present, the checkPaymentInstruction transaction returns successfully. If one or more parameters are missing, the plug-in throws an invalid payment instruction exception.
validatePaymentInstruction	The plug-in checks to see if all of the required parameters for the specified payment instruction are present. If the parameters are present, the validatePaymentInstruction transaction returns successfully. If one or more parameters are missing, the plug-in throws an invalid payment instruction exception.
approve	The plug-in receives the approve request and checks to see if all of the required parameters for the specified payment instruction are present. If the parameters are present, the approve transaction returns successfully. The ReferenceNumber, ResponseCode, ReasonCode, and TrackingId are set in the financial transaction. If one or more parameters are missing, the plug-in throws an invalid payment instruction exception. If the LOC plug-in is extended to connect to an external accounts receivable system, the plug-in should connect to the accounts receivable system to check the active status and adjust the requested amount from the spending balance of the credit line. It should also process the response from the accounts receivable system and set this information in the financial transaction.
approveAndDeposit	The plug-in receives the approveAndDeposit request and checks to see if all of the required parameters for the specified payment instruction are present. If the parameters are present, the approveAndDeposit transaction returns successfully. The ReferenceNumber, ResponseCode, ReasonCode, and TrackingId are set in the financial transaction. If one or more parameters are missing, the plug-in throws an invalid payment instruction exception. If the LOC plug-in is extended to connect to an external accounts receivable system, the plug-in should connect to the accounts receivable system to check the active status and adjust the requested amount from the spending balance of the credit line. It should also process the response from the accounts receivable system and set this information in the financial transaction.
deposit	The plug-in receives the deposit request and checks to see if all of the required parameters for the specified payment instruction are present. If the parameters are present, the deposit transaction returns successfully. The ReferenceNumber, ResponseCode, ReasonCode, and TrackingId are set in the financial transaction. If one or more parameters are missing, the plug-in throws an invalid payment instruction exception. If the LOC plug-in is extended to connect to an external accounts receivable system, the plug-in should connect to the accounts receivable system to check the active status and adjust the requested amount from the spending balance of the credit line. It should also process the response from the accounts receivable system and set this information in the financial transaction.
credit	The plug-in receives the credit request and checks to see if all of the required parameters for the specified payment instruction are present. If the parameters are present, the credit transaction returns successfully. The ReferenceNumber, ResponseCode, ReasonCode, and TrackingId are set in the financial transaction. If one or more parameters are missing, the plug-in throws an invalid payment instruction exception. If the LOC plug-in is extended to connect to an external accounts receivable system, the plug-in should connect to the accounts receivable system to check the active status and adjust the requested amount from the spending balance of the credit line. It should also process the response from the accounts receivable system and set this information in the financial transaction. The credit can be a dependent credit or independent credit transaction. For more information about dependent and independent credits, see the Payment plug-in specification.
reverseApproval	The plug-in receives the reverseApproval request and checks to see if all of the required parameters for the specified payment instruction are present. If the parameters are present, the reverseApproval transaction returns successfully. The ReferenceNumber, ResponseCode, ReasonCode, and TrackingId are set in the financial transaction. If one or more parameters are missing, the plug-in throws an invalid payment instruction exception. If the LOC plug-in is extended to connect to an external accounts receivable system, the plug-in should connect to the accounts receivable system to check the active status and adjust the requested amount from the spending balance of the credit line. It should also process the response from the accounts receivable system and set this information in the financial transaction.
reverseDeposit	The plug-in receives the reverseDeposit request and checks to see if all of the required parameters for the specified payment instruction are present. If the parameters are present, the reverseDeposit transaction returns successfully. The ReferenceNumber, ResponseCode, ReasonCode, and TrackingId are set in the financial transaction. If one or more parameters are missing, the plug-in throws an invalid payment instruction exception. If the LOC plug-in is extended to connect to an external accounts receivable system, the plug-in should connect to the accounts receivable system to check the active status and adjust the requested amount from the spending balance of the credit line. It should also process the response from the accounts receivable system and set this information in the financial transaction.
reverseCredit	The plug-in receives the reverseCredit request and checks to see if all of the required parameters for the specified payment instruction are present. If the parameters are present, the reverseCredit transaction returns successfully. The ReferenceNumber, ResponseCode, ReasonCode, and TrackingId are set in the financial transaction. If one or more parameters are missing, the plug-in throws an invalid payment instruction exception. If the LOC plug-in is extended to connect to an external accounts receivable system, the plug-in should connect to the accounts receivable system to check the active status and adjust the requested amount from the spending balance of the credit line. It should also process the response from the accounts receivable system and set this information in the financial transaction. The credit can be a dependent credit or independent credit transaction.