provideBanksComponent

After creating an instance of the PrimerHeadlessUniversalCheckout.ComponentWithRedirectManager you must use one of the compatible provide methods which will provide the component that can be used to build the flow. The method provideBanksComponent is backward compatible with older versions of iOS.

SWIFT

public func provideBanksComponent(paymentMethodType: String) throws -> any PrimerHeadlessMainComponent

​

Parameters

Hide Parameters

paymentMethodType · String · required

A unique string identifier for the payment method. Supported payment methods for current client session are returned in primerHeadlessUniversalCheckoutDidLoadAvailablePaymentMethods. For Component with redirect manager, the supported payment method is ADYEN_IDEAL.

​

Returns

An instance conforming to the PrimerHeadlessMainComponent protocol. The PrimerHeadlessMainComponent protocol conforms to the PrimerHeadlessCollectDataComponent protocol.

Hide PrimerHeadlessMainComponent

Hide PrimerHeadlessCollectDataComponent

Data · PrimerCollectableData

The Data associated type

Step · PrimerHeadlessStep

The Step associated type

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.

errorDelegate · PrimerHeadlessErrorableDelegate

Error delegate will be triggered every time an error is thrown in the process.

SWIFT

  func didReceiveError(error: PrimerError)

validationDelegate · PrimerHeadlessValidatableDelegate

Validation delegate will be triggered every time collected data is updated.

SWIFT

  func didUpdate(validationStatus: PrimerValidationStatus, for data: PrimerCollectableData?)

PrimerValidationStatus · Enum

PrimerValidationStatus is an enum that represents the different validation statuses in the Primer SDK. It helps to communicate the state of validation for a particular process, providing clear categorization of validation states.

Hide enum PrimerValidationStatus

validating

Enum case representing the ongoing validation state. This indicates that the validation process is currently in progress.

valid

Enum case representing a successful validation state. This indicates that the validation process has completed successfully and the data is valid.

invalid

Enum case representing an unsuccessful validation state due to validation errors. This indicates that the validation process has completed but has found one or more errors in the data.

Hide Associated Value

errors · [PrimerValidationError]

An array of PrimerValidationError representing the specific validation errors found.

error

Enum case representing an error state due to an unexpected issue. This indicates that an unexpected error has occurred during the validation process.

Hide Associated Value

error · PrimerError

A PrimerError representing the unexpected error that occurred.

stepDelegate · PrimerHeadlessSteppableDelegate

BanksStep is a enum class holding different output data for specific steps. Whenever submit method is called, stepDelegate will trigger the next step in case the call to the mentioned method was successful.

In the case of ADYEN_IDEAL, the steps return will be of type BanksStep

Show enum BanksStep

loading

Enum member representing the step of loading data for the form redirect component.

banksRetrieved(banks: [IssuingBank])

Enum member representing the step of issuing banks retrieved.

Hide Properties

banks · [IssuingBank]

The issuing banks array associated with this payment flow.

Hide IssuingBank

The IssuingBank class provides properties to hold bank details.

Hide Properties

id · String

The string bank id

name · String

The bank name string

iconUrlStr · String

The bank icon url string

isDisabled · String

Boolean indicating whether the bank is disabled

SWIFT

  func didReceiveStep(step: PrimerHeadlessStep)

updateCollectedData(collectableData: Data)

Update component with collected data by passing an enum representing collectable data. 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 validationDelegate.

In case of ADYEN_IDEAL, the Data will be of type BanksCollectableData

Show enum BanksCollectableData

bankId

Enum member representing the bank id.

Hide Properties

bankId · String

The string bank id

bankFilterText · String

Enum member representing the text used for filtering the list of banks by name.

Hide Properties

text

The text used for filtering the list of banks by name.

​

Throws

Hide Throws

unsupportedPaymentMethod

An error that will be thrown in case the provide method has been called using unsupported paymentMethodType.

Supported payment methods for current client session are returned in the onAvailablePaymentMethodsLoaded delegate.

Currently, the supported payment method types are:

• ADYEN_IDEAL

genericError

An error that will be thrown in case the provide method fails because of sdk not correctly used.