Field Detail

• COPYRIGHT

  public static final java.lang.String COPYRIGHT
  

  The IBM copyright notice field.

  See Also:

  Constant Field Values

Constructor Detail

• PluginController

  public PluginController()
  

  This method is the constructor for PluginController.

Method Detail

• getMessage

  public java.lang.String getMessage(PaymentContext paymentContext,
                            java.lang.String paymentSystemName,
                            java.lang.String store,
                            java.lang.String messageKey)
                              throws InputException,
                                     BackendException,
                                     InternalException,
                                     ConfigException
  

  This method is the implementation of getMessage(PaymentContext, String, String, String).

  Specified by:

  getMessage in interface PaymentsInterface

  Parameters:

  paymentContext - The payment context to be used in this request.

  paymentSystemName - Identifies the payment system that will process the request.

  store - Identifies the store on which the request was processed.

  messageKey - The key to the message to be translated.

  Returns:

  Translated message text provided by the plugin, that explain the reason of the failure.

  Throws:

  InputException - This exception is thrown if invalid parameter(s) is(are) passed in; for example, null in a mandatory field.

  BackendException - This Exception is thrown if any dependent system fails: database, EJBs' container, backend system (CommunicationException).

  InternalException - This exception is thrown if an internal error is found; typically, NullPointerException, broken switch, logic error, and so on.

  ConfigException - This exception is thrown if a configuration problem is found; for example, if the target plug-in is misconfigured.

  See Also:

  PaymentsInterface.getMessage(PaymentContext, String, String, String)

• getPaymentInstruction

  public PaymentInstruction getPaymentInstruction(PaymentContext paymentContext,
                                         java.lang.String paymentInstruction_Id,
                                         java.lang.Boolean maskSensitiveData)
                                           throws InputException,
                                                  BackendException,
                                                  InternalException,
                                                  ConfigException
  

  This method is the implementation of getPaymentInstruction(PaymentContext, String, Boolean).

  Specified by:

  getPaymentInstruction in interface PaymentsInterface

  Parameters:

  paymentContext - The payment context to be used in this request.

  paymentInstruction_Id - PPC unique identifier of the payment instruction .

  maskSensitiveData - Indicates if sensitive protocol data should be masked.

  Returns:

  PaymentInstruction The requested PaymentInstruction with all of its persisted data.

  Throws:

  InputException - This exception is thrown if invalid parameter(s) is(are) passed in; for example, null in a mandatory field.\

  BackendException - This Exception is thrown if any dependent system fails: database, EJBs' container, backend system (CommunicationException).

  InternalException - This exception is thrown if an internal error is found; typically, NullPointerException, broken switch, logic error, and so on.

  ConfigException - This exception is thrown if a configuration problem is found; for example, if the target plug-in is misconfigured.

  See Also:

  PaymentsInterface.getPaymentInstruction(PaymentContext, String, Boolean)

• getRemainingValueOnPaymentInstruction

  public java.math.BigDecimal getRemainingValueOnPaymentInstruction(PaymentContext paymentContext,
                                                           PaymentInstruction paymentInstruction)
                                                             throws InputException,
                                                                    BackendException,
                                                                    InternalException,
                                                                    ConfigException
  

  This method is the implementation of getRemainingValueOnPaymentInstruction(PaymentContext, PaymentInstruction).

  Specified by:

  getRemainingValueOnPaymentInstruction in interface PaymentsInterface

  Parameters:

  paymentContext - The payment context to be used in this request.

  paymentInstruction - Value object that contains the data (typically the payment instruction id and account number) required to obtain the available balance .

  Returns:

  The available value on the specified Payment Instruction.

  Throws:

  InputException - This exception is thrown if invalid parameter(s) is(are) passed in; for example, null in a mandatory field.

  BackendException - This Exception is thrown if any dependent system fails: database, EJBs' container, backend system (CommunicationException).

  InternalException - This exception is thrown if an internal error is found; typically, NullPointerException, broken switch, logic error, and so on.

  ConfigException - This exception is thrown if a configuration problem is found; for example, if the target plug-in is misconfigured.

  See Also:

  PaymentsInterface.getRemainingValueOnPaymentInstruction(PaymentContext, PaymentInstruction)

• approve

  public Result approve(PaymentContext paymentContext,
               java.lang.String paymentId,
               java.math.BigDecimal amount)
                 throws InputException,
                        BackendException,
                        InternalException,
                        ConfigException
  

  This method is the implementation of approve(PaymentContext, String, BigDecimal).

  Specified by:

  approve in interface PaymentsInterface

  Parameters:

  paymentContext - The payment context to be used in this request.

  paymentId - The unique identifier of the Payment container.

  amount - The requested approval amount. PPC will verify that the amount is within the amount limits for this Payment . If the amount is zero or null, InvalidDataException will be thrown.

  Returns:

  The transaction result with the included Payment container value object.

  Users of this method: EDP.

  Throws:

  InputException - This exception is thrown if invalid parameter(s) is(are) passed in; for example, null in a mandatory field.

  BackendException - This Exception is thrown if any dependent system fails: database, EJBs' container, backend system (CommunicationException).

  InternalException - This exception is thrown if an internal error is found; typically, NullPointerException, broken switch, logic error, and so on.

  ConfigException - This exception is thrown if a configuration problem is found; for example, if the target plug-in is misconfigured.

  See Also:

  PaymentsInterface.approve(PaymentContext, String, BigDecimal)

• approveAndDeposit

  public Result approveAndDeposit(PaymentContext paymentContext,
                         java.lang.String paymentId,
                         java.math.BigDecimal amount)
                           throws InputException,
                                  BackendException,
                                  InternalException,
                                  ConfigException
  

  This method is the implementation of approveAndDeposit(PaymentContext, String, BigDecimal).

  Specified by:

  approveAndDeposit in interface PaymentsInterface

  Parameters:

  paymentContext - The payment context to be used in this request.

  paymentId - The unique identifier of the Payment container.

  amount - The requested approval and deposit amount. PPC will verify that the amount is within the amount limits for this Payment. If the amount is zero or null, InvalidDataException will be thrown.

  Returns:

  The transaction result

  Users of this method: EDP.

  Throws:

  InputException - This exception is thrown if invalid parameter(s) is(are) passed in; for example, null in a mandatory field.

  BackendException - This Exception is thrown if any dependent system fails: database, EJBs' container, backend system (CommunicationException).

  InternalException - This exception is thrown if an internal error is found; typically, NullPointerException, broken switch, logic error, and so on.

  ConfigException - This exception is thrown if a configuration problem is found; for example, if the target plug-in is misconfigured.

  See Also:

  PaymentsInterface.approveAndDeposit(PaymentContext, String, BigDecimal)

