Field Detail

• COPYRIGHT

  static final java.lang.String COPYRIGHT
  

  The IBM copyright notice field.

  See Also:

  Constant Field Values

Method Detail

• getCredit

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

  This method obtains a specific Credit container value object.

  Related PaymentInstruction is also retrieved. However, other container objects associated with the PaymentInstruction are not retrieved.

  PPC will look for the credit using the creditId. PPC will return the credit value object and its associated PaymentInstruction in it. If credit doesn't exist (or it has already been marked for deletion), null will be returned.

  If the plug-in supports real-time queries, PPC will delegate the request to the plug-in and once the response is returned, PPC will synchronize the Credit details in the database.

  Users of this method: EDP, PPC Admin UI.

  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.

  java.rmi.RemoteException - Remote exception.

• getMessage

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

  This method obtains a translated message for a specified error key (for example, a reason code).

  PPC will delegate the getMessage request to the target plug-in.

  Users of this method: EDP, PPC Admin UI.

  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.

  java.rmi.RemoteException - Remote exception.

• getPayment

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

  This method obtains a specific Payment container value object.

  Related PaymentInstruction is also retrieved. However, other container objects associated with the PaymentInstruction are not retrieved.

  PPC will look for the payment using the paymentId. PPC will return the payment value object and its associated PaymentInstruction in it. If payment doesn't exist (or it has already been marked for deletion), null will be returned.

  If the plug-in supports real-time queries, PPC will delegate the request to the plug-in and once the response is returned, PPC will synchronize the Payment details in the database.

  Users of this method: EDP, PPC Admin UI.

  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.

  java.rmi.RemoteException - Remote exception.

• getPaymentInstruction

  PaymentInstruction getPaymentInstruction(PaymentContext paymentContext,
                                         java.lang.String paymentInstructionId,
                                         java.lang.Boolean maskSensitiveData)
                                           throws InputException,
                                                  BackendException,
                                                  InternalException,
                                                  ConfigException,
                                                  java.rmi.RemoteException
  

  This method obtains a specific PaymentInstruction container value object.

  Associated data is also retrieved: Payments, Credits, and ExtendedData.

  Users of this method: EDP, PPC Admin UI.

  Parameters:

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

  paymentInstructionId - 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.

  java.rmi.RemoteException - Remote exception.

• getRemainingValueOnPaymentInstruction

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

  This method obtains the available amount in an account.

  There are some sorts of payment methods, like stored value cards and credit lines, where there is a tangible limit amount. Payment back-end systems may provide a registry of what still can be charged against a particular account. For example, a credit card with real-time validation of its remaining limit.

  EDP may leverage this method in the future. For example, a gift certificate is to be fully consumed before a credit card is used for an order. However, the customer doesn't know how much is available in the gift certificate.

  This method only makes to be invoked when the target plug-in supports real-time queries.

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

  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.

  java.rmi.RemoteException - Remote exception.

• approve

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

  This method executes an approve transaction against a particular Payment container.

  PPC makes sure that:

  • PaymentInstruction is in STATE_VALID
  • Payment is in STATE_NEW
  • there is enough amount in Payment to be approved
  • there is no pending transaction against the same PaymentInstruction

  The PPC will:

  • move Payment container into STATE_APPROVING
  • set approving amount in Payment
  • increase approving amount in PaymentInstruction
  • delegate the request to the target plug-in

  On successful transaction response, PPC will:

  • move Payment container into STATE_APPROVED
  • reset Payment approving amount to zero
  • decrease approving amount in the PaymentInstruction by the requested amount
  • update Payment approved amount by the actual processed amount

  On transaction declined response, PPC will:

  • move Payment contained into STATE_FAILED
  • reset Payment approving amount to zero
  • decrease approving amount in the PaymentInstruction by the requested amount

  On PluginTimeOutException, PPC will:

  • keep Payment in STATE_APPROVING
  • keep approving amount in Payment unchanged
  • keep approving amount in PaymentInstruction unchanged
  • set reasonCode with PPC_TRANSACTION_TIMEOUT

   PPC validation
           PaymentInstruction state validation
                   STATE_VALID is required
  
           Payment state validation
                   STATE_NEW        PPC will allow the action to take place
                   STATE_APPROVING  PPC will allow the action to take place as a retry
           Payment amount validation
                   requested amount <= Payment.amount
                   if this is a retry transaction, requested amount == Payment.approvingAmount
   
  

  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.

  java.rmi.RemoteException - Remote exception.

