payments-ui-core/com.stripe.android.ui.core.elements

Package-level declarations

Types

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

@Serializable

data class AddressSpec(val apiPath: IdentifierSpec = IdentifierSpec.Generic("billing_details[address]"), val allowedCountryCodes: Set<String> = CountryUtils.supportedBillingCountries, val displayFields: Set<DisplayField> = emptySet(), val showLabel: Boolean = true, val type: AddressType = AddressType.Normal(), val hideCountry: Boolean = false) : FormItemSpec, Parcelable

AffirmHeaderElement

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

data class AffirmHeaderElement(val identifier: IdentifierSpec, val controller: Controller? = null) : FormElement

AffirmTextSpec

@Serializable

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

data class AffirmTextSpec(val apiPath: IdentifierSpec = IdentifierSpec.Generic("affirm_header")) : FormItemSpec

Header that displays promo information about Affirm

AfterpayClearpayHeaderElement

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

data class AfterpayClearpayHeaderElement(val identifier: IdentifierSpec, val controller: Controller? = null) : FormElement

AfterpayClearpayTextSpec

@Serializable

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

data class AfterpayClearpayTextSpec(val apiPath: IdentifierSpec = IdentifierSpec.Generic("afterpay_text")) : FormItemSpec

Header that displays information about installments for Afterpay

AuBankAccountNumberConfig

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

class AuBankAccountNumberConfig : TextFieldConfig

A text field configuration for an AU bank account number

AuBankAccountNumberSpec

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

@Serializable

data class AuBankAccountNumberSpec(val apiPath: IdentifierSpec = IdentifierSpec.Generic( "au_becs_debit[account_number]" )) : FormItemSpec

AuBecsDebitMandateTextElement

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

data class AuBecsDebitMandateTextElement(val identifier: IdentifierSpec, val merchantName: String?, val controller: InputController? = null) : FormElement

This is an element that has static text because it takes no user input, it is not outputted from the list of form field values. If the stringResId contains a %s, the first one will be populated in the form with the merchantName parameter.

AuBecsDebitMandateTextSpec

@Serializable

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

data class AuBecsDebitMandateTextSpec(val apiPath: IdentifierSpec = IdentifierSpec.Generic("au_becs_mandate")) : FormItemSpec

BacsDebitAccountNumberConfig

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

class BacsDebitAccountNumberConfig : TextFieldConfig

BacsDebitBankAccountSpec

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

@Serializable

class BacsDebitBankAccountSpec : FormItemSpec

BacsDebitConfirmSpec

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

@Serializable

class BacsDebitConfirmSpec : FormItemSpec

BacsDebitSortCodeConfig

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

class BacsDebitSortCodeConfig : TextFieldConfig

BlikConfig

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

class BlikConfig : TextFieldConfig

BlikElement

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

class BlikElement(val identifier: IdentifierSpec = IdentifierSpec.BlikCode, val controller: InputController = SimpleTextFieldController( textFieldConfig = BlikConfig() )) : SectionSingleFieldElement

BsbConfig

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

class BsbConfig(banks: List<BecsDebitBanks.Bank>) : TextFieldConfig

A text field configuration for a BSB number, or Bank State Branch Number, a six-digit number used to identify the individual branch of an Australian financial institution

BsbElement

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

class BsbElement(identifierSpec: IdentifierSpec, banks: List<BecsDebitBanks.Bank>, initialValue: String?) : FormElement

BsbSpec

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

@Serializable

data class BsbSpec(val apiPath: IdentifierSpec = IdentifierSpec.Generic( "au_becs_debit[bsb_number]" )) : FormItemSpec

Capitalization

@Serializable

enum Capitalization : Enum<Capitalization>

CardBillingAddressElement

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

