paymentsheet/com.stripe.android.paymentsheet/PaymentSheet

PaymentSheet

A drop-in class that presents a bottom sheet to collect and process a customer's payment.

Constructors

constructor(activity: ComponentActivity, callback: PaymentSheetResultCallback)

Constructor to be used when launching PaymentSheet from a ComponentActivity.

constructor(activity: ComponentActivity, externalPaymentMethodConfirmHandler: ExternalPaymentMethodConfirmHandler, callback: PaymentSheetResultCallback)

Constructor to be used when launching PaymentSheet from a ComponentActivity and external payment methods are specified in your Configuration.

constructor(activity: ComponentActivity, createIntentCallback: CreateIntentCallback, paymentResultCallback: PaymentSheetResultCallback)

Constructor to be used when launching PaymentSheet from a ComponentActivity and intending to create and optionally confirm the PaymentIntent or SetupIntent on your server.

constructor(activity: ComponentActivity, createIntentCallback: CreateIntentCallback, externalPaymentMethodConfirmHandler: ExternalPaymentMethodConfirmHandler, paymentResultCallback: PaymentSheetResultCallback)

Constructor to be used when launching PaymentSheet from a ComponentActivity and intending to create and optionally confirm the PaymentIntent or SetupIntent on your server and external payment methods are specified in your Configuration.

constructor(fragment: Fragment, callback: PaymentSheetResultCallback)

Constructor to be used when launching the payment sheet from a Fragment.

constructor( fragment: Fragment, externalPaymentMethodConfirmHandler: ExternalPaymentMethodConfirmHandler, callback: PaymentSheetResultCallback)

Constructor to be used when launching the payment sheet from a Fragment and external payment methods are specified in your Configuration.

constructor(fragment: Fragment, createIntentCallback: CreateIntentCallback, paymentResultCallback: PaymentSheetResultCallback)

Constructor to be used when launching PaymentSheet from a Fragment and intending to create and optionally confirm the PaymentIntent or SetupIntent on your server.

constructor(fragment: Fragment, createIntentCallback: CreateIntentCallback, externalPaymentMethodConfirmHandler: ExternalPaymentMethodConfirmHandler, paymentResultCallback: PaymentSheetResultCallback)

Constructor to be used when launching PaymentSheet from a Fragment and intending to create and optionally confirm the PaymentIntent or SetupIntent on your server and external payment methods are specified in your Configuration.

Types

Address

data class Address( val city: String? = null, val country: String? = null, val line1: String? = null, val line2: String? = null, val postalCode: String? = null, val state: String? = null) : Parcelable

Appearance

data class Appearance : Parcelable

BillingDetails

data class BillingDetails( val address: PaymentSheet.Address? = null, val email: String? = null, val name: String? = null, val phone: String? = null) : Parcelable

BillingDetailsCollectionConfiguration

data class BillingDetailsCollectionConfiguration( val name: PaymentSheet.BillingDetailsCollectionConfiguration.CollectionMode = CollectionMode.Automatic, val phone: PaymentSheet.BillingDetailsCollectionConfiguration.CollectionMode = CollectionMode.Automatic, val email: PaymentSheet.BillingDetailsCollectionConfiguration.CollectionMode = CollectionMode.Automatic, val address: PaymentSheet.BillingDetailsCollectionConfiguration.AddressCollectionMode = AddressCollectionMode.Automatic, val attachDefaultsToPaymentMethod: Boolean = false, allowedCountries: Set<String> = emptySet()) : Parcelable

Configuration for how billing details are collected during checkout.

Builder

class Builder(resultCallback: PaymentSheetResultCallback)

Builder to add optional callbacks to PaymentSheet.

ButtonThemes

class ButtonThemes(val link: PaymentSheet.ButtonThemes.LinkButtonTheme = LinkButtonTheme.WHITE) : Parcelable

Theme configuration for wallet buttons

CardBrandAcceptance

sealed class CardBrandAcceptance : Parcelable

Options to block certain card brands on the client

Colors

data class Colors( @ColorInt val primary: Int, @ColorInt val surface: Int, @ColorInt val component: Int, @ColorInt val componentBorder: Int, @ColorInt val componentDivider: Int, @ColorInt val onComponent: Int, @ColorInt val onSurface: Int, @ColorInt val subtitle: Int, @ColorInt val placeholderText: Int, @ColorInt val appBarIcon: Int, @ColorInt val error: Int) : Parcelable

Companion

object Companion

Configuration

data class Configuration : Parcelable

Configuration for PaymentSheet

CustomerConfiguration

data class CustomerConfiguration : Parcelable

CustomPaymentMethod

class CustomPaymentMethod : Parcelable