• approveAndDeposit

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

  This method executes an approveAndDeposit (sale) transaction against a particular Payment container.

  PPC makes sure that:

  • PaymentInstruction is in STATE_VALID
  • Payment is in STATE_NEW
  • there is enough amount in Payment to be approved and deposited
  • there is no pending transaction against the same PaymentInstruction

  The PPC will:

  • move payment container into STATE_APPROVING
  • set approving amount in Payment
  • set depositing amount in Payment
  • increase approving amount in PaymentInstruction
  • increase depositing amount in PaymentInstruction
  • delegate the request to the target plug-in

  On successful transaction response, PPC will:

  • move Payment container into STATE_APPROVED
  • reset Payment approving amount to zero
  • reset Payment depositing amount to zero
  • decrease approving amount in the Payment Instruction by the requested amount
  • decrease depositing amount in the Payment Instruction by the requested amount
  • update Payment approved amount by the actual processed amount
  • update Payment deposited amount by the actual processed amount

  On transaction declined response, PPC will:

  • move Payment contained into STATE_FAILED
  • reset Payment approving amount to zero
  • reset Payment depositing amount to zero
  • decrease approving amount in the PaymentInstruction by the requested amount
  • decrease depositing amount in the PaymentInstruction by the requested amount

  On PluginTimeOutException, PPC will:

  • keep Payment in STATE_APPROVING
  • keep approving amount in Payment unchanged
  • keep depositing amount in Payment unchanged
  • keep approving amount in PaymentInstruction unchanged
  • keep depositing amount in PaymentInstruction unchanged
  • set reasonCode with PPC_TRANSACTION_TIMEOUT

   PPC validation
           PaymentInstruction state validation
                   STATE_VALID is required
  
           Payment state validation
                   STATE_NEW        PPC will allow the action to take place
                   STATE_APPROVING  PPC will allow the action to take place as a retry
           Payment amount validation
                   requested amount <= Payment.amount
                   if this is a retry transaction check for 
                         requested amount == Payment.approvingAmount 
                   and 
                         requested amount == Payment.depositingAmount
   
  

  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.

  java.rmi.RemoteException - Remote exception.

• checkPaymentInstruction

  Result checkPaymentInstruction(PaymentContext paymentContext,
                               PaymentInstruction paymentInstruction)
                                 throws InputException,
                                        BackendException,
                                        InternalException,
                                        ConfigException,
                                        java.rmi.RemoteException
  

  This method initiates a checkPaymentInstruction against the Plugin processing the specified Payment Instruction. This method is provided to allow EDP to verify the parameters on a PaymentInstruction before creating a PaymentInstruction.

  However, this method can be invoked against existing and non-existing Payment Instructions from the PPC perspective. If a Payment Instruction exists, PPC will mark it VALID or INVALID accordingly. If the Payment Instruction doesn't exist yet, PPC will only mark the value object.

  Users of this method: EDP.

  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.

  java.rmi.RemoteException - Remote exception.

• closePaymentInstruction

  void closePaymentInstruction(PaymentContext paymentContext,
                             java.lang.String paymentInstructionId)
                               throws InputException,
                                      BackendException,
                                      InternalException,
                                      ConfigException,
                                      java.rmi.RemoteException
  

  This method will mark the PaymentInstruction as STATE_CLOSED. PPC allows any pending operation under this PaymentInstruction to finish, but it does not allow any new operations to be created.

  Users of this method: EDP.

  Parameters:

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

  paymentInstructionId - 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.

  java.rmi.RemoteException - Remote exception.