class CardBillingAddressElement(identifier: IdentifierSpec, rawValuesMap: Map<IdentifierSpec, String?> = emptyMap(), countryCodes: Set<String> = emptySet(), countryDropdownFieldController: DropdownFieldController = DropdownFieldController( CountryConfig(countryCodes), rawValuesMap[IdentifierSpec.Country] ), sameAsShippingElement: SameAsShippingElement?, shippingValuesMap: Map<IdentifierSpec, String?>?, collectionMode: BillingDetailsCollectionConfiguration.AddressCollectionMode = BillingDetailsCollectionConfiguration.AddressCollectionMode.Automatic) : AddressElement

This is a special type of AddressElement that removes fields from the address based on the country. It is only intended to be used with the card payment method.

CardDetailsSectionController

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

class CardDetailsSectionController(cardAccountRangeRepositoryFactory: CardAccountRangeRepository.Factory, initialValues: Map<IdentifierSpec, String?>, collectName: Boolean = false, cbcEligibility: CardBrandChoiceEligibility = CardBrandChoiceEligibility.Ineligible) : SectionFieldErrorController

CardDetailsSectionElement

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

class CardDetailsSectionElement(cardAccountRangeRepositoryFactory: CardAccountRangeRepository.Factory, initialValues: Map<IdentifierSpec, String?>, collectName: Boolean = false, cbcEligibility: CardBrandChoiceEligibility = CardBrandChoiceEligibility.Ineligible, val identifier: IdentifierSpec, val controller: CardDetailsSectionController = CardDetailsSectionController( cardAccountRangeRepositoryFactory = cardAccountRangeRepositoryFactory, initialValues = initialValues, collectName = collectName, cbcEligibility = cbcEligibility, )) : FormElement

CashAppPayMandateTextSpec

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

@Serializable

data class CashAppPayMandateTextSpec(val apiPath: IdentifierSpec = IdentifierSpec.Generic("cashapp_mandate"), @StringRes val stringResId: Int = R.string.stripe_cash_app_pay_mandate) : FormItemSpec

CountrySpec

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

@Serializable

data class CountrySpec(val apiPath: IdentifierSpec = IdentifierSpec.Country, val allowedCountryCodes: Set<String> = CountryUtils.supportedBillingCountries) : FormItemSpec

This is the specification for a country field.

CvcConfig

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

class CvcConfig : CardDetailsTextFieldConfig

CvcController

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

class CvcController(cvcTextFieldConfig: CvcConfig = CvcConfig(), cardBrandFlow: StateFlow<CardBrand>, val initialValue: String? = null, val showOptionalLabel: Boolean = false) : TextFieldController, SectionFieldErrorController

CvcElement

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

data class CvcElement(val _identifier: IdentifierSpec, val controller: CvcController) : SectionSingleFieldElement

DisplayField

@Serializable

enum DisplayField : Enum<DisplayField>

DropdownItemSpec

@Serializable

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

data class DropdownItemSpec(val apiValue: String? = null, val displayText: String = "Other") : Parcelable

DropdownSpec

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

@Serializable

data class DropdownSpec(val apiPath: IdentifierSpec, val labelTranslationId: TranslationId, val items: List<DropdownItemSpec>) : FormItemSpec

EmailElement

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

data class EmailElement(val identifier: IdentifierSpec = IdentifierSpec.Email, val initialValue: String? = "", val controller: TextFieldController = SimpleTextFieldController( EmailConfig(), initialValue = initialValue )) : SectionSingleFieldElement

EmailSpec

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

@Serializable

data class EmailSpec(val apiPath: IdentifierSpec = IdentifierSpec.Email) : FormItemSpec

EmptyFormElement

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

data class EmptyFormElement(val identifier: IdentifierSpec = IdentifierSpec.Generic("empty_form"), val controller: Controller? = null) : FormElement

EmptyFormSpec

@Serializable

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

data object EmptyFormSpec : FormItemSpec