• checkPaymentInstruction

  public Result checkPaymentInstruction(PaymentContext paymentContext,
                               PaymentInstruction paymentInstruction)
                                 throws InputException,
                                        BackendException,
                                        InternalException,
                                        ConfigException
  

  This method is the implementation of checkPaymentInstruction(PaymentContext, PaymentInstruction).

  Specified by:

  checkPaymentInstruction in interface PaymentsInterface

  Parameters:

  paymentContext - The payment context to be used in this request.

  paymentInstruction - Contains the information and reference of PaymentInstruction.

  Returns:

  The verify result which includes a PaymentInstruction object with the verified information.

  Throws:

  InputException - This exception is thrown if invalid parameter(s) is(are) passed in; for example, null in a mandatory field.

  BackendException - This Exception is thrown if any dependent system fails: database, EJBs' container, backend system (CommunicationException).

  InternalException - This exception is thrown if an internal error is found; typically, NullPointerException, broken switch, logic error, and so on.

  ConfigException - This exception is thrown if a configuration problem is found; for example, if the target plug-in is misconfigured.

  See Also:

  PaymentsInterface.checkPaymentInstruction(PaymentContext, PaymentInstruction)

• closePaymentInstruction

  public void closePaymentInstruction(PaymentContext paymentContext,
                             java.lang.String paymentInstruction_Id)
                               throws InputException,
                                      BackendException,
                                      InternalException,
                                      ConfigException
  

  This method is the implementation of closePaymentInstruction(PaymentContext, String).

  Specified by:

  closePaymentInstruction in interface PaymentsInterface

  Parameters:

  paymentContext - The payment context to be used in this request.

  paymentInstruction_Id - PPC unique identifier of the payment instruction .

  Throws:

  InputException - This exception is thrown if invalid parameter(s) is(are) passed in; for example, null in a mandatory field.

  BackendException - This Exception is thrown if any dependent system fails: database, EJBs' container, backend system (CommunicationException).

  InternalException - This exception is thrown if an internal error is found; typically, NullPointerException, broken switch, logic error, and so on.

  ConfigException - This exception is thrown if a configuration problem is found; for example, if the target plug-in is misconfigured.

  See Also:

  PaymentsInterface.closePaymentInstruction(PaymentContext, String)

• createDependentCredit

  public Credit createDependentCredit(PaymentContext paymentContext,
                             java.lang.String paymentId,
                             java.math.BigDecimal amount)
                               throws InputException,
                                      BackendException,
                                      InternalException,
                                      ConfigException
  

  This method is the implementation of createDependentCredit(PaymentContext, String, BigDecimal).

  Specified by:

  createDependentCredit in interface PaymentsInterface

  Parameters:

  paymentContext - The payment context to be used in this request.

  paymentId - Unique identifier of the payment previously created.

  amount - The amount to be credited.

  Returns:

  Credit represent the newly created Credit associated the specified Payment. This Credit object will be use to execute any subsequent transaction. Valid payment actions are credit.

  Users of this method: none. This feature is not used yet.

  Throws:

  InputException - This exception is thrown if invalid parameter(s) is(are) passed in; for example, null in a mandatory field.

  BackendException - This Exception is thrown if any dependent system fails: database, EJBs' container, backend system (CommunicationException).

  InternalException - This exception is thrown if an internal error is found; typically, NullPointerException, broken switch, logic error, and so on.

  ConfigException - This exception is thrown if a configuration problem is found; for example, if the target plug-in is misconfigured.

  See Also:

  PaymentsInterface.createDependentCredit(PaymentContext, String, BigDecimal)

• createIndependentCredit

  public Credit createIndependentCredit(PaymentContext paymentContext,
                               java.lang.String paymentInstruction_Id,
                               java.math.BigDecimal amount)
                                 throws InputException,
                                        BackendException,
                                        InternalException,
                                        ConfigException
  

  This method is the implementation of createIndependentCredit(PaymentContext, String, BigDecimal).

  Specified by:

  createIndependentCredit in interface PaymentsInterface

  Parameters:

  paymentContext - The payment context to be used in this request.

  paymentInstruction_Id - PPC unique identifier of the payment instruction .

  amount - The amount to be credited.

  Returns:

  The newly created Credit associated the specified Payment Instruction. This Credit object will be use to execute any subsequent transaction. Valid payment actions are credit.

  Throws:

  InputException - This exception is thrown if invalid parameter(s) is(are) passed in; for example, null in a mandatory field.

  BackendException - This Exception is thrown if any dependent system fails: database, EJBs' container, backend system (CommunicationException).

  InternalException - This exception is thrown if an internal error is found; typically, NullPointerException, broken switch, logic error, and so on.

  ConfigException - This exception is thrown if a configuration problem is found; for example, if the target plug-in is misconfigured.

  See Also:

  PaymentsInterface.createIndependentCredit(PaymentContext, String, BigDecimal)

• createPayment

  public Payment createPayment(PaymentContext paymentContext,
                      java.lang.String paymentInstruction_Id,
                      java.math.BigDecimal amount)
                        throws InputException,
                               BackendException,
                               InternalException,
                               ConfigException
  

  This method is the implementation of createPayment(PaymentContext, String, BigDecimal).

  Specified by:

  createPayment in interface PaymentsInterface

  Parameters:

  paymentContext - The payment context to be used in this request.

  paymentInstruction_Id - PPC unique identifier of the payment instruction .

  amount - The amount to be approved.

  Returns:

  The newly created Payment associated the specified Payment Instruction. This Payment object will be use to execute any subsequent transaction. Valid payment actions are approve and approveAndDeposit.

  Throws:

  InputException - This exception is thrown if invalid parameter(s) is(are) passed in; for example, null in a mandatory field.

  BackendException - This Exception is thrown if any dependent system fails: database, EJBs' container, backend system (CommunicationException).

  InternalException - This exception is thrown if an internal error is found; typically, NullPointerException, broken switch, logic error, and so on.

  ConfigException - This exception is thrown if a configuration problem is found; for example, if the target plug-in is misconfigured.

  See Also:

  PaymentsInterface.createPayment(PaymentContext, String, BigDecimal)

• createPaymentInstruction

  public PaymentInstruction createPaymentInstruction(PaymentContext paymentContext,
                                            PaymentInstruction paymentInstruction)
                                              throws InputException,
                                                     BackendException,
                                                     InternalException,
                                                     ConfigException
  

  This method is the implementation of createPaymentInstruction(PaymentContext, PaymentInstruction).

  Specified by:

  createPaymentInstruction in interface PaymentsInterface

  Parameters:

  paymentContext - The payment context to be used in this request.

  paymentInstruction - The value object that contains the data requires to create a persistent Payment Instruction. Require parameters on PaymentInstruction during createPaymentInstruction()

                     storeId  represent the store to which the paymentInstruction belongs.
           paymentSystemName represents the payment system that will process the request and any subsequent request
           extendedData contains most of the payment method information.  The supported types are Integer, Long, BigDecimal, String, Binary (StringBuffer), Boolean.
           amount the maximum amount that this Payment Instruction will be good for.  PPC will allow Payments to be created up to this amount.
           currency currency use for the amount and all amount on any payment action.
                     
  

  Returns:

  PaymentInstruction On successful execution it will contain the requested information plus a unique identifier and time it was created.

  Throws:

  InputException - This exception is thrown if invalid parameter(s) is(are) passed in; for example, null in a mandatory field.

  BackendException - This Exception is thrown if any dependent system fails: database, EJBs' container, backend system (CommunicationException).

  InternalException - This exception is thrown if an internal error is found; typically, NullPointerException, broken switch, logic error, and so on.

  ConfigException - This exception is thrown if a configuration problem is found; for example, if the target plug-in is misconfigured.

  See Also:

  PaymentsInterface.createPaymentInstruction(PaymentContext, PaymentInstruction)