• createDependentCredit

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

  This method will create a dependent Credit Object associated to the specified PaymentInstruction which is associated to the Payment. This new Credit can later be use to execute Credit Actions against the appropriate Payment Plugin.

   PaymentInstruction State validation
        STATE_NEW     PPC will not allow the action to take place InvalidPaymentInstructionException
           STATE_VALID   PPC will allow the action to take place
           STATE_INVALID PPC will not allow the action to take place InvalidPaymentInstructionException
           STATE_CLOSED  PPC will not allow the action to take place and throw InvalidPaymentInstructionException
  
   Payment State validation
        STATE_NEW       PPC will not allow the action to take place InvalidPaymentException
        STATE_APPROVING PPC will not allow the action to take place InvalidPaymentException
           STATE_APPROVED  PPC will allow the action to take place
           STATE_EXPIRED   PPC will allow the action to take place
           STATE_CANCELED  PPC will not allow the action to take place and throw InvalidPaymentException
           STATE_FAILED    PPC will not allow the action to take place and throw InvalidPaymentException
   
  

  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.

  java.rmi.RemoteException - Remote exception.

• createIndependentCredit

  Credit createIndependentCredit(PaymentContext paymentContext,
                               java.lang.String paymentInstructionId,
                               java.math.BigDecimal amount)
                                 throws InputException,
                                        BackendException,
                                        InternalException,
                                        ConfigException,
                                        java.rmi.RemoteException
  

  PPC will create a Credit Object associated to the specified PaymentInstruction. This new Credit can later be use to execute Credit Actions against the appropriate Payment Plugin.

   PaymentInstruction State validation
        STATE_NEW     PPC will not allow the action to take place InvalidPaymentInstructionException
           STATE_VALID   PPC will allow the action to take place
           STATE_INVALID PPC will not allow the action to take place InvalidPaymentInstructionException
           STATE_CLOSED  PPC will not allow the action to take place and throw InvalidPaymentInstructionException
   
  

  Users of this method: EDP.

  Parameters:

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

  paymentInstructionId - 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.

  java.rmi.RemoteException - Remote exception.

• createPayment

  Payment createPayment(PaymentContext paymentContext,
                      java.lang.String paymentInstructionId,
                      java.math.BigDecimal amount)
                        throws InputException,
                               BackendException,
                               InternalException,
                               ConfigException,
                               java.rmi.RemoteException
  

  PPC will create a Payment Object associated to the specified PaymentInstruction. This new Payment can later be use to execute Payment Actions against the appropriate Payment Plugin. This payment can be use to execute one or more deposit.

   PaymentInstruction State validation
        STATE_NEW     PPC will not allow the action to take place InvalidPaymentInstructionException
           STATE_VALID   PPC will allow the action to take place
           STATE_INVALID PPC will not allow the action to take place InvalidPaymentInstructionException
           STATE_CLOSED  PPC will not allow the action to take place and throw InvalidPaymentInstructionException
   
  

  Users of this method: EDP.

  Parameters:

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

  paymentInstructionId - 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.

  java.rmi.RemoteException - Remote exception.

• createPaymentInstruction

  PaymentInstruction createPaymentInstruction(PaymentContext paymentContext,
                                            PaymentInstruction paymentInstruction)
                                              throws InputException,
                                                     BackendException,
                                                     InternalException,
                                                     ConfigException,
                                                     java.rmi.RemoteException
  

  This api will create a Payment Instruction and store the information in PPC. PPC will call the checkPaymentInstruction() method on the specified plugin by the paymentSystemName field. The plugin will validate the information received on the PaymentInstruction and will inform PPC if the PaymentInstruction data is good or bad.

  Users of this method: EDP.

  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.

  java.rmi.RemoteException - Remote exception.

