Package com.broadleafcommerce.vendor.stripe.service.setupintent

Interface StripeSetupIntentService

All Known Implementing Classes:
DefaultStripeSetupIntentService
public interface StripeSetupIntentService
The service is used to work with SetupIntent API.
Author:
Dima Myroniuk (dmyroniuk)

  • Method Details

    • createSetupIntent

      SetupIntentResponse createSetupIntent(SetupIntentRequest request)
      Creates a SetupIntent object for the provided request. It can be used to attach a payment method and confirm to collect any required permissions to charge the payment method later.

      If the SetupIntentRequest.getStripeCustomerId() is not provided the new Customer will be created.

      This method supports creating the SetupIntent for the "us_bank_account" payment method type (ACH). To specify this type add PAYMENT_METHOD_TYPE to the SetupIntentRequest.additionalFields with "us_bank_account" value.

      Parameters:
      request - the request to create the SetupIntent
      Returns:
      the response that contains the SetupIntent.getClientSecret() and the Customer ID for which this intent was created

    • getSetupIntentInfo

      default SetupIntentResponse getSetupIntentInfo(ReadSetupIntentRequest request)
      Gets a SetupIntent info for the specified id.
      Parameters:
      request - the request to read the SetupIntent
      Returns:
      the SetupIntent info for the specified id