Interface FinalizePaymentCmd

  • All Superinterfaces:
    AEDPPaymentTaskCmd, AEDPStoreTaskCmd, AEDPTaskCmd,,,,, ECCommand,,, TaskCommand
    All Known Implementing Classes:
    FinalizePaymentCmdImpl, FinalizePaymentVoidCmdImpl

    public interface FinalizePaymentCmd
    extends AEDPStoreTaskCmd
    This task command acts as a wrapper for payments rules finalize payment event. This task command is called by UpdateReleaseManifestStatusCmdImpl.It ensures that funds have been captured because goods have been shipped.

    This command is associated with the fulfillment of the order release. It ensures that funds have been captured because goods have been shipped. It occurs when the order items in the release are fulfilled (items are boxed and shipped

    The possible payment actions associated with this event are: Approve, Deposit, and ReverseApproval.

    For example, in an order release, the items being purchased are packaged and the package is scanned. A shipment confirmation notice is sent and the order items are marked "shipped." At this point, the FinalizePaymentCmd is called. Payment rules are read and payment actions are identified to achieve the desired target state for the complete reservation amount (the sum of all Payment Rules amounts). Assuming that a payment approval has already occurred, the payment amount is checked against the earlier approved amount to see if it is less than, equal to, or greater than the approved payment amount for the payment method.

    Amounts already in an approved state must be deposited. Depending on the core definition of the deposit payment action for the payment method, deposits can occur right away, even if the approved and deposit amounts do not match, or later when the total approved and deposited amount is actually reached.

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

    The default implementation of this command is FinalizePaymentCmdImpl.
    See Also:
    • 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

      • setFinalizationAmount

        void setFinalizationAmount(java.math.BigDecimal finalizationAmount)
        This method sets the amount to be finalized.
        finalizationAmount - A BigDecimal that specifies the amount to be finalized.
      • setReleaseId

        void setReleaseId(java.lang.Long releaseId)
        This method sets the ID of the release for which the amount is being finalized.
        releaseId - A Long that specifies the release identifier.