• credit

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

  This api will initiate a credit transaction against the specified Credit. It will find the plugin that was associated to this paymentInstruction and execute the credit API against that plugin. The Credit objects in PPC will be changed into the STATE_CREDITING state. The state will be change to STATE_CREDITED on a successful response from the plugin. PPC will check that the requested credit amount will be within the amount in the Payment or PaymentInstruction. PPC will validate the Objects and the requested amount, set the PaymentInstruction.creditingAmount and Payment.creditingAmount(dependent credit) equal to the requested amount. On a PluginTimeOut exception, the Payment or PaymentInstruction will stay with its crediting amount. And the payment Transaction will stay in STATE_PENDING state with a reason Code of PPC_CREDIT_TIMEOUT. On successful response from the plugin, PPC will update the PaymentInstruction.creditedAmount or Payment.creditedAmount (dependent credit) to include the requested amount. Payment.creditingAmount or PaymentInstruction.creditingAmount will be decreased by the requested amount.

   PPC Object validation
    Independent credit validation
           PaymentInstruction
               state validation
                STATE_NEW     PPC will not allow the action to take place InvalidPaymentInstructionException
                   STATE_VALID   PPC will allow the action to take place
                   STATE_INVALID PPC will not allow the action to take place and throw InvalidPaymentInstructionException
                   STATE_CLOSED  PPC will not allow the action to take place and throw InvalidPaymentInstructionException
               amount validation
                   amount <= PaymentInstruction.amount - PaymentInstruction.creditingAmount - PaymentInstruction.creditedAmount
                if this is a retry credit transaction amount <= PaymentInstruction.creditingAmount
        Credit
               state validation
                STATE_NEW       PPC will allow the action to take place
                   STATE_CREDITING PPC will allow the action to take place, this is a retry credit transaction
                   STATE_CREDITED  PPC will not allow the action to take place and throw InvalidCreditException
                   STATE_FAILED    PPC will not allow the action to take place and throw InvalidCreditException
                STATE_CANCELED  PPC will not allow the action to take place and throw InvalidCreditException
               amount validation
                   amount <= Credit.expectedAmount
                if this is a retry credit transactiion amount == Credit.creditingAmount
  
  
   dependent credit validation
           PaymentInstruction
               state validation
                STATE_NEW     PPC will not allow the action to take place InvalidPaymentInstructionException
                   STATE_VALID   PPC will allow the action to take place
                   STATE_INVALID PPC will not allow the action to take place and throw InvalidPaymentInstructionException
                   STATE_CLOSED  PPC will not allow the action to take place and throw InvalidPaymentInstructionException
               amount validation
                   amount <= PaymentInstruction.depositedAmount - PaymentInstruction.reversingDepositedAmount -
                           PaymentInstruction.creditingAmount - PaymentInstruction.creditedAmount
                if this is a retry credit transaction amount <= PaymentInstruction.creditingAmount
           Payment dependant credit validation
               state validation
                   STATE_NEW          PPC will not allow the action to take place and throw InvalidPaymentException.
                   STATE_APPROVING PPC will not allow the action to take place and throw InvalidPaymentException.
                   STATE_APPROVED  PPC will allow the action to take place.
                   STATE_FAILED      PPC will not allow the action to take place and throw InvalidPaymentException.
                   STATE_EXPIRED      PPC will allow the action to take place.
                   STATE_CANCELED  PPC will not allow the action to take place and throw InvalidPaymentException.
               amount validation
                   amount <= Payment.depositedAmount - Payment.reversingDepositedAmount - Payment.creditingAmount - Payment.creditedAmount
                if this is a retry credit transaction amount <= Payment.creditingAmount
        Credit
               state validation
                STATE_NEW       PPC will allow the action to take place
                   STATE_CREDITING PPC will allow the action to take place, this is a retry credit transaction
                   STATE_CREDITED  PPC will not allow the action to take place and throw InvalidCreditException
                   STATE_FAILED    PPC will not allow the action to take place and throw InvalidCreditException
                STATE_CANCELED  PPC will not allow the action to take place and throw InvalidCreditException
               amount validation
                   amount <= Credit.expectedAmount
                if this is a retry credit transactiion amount == Credit.creditingAmount
   
  

  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.

  java.rmi.RemoteException - Remote exception.