• credit

  public Result credit(PaymentContext paymentContext,
              java.lang.String creditId,
              java.math.BigDecimal amount)
                throws InputException,
                       BackendException,
                       InternalException,
                       ConfigException
  

  This method is the implementation of credit(PaymentContext, String, BigDecimal).

  Specified by:

  credit in interface PaymentsInterface

  Parameters:

  paymentContext - The payment context to be used in this request.

  creditId - Unique identifier for the PPC payment.

  amount - The requested amount to be credited. PPC will verify that the amount is within the allowed boundaries within the Payment or PaymentInstruction for a deposit action. If the amount is zero or null InvalidDataException will be thrown.

  Returns:

  The transaction result which includes the CREDITED Credit object. This Credit object can be use to execute subsequent reverseCredit transaction. On successful execution, the Credit will be in the CREDITED state and the associated Payment or PaymentInstruction will have a creditedAmount. On failed operation, the Credit state will be marked as STATE_FAILED, Off_line type plugins will place the Credit in STATE_CREDITING. If PPC receives PluginTimeOutException the Credit state will be STATE_CREDITING, the associated Payment or PaymentInstruction will have a creditingAmount.

  Users of this method: EDP.

  Throws:

  InputException - This exception is thrown if invalid parameter(s) is(are) passed in; for example, null in a mandatory field.

  BackendException - This Exception is thrown if any dependent system fails: database, EJBs' container, backend system (CommunicationException).

  InternalException - This exception is thrown if an internal error is found; typically, NullPointerException, broken switch, logic error, and so on.

  ConfigException - This exception is thrown if a configuration problem is found; for example, if the target plug-in is misconfigured.

  See Also:

  PaymentsInterface.credit(PaymentContext, String, BigDecimal)

• deletePaymentInstruction

  public void deletePaymentInstruction(PaymentContext paymentContext,
                              java.lang.String paymentInstruction_Id)
                                throws InputException,
                                       BackendException,
                                       InternalException,
                                       ConfigException
  

  This method is the implementation of deletePaymentInstruction(PaymentContext, String).

  Specified by:

  deletePaymentInstruction in interface PaymentsInterface

  Parameters:

  paymentContext - The payment context to be used in this request.

  paymentInstruction_Id - PPC unique identifier of the payment instruction .

  Throws:

  InputException - This exception is thrown if invalid parameter(s) is(are) passed in; for example, null in a mandatory field.

  BackendException - This Exception is thrown if any dependent system fails: database, EJBs' container, backend system (CommunicationException).

  InternalException - This exception is thrown if an internal error is found; typically, NullPointerException, broken switch, logic error, and so on.

  ConfigException - This exception is thrown if a configuration problem is found; for example, if the target plug-in is misconfigured.

  See Also:

  PaymentsInterface.deletePaymentInstruction(PaymentContext, String)

• deposit

  public Result deposit(PaymentContext paymentContext,
               java.lang.String paymentId,
               java.math.BigDecimal amount)
                 throws InputException,
                        BackendException,
                        InternalException,
                        ConfigException
  

  This method is the implementation of deposit(PaymentContext, String, BigDecimal).

  Specified by:

  deposit in interface PaymentsInterface

  Parameters:

  paymentContext - The payment context to be used in this request

  paymentId - The unique identifier of the Payment container

  amount - The requested deposit amount. PPC will verify that the amount is within the approved amount limits for this Payment. If the amount is zero or null, InvalidDataException will be thrown.

  Returns:

  The transaction result with the included Payment container value object

  Users of this method: EDP.

  Throws:

  InputException - This exception is thrown if invalid parameter(s) is(are) passed in; for example, null in a mandatory field.

  BackendException - This Exception is thrown if any dependent system fails: database, EJBs' container, backend system (CommunicationException).

  InternalException - This exception is thrown if an internal error is found; typically, NullPointerException, broken switch, logic error, and so on.

  ConfigException - This exception is thrown if a configuration problem is found; for example, if the target plug-in is misconfigured.

  See Also:

  PaymentsInterface.deposit(PaymentContext, String, BigDecimal)

• editCredit

  public Result editCredit(PaymentContext paymentContext,
                  Credit objCredit,
                  java.math.BigDecimal processAmount,
                  java.lang.String reasonCode,
                  java.lang.String responseCode,
                  java.lang.String referenceNumber,
                  ExtendedData extendedData)
                    throws InputException,
                           BackendException,
                           InternalException,
                           ConfigException
  

  This method is the implementation of editCredit(PaymentContext, Credit, BigDecimal, String, String, String, ExtendedData).

  Specified by:

  editCredit in interface PaymentsInterface

  Parameters:

  paymentContext - The payment context to be used in this request.

  objCredit - The credit.

  processAmount - The process amount.

  reasonCode - The reason code.

  responseCode - The response code.

  referenceNumber - The reference number.

  extendedData - The extended data.

  Returns:

  The transaction result for editting the credit.

  Throws:

  InputException - This exception is thrown if invalid parameter(s) is(are) passed in; for example, null in a mandatory field.

  BackendException - This Exception is thrown if any dependent system fails: database, EJBs' container, backend system (CommunicationException).

  InternalException - This exception is thrown if an internal error is found; typically, NullPointerException, broken switch, logic error, and so on.

  ConfigException - This exception is thrown if a configuration problem is found; for example, if the target plug-in is misconfigured.

  See Also:

  PaymentsInterface.editCredit(PaymentContext, Credit, BigDecimal, String, String, String, ExtendedData)

