Interface ReservePaymentCmd

  • All Superinterfaces:
    AEDPPaymentTaskCmd, AEDPStoreTaskCmd, AEDPTaskCmd,,,,, ECCommand,,, TaskCommand
    All Known Implementing Classes:
    ReservePaymentCmdImpl, ReservePaymentVoidCmdImpl

    public interface ReservePaymentCmd
    extends AEDPStoreTaskCmd

    This task command is used to reserve payments in the payments rules subcomponent. The default implementation of this command is ReservePaymentCmdImpl. The command is associated with release to fulfillment. It reserves funds for order releases that will be shipped (the order has been released to a warehouse or some other entity for fulfillment).

    The possible payment actions are: Approve, Deposit, and ReverseApproval.

    For example, a customer order is selected for fulfillment. All the order items are due to ship from the same fulfillment center at the same time using the same carrier (a single order release). The release is selected and a ReservePaymentCmd command is called. Payment rules are read and payment actions are identified to achieve the desired target state for the complete reservation amount. Payment instructions are used in their configured order of priority, based on the configuration of the payment method. Assuming that the target state for the Payment is Approved, if the payment was not previously approved during the PrimePaymentCmd, it is approved now. (If it was approved already, a second approval does not occur during this event.) The order items are released and ready for fulfillment.

    If a payment action with the payment back end system fails, a tickler is created to notify a Customer Service Representative.

    • Field Detail


        static final java.lang.String COPYRIGHT
        The IBM Copyright notice field.
        See Also:
        Constant Field Values
      • defaultCommandClassName

        static final java.lang.String defaultCommandClassName
        The default implementation of this command.
        See Also:
        Constant Field Values
      • NAME

        static final java.lang.String NAME
        The full name of this command.
        See Also:
        Constant Field Values
    • Method Detail

      • setReleases

        void setReleases(java.util.HashMap releases)
        This method sets the releases to be processed in this request.
        releases - A HashMap containing (Long, BigDecimal) pair that represents the list of release IDs and their amounts to be reserved.
      • setReservationAmount

        void setReservationAmount(java.math.BigDecimal reservationAmount)
        This method sets the total reservation amount.
        reservationAmount - A BigDecimal that specifies the amount to be reserved.