Package com.broadleafcommerce.payment.service.gateway

Class StripeRestConfigurationProperties

java.lang.Object
com.broadleafcommerce.paymentgateway.properties.DiscriminatedProperties<StripeRestConfigurationProperties>
com.broadleafcommerce.payment.service.gateway.StripeRestConfigurationProperties
@ConfigurationProperties("broadleaf.stripe.rest") public class StripeRestConfigurationProperties extends com.broadleafcommerce.paymentgateway.properties.DiscriminatedProperties<StripeRestConfigurationProperties>

  • Constructor Details

    • StripeRestConfigurationProperties

      public StripeRestConfigurationProperties()

  • Method Details

    • getPrivateApiKey

      public String getPrivateApiKey(@Nullable String applicationId, @Nullable String tenantId)

    • getWebhookEndpointSecret

      public String getWebhookEndpointSecret(@Nullable String applicationId, @Nullable String tenantId)

    • getShouldIncludeLevel3Data

      @Deprecated public boolean getShouldIncludeLevel3Data()
      Deprecated.
      in favor of getShouldIncludeLevel3Data(String, String)

    • getShouldIncludeLevel3Data

      public boolean getShouldIncludeLevel3Data(@Nullable String applicationId, @Nullable String tenantId)

    • getPaymentIntentReturnUrl

      @Deprecated @Nullable public String getPaymentIntentReturnUrl()
      Deprecated.
      in favor of getPaymentIntentReturnUrl(String, String)

    • getPaymentIntentReturnUrl

      @Nullable public String getPaymentIntentReturnUrl(@Nullable String applicationId, @Nullable String tenantId)

    • getPaymentIntentReturnUrl

      @Nullable public String getPaymentIntentReturnUrl(@NonNull @NonNull com.broadleafcommerce.paymentgateway.domain.PaymentRequest paymentRequest)

    • isAbsoluteUrl

      protected boolean isAbsoluteUrl(@NonNull @NonNull String url)

    • setPublicApiKey

      @Deprecated public void setPublicApiKey(String publicApiKey)
      Deprecated.
      this is not used in the gateway but on the frontend
      The Stripe-provided public key for your REST API integration

    • setPrivateApiKey

      public void setPrivateApiKey(String privateApiKey)
      The Stripe-provided private key for your REST API integration

    • setWebhookEndpointSecret

      public void setWebhookEndpointSecret(String webhookEndpointSecret)
      The Stripe-provided secret key for your webhook endpoint

    • setPaymentIntentReturnUrl

      public void setPaymentIntentReturnUrl(String paymentIntentReturnUrl)
      Where the user should be redirected after they authenticate or cancel their payment on the payment method’s app or site. This is only relevant for requests where the PaymentIntent is being confirmed. Note the two accessors getPaymentIntentReturnUrl(String, String) and getPaymentIntentReturnUrl(PaymentRequest). If calling getPaymentIntentReturnUrl(PaymentRequest), then "broadleaf.stripe.rest.payment-intent-return-url" can be a relative url which will be combined with PaymentRequest.getSiteBaseUrl() to form a full url. If calling getPaymentIntentReturnUrl(String, String), then the value of "broadleaf.stripe.rest.payment-intent-return-url" must be an absolute url. Otherwise, either a relative or absolute url may be used.

    • setShouldIncludeLevel3Data

      public void setShouldIncludeLevel3Data(boolean shouldIncludeLevel3Data)
      Whether or not credit card level 3 data should be included in each transaction. This is most applicable for businesses that accept a significant portion of corporate credit cards. The inclusion of this data for corporate card transactions can lead to more favorable rates from the processing credit card companies.

    • setHardDeclineCodes

      public void setHardDeclineCodes(List<String> hardDeclineCodes)
      The list of payment gateway response codes that should be considered a PaymentDeclineType.HARD decline. The categorization of decline types is primarily used with saved payment methods where a payment method should no longer be used if it's related to a hard decline. For example, if a payment gateway tells us that the payment method is stolen, then we should not allow it to be used anymore.

    • setInvalidPaymentMethodDelcineCodes

      public void setInvalidPaymentMethodDelcineCodes(List<String> invalidPaymentMethodDelcineCodes)
      The list of decline codes. If during payment request an error occurs and the decline code of the error is present in this list the DefaultTransactionFailureTypes.INVALID_PAYMENT_METHOD will be set as PaymentResponse.getFailureType().

    • getPublicApiKey

      @Deprecated public String getPublicApiKey()
      Deprecated.
      this is not used in the gateway but on the frontend
      The Stripe-provided public key for your REST API integration

    • getHardDeclineCodes

      public List<String> getHardDeclineCodes()
      The list of payment gateway response codes that should be considered a PaymentDeclineType.HARD decline. The categorization of decline types is primarily used with saved payment methods where a payment method should no longer be used if it's related to a hard decline. For example, if a payment gateway tells us that the payment method is stolen, then we should not allow it to be used anymore.
      Returns:
      The list of payment gateway response codes that should be considered a PaymentDeclineType.HARD decline

    • getInvalidPaymentMethodDelcineCodes

      public List<String> getInvalidPaymentMethodDelcineCodes()
      The list of decline codes. If during payment request an error occurs and the decline code of the error is present in this list the DefaultTransactionFailureTypes.INVALID_PAYMENT_METHOD will be set as PaymentResponse.getFailureType().
      Returns:
      the list of decline codes related to DefaultTransactionFailureTypes.INVALID_PAYMENT_METHOD