• editPayment

  public Result editPayment(PaymentContext paymentContext,
                   Payment payment,
                   java.math.BigDecimal processAmount,
                   java.lang.String reasonCode,
                   java.lang.String responseCode,
                   java.lang.String referenceNumber,
                   ExtendedData extendedData)
                     throws InputException,
                            BackendException,
                            InternalException,
                            ConfigException
  

  This method is the implementation of editPayment(PaymentContext, Payment, BigDecimal, String, String, String, ExtendedData).

  Specified by:

  editPayment in interface PaymentsInterface

  Parameters:

  paymentContext - The payment context to be used in this request.

  payment - The Payment VO.

  processAmount - Transaction process amount.

  reasonCode - Transaction reason code.

  responseCode - Transaction response code.

  referenceNumber - Transaction financial code.

  extendedData - Transaction extendedData.

  Returns:

  The transaction result for editting the payment.

  Throws:

  InputException - This exception is thrown if invalid parameter(s) is(are) passed in; for example, null in a mandatory field.

  BackendException - This Exception is thrown if any dependent system fails: database, EJBs' container, backend system (CommunicationException).

  InternalException - This exception is thrown if an internal error is found; typically, NullPointerException, broken switch, logic error, and so on.

  ConfigException - This exception is thrown if a configuration problem is found; for example, if the target plug-in is misconfigured.

  See Also:

  PaymentsInterface.editPayment(PaymentContext, Payment, BigDecimal, String, String, String, ExtendedData)

• editPaymentInstruction

  public Result editPaymentInstruction(PaymentContext paymentContext,
                              PaymentInstruction piWithNewValues)
                                throws InputException,
                                       BackendException,
                                       InternalException,
                                       ConfigException
  

  This method is the implementation of editPaymentInstruction(PaymentContext, PaymentInstruction).

  Specified by:

  editPaymentInstruction in interface PaymentsInterface

  Parameters:

  paymentContext - The payment context to be used in this request

  piWithNewValues - The value object that contains the data which requires to be updated on the persistent Payment Instruction.

                          Required parameters on PaymentInstruction value object during editPaymentInstruction
                   id           unique identifier for the paymentInstruction within PPC
               Optional parameters on PaymentInstruction value object during editPaymentInstruction
                   amount       in case that the amount used on this PaymentInstruction needs to be updated.
                   currency     in case that the currency has to be changed.  PPC will allow this change as
                                 long as no Payment/Credit object is created for this PaymentInstruction
                   extendedData if any information related to the specified Payment Instruction has changed.  PPC will not
                                 allow this information to be updated if there is a payment that has been approved using
                                 this information.
                                  
  

  Returns:

  The edit result which includes a PaymentInstruction object with the updated information.

  Throws:

  InputException - This exception is thrown if invalid parameter(s) is(are) passed in; for example, null in a mandatory field.

  BackendException - This Exception is thrown if any dependent system fails: database, EJBs' container, backend system (CommunicationException).

  InternalException - This exception is thrown if an internal error is found; typically, NullPointerException, broken switch, logic error, and so on.

  ConfigException - This exception is thrown if a configuration problem is found; for example, if the target plug-in is misconfigured.

  See Also:

  PaymentsInterface.editPaymentInstruction(PaymentContext, PaymentInstruction)

• reverseApproval

  public Result reverseApproval(PaymentContext paymentContext,
                       java.lang.String paymentId,
                       java.math.BigDecimal amount)
                         throws InputException,
                                BackendException,
                                InternalException,
                                ConfigException
  

  This method is the implementation of reverseApproval(PaymentContext, String, BigDecimal).

  Specified by:

  reverseApproval in interface PaymentsInterface

  Parameters:

  paymentContext - The payment context to be used in this request

  paymentId - Unique identifier for the paymentInstruction within PPC

  amount - The requested reverseApproval amount. if zero or null, the full approvedAmount will be reversed.

  Returns:

  The transaction result which includes a Payment with an adjusted approvedAmount. If the adjusted approvedAmount is zero, The Payment state will be in STATE_CANCELED. This Payment object will be used to execute any subsequent transaction (Deposit, reverseDeposit) up to the adjusted approvedAmount. On successful execution the Payment Transaction Payment approvedAmount will be decrease by the requested amount. On failed operation the Payment Transaction the Payment object approvedAmount will not be decreased. If PPC receives a PluginTimeOutException the Payment object will contain a reversingApprovalAmount that includes the requested amount.

  Users of this method: EDP.

  Throws:

  InputException - This exception is thrown if invalid parameter(s) is(are) passed in; for example, null in a mandatory field.

  BackendException - This Exception is thrown if any dependent system fails: database, EJBs' container, backend system (CommunicationException).

  InternalException - This exception is thrown if an internal error is found; typically, NullPointerException, broken switch, logic error, and so on.

  ConfigException - This exception is thrown if a configuration problem is found; for example, if the target plug-in is misconfigured.

  See Also:

  PaymentsInterface.reverseApproval(PaymentContext, String, BigDecimal)

• reverseCredit

  public Result reverseCredit(PaymentContext paymentContext,
                     java.lang.String creditId,
                     java.math.BigDecimal amount)
                       throws InputException,
                              BackendException,
                              InternalException,
                              ConfigException
  

  This method is the implementation of reverseCredit(PaymentContext, String, BigDecimal).

  Specified by:

  reverseCredit in interface PaymentsInterface

  Parameters:

  paymentContext - The payment context to be used in this request

  creditId - Unique identifier for the credit within PPC

  amount - The requested reverseCredit amount.

  Returns:

  The transaction result which includes a Credit object with the updated creditedAmount

  Throws:

  InputException - This exception is thrown if invalid parameter(s) is(are) passed in; for example, null in a mandatory field.

  BackendException - This Exception is thrown if any dependent system fails: database, EJBs' container, backend system (CommunicationException).

  InternalException - This exception is thrown if an internal error is found; typically, NullPointerException, broken switch, logic error, and so on.

  ConfigException - This exception is thrown if a configuration problem is found; for example, if the target plug-in is misconfigured.

  See Also:

  PaymentsInterface.reverseCredit(PaymentContext, String, BigDecimal)

• getMerchant

  public java.util.Collection getMerchant(java.lang.String name,
                                 java.lang.Long memberId)
                                   throws InvalidDataException,
                                          InternalException,
                                          java.rmi.RemoteException
  

  This method is This method gets all merchants with the specific attributes.

  Specified by:

  getMerchant in interface PaymentsAdminInterface

  Parameters:

  name - A String that specifies the current name.

  memberId - A Long that represents the owner of the merchant.

  Returns:

  A Collection that contains all merchants with the specific attributes.

  Throws:

  InvalidDataException - This exception is thrown if the some parameters are invalid .

  InternalException - This exception is thrown if EJB error occurs.

  java.rmi.RemoteException - This is Remote exception.

