Package com.broadleafcommerce.orderoperation.service.payment

Class OrderOperationPaymentProperties

java.lang.Object
com.broadleafcommerce.orderoperation.properties.DiscriminatedProperties<OrderOperationPaymentProperties>
com.broadleafcommerce.orderoperation.service.payment.OrderOperationPaymentProperties
@ConfigurationProperties("broadleaf.orderoperation.service.payment") public class OrderOperationPaymentProperties extends DiscriminatedProperties<OrderOperationPaymentProperties>
Payment-related properties within OrderOperationServices, discriminated by tenant and application.
Author:
Sunny Yu

  • Constructor Details

    • OrderOperationPaymentProperties

      public OrderOperationPaymentProperties()

  • Method Details

    • getCapturePaymentGatewayPriorities

      public List<String> getCapturePaymentGatewayPriorities(@Nullable String applicationId, @Nullable String tenantId)
      Gets the value of capturePaymentGatewayPriorities based on the given application and tenant id.
      Parameters:
      applicationId - the current context's application id
      tenantId - the current context's tenant id
      Returns:
      the value of capturePaymentGatewayPriorities based on the given application and tenant id

    • getRefundPaymentGatewayPriorities

      public List<String> getRefundPaymentGatewayPriorities(@Nullable String applicationId, @Nullable String tenantId)
      Gets the value of refundPaymentGatewayPriorities based on the given application and tenant id.
      Parameters:
      applicationId - the current context's application id
      tenantId - the current context's tenant id
      Returns:
      the value of refundPaymentGatewayPriorities based on the given application and tenant id

    • getCancelPaymentGatewayPriorities

      public List<String> getCancelPaymentGatewayPriorities(@Nullable String applicationId, @Nullable String tenantId)
      Gets the value of cancelPaymentGatewayPriorities based on the given application and tenant id.
      Parameters:
      applicationId - the current context's application id
      tenantId - the current context's tenant id
      Returns:
      the value of cancelPaymentGatewayPriorities based on the given application and tenant id

    • getAutoCapturePaymentGateways

      public List<String> getAutoCapturePaymentGateways(@Nullable String applicationId, @Nullable String tenantId)
      Gets the value of autoCapturePaymentGateways based on the given application and tenant id.
      Parameters:
      applicationId - the current context's application id
      tenantId - the current context's tenant id
      Returns:
      the value of autoCapturePaymentGateways based on the given application and tenant id

    • setCapturePaymentGatewayPriorities

      public void setCapturePaymentGatewayPriorities(List<String> capturePaymentGatewayPriorities)
      A list of payment gateway types defining the order by which payments will be captured.

      Note that these priorities affect claiming checkout-executed AuthAndCapture transactions as well, therefore it is recommended to put payment gateways that use AuthAndCapture transaction type at a higher priority. This is to ensure that transactions can be claimed when possible, instead of executing new capture transactions.

    • setRefundPaymentGatewayPriorities

      public void setRefundPaymentGatewayPriorities(List<String> refundPaymentGatewayPriorities)
      A list of payment gateway types defining the order by which payments will be refunded.

    • setCancelPaymentGatewayPriorities

      public void setCancelPaymentGatewayPriorities(List<String> cancelPaymentGatewayPriorities)
      A list of payment gateway types defining the order by which the payments will be refunded and/or reversed for the cancelled fulfillment.

    • setEnableAutoCapture

      public void setEnableAutoCapture(boolean enableAutoCapture)
      If true, auto-capture will be enabled for the specified gateways during order creation.

    • setAutoCapturePaymentGateways

      public void setAutoCapturePaymentGateways(List<String> autoCapturePaymentGateways)
      A list of payment gateway types that require auto-capturing the payments. To enable auto-capturing during order creation, set enableAutoCapture to true.

    • isEnableAutoCapture

      public boolean isEnableAutoCapture()
      If true, auto-capture will be enabled for the specified gateways during order creation.