provideNolPayPaymentComponent

This method allows you get a new instance of NolPayPaymentComponent that can be used to link new nol Pay cards.

KOTLIN

fun provideNolPayPaymentComponent(viewModelStoreOwner: ViewModelStoreOwner): NolPayPaymentComponent

​

Parameters

Hide Parameters

viewModelStoreOwner · ViewModelStoreOwner · required

The ViewModelStoreOwner to associate with the component.

​

Returns

An instance of NolPayPaymentComponent.

Hide NolPayPaymentComponent

start()

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

updateCollectedData(collectableData: NolPayPaymentCollectableData)

Update component with collected data by passing implementations of sealed interface representing collectable data for payment flow with a nol Pay card. 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 NolPayPaymentCollectableData

NolPayCardAndPhoneData

Data class representing nol Pay card and phone data used in payment process.

Hide Properties

nolPaymentCard

The nol Pay payment card to use for payment is retrieved using NolPayLinkedCardsComponent.

mobileNumber

The mobile number in E.164 format that the nol Pay payment card was associated with.

NolPayTagData

Data class representing nol Pay tag data collected during the payment process.

Hide Properties

tag · Tag

An NFC tag decoded using NolPayNfcComponent.

submit()

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

componentStep: Flow<NolPayPaymentStep>

NolPayPaymentStep 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 NolPayPaymentStep

CollectCardAndPhoneData

Object representing the step of collecting card and phone data for nol Pay payment.

CollectTagData

Object representing the step of collecting tag data for nol Pay card linking.

The PrimerValidationStatus interface encompasses a range of validation statuses.

Show sealed interface PrimerValidationStatus

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

Hide Properties

collectableData

The data being validated.

Indicates that the data has successfully been validated.

Hide Properties

collectableData

The successfully validated data.

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

The data that failed validation.

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

The data for which the error occurred.

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.