• reverseDeposit

  public Result reverseDeposit(PaymentContext paymentContext,
                      java.lang.String paymentId,
                      java.math.BigDecimal amount)
                        throws InputException,
                               BackendException,
                               InternalException,
                               ConfigException
  

  This method is the implementation of reverseDeposit(PaymentContext, String, BigDecimal).

  Specified by:

  reverseDeposit in interface PaymentsInterface

  Parameters:

  paymentContext - The payment context to be used in this request

  paymentId - Unique identifier for the payment within PPC

  amount - The requested reverse amount . The amount has to be equal to one of the previously deposited Payment during or close to the same day.

  Returns:

  The transaction result which includes the Payment with an adjusted depositedAmount. This Payment object will be use to execute any subsequent transaction (Deposit, reverseDeposit, dependent Credit) up to the adjusted depositedAmount. On successful execution, the Payment depositedAmount will be decrease by the requested amount. On failed operation, the Payment object depositedAmount will not be decreased. If PPC receives a PluginTimeOutException the Payment object will contain a reversingDepositedAmount that includes the requested amount.

  Throws:

  InputException - This exception is thrown if invalid parameter(s) is(are) passed in; for example, null in a mandatory field.

  BackendException - This Exception is thrown if any dependent system fails: database, EJBs' container, backend system (CommunicationException).

  InternalException - This exception is thrown if an internal error is found; typically, NullPointerException, broken switch, logic error, and so on.

  ConfigException - This exception is thrown if a configuration problem is found; for example, if the target plug-in is misconfigured.

  See Also:

  PaymentsInterface.reverseDeposit(PaymentContext, String, BigDecimal)

• validatePaymentInstruction

  public Result validatePaymentInstruction(PaymentContext paymentContext,
                                  PaymentInstruction paymentInstruction)
                                    throws InputException,
                                           BackendException,
                                           InternalException,
                                           ConfigException
  

  This method is the implementation of validatePaymentInstruction(PaymentContext, PaymentInstruction).

  Specified by:

  validatePaymentInstruction in interface PaymentsInterface

  Parameters:

  paymentContext - The payment context to be used in this request.

  paymentInstruction - Contains the information and reference of PaymentInstruction.

  Returns:

  The validation result which includes a PaymentInstruction object with the validated information.

  Throws:

  InputException - This exception is thrown if invalid parameter(s) is(are) passed in; for example, null in a mandatory field.

  BackendException - This Exception is thrown if any dependent system fails: database, EJBs' container, backend system (CommunicationException).

  InternalException - This exception is thrown if an internal error is found; typically, NullPointerException, broken switch, logic error, and so on.

  ConfigException - This exception is thrown if a configuration problem is found; for example, if the target plug-in is misconfigured.

  See Also:

  PaymentsInterface.validatePaymentInstruction(PaymentContext, PaymentInstruction)

• getCredit

  public Credit getCredit(PaymentContext paymentContext,
                 java.lang.String creditId)
                   throws InputException,
                          BackendException,
                          InternalException,
                          ConfigException
  

  This method is the implementation of getCredit(PaymentContext, String).

  Specified by:

  getCredit in interface PaymentsInterface

  Parameters:

  paymentContext - The payment context to be used in this request.

  creditId - Unique identifier of the credit within PPC.

  Returns:

  The credit value object if found, null otherwise.

  Throws:

  InputException - This exception is thrown if invalid parameter(s) is(are) passed in; for example, null in a mandatory field.

  BackendException - This Exception is thrown if any dependent system fails: database, EJBs' container, backend system (CommunicationException).

  InternalException - This exception is thrown if an internal error is found; typically, NullPointerException, broken switch, logic error, and so on.

  ConfigException - This exception is thrown if a configuration problem is found; for example, if the target plug-in is misconfigured.

  See Also:

  PaymentsInterface.getCredit(PaymentContext, String)

• getPayment

  public Payment getPayment(PaymentContext paymentContext,
                   java.lang.String paymentId)
                     throws InputException,
                            BackendException,
                            InternalException,
                            ConfigException
  

  This method is the implementation of getPayment(PaymentContext, String).

  Specified by:

  getPayment in interface PaymentsInterface

  Parameters:

  paymentContext - The payment context to be used in this request.

  paymentId - Unique identifier for the requested payment.

  Returns:

  The Payment with the specific paymentId.

  Throws:

  InputException - This exception is thrown if invalid parameter(s) is(are) passed in; for example, null in a mandatory field.

  BackendException - This Exception is thrown if any dependent system fails: database, EJBs' container, backend system (CommunicationException).

  InternalException - This exception is thrown if an internal error is found; typically, NullPointerException, broken switch, logic error, and so on.

  ConfigException - This exception is thrown if a configuration problem is found; for example, if the target plug-in is misconfigured.

  See Also:

  PaymentsInterface.getPayment(PaymentContext, String)

• createMerchant

  public com.ibm.commerce.payments.plugincontroller.beans.MerchantAccessBean createMerchant(java.lang.String merchantName,
                                                                                   java.lang.Long memberId)
                                                                                     throws InvalidDataException,
                                                                                            InternalException,
                                                                                            java.rmi.RemoteException
  

  This method creates a merchant in WebSphere Commerce, which represents the payment perspective for a store. Since here the state is not included in the parameter list, the merchant is created with state 1 default.

  Specified by:

  createMerchant in interface PaymentsAdminInterface

  Parameters:

  merchantName - A String that specifies the current merchant name.

  memberId - A Long that specifies the owner of the new merchant.

  Returns:

  The merchant

  Throws:

  InvalidDataException - This exception is thrown when some parameters are invalid.

  InternalException - This exception is thrown when EJB error occurs.

  java.rmi.RemoteException - Remote exception.

• createMerchant

  public com.ibm.commerce.payments.plugincontroller.beans.MerchantAccessBean createMerchant(java.lang.String merchantName,
                                                                                   java.lang.Long memberId,
                                                                                   java.lang.Boolean state)
                                                                                     throws InvalidDataException,
                                                                                            InternalException,
                                                                                            java.rmi.RemoteException
  

  This method creates a merchant in WebSphere Commerce, which represents the payment perspective for a store.

  Specified by:

  createMerchant in interface PaymentsAdminInterface

  Parameters:

  merchantName - A String that specifies the current merchant name.

  memberId - A Long that specifies the owner of the new merchant.

  state - A Boolean indicating the state of the merchant.

  Returns:

  The merchant

  Throws:

  InvalidDataException - This exception is thrown when some parameters are invalid.

  InternalException - This exception is thrown when EJB error occurs.

  java.rmi.RemoteException - Remote exception.

• createMerchantConf

  public com.ibm.commerce.payments.plugincontroller.beans.MerchantConfAccessBean createMerchantConf(java.lang.Long merchantId,
                                                                                           java.lang.String paymentSystemName,
                                                                                           java.lang.String paymentConfigurationGroup)
                                                                                             throws InvalidDataException,
                                                                                                    InternalException,
                                                                                                    java.rmi.RemoteException
  

  This method creates a merchant configuration which means for a specific merchant, which payment system and payment configuration group are used.

  Specified by:

  createMerchantConf in interface PaymentsAdminInterface

  Parameters:

  merchantId - A Long that specifies the merchant id this merchant configuration belongs to.

  paymentSystemName - A String that specifies the current payment system name.

  paymentConfigurationGroup - A String that specifies the current payment configuration group.

  Returns:

  The merchant configuration.

  Throws:

  InvalidDataException - This exception is thrown when some parameters are invalid.

  InternalException - This exception is thrown when EJB error occurs.

  java.rmi.RemoteException - Remote exception.