• deletePaymentInstruction

  void deletePaymentInstruction(PaymentContext paymentContext,
                              java.lang.String paymentInstructionId)
                                throws InputException,
                                       BackendException,
                                       InternalException,
                                       ConfigException,
                                       java.rmi.RemoteException
  

  This api will mark the PaymentInstruction and all of its associated Payments/Credits. The Payment Instruction will not be deleted from the database. It will be mark as deleted. PPC will check that no one tries to use this PI on any operation since it has been deleted. PPC will mark the PaymentInstruction as delete once the pending transaction associated to the PaymentInstruction has been completed. PPC will check that the PaymentInstruction has been marked STATE_CLOSED before executing the deletion.

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

  Parameters:

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

  paymentInstructionId - 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.

  java.rmi.RemoteException - Remote exception.

• deposit

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

  This api executes a deposit transaction against a particular Payment container .

  PPC makes sure that:

  • PaymentInstruction is in STATE_VALID
  • Payment is in STATE_APPROVED
  • there is enough approved amount in Payment to be deposited
  • there is no pending transaction against the same PaymentInstruction

  The PPC will:

  • set depositing amount in Payment
  • increase depositing amount in PaymentInstruction
  • delegate the request to the target plug-in

  On successful transaction response, PPC will:

  • reset Payment depositing amount by the requested amount
  • decrease depositing amount in the PaymentInstruction by the requested amount
  • update Payment deposited amount by the actual processed amount

  On transaction declined response, PPC will:

  • move Payment contained into STATE_FAILED
  • reset Payment depositing amount to zero
  • decrease depositing amount in the PaymentInstruction by the requested amount

  On PluginTimeOutException, PPC will:

  • keep depositing amount in Payment unchanged
  • keep depositing amount in PaymentInstruction unchanged
  • set reasonCode with PPC_TRANSACTION_TIMEOUT

   PPC validation
           PaymentInstruction state validation
                   STATE_VALID is required
  
           Payment state validation
                   STATE_APPROVED  PPC will allow the action to take place
           Payment amount validation
                   requested amount <= Payment.approvedAmount - Payment.depositedAmount
                   if this is a retry transaction, check for
                        requested amount == Payment.depositingAmount
   
  

  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.

  java.rmi.RemoteException - Remote exception.

• editCredit

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

  This api will edit the credit.

  Parameters:

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

  creditLocal - 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.

  java.rmi.RemoteException - Remote exception.

• editPayment

  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,
                            java.rmi.RemoteException
  

  This method is used to update the pending payment and it's pending transaction attribute paymentVO includes status. This is a flag to decide whether fix pending payment or make it fail or keep this payment at current status.

  processAmount reasonCode responseCode referenceNumber extendedData is use to update the pending transaction

  Users of this method: PPC Admin UI.

  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.

  java.rmi.RemoteException - Remote exception.

