Whitelabel Pay SDK/com.paymenttools.paymenttoolssdk/WhitelabelPayImplementation

WhitelabelPayImplementation

class WhitelabelPayImplementation(context: Context, configs: WhitelabelPayConfigurations) : WhitelabelPay

Payment tools SDK to enroll into the Payment tools White Label Pay program. After successful enrollment you can read and use payment tokens. Public-private key pair, device id, enrollment and payment tokens are stored in an encrypted shared preferences file.

Parameters

context

Application context

configs

Configuration object filled from merchant side

Constructors

WhitelabelPayImplementation

constructor(context: Context, configs: WhitelabelPayConfigurations)

Types

Companion

object Companion

Properties

availableOfflineTokensCount

open override val availableOfflineTokensCount: Int

The number of tokens available in the local storage.

state

open override val state: StateFlow<State>

Property that reflects the current state of the SDK.

subjectId

open override val subjectId: UUID?

Property that provides the device subject associated to reference id in WhitelabelPayConfigurations. Can be null if the device is not fully enrolled.

token

open override val token: StateFlow<Token>

Property that provides a Token depending on the current state of the SDK.

Functions

deactivatePaymentMean

open suspend override fun deactivatePaymentMean(paymentMeanId: String, onDeactivationSuccess: () -> Unit)

Deactivate an active payment means, calling this func will ask the server to deactivate the payment means. It will also delete all payment tokens for the payment mean.

deletePaymentMean

open suspend override fun deletePaymentMean(paymentMeanId: String, onDeletionSuccess: () -> Unit)

Function to delete a payment mean. Deleting an active mean will result in deleting all it's payment tokens as well.

deviceState

open override fun deviceState(): State

Provides the status of the device State locally saved in the storage.

exportLogs

open override fun exportLogs(): File?

getEnrolmentToken

open override fun getEnrolmentToken(): Token

Provides an enrolment token Token.Enrolment to enroll a card in WhitelabelPay

getPaymentMeansList

open suspend override fun getPaymentMeansList(): List<PaymentMean>

Provides the list of payment means PaymentMean. The list consists of active and also inactive payment means. Deleted payment means won't be displayed in this list.

getPayments

open suspend override fun getPayments(page: Int, sortQuery: String?, status: TransactionStatus?): PaymentsOverview

Function to retrieve the payments history overview

getPaymentToken

open override fun getPaymentToken(): Token

Provides a signed payment token Token.Payment from White Label Pay. The Token.Payment.signedToken is the signed token representation required to make a successful payment transaction.

handleNotification

open suspend override fun handleNotification(eventType: String?)

Function to pass a received the notification data payload instance to the SDK in order to adjust the SDK state accordingly. This function should be called from FirebaseMessagingService.onMessageReceived(remoteMessage: RemoteMessage)

reactivatePaymentMean

open suspend override fun reactivatePaymentMean(paymentMeanId: String, onReactivationSuccess: () -> Unit)

Calling this method will reactivate a deactivated payment mean.

reset

open override fun reset()

Function to purge all SDK data. This will effectively reset the SDK for a clean start.

setReferenceId

open suspend override fun setReferenceId(referenceId: String)

Function to set the reference Id in WhitelabelPayConfigurations

signOff

open suspend override fun signOff(onSignOffSuccess: () -> Unit)

Calling this method will delete all user specific data, including payment means, payment tokens, enrolment token and signing keys.

startMonitoringUpdates

open override fun startMonitoringUpdates(onError: (WhitelabelPayError) -> Unit)

Function to start refreshing tokens and and data sync with the backend. Calling this function periodically emits a new Token, as well as syncs the SDK state with the backend.

stopMonitoringUpdates

open override fun stopMonitoringUpdates()

Function to stop refreshing emitting new token object in token property, as well as stopping sync polling.

sync

open suspend fun sync(): State

Sync the SDK state without updating the token value.

open suspend override fun sync(updateToken: Boolean): State

Sync the local SDK state with the backend. Should be called whenever appropriate to have the SDK in a synced state.