• mapStoreMerchant

  public com.ibm.commerce.payments.plugincontroller.beans.StoreMerchantAccessBean mapStoreMerchant(java.lang.Integer storeId,
                                                                                          java.lang.Long merchantId)
                                                                                            throws InvalidDataException,
                                                                                                   InternalException,
                                                                                                   java.rmi.RemoteException
  

  This method creates the association between the store and the merchant.

  Specified by:

  mapStoreMerchant in interface PaymentsAdminInterface

  Parameters:

  storeId - An Integer that specifies the current store id.

  merchantId - A Long that specifies the current merchant id.

  Returns:

  A StoreMerchantAccessBean that represents the store merchant.

  Throws:

  InvalidDataException - This exception is thrown when some parameters are invalid.

  InternalException - This exception is thrown when EJB error occurs.

  java.rmi.RemoteException - Remote exception.

• putMerchantConfInfo

  public void putMerchantConfInfo(java.lang.Long merchConfId,
                         java.util.Hashtable properties)
                           throws InvalidDataException,
                                  InternalException,
                                  java.rmi.RemoteException,
                                  ConfigException
  

  This method creates the properties for the specific merchant configuration id by taking a hashtable as input.

  Specified by:

  putMerchantConfInfo in interface PaymentsAdminInterface

  Parameters:

  merchConfId - A Long that specifies the merchant configuration id that the merchant configuration information belongs to.

  properties - A Hashtable that contains the properties that will be put into the database.

  Throws:

  InvalidDataException - This exception is thrown when some parameters are invalid.

  InternalException - This exception is thrown when EJB error occurs.

  java.rmi.RemoteException - Remote exception.

  ConfigException - Configuration exception.

• putMerchantConfInfo

  public com.ibm.commerce.payments.plugincontroller.beans.MerchantConfInfoAccessBean putMerchantConfInfo(java.lang.Long merchConfId,
                                                                                                java.lang.String name,
                                                                                                java.lang.String value,
                                                                                                boolean encrypted)
                                                                                                  throws InvalidDataException,
                                                                                                         InternalException,
                                                                                                         java.rmi.RemoteException
  

  This method creates a property for the specific merchant configuration id. The value of this property should be encrypted configured in a single XML file. The XML file specifies which property should be encrypted according to the property name.

  Specified by:

  putMerchantConfInfo in interface PaymentsAdminInterface

  Parameters:

  merchConfId - A Long that specifies the merchant configuration id that the merchant configuration information belongs to.

  name - A String that specifies the property name.

  value - A String that specifies the property value.

  encrypted - A String boolean indicating if the property needs encrypt.

  Returns:

  The merchant configuration information

  Throws:

  InvalidDataException - This exception is thrown when some parameters are invalid.

  InternalException - This exception is thrown when EJB error occurs.

  java.rmi.RemoteException - Remote exception.

• editStoreMerchant

  public void editStoreMerchant(java.lang.Integer storeId,
                       java.lang.Long merchantId)
                         throws InvalidDataException,
                                InternalException,
                                java.rmi.RemoteException
  

  This method edits the association between the store and the merchant, which updates the store to be mapped to another merchant with merchantId.

  Specified by:

  editStoreMerchant in interface PaymentsAdminInterface

  Parameters:

  storeId - An Integer that specifies the current store id.

  merchantId - The new merchant id that will be associated with current store.

  Throws:

  InvalidDataException - The invalid data exception.

  InternalException - The internal exception.

  java.rmi.RemoteException - The remote exception.

• editMerchantConfInfo

  public void editMerchantConfInfo(java.lang.Long merchConfId,
                          java.lang.String name,
                          java.lang.String value,
                          boolean encrypted)
                            throws InvalidDataException,
                                   InternalException,
                                   java.rmi.RemoteException
  

  This method edits the property value with specific name to a new value of the merchant configuration.

  Specified by:

  editMerchantConfInfo in interface PaymentsAdminInterface

  Parameters:

  merchConfId - A Long that specifies the current merchant configuration id the property with name belongs to.

  name - A String that specifies the property name.

  value - A Sting that specifies the new value of this property with name.

  encrypted - A boolean that indicating if the property needs encrypt.

  Throws:

  InvalidDataException - This exception is thrown when some parameters are invalid.

  InternalException - This exception is thrown when EJB error occurs.

  java.rmi.RemoteException - Remote exception.

• editMerchantConfInfo

  public void editMerchantConfInfo(java.lang.Long merchConfId,
                          java.util.Hashtable properties)
                            throws InvalidDataException,
                                   InternalException,
                                   java.rmi.RemoteException,
                                   ConfigException
  

  This method edits the properties for the specific merchant configuration id.

  Specified by:

  editMerchantConfInfo in interface PaymentsAdminInterface

  Parameters:

  merchConfId - A Long that specifies the current merchant configuration id the properties in the hashtable belongs to.

  properties - A Hashtable that contains the properties to be updated with new values.

  Throws:

  InvalidDataException - This exception is thrown when some parameters are invalid.

  InternalException - This exception is thrown when EJB error occurs.

  java.rmi.RemoteException - Remote exception.

  ConfigException - Configuration exception

• deleteMerchant

  public void deleteMerchant(java.lang.Long merchantId)
                      throws InvalidDataException,
                             InternalException,
                             java.rmi.RemoteException
  

  This method deletes the specific merchant with merchant id.

  Specified by:

  deleteMerchant in interface PaymentsAdminInterface

  Parameters:

  merchantId - A Long that specifies the current merchant id.

  Throws:

  InvalidDataException - This exception is thrown when some parameters are invalid.

  InternalException - This exception is thrown when EJB error occurs.

  java.rmi.RemoteException - Remote exception.

• deleteStoreMerchant

  public void deleteStoreMerchant(java.lang.Integer storeId)
                           throws InvalidDataException,
                                  InternalException,
                                  java.rmi.RemoteException
  

  This method deletes the association between the store and the merchant.

  Specified by:

  deleteStoreMerchant in interface PaymentsAdminInterface

  Parameters:

  storeId - An Integer that specifies the current store id.

  Throws:

  InvalidDataException - This exception is thrown when some parameters are invalid.

  InternalException - This exception is thrown when EJB error occurs.

  java.rmi.RemoteException - Remote exception.

• deleteMerchantConf

  public void deleteMerchantConf(java.lang.Long merchConfId)
                          throws InvalidDataException,
                                 InternalException,
                                 java.rmi.RemoteException
  

  This method deletes the merchant configuration with merchant configuration id.

  Specified by:

  deleteMerchantConf in interface PaymentsAdminInterface

  Parameters:

  merchConfId - A Long that specifies the current merchant configuration id.

  Throws:

  InvalidDataException - This exception is thrown when some parameters are invalid.

  InternalException - This exception is thrown when EJB error occurs.

  java.rmi.RemoteException - Remote exception.