• editPaymentInstruction

  Result editPaymentInstruction(PaymentContext paymentContext,
                              PaymentInstruction paymentInstruction)
                                throws InputException,
                                       BackendException,
                                       InternalException,
                                       ConfigException,
                                       java.rmi.RemoteException
  

  This api will update the extendedData, amount or any other attribute contained in the value object on the specified PaymentInstruction. PPC will call the plugins checkPaymentInstruction method to validate the extendedData if any changes are detected on it. PPC will analyze the value object and determine which fields from the paymentInstruction value object needs to be updated for the specified PaymentInstruction.

   PPC Object validation
           PaymentInstruction
               state validation
                   STATE_NEW PPC will allow the action to take place
                   STATE_VALID PPC will allow the action to take place
                   STATE_INVALID PPC will allow the action to take place
                   STATE_CLOSED PPC will not allow the action to happen and throw InvalidPaymentInstructionException
   
  

  Users of this method: EDP, PPC Admin UI.

  Parameters:

  paymentContext - The payment context to be used in this request

  paymentInstruction - 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.

  java.rmi.RemoteException - Remote exception.

• reverseApproval

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

  This api will initiate a reverseApproval transaction against the specified Payment. It will find the plugin that was associated to this payment and execute the reverseApproval API against that plugin. The ReverseApproval transaction object created within PPC will be initially created in the STATE_PENDING state. The state will be change to STATE_SUCCESS on a successful response from the plugin. PPC will check that the requested reverse amount will be within the approvedAmount in the specified Payment. PPC will validate the Objects and requested amount and set the Payment.reversingApprovalAmount and PaymentInstruction.reversingApprovalAmount to include the requested amount . On a PluginTimeOutException the Payment and PaymentInstruction will stay with its reversingAmount. The payment Transaction will stay in STATE_PENDING state with a reason Code of PPC_REVERSE_APPROVAL_TIMEOUT. On successful response from the plugin PPC will update the Payment.approvedAmount and PaymentInstruction.approvedAmount, it will decrease them by the requestedAmount . PPC will decrease the Payment.reversingApprovalAmount or PaymentInstruction.reversingApprovalAmount by the requested amount.

   PPC Object validation
           PaymentInstruction
               state validation
                STATE_NEW     PPC will not allow the action to take place InvalidPaymentInstructionException
                   STATE_VALID   PPC will allow the action to take place
                   STATE_INVALID PPC will not allow the action to take place and throw InvalidPaymentInstructionException
                   STATE_CLOSED  PPC will not allow the action to take place and throw InvalidPaymentInstructionException
               amount validation
                   amount <= PaymentInstruction.approvedAmount - PaymentInstruction.reversingApprovedAmount
                if this is a retry reverse approval transaction amount <= PaymentInstruction.reversingApprovedAmount
  
           Payment
               state validation
                   STATE_NEW          PPC will not allow the action to take place and throw InvalidPaymentException.
                   STATE_APPROVING PPC will not allow the action to take place and throw InvalidPaymentException.
                   STATE_APPROVED  PPC will allow the action to take place.
                   STATE_FAILED      PPC will not allow the action to take place and throw InvalidPaymentException.
                   STATE_EXPIRED      PPC will not allow the action to take place and throw InvalidPaymentException.
                   STATE_CANCELED  PPC will not allow the action to take place and throw InvalidPaymentException.
               amount validation
                Payment.depositingAmount == 0 && Payment.DepositedAmount == 0 && amount <= Payment.approvedAmount
                if this is a retry reverse approval transaction amount == Payment.reversingApprovedAmount
   
  

  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.

  java.rmi.RemoteException - the Remote exception.

