Package com.broadleafcommerce.cartoperation.domain.payment

Class CheckoutPaymentMethodOption

java.lang.Object
com.broadleafcommerce.cartoperation.domain.payment.CheckoutPaymentMethodOption
All Implemented Interfaces:
Serializable
@Validated public class CheckoutPaymentMethodOption extends Object implements Serializable
DTO that provides information about the payment methods that are configured for checkout.
Author:
Marie Standeven (mariestandeven)
See Also:

  • Constructor Details

    • CheckoutPaymentMethodOption

      public CheckoutPaymentMethodOption()

  • Method Details

    • getPaymentMethodType

      public String getPaymentMethodType()
      The type of this payment like Credit Card or Gift Card.

    • getPaymentMethodGatewayType

      public String getPaymentMethodGatewayType()
      The gateway configured for this payment method.

    • getFees

      public List<CheckoutPaymentMethodOption.FeeDto> getFees()
      The list of applicable fees for this payment option. Can be discountable and/or taxable.

      Will only be applied in the case of Collect on Delivery (COD) type payments by default. We will eventually extend out of box support to any payment options.

    • getCartMinTotalRestriction

      public Map<String,BigDecimal> getCartMinTotalRestriction()
      The minimum total a cart can have for this payment method, per currency.

      Will only be applied in the case of Collect on Delivery (COD) type payments by default. We will eventually extend out of box support to any payment options.

    • getCartMaxTotalRestriction

      public Map<String,BigDecimal> getCartMaxTotalRestriction()
      The maximum total a cart can have for this payment method, per currency.

      Will only be applied in the case of Collect on Delivery (COD) type payments by default. We will eventually extend out of box support to any payment options.

    • getFulfillmentInclusions

      public Map<String,List<String>> getFulfillmentInclusions()
      List of inclusion criteria to compare against a FulfillmentGroup to determine if this payment option is allowed. The key is the path of the field to compare with on the group. The value is the list of valid values.

      Example values:

      • address.country -> ['US', 'UK', 'CA']
      • fulfillmentOption.name -> ['STANDARD', 'PRIORITY', 'EXPRESS']

    • getFulfillmentExclusions

      public Map<String,List<String>> getFulfillmentExclusions()
      List of exclusion criteria to compare against a FulfillmentGroup to determine if this payment option is allowed. The key is the path of the field to compare with on the group. The value is the list of valid values.

      Example values:

      • address.country -> ['US', 'UK', 'CA']
      • fulfillmentOption.name -> ['STANDARD', 'PRIORITY', 'EXPRESS']

    • setPaymentMethodType

      public void setPaymentMethodType(String paymentMethodType)
      The type of this payment like Credit Card or Gift Card.

    • setPaymentMethodGatewayType

      public void setPaymentMethodGatewayType(String paymentMethodGatewayType)
      The gateway configured for this payment method.

    • setFees

      public void setFees(List<CheckoutPaymentMethodOption.FeeDto> fees)
      The list of applicable fees for this payment option. Can be discountable and/or taxable.

      Will only be applied in the case of Collect on Delivery (COD) type payments by default. We will eventually extend out of box support to any payment options.

    • setCartMinTotalRestriction

      public void setCartMinTotalRestriction(Map<String,BigDecimal> cartMinTotalRestriction)
      The minimum total a cart can have for this payment method, per currency.

      Will only be applied in the case of Collect on Delivery (COD) type payments by default. We will eventually extend out of box support to any payment options.

    • setCartMaxTotalRestriction

      public void setCartMaxTotalRestriction(Map<String,BigDecimal> cartMaxTotalRestriction)
      The maximum total a cart can have for this payment method, per currency.

      Will only be applied in the case of Collect on Delivery (COD) type payments by default. We will eventually extend out of box support to any payment options.

    • setFulfillmentInclusions

      public void setFulfillmentInclusions(Map<String,List<String>> fulfillmentInclusions)
      List of inclusion criteria to compare against a FulfillmentGroup to determine if this payment option is allowed. The key is the path of the field to compare with on the group. The value is the list of valid values.

      Example values:

      • address.country -> ['US', 'UK', 'CA']
      • fulfillmentOption.name -> ['STANDARD', 'PRIORITY', 'EXPRESS']

    • setFulfillmentExclusions

      public void setFulfillmentExclusions(Map<String,List<String>> fulfillmentExclusions)
      List of exclusion criteria to compare against a FulfillmentGroup to determine if this payment option is allowed. The key is the path of the field to compare with on the group. The value is the list of valid values.

      Example values:

      • address.country -> ['US', 'UK', 'CA']
      • fulfillmentOption.name -> ['STANDARD', 'PRIORITY', 'EXPRESS']

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • canEqual

      protected boolean canEqual(Object other)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object