• deleteMerchantConfInfo

  public void deleteMerchantConfInfo(java.lang.Long merchConfId,
                            java.lang.String name)
                              throws InvalidDataException,
                                     InternalException,
                                     java.rmi.RemoteException
  

  This method deletes the specific property with name for the merchant configuration.

  Specified by:

  deleteMerchantConfInfo in interface PaymentsAdminInterface

  Parameters:

  merchConfId - A Long that specifies the current merchant configuration id the property belongs to.

  name - A String that specifies the current property name.

  Throws:

  InvalidDataException - Invalid data exception..

  InternalException - Internal exception.

  java.rmi.RemoteException - Remote exception.

• deleteMerchantConfInfo

  public void deleteMerchantConfInfo(java.lang.Long merchConfId)
                              throws InvalidDataException,
                                     InternalException,
                                     java.rmi.RemoteException
  

  This method deletes all properties for the merchant configuration.

  Specified by:

  deleteMerchantConfInfo in interface PaymentsAdminInterface

  Parameters:

  merchConfId - A Long that specifies the current merchant configuration id.

  Throws:

  InvalidDataException - This exception is thrown when some parameters are invalid.

  InternalException - This exception is thrown when EJB error occurs.

  java.rmi.RemoteException - Remote exception.

• deleteMerchantConfInfo

  public void deleteMerchantConfInfo(java.lang.Long merchConfId,
                            java.util.ArrayList properties)
                              throws InvalidDataException,
                                     InternalException,
                                     java.rmi.RemoteException
  

  This method deletes all properties in the array list for the merchant configuration.

  Specified by:

  deleteMerchantConfInfo in interface PaymentsAdminInterface

  Parameters:

  merchConfId - A Long that specifies the current merchant configuration id the properties belong to.

  properties - An ArrayList that represents the properties need to be deleted.

  Throws:

  InvalidDataException - This exception is thrown when some parameters are invalid.

  InternalException - This exception is thrown when EJB error occurs.

  java.rmi.RemoteException - Remote exception.

• getMerchantById

  public com.ibm.commerce.payments.plugincontroller.beans.MerchantAccessBean getMerchantById(java.lang.Long merchantId)
                                                                                      throws InvalidDataException,
                                                                                             InternalException,
                                                                                             java.rmi.RemoteException
  

  This method gets the merchant with specific merchant id.

  Specified by:

  getMerchantById in interface PaymentsAdminInterface

  Parameters:

  merchantId - A Long that specifies the current merchant id.

  Returns:

  MerchantAccessBean The merchant access bean with merchantId.

  Throws:

  InvalidDataException - This exception is thrown when some parameters are invalid.

  InternalException - This exception is thrown when EJB error occurs.

  java.rmi.RemoteException - Remote exception.

• getStoreMerchantByStoreId

  public com.ibm.commerce.payments.plugincontroller.beans.StoreMerchantAccessBean getStoreMerchantByStoreId(java.lang.Integer storeId)
                                                                                                     throws InvalidDataException,
                                                                                                            InternalException,
                                                                                                            java.rmi.RemoteException
  

  This method gets the association between store and merchant with the specific store id.

  Specified by:

  getStoreMerchantByStoreId in interface PaymentsAdminInterface

  Parameters:

  storeId - An Integer that specifies the current store id.

  Returns:

  The association between store and merchant.

  Throws:

  InvalidDataException - This exception is thrown when some parameters are invalid.

  InternalException - This exception is thrown when EJB error occurs.

  java.rmi.RemoteException - Remote exception.

• getStoreMerchantByMerchantId

  public java.util.Collection getStoreMerchantByMerchantId(java.lang.Long merchantId)
                                                    throws InvalidDataException,
                                                           InternalException,
                                                           java.rmi.RemoteException
  

  This method gets all association with current merchant id.

  Specified by:

  getStoreMerchantByMerchantId in interface PaymentsAdminInterface

  Parameters:

  merchantId - A Long that specifies the current merchant id.

  Returns:

  All association with merhcantId

  Throws:

  InvalidDataException - This exception is thrown when some parameters are invalid.

  InternalException - This exception is thrown when EJB error occurs.

  java.rmi.RemoteException - Remote exception.

• getMerchantConfById

  public com.ibm.commerce.payments.plugincontroller.beans.MerchantConfAccessBean getMerchantConfById(java.lang.Long merchantConfId)
                                                                                              throws InvalidDataException,
                                                                                                     InternalException,
                                                                                                     java.rmi.RemoteException
  

  This method gets the merchant configuration with merchant configuration id.

  Specified by:

  getMerchantConfById in interface PaymentsAdminInterface

  Parameters:

  merchantConfId - A Long that specifies the current merchant configuration id.

  Returns:

  The current merchant configuration with merchant configuration id

  Throws:

  InvalidDataException - This exception is thrown when some parameters are invalid.

  InternalException - This exception is thrown when EJB error occurs.

  java.rmi.RemoteException - Remote exception.

• getMerchantConf

  public java.util.Collection getMerchantConf(java.lang.Long merchantId)
                                       throws InvalidDataException,
                                              InternalException,
                                              java.rmi.RemoteException
  

  This method gets all merchant configurations according to the input parameters.

  Specified by:

  getMerchantConf in interface PaymentsAdminInterface

  Parameters:

  merchantId - A Long that specifies the current merchant id.

  Returns:

  ArrayList All merchant configurations with merchantId

  Throws:

  InvalidDataException - This exception is thrown when some parameters are invalid.

  InternalException - This exception is thrown when EJB error occurs.

  java.rmi.RemoteException - Remote exception.

• getMerchantConf

  public java.util.Collection getMerchantConf(java.lang.Long merchantId,
                                     java.lang.String paymentSystemName,
                                     java.lang.String paymentConfigurationGroup)
                                       throws InvalidDataException,
                                              InternalException,
                                              java.rmi.RemoteException
  

  This method gets all merchant configurations with the specific merchant id.

  Specified by:

  getMerchantConf in interface PaymentsAdminInterface

  Parameters:

  merchantId - A Long that specifies the current merchant id.

  paymentSystemName -

  paymentConfigurationGroup -

  Returns:

  ArrayList All merchant configurations with merchantId

  Throws:

  InvalidDataException - This exception is thrown when some parameters are invalid.

  InternalException - This exception is thrown when EJB error occurs.

  java.rmi.RemoteException - Remote exception.

• getMerchantConfInfoById

  public com.ibm.commerce.payments.plugincontroller.beans.MerchantConfInfoAccessBean getMerchantConfInfoById(java.lang.Long merchantConfInfoId)
                                                                                                      throws InvalidDataException,
                                                                                                             InternalException,
                                                                                                             java.rmi.RemoteException
  

  This method gets the merchant configuration information according to the merchant configuration information id.

  Specified by:

  getMerchantConfInfoById in interface PaymentsAdminInterface

  Parameters:

  merchantConfInfoId - The current merchant configuration information id

  Returns:

  The current merchant configuration information with merchantConfInfoId

  Throws:

  InvalidDataException - This exception is thrown when some parameters are invalid.

  InternalException - This exception is thrown when EJB error occurs.

  java.rmi.RemoteException - Remote exception.