Defines a custom payment method type that can be displayed in Payment Element.

FlowController

interface FlowController

A class that presents the individual steps of a payment sheet flow.

GooglePayConfiguration

data class GooglePayConfiguration @JvmOverloads constructor( val environment: PaymentSheet.GooglePayConfiguration.Environment, val countryCode: String, val currencyCode: String? = null, val amount: Long? = null, val label: String? = null, val buttonType: PaymentSheet.GooglePayConfiguration.ButtonType = ButtonType.Pay) : Parcelable

IconStyle

enum IconStyle : Enum<PaymentSheet.IconStyle>

Defines the visual style of icons in Payment Element

Insets

class Insets(val startDp: Float, val topDp: Float, val endDp: Float, val bottomDp: Float) : Parcelable

IntentConfiguration

class IntentConfiguration : Parcelable

Contains information needed to render PaymentSheet. The values are used to calculate the payment methods displayed and influence the UI.

LinkConfiguration

class LinkConfiguration : Parcelable

Configuration related to Link.

PaymentMethodLayout

enum PaymentMethodLayout : Enum<PaymentSheet.PaymentMethodLayout>

Defines the layout orientations available for displaying payment methods in PaymentSheet.

PrimaryButton

data class PrimaryButton( val colorsLight: PaymentSheet.PrimaryButtonColors = PrimaryButtonColors.defaultLight, val colorsDark: PaymentSheet.PrimaryButtonColors = PrimaryButtonColors.defaultDark, val shape: PaymentSheet.PrimaryButtonShape = PrimaryButtonShape(), val typography: PaymentSheet.PrimaryButtonTypography = PrimaryButtonTypography()) : Parcelable

PrimaryButtonColors

data class PrimaryButtonColors( @ColorInt val background: Int?, @ColorInt val onBackground: Int, @ColorInt val border: Int, @ColorInt val successBackgroundColor: Int = PRIMARY_BUTTON_SUCCESS_BACKGROUND_COLOR.toArgb(), @ColorInt val onSuccessBackgroundColor: Int = onBackground) : Parcelable

PrimaryButtonShape

data class PrimaryButtonShape(val cornerRadiusDp: Float? = null, val borderStrokeWidthDp: Float? = null, val heightDp: Float? = null) : Parcelable

PrimaryButtonTypography

data class PrimaryButtonTypography(@FontRes val fontResId: Int? = null, val fontSizeSp: Float? = null) : Parcelable

Shapes

data class Shapes constructor( val cornerRadiusDp: Float, val borderStrokeWidthDp: Float, val bottomSheetCornerRadiusDp: Float = cornerRadiusDp) : Parcelable

ShopPayConfiguration

class ShopPayConfiguration( val shopId: String, val billingAddressRequired: Boolean = true, val emailRequired: Boolean = true, val shippingAddressRequired: Boolean, val allowedShippingCountries: List<String>, val lineItems: List<PaymentSheet.ShopPayConfiguration.LineItem>, val shippingRates: List<PaymentSheet.ShopPayConfiguration.ShippingRate>) : Parcelable

Configuration related to Shop Pay, which only applies when using wallet buttons.

Spacing

class Spacing(spacingDp: Float) : Parcelable

TermsDisplay

enum TermsDisplay : Enum<PaymentSheet.TermsDisplay>

TermsDisplay controls how mandates and legal agreements are displayed. Use TermsDisplay.NEVER to never display legal agreements. The default setting is TermsDisplay.AUTOMATIC, which causes legal agreements to be shown only when necessary.

Typography

data class Typography constructor(val sizeScaleFactor: Float, @FontRes val fontResId: Int?, val custom: PaymentSheet.Typography.Custom) : Parcelable

WalletButtonsConfiguration

class WalletButtonsConfiguration( val willDisplayExternally: Boolean = false, val walletsToShow: List<String> = emptyList(), val buttonThemes: PaymentSheet.ButtonThemes = ButtonThemes()) : Parcelable

Configuration for wallet buttons

Functions

presentWithIntentConfiguration

@JvmOverloads

fun presentWithIntentConfiguration(intentConfiguration: PaymentSheet.IntentConfiguration, configuration: PaymentSheet.Configuration? = null)

Present PaymentSheet with an IntentConfiguration.

presentWithPaymentIntent

@JvmOverloads

fun presentWithPaymentIntent(paymentIntentClientSecret: String, configuration: PaymentSheet.Configuration? = null)

Present PaymentSheet to process a PaymentIntent.

presentWithSetupIntent

@JvmOverloads

fun presentWithSetupIntent(setupIntentClientSecret: String, configuration: PaymentSheet.Configuration? = null)

Present PaymentSheet to process a SetupIntent.