Checkout 3DS SDK/com.checkout.threeds.domain.model

Package-level declarations

Types

data class AllStyleCustomization(@ColorRes var textColor: Int? = null, @FontRes var textFont: Int? = null, @ColorRes var tint: Int? = null)

General customization for all elements that could be overridden by specific element customisation

AuthenticationCompleted

data class AuthenticationCompleted : AuthenticationResult

This class holds the details for the success result of the authentication process.

AuthenticationError

data class AuthenticationError : AuthenticationResult

This class holds the details for the error result of the authentication process.

AuthenticationErrorType

enum AuthenticationErrorType : Enum<AuthenticationErrorType> , Parcelable

This enum holds the type of the error occurred during the authentication process.

AuthenticationParameters

data class AuthenticationParameters(val sessionId: String, val sessionSecret: String, val scheme: String)

The class used to provide input parameters required for an authentication request.

AuthenticationResult

open class AuthenticationResult : Parcelable

This class holds the details for the result of the authentication process.

BackgroundCustomization

data class BackgroundCustomization(@ColorRes var backgroundColor: Int? = null, @DimenRes var cornerRadius: Int? = null, @ColorRes var borderColor: Int? = null, @DimenRes var borderWidth: Int? = null, @DimenRes var bgElevation: Int? = null)

Use this class to set the background style of a specified user interface element.

ButtonCustomization

data class ButtonCustomization(val buttonBackground: BackgroundCustomization, val label: TextStyleCustomization)

Use this class to set the visual style of the main action button on a 3DS2 challenge screen.

EditTextCustomization

data class EditTextCustomization(val input: TextStyleCustomization, val editTextBackground: BackgroundCustomization)

Use this class to set the visual style of the challenge text entry box.

FooterCustomization

data class FooterCustomization(@ColorRes var expandIndicatorColor: Int? = null, val labelStyleCustomization: TextStyleCustomization = TextStyleCustomization(), val textStyleCustomization: TextStyleCustomization = TextStyleCustomization())

Use this class to set the visual style of footer section, at the bottom of a 3DS2 challenge screen. This section contains information text provided by the card issuer. Each piece of information is expandable, with just the label and an expand indicator showing until the user expands the section to reveal the body text within.

LabelCustomization

sealed class LabelCustomization

Generic class used to customize the visual style of text on the challenge screen.

NavigationBarCustomization

data class NavigationBarCustomization(@ColorRes var backgroundColor: Int? = null, @DimenRes var panelElevation: Int? = null, val headingStyleCustomization: TextCustomization = TextCustomization(), val buttonStyleCustomization: TextCustomization = TextCustomization())

Use this class to provide objects that specify user interface customizations for the navigation bar that appears at the top of the challenge screen for 3DS1 and 3DS2, and includes the screen title and the Cancel button.

ResultType

sealed class ResultType

This enum holds the type of the result for the authentication process.

SelectorCustomization

data class SelectorCustomization(@ColorRes var selectorColor: Int? = null, val label: TextStyleCustomization = TextStyleCustomization())

Use this class to set the visual style of options that users can select during a single-select or a multi-select challenge.

Severity

enum Severity : Enum<Severity>

The severity levels of warnings produced by the SDK.

SwitchCustomization

data class SwitchCustomization(@ColorRes var textColor: Int? = null, @FontRes var textFont: Int? = null, @ColorRes var thumbColor: Int? = null) : LabelCustomization

Use this class to set the visual style of the ‘allow list’ switch that may appear on a 3DS2 challenge screen. Users can choose to add a merchant to their card issuer’s allow list to ensure they are trusted for future transactions.

TextCustomization

data class TextCustomization(@ColorRes var textColor: Int? = null, @FontRes var textFont: Int? = null, @StringRes var text: Int? = null) : LabelCustomization

Use this class to customize the style of the text in the Navigation Bar used across 3DS1 and 3DS2 challenge screens, as well as the actual text displayed as the title.

TextStyleCustomization

data class TextStyleCustomization(@ColorRes var textColor: Int? = null, @FontRes var textFont: Int? = null) : LabelCustomization

Use this class to customize the visual style of the text on the challenge screen. There are separate TextStyleCustomization classes for the challenge information header, the challenge information text, the label for the challenge entry form and the label for the whitelist selection.

UICustomization

data class UICustomization(val navigationBarCustomization: NavigationBarCustomization = NavigationBarCustomization(), val informationHeaderStyleCustomization: TextStyleCustomization = TextStyleCustomization(), val informationTextStyleCustomization: TextStyleCustomization = TextStyleCustomization(), val entryLabelStyleCustomization: TextStyleCustomization = TextStyleCustomization(), val whitelistLabelStyleCustomization: SwitchCustomization = SwitchCustomization(), val actionButtonStyleCustomization: ButtonCustomization = ButtonCustomization.actionButton(), val alternativeButtonStyleCustomization: ButtonCustomization = ButtonCustomization.alternateButton(), val entryBoxStyleCustomization: EditTextCustomization = EditTextCustomization.default(), val entrySelectorStyleCustomization: SelectorCustomization = SelectorCustomization(), val footerCustomization: FooterCustomization = FooterCustomization())

Used to provide objects that specify user interface customizations for the 3D Secure 2 challenge screens.

Warning

sealed class Warning

Represents a warning produced by the 3DS SDK, either due to potential security issues found, or to communicate a rejected configuration request.

Functions

uiCustomization

fun uiCustomization(block: UICustomization.() -> Unit): UICustomization

Root DSL Method for UICustomization setup