• getMerchantConfInfo

  public java.util.Collection getMerchantConfInfo(java.lang.Long merchConfId)
                                           throws InvalidDataException,
                                                  InternalException,
                                                  java.rmi.RemoteException
  

  This method gets all merchant configuration information according to the input parameter.

  Specified by:

  getMerchantConfInfo in interface PaymentsAdminInterface

  Parameters:

  merchConfId - A Long that specifies the current merchant configuration id.

  Returns:

  All merchant configuration information with merchantConfId

  Throws:

  InvalidDataException - This exception is thrown when some parameters are invalid.

  InternalException - This exception is thrown when EJB error occurs.

  java.rmi.RemoteException - Remote exception.

• getMerchantConfInfo

  public java.util.Collection getMerchantConfInfo(java.lang.Long merchConfId,
                                         java.lang.String name)
                                           throws InvalidDataException,
                                                  InternalException,
                                                  java.rmi.RemoteException
  

  This method gets all merchant configuration information according to the input parameter.

  Specified by:

  getMerchantConfInfo in interface PaymentsAdminInterface

  Parameters:

  merchConfId - A Long that specifies the current merchant configuration id.

  name - The property name

  Returns:

  All merchant configuration information with merchantConfId

  Throws:

  InvalidDataException - This exception is thrown when some parameters are invalid.

  InternalException - This exception is thrown when EJB error occurs.

  java.rmi.RemoteException - Remote exception.

• activateMerchant

  public void activateMerchant(java.lang.Long merchantId)
                        throws InvalidDataException,
                               InternalException,
                               java.rmi.RemoteException
  

  This method activates the merchant with the specific merchant id.

  Specified by:

  activateMerchant in interface PaymentsAdminInterface

  Parameters:

  merchantId - A Long that specifies the current merchant id.

  Throws:

  InvalidDataException - This exception is thrown when some parameters are invalid.

  InternalException - This exception is thrown when EJB error occurs.

  java.rmi.RemoteException - Remote exception.

• deactivateMerchant

  public void deactivateMerchant(java.lang.Long merchantId)
                          throws InvalidDataException,
                                 InternalException,
                                 java.rmi.RemoteException
  

  This method deactivates the merchant with the specific merchant id.

  Specified by:

  deactivateMerchant in interface PaymentsAdminInterface

  Parameters:

  merchantId - The current merchant id.

  Throws:

  InvalidDataException - This exception is thrown when some parameters are invalid.

  InternalException - This exception is thrown when EJB error occurs.

  java.rmi.RemoteException - Remote exception.

• settleBatch

  public com.ibm.commerce.payments.plugincontroller.Batch settleBatch(PaymentContext paymentContext,
                                                             java.lang.String batchId,
                                                             boolean forceClose)
                                                               throws EDPException
  

  This method is used to send batch request to the back end. It sends the batch request to the back end by calling the settleBatch API of the plugin.

  Specified by:

  settleBatch in interface PaymentsInterface

  Parameters:

  paymentContext - the context of payment.

  batchId - The batch identifier represents the batch to be processed.

  forceClose - A boolean indicating if this batch is needed to be closed by force.

  Returns:

  The batch value object in PPC level.

  Throws:

  EDPException

• getBatch

  public com.ibm.commerce.payments.plugincontroller.Batch getBatch(PaymentContext paymentContext,
                                                          java.lang.String batchId)
                                                            throws EDPException
  

  This method gets the batch from the back end by calling the plugin's getBatch() API. For Paymentech plugin ,this method sends RFR to the back end and receives the RFR response from the back end.The RFR response includes the result of the previous batch request.

  Specified by:

  getBatch in interface PaymentsInterface

  Parameters:

  paymentContext -

  batchId - The identifier of the batch value object needs to be gotten.

  Returns:

  The batch value object that has been processed.

  Throws:

  EDPException

• createBatch

  public com.ibm.commerce.payments.plugincontroller.Batch createBatch(PaymentContext paymentContext,
                                                             java.lang.String merchConfId,
                                                             java.util.Collection financialTransactionIds,
                                                             java.util.Map extendedData)
                                                               throws EDPException
  

  This method creates batch for the given batch value object.

  Specified by:

  createBatch in interface PaymentsInterface

  Parameters:

  paymentContext - the context of payment.

  merchConfId - The unique identifier of merchant configuration.

  financialTransactionIds - The financial transactions to be included in the new created batch.

  extendedData - The extended data for the batch.

  Returns:

  The new created batch value object.

  Throws:

  EDPException

• initAuthenticationSession

  public void initAuthenticationSession(PaymentContext paymentContext,
                               java.lang.String paymentInstructionId)
                                 throws EDPException
  

  This method initializes punch-out payment session.

  Specified by:

  initAuthenticationSession in interface PaymentsInterface

  Parameters:

  paymentContext - The plug-in context to be used in this request.

  paymentInstructionId - The id of PaymentInstruction object.

  Throws:

  EDPException

• getAuthenticationURL

  public java.lang.String getAuthenticationURL(PaymentContext paymentContext,
                                      java.lang.String paymentInstructionId)
                                        throws EDPException
  

  This method gets the popup URL or form of punch-out payment.

  Specified by:

  getAuthenticationURL in interface PaymentsInterface

  Parameters:

  paymentContext - The plug-in context to be used in this request.

  paymentInstructionId - The id of PaymentInstruction object.

  Returns:

  the popup URL or form.

  Throws:

  EDPException

• preprocessProviderResponseData

  public java.lang.String preprocessProviderResponseData(PaymentContext paymentContext,
                                                java.lang.String paymentSystemName,
                                                java.util.Map callbackParameters)
                                                  throws EDPException
  

  This method preprocess punch-out payment transaction data from payment service provider side.

  Specified by:

  preprocessProviderResponseData in interface PaymentsInterface

  Parameters:

  paymentContext - The plug-in context to be used in this request.

  paymentSystemName - The payment system name.

  callbackParameters - the parameters from callback request.

  Returns:

  payment instruction id key.

  Throws:

  EDPException

• processProviderResponse

  public java.util.Map processProviderResponse(PaymentContext paymentContext,
                                      java.lang.String paymentInstructionId,
                                      java.util.Map callbackParameters)
                                        throws EDPException
  

  This method gets the result of punch-out payment transaction from payment service provider side.

  Specified by:

  processProviderResponse in interface PaymentsInterface

  Parameters:

  paymentContext - The plug-in context to be used in this request.

  paymentInstructionId - The id of PaymentInstruction object.

  callbackParameters - the parameters from call back request.

  Returns:

  the payment transaction result.

  Throws:

  EDPException