• reverseCredit

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

  This api will initiate a reverseCredit transaction against the specified Credit. It will find the plugin that was associated to this credit and execute the reverseCredit API against that plugin. The ReverseCredit transaction created within PPC will be initially created in the STATE_PENDING state. The state will be change to STATE_SUCCESS on a successful response from the plugin. PPC will check that the requested reverse amount will be within the creditedAmount in the Paymentinstruction or Payment objects. PPC will validate the Objects and requested amount and set the PaymentInstruction.reversingCreditAmount include the requested amount . On a PluginTimeOutException, the PaymentInstruction will stay with its reversingCreditAmount, the payment Transaction will stay in STATE_PENDING with a reason Code of PPC_REVERSE_CREDIT_TIMEOUT. On successful response from the plugin PPC will update the PaymentInstruction.creditedAmount, decreasing it by the requestedAmount.

   PPC Object validation
    Independent credit validation
           PaymentInstruction
               state validation
                STATE_NEW     PPC will not allow the action to take place InvalidPaymentInstructionException
                   STATE_VALID   PPC will allow the action to take place
                   STATE_INVALID PPC will not allow the action to take place and throw InvalidPaymentInstructionException
                   STATE_CLOSED  PPC will not allow the action to take place and throw InvalidPaymentInstructionException
               amount validation
                   amount <= PaymentInstruction.creditedAmount - PaymentInstruction.reversingCreditedAmount
                if this is a retry reverse credit transaction amount <= PaymentInstruction.reversingCreditedAmount
        Credit
               state validation
                STATE_NEW       PPC will not allow the action to take place and throw InvalidCreditException
                   STATE_CREDITING PPC will allow the action to take place, this is a retry credit transaction
                   STATE_CREDITED  PPC will allow the action to take place
                   STATE_FAILED    PPC will not allow the action to take place and throw InvalidCreditException
                STATE_CANCELED  PPC will not allow the action to take place and throw InvalidCreditException
               amount validation
                   amount <= Credit.creditedAmount
                if this is a retry credit transactiion amount == Credit.reversingCreditedAmount
  
  
   dependent credit validation
           PaymentInstruction
               state validation
                STATE_NEW     PPC will not allow the action to take place InvalidPaymentInstructionException
                   STATE_VALID   PPC will allow the action to take place
                   STATE_INVALID PPC will not allow the action to take place and throw InvalidPaymentInstructionException
                   STATE_CLOSED  PPC will not allow the action to take place and throw InvalidPaymentInstructionException
               amount validation
                   amount <= PaymentInstruction.creditedAmount - PaymentInstruction.reversingCreditedAmount
                if this is a retry reverse credit transaction amount <= PaymentInstruction.reversingCreditedAmount
           Payment dependant credit validation
               state validation
                   STATE_NEW          PPC will not allow the action to take place and throw InvalidPaymentException.
                   STATE_APPROVING PPC will not allow the action to take place and throw InvalidPaymentException.
                   STATE_APPROVED  PPC will allow the action to take place.
                   STATE_FAILED      PPC will not allow the action to take place and throw InvalidPaymentException.
                   STATE_EXPIRED      PPC will allow the action to take place.
                   STATE_CANCELED  PPC will not allow the action to take place and throw InvalidPaymentException.
               amount validation
                   amount <= Payment.creditedAmount - Payment.reversingCreditedAmount
                if this is a retry credit transaction amount <= Payment.reversingCreditedAmount
        Credit
               state validation
                STATE_NEW       PPC will not allow the action to take place and throw InvalidCreditException
                   STATE_CREDITING PPC will allow the action to take place, this is a retry credit transaction
                   STATE_CREDITED  PPC will allow the action to take place
                   STATE_FAILED    PPC will not allow the action to take place and throw InvalidCreditException
                STATE_CANCELED  PPC will not allow the action to take place and throw InvalidCreditException
               amount validation
                   amount <= Credit.creditedAmount
                if this is a retry credit transactiion amount == Credit.reversingCreditedAmount
   
  

  Users of this method: EDP.

  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.

  java.rmi.RemoteException - Remote exception.

