This method allows you get a new instance of StripeAchUserDetailsComponent to initiate Stripe ACH payments.

1
fun <T : PrimerHeadlessAchComponent<out PrimerCollectableData, out PrimerHeadlessStep>> provide(paymentMethodType: String): T
kotlin
copy

Parameters

paymentMethodType
StringRequired

A unique string identifier for the payment method. Supported payment methods for current client session are returned in onAvailablePaymentMethodsLoaded callback.

Type parameters

T
PrimerHeadlessAchComponent<out PrimerCollectableData, out PrimerHeadlessStep>Required

The type of the PrimerHeadlessAchComponent implementation to return.

Supported types

Returns

An instance of the passed generic type T, which could be any of the following available components:

Common API and available components
PrimerHeadlessAchComponent
Implemented by all components
Common API
Initialize the component by calling the start function. This method should be called only once.

Call submit function in order to process collected data and move component to next state.

Get a Flow of PrimerError objects that represent errors emitted by this component. Subscribers can observe and handle errors using this Flow.

Supported types
StripeAchUserDetailsComponent
PrimerHeadlessAchComponent<AchUserDetailsCollectableData, AchUserDetailsStep>
API

Update component with collected data by passing implementations of sealed interface. This method can be called at any point, even if you have only partially collected data. To validate the partially collected data, you can refer to the componentValidationStatus and receive the validation status when it's updated.

sealed interface AchUserDetailsCollectableData
A data class representing the customer's first name.
Properties
value
String
The customer's first name.
A data class representing the customer's last name.
Properties
value
String
The customer's last name.
A data class representing the customer's email address.
Properties
value
String
The customer's email address.

AchUserDetailsStep is a class holding different output data for specific steps. Whenever start or submit methods are called, componentStep will trigger the next step in case the call to the mentioned method was successful.

sealed interface AchUserDetailsStep
Data class representing the retrieved user details.
Properties
firstName
String
The first name previously sent on client session creation.
lastName
String
The first name previously sent on client session creation.
The email address previously sent on client session creation.
Object representing the collected user details.

The PrimerValidationStatus interface encompasses a range of validation statuses.

sealed interface PrimerValidationStatus
Indicates that data is currently in the process of being validated.
Properties
collectableData
AchUserDetailsCollectableData

The data being validated.

Indicates that the data has successfully been validated.
Properties
collectableData
AchUserDetailsCollectableData

The successfully validated data.

Indicates that the data has been considered invalid after validation.
Properties
validationErrors
List<PrimerValidationError>

List of PrimerValidationError objects that represent data validation errors emitted by this component.

Properties
errorId
StringRequired
A unique error identifier.
description
StringRequired
A error description.
diagnosticsId
StringRequired
A unique diagnostics id for the given error.
collectableData
AchUserDetailsCollectableData

The data that failed validation.

Represents the status when an error occurred during the validation process.
Properties
error
PrimerError

The specific PrimerError that occurred during validation.

errorId
StringRequired
A unique error identifier.
errorCode
String?
A unique error code.
description
StringRequired
A error description.
A recovery suggestion for the given error. In case it's present, use it to try to recover from error.
diagnosticsId
StringRequired
A unique diagnostics id for the given error.
collectableData
AchUserDetailsCollectableData

The data for which the error occurred.

Example

123456789101112131415
class CheckoutActivity : AppCompatActivity() {  // 👇 Add this  private val stripeAchUserDetailsComponent by lazy {      /**      Note: Although the component focuses on collecting user details pertaining to ACH,      it  also kicks off the tokenization and payment processes and because of that it should      be kept in memory until the checkout is completed. This component implements      Android's ViewModel class, therefore keeping a reference to it is not enough. Instead,       pass a long lifecycle ViewModelStoreOwner when you initialize PrimerHeadlessUniversalCheckoutAchManager,      such as that of your activity or parent fragment.      */      PrimerHeadlessUniversalCheckoutAchManager(viewModelStoreOwner)        .provide<StripeAchUserDetailsComponent>(paymentMethodType = "STRIPE_ACH")  }}
kotlin
copy