TapToPayUxConfiguration

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

Link copied to clipboard
class Builder

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

Link copied to clipboard
sealed interface Color : Parcelable

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

Link copied to clipboard
data class ColorScheme : Parcelable

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

Link copied to clipboard

Whether the UX on the Tap to Pay reader should be in dark mode. If a color resource with dark and light variants is used, the appropriate variant will be chosen based on this setting.

Link copied to clipboard
sealed interface TapZone : Parcelable

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.

Link copied to clipboard

The indicator for the tap zone. This shows where the user should tap on the reader.

Link copied to clipboard
sealed interface TapZonePosition : Parcelable

The position of the tap zone indicator on the screen.

Functions

Link copied to clipboard
abstract fun describeContents(): Int
Link copied to clipboard
abstract fun writeToParcel(p0: Parcel, p1: Int)