Android SDK component with redirect manager: provide

This method allows you get a new instance of a PrimerHeadlessMainComponent implementation.

KOTLIN

@Throws(SdkUninitializedException::class, UnsupportedPaymentMethodException::class)
fun <T : PrimerHeadlessMainComponent<out PrimerCollectableData, out PrimerHeadlessStep>> provide(paymentMethodType: String): T

Parameters

Hide Parameters

paymentMethodType

String

required

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

Type parameters

Hide Type parameters

PrimerHeadlessMainComponent<out PrimerCollectableData, out PrimerHeadlessStep>

required

The type of the PrimerHeadlessMainComponent implementation to return.

Hide Supported types

Type	paymentMethodType
BanksComponent	ADYEN_IDEAL

Returns

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

Hide Common API and available components

PrimerHeadlessMainComponent

Implemented by all components

Show Common API

start()

Initialize the component by calling the start function. This method should be called only once.

submit()

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

componentError: Flow<PrimerError>

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

Hide Supported types

BanksComponent

PrimerHeadlessMainComponent<BanksCollectableData, BanksStep>

Show API

updateCollectedData(collectableData: BanksCollectableData)

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.

Show sealed interface BanksCollectableData

Filter

Data class representing the collected bank list filter.

Hide Properties

query

String

A string representing the query by which the bank list should be filtered.

BankId

Data class representing the collected bank id.

Hide Properties

String

The id of the bank to use when processing the payment.

componentStep: Flow<BanksStep>

BanksStep 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.

Show sealed interface BanksStep

Object signifing that the list of available banks is in the process of being loaded.

BanksRetrieved

A data class representing the step of emitting the list of available banks.

Hide Properties

banks

List<IssuingBank>

The list of available banks.

Show Properties

IssuingBank

Show Properties

String

required

String representing the bank id.

name

String

required

String representing the bank name.

disabled

Boolean

required

Boolean indicating whether the bank is disabled or not.

iconUrl

String

required

A string representing the icon url.

componentValidationStatus: Flow<PrimerValidationStatus<BanksCollectableData>>

The PrimerValidationStatus interface encompasses a range of validation statuses.

Show sealed interface PrimerValidationStatus

Validating<BanksCollectableData>

Indicates that data is currently in the process of being validated.

Hide Properties

collectableData

BanksCollectableData

The data being validated.

Valid<BanksCollectableData>

Indicates that the data has successfully been validated.

Hide Properties

collectableData

BanksCollectableData

The successfully validated data.

Invalid<BanksCollectableData>

Indicates that the data has been considered invalid after validation.

Hide Properties

validationErrors

List<PrimerValidationError>

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

Show PrimerValidationError

List<PrimerValidationError>

Show Type

PrimerValidationError

Show Properties

errorId

String

required

A unique error identifier.

description

String

required

A error description.

diagnosticsId

String

required

A unique diagnostics id for the given error.

collectableData

BanksCollectableData

The data that failed validation.

Error<BanksCollectableData>

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

Hide Properties

error

PrimerError

The specific PrimerError that occurred during validation.

Show PrimerValidationError

errorId

String

required

A unique error identifier.

errorCode

String?

A unique error code.

description

String

required

A error description.

recoverySuggestion

String?

A recovery suggestion for the given error. In case it’s present, use it to try to recover from error.

diagnosticsId

String

required

A unique diagnostics id for the given error.

collectableData

BanksCollectableData

The data for which the error occurred.

Throws

Hide Throws

SdkUninitializedException

An exception that will be thrown in case the SDK was not initialized properly. Before calling any of the manager’s method, the SDK must be initialized using start method.

UnsupportedPaymentMethodException

An exception that will be thrown in case the initialization of the manager has been done using unsupported paymentMethodType - PrimerHeadlessMainComponent combination. Supported payment methods for current client session are returned in onAvailablePaymentMethodsLoaded callback. See Supported types for the supported combinations.

Example

KOTLIN

class CheckoutActivity : AppCompatActivity() {
  // 👇 Add this
  private val banksComponent by lazy {
	PrimerHeadlessUniversalCheckoutComponentWithRedirectManager(viewModelStoreOwner = this)
            .provide(paymentMethodType = "ADYEN_IDEAL")
  }
}

Android SDK

​Parameters

​Type parameters

​Returns

​Throws

​Example

Parameters

Type parameters

Returns

Throws

Example