external/com.stripe.stripeterminal.external.models/TapToPayUxConfiguration

TapToPayUxConfiguration

data class TapToPayUxConfiguration : Serializable

Configuration for the user experience (UX) of the Tap to Pay screen. This configuration is only used for the Tap to Pay reader to customize the appearance of the Tap to Pay screen. There are three main components to the configuration:

The type and position of the tap zone indicator, which directs the user where to tap their payment method.
The overall theme for this screen, either light or dark mode.
The color scheme for this screen.

Use of this SDK is subject to the Stripe Terminal Terms: https://stripe.com/terminal/legal

Types

Builder

class Builder

This builder allows you to create a UX configuration and override only the desired properties.

Color

sealed interface Color : Serializable

A color for the UX on the Tap to Pay reader, for use in a ColorScheme.

ColorScheme

data class ColorScheme : Serializable

The color scheme for the UX on the Tap to Pay reader.

Companion

object Companion

TapZone

sealed interface TapZone : Serializable

Configuration for the tap zone on the Tap to Pay reader. The tap zone is the area on the reader where the customer should tap their payment method.

Theme

enum Theme : Serializable, Enum<TapToPayUxConfiguration.Theme>

The visual theme used by the Tap to Pay Reader UX. If a color resource with dark and light variants is used, the appropriate variant will be chosen based on this setting.