Package com.broadleafcommerce.orderoperation.service.payment

Interface PaymentCaptureService

    • Method Summary

      All Methods Instance Methods Abstract Methods Default Methods 
      Modifier and Type Method Description
      List<TransactionExecutionResponse> captureFulfillment​(@NonNull javax.money.MonetaryAmount amountToCapture, @NonNull com.broadleafcommerce.order.client.domain.Order order, @NonNull com.broadleafcommerce.order.client.domain.OrderFulfillment fulfillment, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
      Responsible for capturing an amount from the Order's payments
      default List<TransactionExecutionResponse> captureFulfillmentTotal​(@NonNull com.broadleafcommerce.order.client.domain.Order order, @NonNull com.broadleafcommerce.order.client.domain.OrderFulfillment fulfillment, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
      Responsible for capturing the OrderFulfillment.getGrandTotal() from the Order's payments

    • Method Detail

      • captureFulfillment

        List<TransactionExecutionResponse> captureFulfillment​(@NonNull
                                                      @NonNull javax.money.MonetaryAmount amountToCapture,
                                                      @NonNull
                                                      @NonNull com.broadleafcommerce.order.client.domain.Order order,
                                                      @NonNull
                                                      @NonNull com.broadleafcommerce.order.client.domain.OrderFulfillment fulfillment,
                                                      @Nullable
                                                      com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
        Responsible for capturing an amount from the Order's payments
        Parameters:
        amountToCapture - The amount to capture for the OrderFulfillment
        order - The order whose payments should be used to captured the specified amount
        fulfillment - The fulfillment to capture payment for
        contextInfo - Context information around sandbox and multitenant state.
        Returns:
        the TransactionExecutionResponses for all the capture transactions
        Throws:
        PaymentCaptureException - If the totalToCapture is too high and cannot be handled by the order's payments
        PaymentTransactionFailureException - If a payment capture transaction fails

      • captureFulfillmentTotal

        default List<TransactionExecutionResponse> captureFulfillmentTotal​(@NonNull
                                                                   @NonNull com.broadleafcommerce.order.client.domain.Order order,
                                                                   @NonNull
                                                                   @NonNull com.broadleafcommerce.order.client.domain.OrderFulfillment fulfillment,
                                                                   @Nullable
                                                                   com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
        Responsible for capturing the OrderFulfillment.getGrandTotal() from the Order's payments
        Parameters:
        order - The order whose payments should be used to captured the specified amount
        fulfillment - The fulfillment to capture payment for
        contextInfo - Context information around sandbox and multitenant state.
        Returns:
        the TransactionExecutionResponses for all the capture transactions
        Throws:
        PaymentCaptureException - If the totalToCapture is too high and cannot be handled by the order's payments
        PaymentTransactionFailureException - If a payment capture transaction fails