This defines an empty form spec. It is not intended to be used when building forms for PaymentSheet. This form solves an issue where {@link CompleteFormFieldValueFilter#filterFlow()} returns null when filtering no elements. If given this EmptyFormSpec, the filtering will view the form as complete. {@link LayoutSpec#create()} is the way to build a form with no elements.

ExternalPaymentMethodSpec

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

@Serializable

data class ExternalPaymentMethodSpec(val type: String, val label: String, val lightImageUrl: String, val darkImageUrl: String? = null) : Parcelable

Information for displaying external payment methods (EPMs), delivered in the v1/elements/sessions response.

ExternalPaymentMethodsRepository

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

class ExternalPaymentMethodsRepository @Inject constructor(errorReporter: ErrorReporter)

FormItemSpec

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

@Serializable(with = FormItemSpecSerializer::class)

sealed class FormItemSpec : Parcelable

This is used to define each section in the visual form layout specification

FormItemSpecSerializer

object FormItemSpecSerializer : JsonContentPolymorphicSerializer<FormItemSpec>

IbanConfig

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

class IbanConfig : TextFieldConfig

A text field configuration for an IBAN, or International Bank Account Number, as defined in ISO 13616-1.

IbanSpec

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

@Serializable

data class IbanSpec(val apiPath: IdentifierSpec = IdentifierSpec.Generic("sepa_debit[iban]")) : FormItemSpec

KeyboardType

@Serializable

enum KeyboardType : Enum<KeyboardType>

KlarnaHeaderStaticTextSpec

@Serializable

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

data class KlarnaHeaderStaticTextSpec(val apiPath: IdentifierSpec = IdentifierSpec.Generic("klarna_header_text")) : FormItemSpec

This is for the Klarna header

KlarnaMandateTextSpec

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

@Serializable

data class KlarnaMandateTextSpec(val apiPath: IdentifierSpec = IdentifierSpec.Generic("klarna_mandate"), @StringRes val stringResId: Int = R.string.stripe_klarna_mandate) : FormItemSpec

LayoutSpec

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

data class LayoutSpec(val items: List<FormItemSpec>)

This is a data representation of the layout of UI fields on the screen.

LpmSerializer

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

object LpmSerializer

MandateTextElement

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

data class MandateTextElement(val identifier: IdentifierSpec, val stringResId: Int, val args: List<String>, val topPadding: Dp = 8.dp, val controller: InputController? = null) : FormElement

MandateTextSpec

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

@Serializable

data class MandateTextSpec(val apiPath: IdentifierSpec = IdentifierSpec.Generic("mandate"), @StringRes val stringResId: Int) : FormItemSpec

Mandate text element spec.

NameSpec

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

@Serializable

data class NameSpec(val apiPath: IdentifierSpec = IdentifierSpec.Name, val labelTranslationId: TranslationId = TranslationId.AddressName) : FormItemSpec

OTPSpec

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

@Serializable

data object OTPSpec : FormItemSpec

PhoneSpec

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

@Serializable

data class PhoneSpec(val apiPath: IdentifierSpec = IdentifierSpec.Phone) : FormItemSpec

PlaceholderSpec

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

@Serializable

data class PlaceholderSpec(val apiPath: IdentifierSpec = IdentifierSpec.Generic("placeholder"), val field: PlaceholderSpec.PlaceholderField = PlaceholderField.Unknown) : FormItemSpec

RenderableFormElement

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

abstract class RenderableFormElement(val identifier: IdentifierSpec, val allowsUserInteraction: Boolean) : FormElement

SaveForFutureUseController

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

class SaveForFutureUseController(saveForFutureUseInitialValue: Boolean) : InputController

SaveForFutureUseElement

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

data class SaveForFutureUseElement(val initialValue: Boolean, val merchantName: String?) : FormElement

This is an element that will make elements (as specified by identifier) hidden when "save for future" use is unchecked

SelectorIcon

@Serializable

@SerialName(value = "next_action_spec")

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

data class SelectorIcon : Parcelable

SepaMandateTextSpec

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

@Serializable

data class SepaMandateTextSpec(val apiPath: IdentifierSpec = IdentifierSpec.Generic("sepa_mandate"), @StringRes val stringResId: Int = R.string.stripe_sepa_mandate) : FormItemSpec

Mandate text element spec.

SharedDataSpec

@Serializable

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

data class SharedDataSpec(val type: String, val fields: ArrayList<FormItemSpec> = arrayListOf(), val selectorIcon: SelectorIcon? = null) : Parcelable

SimpleDropdownConfig

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

class SimpleDropdownConfig(@StringRes val label: Int, items: List<DropdownItemSpec>) : DropdownConfig

SimpleDropdownElement

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

data class SimpleDropdownElement(val identifier: IdentifierSpec, val controller: DropdownFieldController) : SectionSingleFieldElement

SimpleTextSpec

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

@Serializable

data class SimpleTextSpec(val apiPath: IdentifierSpec, @StringRes val label: Int, val capitalization: Capitalization = Capitalization.None, val keyboardType: KeyboardType = KeyboardType.Ascii, val showOptionalLabel: Boolean = false) : FormItemSpec

StaticTextElement

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

data class StaticTextElement(val identifier: IdentifierSpec, val stringResId: Int, val controller: InputController? = null) : FormElement

StaticTextSpec

@Serializable

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

data class StaticTextSpec(val apiPath: IdentifierSpec = IdentifierSpec.Generic("static_text"), @StringRes val stringResId: Int) : FormItemSpec

This is for elements that do not receive user input

TranslationId

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

@Serializable

enum TranslationId : Enum<TranslationId>

UpiConfig

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

class UpiConfig : TextFieldConfig

UpiElement

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

class UpiElement(val controller: InputController = SimpleTextFieldController( textFieldConfig = UpiConfig() )) : SectionSingleFieldElement

Properties

MANDATE_TEST_TAG

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

const val MANDATE_TEST_TAG: String

SAVE_FOR_FUTURE_CHECKBOX_TEST_TAG

const val SAVE_FOR_FUTURE_CHECKBOX_TEST_TAG: String

TEST_TAG_DIALOG_CONFIRM_BUTTON

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

const val TEST_TAG_DIALOG_CONFIRM_BUTTON: String

TEST_TAG_DIALOG_DISMISS_BUTTON

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

const val TEST_TAG_DIALOG_DISMISS_BUTTON: String

TEST_TAG_SIMPLE_DIALOG

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

const val TEST_TAG_SIMPLE_DIALOG: String

Functions

AffirmElementUI

@Composable

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

fun AffirmElementUI()

AfterpayClearpayElementUI

@Composable

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

fun AfterpayClearpayElementUI(enabled: Boolean, element: AfterpayClearpayHeaderElement)

AuBecsDebitMandateElementUI

@Composable

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

fun AuBecsDebitMandateElementUI(element: AuBecsDebitMandateTextElement)

BsbElementUI

@Composable

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

fun BsbElementUI(enabled: Boolean, element: BsbElement, lastTextFieldIdentifier: IdentifierSpec?)

CardDetailsSectionElementUI

@Composable

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

fun CardDetailsSectionElementUI(enabled: Boolean, controller: CardDetailsSectionController, hiddenIdentifiers: Set<IdentifierSpec>, lastTextFieldIdentifier: IdentifierSpec?)

H4Text

@Composable

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

fun H4Text(text: String, modifier: Modifier = Modifier)

HyperlinkedText

@Composable

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

fun HyperlinkedText(text: String, modifier: Modifier = Modifier, color: Color = Color.Unspecified, style: TextStyle = LocalTextStyle.current)

MandateTextUI

@Composable

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

fun MandateTextUI(element: MandateTextElement)

SaveForFutureUseElementUI

@Composable

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

fun SaveForFutureUseElementUI(enabled: Boolean, element: SaveForFutureUseElement, modifier: Modifier = Modifier)

SimpleDialogElementUI

@Composable

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

fun SimpleDialogElementUI(titleText: String, messageText: String?, confirmText: String, dismissText: String, destructive: Boolean = false, onConfirmListener: () -> Unit, onDismissListener: () -> Unit)

StaticTextElementUI

@Composable

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

fun StaticTextElementUI(element: StaticTextElement)