paymentsheet/com.stripe.android.paymentelement/EmbeddedPaymentElement

EmbeddedPaymentElement

class EmbeddedPaymentElement

Types

Link copied to clipboard
class Builder

Builder used in the creation of the EmbeddedPaymentElement.

Link copied to clipboard
Link copied to clipboard
sealed interface ConfigureResult

The result of a configure call.

Link copied to clipboard
enum FormSheetAction : Enum<EmbeddedPaymentElement.FormSheetAction>

The view can display payment methods like "Card" that, when tapped, open a form sheet where customers enter their payment method details. The sheet has a button at the bottom. FormSheetAction enumerates the actions the button can perform.

Link copied to clipboard
Link copied to clipboard
sealed interface Result

The result of an attempt to confirm a PaymentIntent or SetupIntent.

Link copied to clipboard
fun interface ResultCallback

Callback that is invoked when a Result is available.

Link copied to clipboard
abstract class RowSelectionBehavior

Describes how you handle row selections in EmbeddedPaymentElement

Link copied to clipboard
class State : Parcelable

A Parcelable state used to reconfigure EmbeddedPaymentElement across activity boundaries.

Properties

Link copied to clipboard
val paymentOption: StateFlow<EmbeddedPaymentElement.PaymentOptionDisplayData?>

Contains information about the customer's selected payment option. Use this to display the payment option in your own UI.

Link copied to clipboard
var state: EmbeddedPaymentElement.State?

The state of an already configured EmbeddedPaymentElement.

Functions

Link copied to clipboard
fun clearPaymentOption()

Sets the current paymentOption to null.

Link copied to clipboard
suspend fun configure(    intentConfiguration: PaymentSheet.IntentConfiguration,     configuration: EmbeddedPaymentElement.Configuration): EmbeddedPaymentElement.ConfigureResult

Call this method to configure EmbeddedPaymentElement or when the IntentConfiguration values you used to configure EmbeddedPaymentElement (amount, currency, etc.) change.

Link copied to clipboard
fun confirm()

Asynchronously confirms the currently selected payment option.

Link copied to clipboard
@Composable
fun Content()

A composable function that displays payment methods.

Link copied to clipboard
@Composable
fun WalletButtons()

A composable function that displays a vertical list of wallet payment methods that can be used for express checkout.