• reverseDeposit

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

  This api will initiate a reverseDeposit transaction against the specified Payment. It will find the plugin that was associated to this payment and execute the reverseDeposit API against that plugin. The ReverseDeposit financial transaction created within PPC will be initially created in the STATE_PENDING state. The state will be change to STATE_SUCCESS on a successful response from the plugin. PPC will check that the requested reverse amount will be within the depositedAmount in the Payment. PPC will validate the Objects and requested amount and set the Payment.reversingDepositedAmount include the requested amount . On a PluginTimeOutException the Payment will stay with its reversingDepositedAmount, the reverseApproval transaction will stay in STATE_PENDING state with a reason Code of PPC_REVERSE_DEPOSIT_TIMEOUT. On successful response from the plugin, PPC will update the Payment.depositedAmount, decreasing it by the requestedAmount.

  PPC Object validation
          PaymentInstruction
              state validation
                STATE_NEW     PPC will not allow the action to take place InvalidPaymentInstructionException
                   STATE_VALID   PPC will allow the action to take place
                   STATE_INVALID PPC will not allow the action to take place and throw InvalidPaymentInstructionException
                   STATE_CLOSED  PPC will not allow the action to take place and throw InvalidPaymentInstructionException
               amount validation
                   amount <= PaymentInstruction.depositedAmount - PaymentInstruction.reversingDepositedAmount
                if this is a retry reverse approval transaction amount <= PaymentInstruction.reversingDepositedAmount
          Payment
              state validation
           Payment
               state validation
                   STATE_NEW          PPC will not allow the action to take place and throw InvalidPaymentException.
                   STATE_APPROVING PPC will not allow the action to take place and throw InvalidPaymentException.
                   STATE_APPROVED  PPC will allow the action to take place.
                   STATE_FAILED      PPC will not allow the action to take place and throw InvalidPaymentException.
                   STATE_EXPIRED      PPC will not allow the action to take place and throw InvalidPaymentException.
                   STATE_CANCELED  PPC will not allow the action to take place and throw InvalidPaymentException.
               amount validation
                  amount <= Payment.depositedAmount
                if this is a retry reverse approval transaction amount == Payment.reversingDepositedAmount
   
  

  Users of this method: EDP.

  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.

  java.rmi.RemoteException - Remote exception.

• validatePaymentInstruction

  Result validatePaymentInstruction(PaymentContext paymentContext,
                                  PaymentInstruction paymentInstruction)
                                    throws InputException,
                                           BackendException,
                                           InternalException,
                                           ConfigException,
                                           java.rmi.RemoteException
  

  This api will initiate a validate transaction against the specified PaymentInstruction. PPC will find the plugin that was associated to this payment and execute the validate API against that plugin. This validate method can be used for existing and non existing Payment Instruction. If this method is called for an existing PaymentInstruction PPC will mark the PI valid or invalid depending on the Plugin response. If the PaymentInstruction was not previously created, PPC will just mark the ValueObject as valid or invalid depending on the Plugin response.

  If the plugin does not support validatePaymentInstruction API, PPC will call plugin's checkPaymentInstruction API instead.

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

  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.

  java.rmi.RemoteException - Remote exception.

• getBatch

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

  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.

  Parameters:

  paymentContext -

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

  Returns:

  The batch value object tha have been processed.

  Throws:

  EDPException

  java.rmi.RemoteException

• settleBatch

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

  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.

  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

  java.rmi.RemoteException

• createBatch

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

  This method creates batch for the given batch value object.

  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

  java.rmi.RemoteException

• initAuthenticationSession

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

  This method initializes punch-out payment session.

  Parameters:

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

  paymentInstructionId - The id of PaymentInstruction object.

  Throws:

  EDPException

  java.rmi.RemoteException - thrown by the EJB container as part of the EJB specification.

• getAuthenticationURL

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

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

  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

  java.rmi.RemoteException - thrown by the EJB container as part of the EJB specification.

• preprocessProviderResponseData

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

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

  Parameters:

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

  paymentSystemName - The payment system name.

  callbackParameters - the parameters from call back request.

  Returns:

  the result of punch-out payment transaction.

  Throws:

  EDPException

  java.rmi.RemoteException - thrown by the EJB container as part of the EJB specification.

• processProviderResponse

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

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

  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 response of punch-out payment transaction process.

  Throws:

  EDPException

  java.rmi.RemoteException - thrown by the EJB container as part of the EJB specification.