Stripe Android SDK

https://github.com/stripe/stripe-android
Admin
Stripe Android SDK provides powerful and customizable UI elements and low-level APIs to build secure...
Tokens:755,876
Snippets:6,668
Trust Score:9.7
License:MIT
Update:3 weeks ago
Show doc for...
Tokens:
Raw
### Setup constructor

Source: https://github.com/stripe/stripe-android/blob/master/docs/paymentsheet/com.stripe.android.paymentsheet/-payment-sheet/-intent-configuration/-mode/-setup/index.html

Creates a Setup configuration with optional currency and setupFutureUse parameters.

```APIDOC
## Setup

### Description
Use this class when your integration creates a SetupIntent. It configures the PaymentSheet intent mode for setup scenarios.

### Constructor
`Setup(currency: String? = null, setupFutureUse: SetupFutureUse = SetupFutureUse.OffSession)`

### Parameters
- **currency** (String?) - Optional - Three-letter ISO currency code. Filters out payment methods based on supported currency. See [our docs](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-currency) for more info.
- **setupFutureUse** (SetupFutureUse) - Optional - Indicates that you intend to make future payments. Defaults to `SetupFutureUse.OffSession`. See [our docs](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-setup_future_usage) for more info.

### Properties
- **currency** (String?) - The currency code passed to the constructor.

### Inherited Members
- `describeContents(): Int` - Abstract function from Parcelable.
- `writeToParcel(p0: Parcel, p1: Int)` - Abstract function from Parcelable.

```

--------------------------------

### Setup

Source: https://github.com/stripe/stripe-android/blob/master/docs/paymentsheet/com.stripe.android.paymentsheet/-payment-sheet/-intent-configuration/-mode/index.html

Use this class if your integration creates a SetupIntent. It extends Mode and provides a constructor with currency and setupFutureUse.

```APIDOC
## [Setup](-setup/index.html)

### Description
Use this if your integration creates a [SetupIntent](../../../../../payments-core/com.stripe.android.model/-setup-intent/index.html).

### Constructor
```kotlin
class Setup @JvmOverloads constructor(
    val currency: String? = null,
    setupFutureUse: PaymentSheet.IntentConfiguration.SetupFutureUse = SetupFutureUse.OffSession
) : PaymentSheet.IntentConfiguration.Mode
```

### Parameters
- **currency** (String?) - Optional - The currency for the setup. Defaults to null.
- **setupFutureUse** (SetupFutureUse) - Optional - The setup future use for the setup. Defaults to SetupFutureUse.OffSession.
```

--------------------------------

### startActivity(intent: Intent?, options: Bundle?)

Source: https://github.com/stripe/stripe-android/blob/master/docs/financial-connections/com.stripe.android.financialconnections/-financial-connections-sheet-redirect-activity/index.html

Starts a new activity with the given intent and options.

```APIDOC
## startActivity(intent: Intent?, options: Bundle?)

### Description
Starts a new activity with the given intent and options.

### Parameters
- **intent** (Intent?) - Required - The intent describing the activity to start.
- **options** (Bundle?) - Optional - Additional options for starting the activity.

### Returns
Unit
```

--------------------------------

### Configure gradle.properties for Stripe Example App

Source: https://github.com/stripe/stripe-android/blob/master/example/README.md

Append these entries to gradle.properties to configure the example app. Set STRIPE_EXAMPLE_BACKEND_URL to your backend URL and STRIPE_EXAMPLE_PUBLISHABLE_KEY to a test publishable key. STRIPE_ACCOUNT_ID is optional for testing Connect.

```properties
# Set to example backend project in Glitch
STRIPE_EXAMPLE_BACKEND_URL=https://stripe-example-mobile-backend.stripedemos.com/

# Set to a test publishable key from https://dashboard.stripe.com/test/apikeys
STRIPE_EXAMPLE_PUBLISHABLE_KEY=pk_test_mykey

# Optionally, set to a Connect Account id to test Connect
STRIPE_ACCOUNT_ID=
```

--------------------------------

### startActivity(intent: Intent?)

Source: https://github.com/stripe/stripe-android/blob/master/docs/financial-connections/com.stripe.android.financialconnections/-financial-connections-sheet-redirect-activity/index.html

Starts a new activity with the given intent.

```APIDOC
## startActivity(intent: Intent?)

### Description
Starts a new activity with the given intent.

### Parameters
- **intent** (Intent?) - Required - The intent describing the activity to start.

### Returns
Unit
```

--------------------------------

### startActivity(intent: Intent, options: Bundle?)

Source: https://github.com/stripe/stripe-android/blob/master/docs/3ds2sdk/com.stripe.android.stripe3ds2.views/-challenge-progress-fragment/index.html

Starts a new activity with additional activity transition options.

```APIDOC
## startActivity(intent: Intent, options: Bundle?)

### Description
Starts a new activity using the given intent and activity options bundle.

### Method
startActivity

### Parameters
- **intent** (Intent) - Required - The intent describing the activity to start.
- **options** (Bundle?) - Optional - Additional options for the activity transition.

```

--------------------------------

### startActivity(intent: Intent)

Source: https://github.com/stripe/stripe-android/blob/master/docs/3ds2sdk/com.stripe.android.stripe3ds2.views/-challenge-progress-fragment/index.html

Starts a new activity as described by the given intent.

```APIDOC
## startActivity(intent: Intent)

### Description
Starts a new activity using the given intent.

### Method
startActivity

### Parameters
- **intent** (Intent) - Required - The intent describing the activity to start.

```

--------------------------------

### SetupIntent.paymentMethodTypes

Source: https://github.com/stripe/stripe-android/blob/master/docs/payments-core/com.stripe.android.model/-setup-intent/payment-method-types.html

Documentation for the paymentMethodTypes property of the SetupIntent class, which returns the list of payment method types allowed for setup.

```APIDOC
## Property: paymentMethodTypes

### Description
The list of payment method types (e.g. card) that this SetupIntent is allowed to set up.

### Declaration
```kotlin
open override val paymentMethodTypes: List<String>
```

### Type
`List<String>`

### Usage
This property is part of the `SetupIntent` class in the `com.stripe.android.model` package. It is an open override property, meaning it can be overridden in subclasses. It returns the list of payment method types that the SetupIntent is allowed to set up.
```

--------------------------------

### error

Source: https://github.com/stripe/stripe-android/blob/master/docs/paymentsheet/com.stripe.android.link/-link-controller/-confirm-setup-intent-result/-failed/error.html

The error that occurred during the confirm setup intent operation.

```APIDOC
## error

### Description
The error that occurred during the confirm setup intent operation.

### Property
`val error: Throwable`

### Parameters
- **error** (Throwable) - The error that occurred.

### Return Value
A `Throwable` instance representing the error.
```

--------------------------------

### startActivities(intents: Array<out Intent>?, options: Bundle?)

Source: https://github.com/stripe/stripe-android/blob/master/docs/financial-connections/com.stripe.android.financialconnections/-financial-connections-sheet-redirect-activity/index.html

Starts multiple activities from the given intents with options.

```APIDOC
## startActivities(intents: Array<out Intent>?, options: Bundle?)

### Description
Starts multiple activities from the given intents with options.

### Parameters
- **intents** (Array<out Intent>?) - Required - An array of intents describing the activities to start.
- **options** (Bundle?) - Optional - Additional options for starting the activities.

### Returns
Unit
```

--------------------------------

### onPostCreate

Source: https://github.com/stripe/stripe-android/blob/master/docs/payments-core/com.stripe.android.view/-stripe-activity/index.html

Called after the activity has been created. Override to perform additional setup.

```APIDOC
## onPostCreate

### Description
Called after the activity has been created. Override to perform additional setup.

### Method
open fun onPostCreate(savedInstanceState: Bundle?, persistentState: PersistableBundle?)

### Parameters
- **savedInstanceState** (Bundle?) - Optional - The saved instance state, if any.
- **persistentState** (PersistableBundle?) - Optional - The persistent state, if any.
```

--------------------------------

### startActionMode(callback: ActionMode.Callback?): ActionMode?

Source: https://github.com/stripe/stripe-android/blob/master/docs/financial-connections/com.stripe.android.financialconnections/-financial-connections-sheet-redirect-activity/index.html

Starts an action mode with the given callback.

```APIDOC
## startActionMode(callback: ActionMode.Callback?): ActionMode?

### Description
Starts an action mode with the given callback.

### Parameters
- **callback** (ActionMode.Callback?) - Required - The callback for the action mode.

### Returns
ActionMode? - The action mode that was started, or null if it could not be started.
```

--------------------------------

### startActivities(intents: Array<out Intent>?)

Source: https://github.com/stripe/stripe-android/blob/master/docs/financial-connections/com.stripe.android.financialconnections/-financial-connections-sheet-redirect-activity/index.html

Starts multiple activities from the given intents.

```APIDOC
## startActivities(intents: Array<out Intent>?)

### Description
Starts multiple activities from the given intents.

### Parameters
- **intents** (Array<out Intent>?) - Required - An array of intents describing the activities to start.

### Returns
Unit
```

--------------------------------

### getSetupIntentResult

Source: https://github.com/stripe/stripe-android/blob/master/docs/payments-core/com.stripe.android/index.html

Get the SetupIntentResult from Intent returned via Activity#onActivityResult for SetupIntentResult confirmation.

```APIDOC
## getSetupIntentResult

### Description
Get the SetupIntentResult from Intent returned via Activity#onActivityResult for SetupIntentResult confirmation.

### Method
suspend fun

### Signature
`Stripe.getSetupIntentResult(requestCode: Int, data: Intent): SetupIntentResult`

### Parameters
- **requestCode** (Int) - Required - The request code from onActivityResult.
- **data** (Intent) - Required - The Intent from onActivityResult.

### Returns
- **SetupIntentResult** - The result of the SetupIntent operation.
```

--------------------------------

### handleNextActionForSetupIntent(clientSecret: String)

Source: https://github.com/stripe/stripe-android/blob/master/docs/payments-core/com.stripe.android.payments.paymentlauncher/-payment-launcher/handle-next-action-for-setup-intent.html

Fetches a SetupIntent and handles its next action. This is an abstract method that must be implemented by a concrete PaymentLauncher.

```APIDOC
## handleNextActionForSetupIntent(clientSecret: String)

### Description
Fetches a [SetupIntent](../../com.stripe.android.model/-setup-intent/index.html) and handles its next action.

### Method
abstract fun handleNextActionForSetupIntent(clientSecret: String)

### Parameters
- **clientSecret** (String) - Required - The client secret of the SetupIntent.

### Return Type
Unit (no return value)

### Notes
This is an abstract method in the PaymentLauncher interface/class. Implementations should fetch the SetupIntent using the provided client secret and handle any required next actions.
```

--------------------------------

### start

Source: https://github.com/stripe/stripe-android/blob/master/docs/3ds2sdk/com.stripe.android.stripe3ds2.transaction/-transaction-timer/start.html

Starts the transaction timer. This is an abstract suspend function that must be implemented by subclasses.

```APIDOC
## start

### Description
Starts the transaction timer. This is an abstract suspend function that must be implemented by subclasses.

### Method
suspend fun

### Signature
```kotlin
abstract suspend fun start()
```

### Parameters
None

### Returns
Unit

### Throws
None documented

### Example
```kotlin
// Example usage in a coroutine
launch {
    transactionTimer.start()
}
```
```

--------------------------------

### between(start: Date, end: Date): PaymentsProps.DateFilter

Source: https://github.com/stripe/stripe-android/blob/master/docs/connect/com.stripe.android.connect/-payments-props/-date-filter/-companion/index.html

Creates a DateFilter that selects payments between the given start and end dates.

```APIDOC
## between(start: Date, end: Date): PaymentsProps.DateFilter

### Description
Creates a `PaymentsProps.DateFilter` that filters payments occurring between the specified start and end dates (inclusive).

### Method
`fun between(start: Date, end: Date): PaymentsProps.DateFilter`

### Parameters
- **start** (`java.util.Date`) - Required - The start date (inclusive) of the range.
- **end** (`java.util.Date`) - Required - The end date (inclusive) of the range.

### Returns
- `PaymentsProps.DateFilter` - A date filter for payments within the given date range.

### Example
```kotlin
val filter = PaymentsProps.DateFilter.Companion.between(startDate, endDate)
```
```

--------------------------------

### startActionMode(callback: ActionMode.Callback?, type: Int): ActionMode?

Source: https://github.com/stripe/stripe-android/blob/master/docs/financial-connections/com.stripe.android.financialconnections/-financial-connections-sheet-redirect-activity/index.html

Starts an action mode with the given callback and type.

```APIDOC
## startActionMode(callback: ActionMode.Callback?, type: Int): ActionMode?

### Description
Starts an action mode with the given callback and type.

### Parameters
- **callback** (ActionMode.Callback?) - Required - The callback for the action mode.
- **type** (Int) - Required - The type of action mode.

### Returns
ActionMode? - The action mode that was started, or null if it could not be started.
```

--------------------------------

### Start

Source: https://github.com/stripe/stripe-android/blob/master/docs/3ds2sdk/com.stripe.android.stripe3ds2.transaction/-init-challenge-result/-start/index.html

Data class representing a successful challenge initiation result. Use this to access the challenge view arguments required to start the challenge flow.

```APIDOC
## Start

### Description
Data class representing a successful challenge initiation result. It holds the challenge view arguments needed to display the challenge flow.

### Constructor
- **Start**(challengeViewArgs: [ChallengeViewArgs](../../../com.stripe.android.stripe3ds2.views/-challenge-view-args/index.html))

### Properties
- **challengeViewArgs**: [ChallengeViewArgs](../../../com.stripe.android.stripe3ds2.views/-challenge-view-args/index.html) - The arguments required to render the challenge view.

### Functions
- **toBundle**(): [Bundle](https://developer.android.com/reference/kotlin/android/os/Bundle.html) - Converts the challenge view arguments to a Bundle for passing between components.

### Inherited Functions
- **describeContents**(): [Int](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html) - (from [ChallengeViewArgs](../../../com.stripe.android.stripe3ds2.views/-challenge-view-args/index.html)) - Describe the kinds of special objects contained in this Parcelable instance.
- **writeToParcel**(p0: [Parcel](https://developer.android.com/reference/kotlin/android/os/Parcel.html), p1: [Int](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html)) - (from [ChallengeViewArgs](../../../com.stripe.android.stripe3ds2.views/-challenge-view-args/index.html)) - Flatten this object into a Parcel.
```

--------------------------------

### retrieveSetupIntent(clientSecret, stripeAccountId, expand, callback)

Source: https://github.com/stripe/stripe-android/blob/master/docs/payments-core/com.stripe.android/-stripe/index.html

Retrieve a SetupIntent asynchronously.

```APIDOC
## retrieveSetupIntent(clientSecret, stripeAccountId, expand, callback)

### Description
Retrieve a SetupIntent asynchronously.

### Method
Function

### Signature
`fun retrieveSetupIntent(clientSecret: String, stripeAccountId: String? = this.stripeAccountId, expand: List<String> = emptyList(), callback: ApiResultCallback<SetupIntent>)`

### Parameters
- **clientSecret** (String) - Required - The client secret of the SetupIntent.
- **stripeAccountId** (String?) - Optional - The Stripe account ID to use. Defaults to the Stripe instance's account ID.
- **expand** (List<String>) - Optional - List of fields to expand. Defaults to empty list.
- **callback** (ApiResultCallback<SetupIntent>) - Required - Callback to receive the result.

### Return
- **SetupIntent** - The retrieved SetupIntent.
```

--------------------------------

### fun build(): AddressLauncher.Configuration

Source: https://github.com/stripe/stripe-android/blob/master/docs/paymentsheet/com.stripe.android.paymentsheet.addresselement/-address-launcher/-configuration/-builder/build.html

Builds and returns an AddressLauncher.Configuration instance using the builder's current settings.

```APIDOC
## build

### Description
Builds an AddressLauncher.Configuration object with the configured parameters.

### Method
build()

### Return Type
AddressLauncher.Configuration

### Parameters
None

### Example
```kotlin
val configuration = builder.build()
```
```

--------------------------------

### SetupIntent.usage

Source: https://github.com/stripe/stripe-android/blob/master/docs/payments-core/com.stripe.android.model/-setup-intent/usage.html

Documentation for the `usage` property of the `SetupIntent` class in the Stripe Android SDK.

```APIDOC
## Property: usage

### Description
Indicates how the payment method is intended to be used in the future. Use `StripeIntent.Usage.OnSession` if you intend to only reuse the payment method when the customer is in your checkout flow. Use `StripeIntent.Usage.OffSession` if your customer may or may not be in your checkout flow. If not provided, this value defaults to `StripeIntent.Usage.OffSession`.

### Type
`StripeIntent.Usage?` (nullable)

### Default Value
`StripeIntent.Usage.OffSession`

### Usage
- `StripeIntent.Usage.OnSession` - Reuse the payment method only when the customer is in your checkout flow.
- `StripeIntent.Usage.OffSession` - Reuse the payment method when the customer may or may not be in your checkout flow.
```

--------------------------------

### getToolbarCustomization

Source: https://github.com/stripe/stripe-android/blob/master/docs/3ds2sdk/com.stripe.android.stripe3ds2.init.ui/-stripe-ui-customization/index.html

Gets the toolbar customization.

```APIDOC
## getToolbarCustomization

### Description
Gets the toolbar customization.

### Method
getToolbarCustomization

### Signature
`@Nullable open fun getToolbarCustomization(): ToolbarCustomization?`

### Returns
- **ToolbarCustomization?** - The toolbar customization, or null if not set.
```

--------------------------------

### onConfirmSetupIntentResult(result: LinkController.ConfirmSetupIntentResult)

Source: https://github.com/stripe/stripe-android/blob/master/docs/paymentsheet/com.stripe.android.link/-link-controller/-confirm-setup-intent-callback/on-confirm-setup-intent-result.html

Callback method that receives the result of a setup intent confirmation. Implement this to handle the outcome of the confirmation flow.

```APIDOC
## onConfirmSetupIntentResult

### Description
Abstract callback method that is called when a setup intent confirmation result is available. Implement this method to handle the result of the confirmation flow.

### Method
onConfirmSetupIntentResult

### Signature
```kotlin
abstract fun onConfirmSetupIntentResult(result: LinkController.ConfirmSetupIntentResult)
```

### Parameters
- **result** (LinkController.ConfirmSetupIntentResult) - The result of the setup intent confirmation, containing the outcome data.

### Returns
Unit (no return value)

### Notes
- This is an abstract method in the ConfirmSetupIntentCallback interface, intended to be implemented by the caller.
- The result parameter provides the confirmation result, which can be used to inspect the outcome of the setup intent flow.
```

--------------------------------

### getLabelCustomization

Source: https://github.com/stripe/stripe-android/blob/master/docs/3ds2sdk/com.stripe.android.stripe3ds2.init.ui/-stripe-ui-customization/index.html

Gets the label customization.

```APIDOC
## getLabelCustomization

### Description
Gets the label customization.

### Method
getLabelCustomization

### Signature
`@Nullable open fun getLabelCustomization(): LabelCustomization?`

### Returns
- **LabelCustomization?** - The label customization, or null if not set.
```

--------------------------------

### retrieveSetupIntent

Source: https://github.com/stripe/stripe-android/blob/master/docs/payments-core/com.stripe.android/index.html

Retrieve a SetupIntent asynchronously.

```APIDOC
## retrieveSetupIntent

### Description
Retrieve a SetupIntent asynchronously.

### Method
suspend fun

### Signature
`Stripe.retrieveSetupIntent(clientSecret: String, stripeAccountId: String? = this.stripeAccountId, expand: List<String> = emptyList()): SetupIntent`

### Parameters
- **clientSecret** (String) - Required - The client secret of the SetupIntent.
- **stripeAccountId** (String?) - Optional - The Stripe account ID, defaults to this.stripeAccountId.
- **expand** (List<String>) - Optional - A list of fields to expand, defaults to emptyList().

### Returns
- **SetupIntent** - The retrieved SetupIntent.
```

--------------------------------

### confirm

Source: https://github.com/stripe/stripe-android/blob/master/docs/paymentsheet/com.stripe.android.paymentsheet/-payment-sheet/-flow-controller/index.html

Completes the payment or setup flow.

```APIDOC
## confirm

### Description
Completes the payment or setup flow. Call this when the user confirms the payment.

### Method
confirm

### Parameters
None

### Return Type
Unit (abstract fun)

### Usage Example
```kotlin
flowController.confirm()
```
```

--------------------------------

### handleNextActionForSetupIntent

Source: https://github.com/stripe/stripe-android/blob/master/docs/payments-core/com.stripe.android/-stripe/index.html

Handles the next action for a previously confirmed SetupIntent, used for manual confirmation flow.

```APIDOC
## handleNextActionForSetupIntent

### Description
Handle next_action for a previously confirmed SetupIntent. Used for manual confirmation flow.

### Method
handleNextActionForSetupIntent

### Parameters
- **activity** (ComponentActivity) - Required - The activity that will handle the result.
- **clientSecret** (String) - Required - The client secret of the SetupIntent.
- **stripeAccountId** (String?) - Optional - The Stripe account ID, defaults to this.stripeAccountId.

### Alternative Overload
- **fragment** (Fragment) - Required - The fragment that will handle the result.
- **clientSecret** (String) - Required - The client secret of the SetupIntent.
- **stripeAccountId** (String?) - Optional - The Stripe account ID, defaults to this.stripeAccountId.
```

--------------------------------

### postponeEnterTransition

Source: https://github.com/stripe/stripe-android/blob/master/docs/payments-core/com.stripe.android.view/-payment-auth-web-view-activity/index.html

Postpones the enter transition until it is started.

```APIDOC
## postponeEnterTransition

### Description
Postpones the enter transition until it is started.

### Method
Function

### Signature
`open fun postponeEnterTransition()`

```

--------------------------------

### presentWithSetupIntent(setupIntentClientSecret: String, configuration: PaymentSheet.Configuration?)

Source: https://github.com/stripe/stripe-android/blob/master/docs/paymentsheet/com.stripe.android.paymentsheet/-payment-sheet/index.html

Presents PaymentSheet to process a SetupIntent using the provided client secret and optional PaymentSheet.Configuration instance.

```kotlin
```kotlin
@JvmOverloads
fun presentWithSetupIntent(
    setupIntentClientSecret: String,
    configuration: PaymentSheet.Configuration? = null
)
```
```

--------------------------------

### get()

Source: https://github.com/stripe/stripe-android/blob/master/docs/payments-core/com.stripe.android/-payment-auth-config/-companion/index.html

Returns the current PaymentAuthConfig instance.

```APIDOC
## get()

### Description
Returns the current PaymentAuthConfig instance.

### Method
`fun get(): PaymentAuthConfig`

### Return Value
- `PaymentAuthConfig` - The current payment authentication configuration.

```

--------------------------------

### get()

Source: https://github.com/stripe/stripe-android/blob/master/docs/payments-core/com.stripe.android/-payment-auth-config/-companion/get.html

Retrieves the current PaymentAuthConfig instance.

```APIDOC
## get()

### Description
Retrieves the current PaymentAuthConfig instance.

### Method
N/A (Kotlin function)

### Endpoint
N/A

### Parameters
None

### Request Example
N/A

### Response
#### Success Response
- **PaymentAuthConfig** - The current PaymentAuthConfig instance.

#### Response Example
N/A
```

--------------------------------

### getTextBoxCustomization

Source: https://github.com/stripe/stripe-android/blob/master/docs/3ds2sdk/com.stripe.android.stripe3ds2.init.ui/-stripe-ui-customization/index.html

Gets the text box customization.

```APIDOC
## getTextBoxCustomization

### Description
Gets the text box customization.

### Method
getTextBoxCustomization

### Signature
`@Nullable open fun getTextBoxCustomization(): TextBoxCustomization?`

### Returns
- **TextBoxCustomization?** - The text box customization, or null if not set.
```

--------------------------------

### handleNextActionForSetupIntent(fragment, clientSecret, stripeAccountId)

Source: https://github.com/stripe/stripe-android/blob/master/docs/payments-core/com.stripe.android/-stripe/handle-next-action-for-setup-intent.html

Handles the next_action for a previously confirmed SetupIntent using a Fragment. Used for manual confirmation flow.

```APIDOC
## handleNextActionForSetupIntent(fragment, clientSecret, stripeAccountId)

### Description
Handles the next_action for a previously confirmed SetupIntent. Used for manual confirmation flow.

### Method
fun handleNextActionForSetupIntent(fragment: Fragment, clientSecret: String, stripeAccountId: String? = this.stripeAccountId)

### Parameters
- **fragment** (Fragment) - Required - The Fragment launching the payment authentication flow.
- **clientSecret** (String) - Required - The client_secret property of a confirmed SetupIntent object.
- **stripeAccountId** (String?) - Optional - The Connect account to associate with this request. By default, will use the Connect account that was used to instantiate the Stripe object, if specified.

### Annotations
- @UiThread
- @JvmOverloads
```

--------------------------------

### constructor

Source: https://github.com/stripe/stripe-android/blob/master/docs/payments-core/com.stripe.android.model/-payment-method-options-params/-blik/index.html

Creates a Blik instance with the code and optional setupFutureUsage.

```APIDOC
## Blik

### Description
Constructs a Blik payment method options object.

### Signature
```kotlin
class Blik @JvmOverloads constructor(
    var code: String,
    var setupFutureUsage: ConfirmPaymentIntentParams.SetupFutureUsage? = null
) : PaymentMethodOptionsParams
```

### Parameters
- **code** (String) - Required - The BLIK code.
- **setupFutureUsage** (ConfirmPaymentIntentParams.SetupFutureUsage?) - Optional - The setup future usage value.
```

--------------------------------

### onWindowStartingActionMode

Source: https://github.com/stripe/stripe-android/blob/master/docs/payments-core/com.stripe.android.view/-payment-auth-web-view-activity/index.html

Called when a window starts an action mode.

```APIDOC
## onWindowStartingActionMode

### Description
Called when a window starts an action mode.

### Method
open fun onWindowStartingActionMode()
```

--------------------------------

### onSupportActionModeStarted

Source: https://github.com/stripe/stripe-android/blob/master/docs/payments-core/com.stripe.android.view/-payment-auth-web-view-activity/index.html

Called when a support action mode is started.

```APIDOC
## onSupportActionModeStarted

### Description
Called when a support action mode is started.

### Method
@CallSuper
open fun onSupportActionModeStarted(@NonNull mode: ActionMode)

### Parameters
- **mode** (ActionMode) - Required - The action mode that started.
```

--------------------------------

### fun createAccountOnboardingController(activity: FragmentActivity, title: String? = null, props: AccountOnboardingProps? = null): AccountOnboardingController

Source: https://github.com/stripe/stripe-android/blob/master/docs/connect/com.stripe.android.connect/-embedded-component-manager/index.html

Returns a controller for presenting the Account Onboarding component full screen.

```APIDOC
## Function: createAccountOnboardingController

### Description
Returns a controller for presenting the Account Onboarding component full screen.

### Parameters
- **activity** (FragmentActivity) - Required - The activity used to present the component.
- **title** (String?) - Optional - The title for the onboarding screen.
- **props** (AccountOnboardingProps?) - Optional - Properties for configuring the onboarding component.

### Returns
- **AccountOnboardingController** - A controller for the Account Onboarding component.
```

--------------------------------

### onLocalVoiceInteractionStarted

Source: https://github.com/stripe/stripe-android/blob/master/docs/payments-core/com.stripe.android.view/-payment-auth-web-view-activity/index.html

Called when local voice interaction starts.

```APIDOC
## onLocalVoiceInteractionStarted

### Description
Called when local voice interaction starts.

### Method
`open fun onLocalVoiceInteractionStarted()`
```

--------------------------------

### presentWithSetupIntent

Source: https://github.com/stripe/stripe-android/blob/master/docs/paymentsheet/com.stripe.android.paymentsheet/-payment-sheet/present-with-setup-intent.html

Presents PaymentSheet to process a SetupIntent. If the SetupIntent is already confirmed, the PaymentSheetResultCallback will be invoked with PaymentSheetResult.Completed.

```APIDOC
## presentWithSetupIntent

### Description
Presents PaymentSheet to process a SetupIntent. If the SetupIntent is already confirmed, the PaymentSheetResultCallback will be invoked with PaymentSheetResult.Completed.

### Method
presentWithSetupIntent

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

### Parameters
- **setupIntentClientSecret** (String) - Required - The client secret of the SetupIntent.
- **configuration** (PaymentSheet.Configuration?) - Optional - An optional PaymentSheet configuration.

### Callback
PaymentSheetResultCallback - Invoked with PaymentSheetResult.Completed if the SetupIntent is already confirmed.
```

--------------------------------

### onActionModeStarted(mode)

Source: https://github.com/stripe/stripe-android/blob/master/docs/financial-connections/com.stripe.android.financialconnections/-financial-connections-sheet-redirect-activity/index.html

Called when an action mode has started.

```APIDOC
## onActionModeStarted(mode: ActionMode?)

### Description
Called when an action mode has started.

### Method
Function

### Signature
`open fun onActionModeStarted(mode: ActionMode?)`

### Parameters
- **mode** (ActionMode?) - Required - The action mode that started.
```

--------------------------------

### getAccentColor

Source: https://github.com/stripe/stripe-android/blob/master/docs/3ds2sdk/com.stripe.android.stripe3ds2.init.ui/-stripe-ui-customization/index.html

Gets the accent color for the UI customization.

```APIDOC
## getAccentColor

### Description
Gets the accent color for the UI customization.

### Method
getAccentColor

### Signature
`@Nullable open fun getAccentColor(): String?`

### Returns
- **String?** - The accent color, or null if not set.
```

--------------------------------

### onSetupResult

Source: https://github.com/stripe/stripe-android/blob/master/docs/payments-core/com.stripe.android/-stripe/index.html

Handles the result of a SetupIntent confirmation flow.

```APIDOC
## onSetupResult

### Description
Should be called via `Activity#onActivityResult(int, int, Intent)` to handle the result of a SetupIntent confirmation (see `confirmSetupIntent`).

### Method
`onSetupResult`

### Parameters
- `requestCode` (Int) - Required - The request code passed to `startActivityForResult`.
- `data` (Intent?) - Required - The intent data returned from the activity result.
- `callback` (ApiResultCallback<SetupIntentResult>) - Required - Callback to receive the result of the setup.

### Return
`Boolean` - Returns `true` if the result was handled, `false` otherwise.
```

--------------------------------

### setupFutureUsage

Source: https://github.com/stripe/stripe-android/blob/master/docs/payments-core/com.stripe.android.model/-payment-method-options-params/-blik/setup-future-usage.html

Documentation for the `setupFutureUsage` property of the `Blik` class in the Stripe Android SDK.

```APIDOC
## Property: setupFutureUsage

### Description

A mutable property that specifies the setup future usage for a BLIK payment method. It is of type `ConfirmPaymentIntentParams.SetupFutureUsage?` and can be set to `null`.

### Declaration

```kotlin
var setupFutureUsage: ConfirmPaymentIntentParams.SetupFutureUsage?
```

### Parameters

- **setupFutureUsage** (`ConfirmPaymentIntentParams.SetupFutureUsage?`) - Optional. Indicates the intended use of the payment method after the initial transaction. Set to `null` if not used.
```

--------------------------------

### ChallengeContract

Source: https://github.com/stripe/stripe-android/blob/master/docs/3ds2sdk/com.stripe.android.stripe3ds2.transaction/-challenge-contract/index.html

Documentation for the ChallengeContract class, an ActivityResultContract for starting ChallengeActivity.

```APIDOC
## ChallengeContract

### Description
An ActivityResultContract for starting ChallengeActivity.

### Constructor
constructor()

### Functions

#### createIntent
open override fun createIntent(context: Context, input: ChallengeViewArgs): Intent

#### getSynchronousResult
open fun getSynchronousResult(context: Context, input: ChallengeViewArgs): ActivityResultContract.SynchronousResult<ChallengeResult>?

#### parseResult
open override fun parseResult(resultCode: Int, intent: Intent?): ChallengeResult

```

--------------------------------

### presentWithSetupIntent

Source: https://github.com/stripe/stripe-android/blob/master/docs/payments-core/com.stripe.android.payments.bankaccount/-collect-bank-account-launcher/present-with-setup-intent.html

Documentation for the presentWithSetupIntent method of CollectBankAccountLauncher, including two overloads.

```APIDOC
## presentWithSetupIntent

### Description
Presents the bank account collection flow for a SetupIntent. This method is part of the CollectBankAccountLauncher interface and is used to launch the bank account collection UI for a SetupIntent.

### Method
presentWithSetupIntent

### Parameters
- **publishableKey** (String) - Required - The publishable key for the Stripe account.
- **stripeAccountId** (String?) - Optional - The Stripe account ID, defaults to null.
- **clientSecret** (String) - Required - The client secret for the SetupIntent.
- **configuration** (CollectBankAccountConfiguration) - Required - The configuration for the bank account collection.

### Overloads
- `presentWithSetupIntent(publishableKey: String, stripeAccountId: String? = null, clientSecret: String, configuration: CollectBankAccountConfiguration)`
- `presentWithSetupIntent(publishableKey: String, stripeAccountId: String? = null, clientSecret: String, configuration: CollectBankAccountConfiguration, preCollectedConsent: FinancialConnectionsPreCollectedConsent?)`
```

--------------------------------

### constructor(publishableKey: String, merchantDisplayName: String, email: String, stripeAccountId: String? = null)

Source: https://github.com/stripe/stripe-android/blob/master/docs/paymentsheet/com.stripe.android.link/-link-controller/-configuration/index.html

Creates a new Configuration instance with the provided publishable key, merchant display name, email, and optional Stripe account ID.

```APIDOC
## Constructor

### Description
Creates a new Configuration instance for LinkController.

### Parameters
- **publishableKey** (String) - Required - The Stripe publishable key.
- **merchantDisplayName** (String) - Required - The merchant display name.
- **email** (String) - Required - The customer's email address.
- **stripeAccountId** (String?) - Optional - The Stripe account ID. Defaults to null.

### Example
```kotlin
val config = LinkController.Configuration(
    publishableKey = "pk_test_...",
    merchantDisplayName = "Example Merchant",
    email = "customer@example.com"
)
```
```

--------------------------------

### getRequestCode

Source: https://github.com/stripe/stripe-android/blob/master/docs/payments-core/com.stripe.android.model/-setup-intent/index.html

Extension function to get the request code for a StripeIntent.

```APIDOC
## Function: getRequestCode

### Description
Returns the request code associated with the StripeIntent.

### Signature
```kotlin
fun StripeIntent.getRequestCode(): Int
```

### Parameters
- **receiver** (StripeIntent) - The StripeIntent instance.

### Return Type
- **Int** - The request code.
```

--------------------------------

### getButtonCustomization

Source: https://github.com/stripe/stripe-android/blob/master/docs/3ds2sdk/com.stripe.android.stripe3ds2.init.ui/-stripe-ui-customization/index.html

Gets the button customization for a specific button type.

```APIDOC
## getButtonCustomization

### Description
Gets the button customization for a specific button type.

### Method
getButtonCustomization

### Signature
`@Nullable open fun getButtonCustomization(@NonNull buttonType: UiCustomization.ButtonType): ButtonCustomization?`

### Parameters
- **buttonType** (UiCustomization.ButtonType) - Required - The predefined button type.

### Returns
- **ButtonCustomization?** - The button customization, or null if not set.

---

### Description
Gets the button customization for a specific button type.

### Method
getButtonCustomization

### Signature
`@Nullable open fun getButtonCustomization(@NonNull buttonType: String): ButtonCustomization?`

### Parameters
- **buttonType** (String) - Required - The button type as a string.

### Returns
- **ButtonCustomization?** - The button customization, or null if not set.
```

--------------------------------

### SetupIntent.status

Source: https://github.com/stripe/stripe-android/blob/master/docs/payments-core/com.stripe.android.model/-setup-intent/status.html

Documentation for the `status` property of the `SetupIntent` class.

```APIDOC
## Property: status

### Description

Status of this SetupIntent. See [Stripe documentation](https://stripe.com/docs/payments/intents#intent-statuses) for details.

### Declaration

```kotlin
open override val status: StripeIntent.Status?
```

### Type

`StripeIntent.Status?` (nullable)

### Remarks

This property is part of the `SetupIntent` class in the `com.stripe.android.model` package.
```

--------------------------------

### fromJson

Source: https://github.com/stripe/stripe-android/blob/master/docs/payments-core/com.stripe.android.model/-setup-intent/-companion/index.html

Creates a SetupIntent instance from a JSONObject. This is a static method that can be called directly on the Companion object.

```APIDOC
## fromJson

### Description
Creates a SetupIntent instance from a JSONObject.

### Method
fromJson

### Signature
@JvmStatic
fun fromJson(jsonObject: JSONObject?): SetupIntent?

### Parameters
- **jsonObject** (JSONObject?) - The JSON object representing the SetupIntent. Can be null.

### Returns
- **SetupIntent?** - The parsed SetupIntent, or null if the input is null or cannot be parsed.
```

--------------------------------

### handleNextActionForSetupIntent(activity, clientSecret, stripeAccountId)

Source: https://github.com/stripe/stripe-android/blob/master/docs/payments-core/com.stripe.android/-stripe/handle-next-action-for-setup-intent.html

Handles the next_action for a previously confirmed SetupIntent using an Activity. Used for manual confirmation flow.

```APIDOC
## handleNextActionForSetupIntent(activity, clientSecret, stripeAccountId)

### Description
Handles the next_action for a previously confirmed SetupIntent. Used for manual confirmation flow.

### Method
fun handleNextActionForSetupIntent(activity: ComponentActivity, clientSecret: String, stripeAccountId: String? = this.stripeAccountId)

### Parameters
- **activity** (ComponentActivity) - Required - The Activity that is launching the payment authentication flow.
- **clientSecret** (String) - Required - The client_secret property of a confirmed SetupIntent object.
- **stripeAccountId** (String?) - Optional - The Connect account to associate with this request. By default, will use the Connect account that was used to instantiate the Stripe object, if specified.

### Annotations
- @UiThread
- @JvmOverloads
```

--------------------------------

### onStart()

Source: https://github.com/stripe/stripe-android/blob/master/docs/3ds2sdk/com.stripe.android.stripe3ds2.views/-challenge-progress-fragment/index.html

Called when the fragment is visible to the user and actively running.

```APIDOC
## onStart()

### Description
Called when the fragment is visible to the user and actively running.

### Method
open fun onStart()

### Parameters
None

### Returns
Unit
```

--------------------------------

### mode property

Source: https://github.com/stripe/stripe-android/blob/master/docs/financial-connections-core/com.stripe.android.financialconnections.model/-manual-entry/index.html

Gets the manual entry mode of this ManualEntry instance.

```APIDOC
## mode property

### Description
Returns the manual entry mode associated with this ManualEntry.

### Returns
- **mode** (ManualEntryMode) - The manual entry mode.

### Example
```kotlin
val mode = manualEntry.mode
```
```

--------------------------------

### fun init(context: Context, publishableKey: String, stripeAccountId: String? = null)

Source: https://github.com/stripe/stripe-android/blob/master/docs/payments-core/com.stripe.android/-payment-configuration/-companion/init.html

Initializes the PaymentConfiguration with the provided context, publishable key, and optional Stripe account ID. This must be called before using the SDK.

```APIDOC
## init(context: Context, publishableKey: String, stripeAccountId: String? = null)

### Description
Initializes the PaymentConfiguration with the provided context, publishable key, and optional Stripe account ID. This must be called before using the SDK.

### Method
`fun init(context: Context, publishableKey: String, stripeAccountId: String? = null)`

### Parameters
- **context** (Context) - Required - The application context.
- **publishableKey** (String) - Required - A publishable key from the Dashboard's [API keys](https://dashboard.stripe.com/apikeys) page.
- **stripeAccountId** (String?) - Optional - The Stripe account ID for connected accounts. Defaults to null.

### Return Type
`Unit`

### Example
```kotlin
PaymentConfiguration.init(context, "pk_test_...", stripeAccountId = "acct_...")
```
```

--------------------------------

### sealed class Mode

Source: https://github.com/stripe/stripe-android/blob/master/docs/paymentsheet/com.stripe.android.paymentsheet/-payment-sheet/-intent-configuration/index.html

Contains information about the desired payment or setup flow.

```APIDOC
## sealed class Mode

### Description
Contains information about the desired payment or setup flow.

### Declaration
```kotlin
sealed class Mode : Parcelable
```

### Subclasses
- **PaymentMode** - Represents a payment flow.
- **SetupMode** - Represents a setup flow.

### Usage
Used in `PaymentSheet.IntentConfiguration` to specify the flow type.
```

--------------------------------

### completed

Source: https://github.com/stripe/stripe-android/blob/master/docs/paymentsheet/com.stripe.android.paymentelement/-custom-payment-method-result/-companion/index.html

Creates a CustomPaymentMethodResult indicating the customer successfully completed the payment or setup.

```APIDOC
## Function: completed

### Description
Creates a CustomPaymentMethodResult indicating the customer successfully completed the payment or setup.

### Signature
@JvmStatic
fun completed(): CustomPaymentMethodResult

### Parameters
None

### Returns
- **CustomPaymentMethodResult** - A result representing successful completion.
```

--------------------------------

### fun confirmSetupIntent(clientSecret: String)

Source: https://github.com/stripe/stripe-android/blob/master/docs/paymentsheet/com.stripe.android.link/-link-controller/-presenter/confirm-setup-intent.html

Confirms a SetupIntent using the payment method from the most recent successful present call. Requires that present has completed successfully first; otherwise the result is ConfirmSetupIntentResult.Failed. The result is communicated through the ConfirmSetupIntentCallback provided during presenter creation.

```APIDOC
## confirmSetupIntent

### Description
Confirms a SetupIntent using the payment method from the most recent successful present call. This uses the payment method already created during the present flow to confirm the provided SetupIntent. Requires that present has completed successfully first; otherwise the result is ConfirmSetupIntentResult.Failed. The result will be communicated through the ConfirmSetupIntentCallback provided during presenter creation.

### Method
FUNCTION

### Signature
fun confirmSetupIntent(clientSecret: String)

### Parameters
- **clientSecret** (String) - Required - The client secret of the SetupIntent to confirm.

### Return
Unit (no return value)

### Errors
- If present has not completed successfully, the result is ConfirmSetupIntentResult.Failed.
```

--------------------------------

### confirmSetupIntent (Fragment)

Source: https://github.com/stripe/stripe-android/blob/master/docs/payments-core/com.stripe.android/-stripe/index.html

Confirms a SetupIntent using a Fragment for authentication.

```APIDOC
## confirmSetupIntent (Fragment)

### Description
Confirms and, if necessary, authenticates a SetupIntent.

### Method
fun

### Signature
```kotlin
@UiThread
@JvmOverloads
fun confirmSetupIntent(
    fragment: Fragment,
    confirmSetupIntentParams: ConfirmSetupIntentParams,
    stripeAccountId: String? = this.stripeAccountId
)
```

### Parameters
- **fragment** (Fragment) - Required - The fragment used for authentication.
- **confirmSetupIntentParams** (ConfirmSetupIntentParams) - Required - Parameters for confirming the SetupIntent.
- **stripeAccountId** (String?) - Optional - The Stripe account ID to use.
```

--------------------------------

### val paymentMethod: PaymentMethod

Source: https://github.com/stripe/stripe-android/blob/master/docs/paymentsheet/com.stripe.android.link/-link-controller/-confirm-setup-intent-result/-success/payment-method.html

The payment method that was attached during the setup intent confirmation.

```APIDOC
## Property: paymentMethod

### Description
The payment method that was attached.

### Signature
```kotlin
val paymentMethod: PaymentMethod
```

### Type
[PaymentMethod](../../../../../payments-core/com.stripe.android.model/-payment-method/index.html)

### Parameters
- **paymentMethod** - The payment method that was attached.

```

--------------------------------

### onLocalVoiceInteractionStarted

Source: https://github.com/stripe/stripe-android/blob/master/docs/payments-core/com.stripe.android.view/-payment-auth-web-view-activity/index.html

Called when local voice interaction starts. This is an open function that can be overridden.

```APIDOC
## onLocalVoiceInteractionStarted

### Description
Called when local voice interaction starts.

### Method
open fun onLocalVoiceInteractionStarted()

### Parameters
None

### Returns
Unit

```

--------------------------------

### onPrepareOptionsMenu

Source: https://github.com/stripe/stripe-android/blob/master/docs/payments-core/com.stripe.android.view/-stripe-activity/index.html

Called to prepare the options menu. Override to modify the menu.

```APIDOC
## onPrepareOptionsMenu

### Description
Called to prepare the options menu. Override to modify the menu.

### Method
open override fun onPrepareOptionsMenu(menu: Menu): Boolean

### Parameters
- **menu** (Menu) - Required - The options menu.

### Returns
- **Boolean** - Whether the menu was prepared.
```

--------------------------------

### confirmSetupIntent(fragment, confirmSetupIntentParams, stripeAccountId)

Source: https://github.com/stripe/stripe-android/blob/master/docs/payments-core/com.stripe.android/-stripe/confirm-setup-intent.html

Confirms and, if necessary, authenticates a SetupIntent using a Fragment as the launching context.

```APIDOC
## confirmSetupIntent(fragment, confirmSetupIntentParams, stripeAccountId)

### Description
Confirms and, if necessary, authenticates a SetupIntent using a Fragment as the launching context.

### Method
fun confirmSetupIntent(fragment: Fragment, confirmSetupIntentParams: ConfirmSetupIntentParams, stripeAccountId: String? = this.stripeAccountId)

### Parameters
- **fragment** (Fragment) - Required - The Fragment that is launching the payment authentication flow.
- **confirmSetupIntentParams** (ConfirmSetupIntentParams) - Required - A set of params with which to confirm the Setup Intent.
- **stripeAccountId** (String?) - Optional - The Connect account to associate with this request. By default, uses the Connect account used to instantiate the Stripe object, if specified.
```

--------------------------------

### onPreparePanel

Source: https://github.com/stripe/stripe-android/blob/master/docs/payments-core/com.stripe.android.view/-stripe-activity/index.html

Called to prepare a panel. Override to customize the panel.

```APIDOC
## onPreparePanel

### Description
Called to prepare a panel. Override to customize the panel.

### Method
open override fun onPreparePanel(featureId: Int, view: View?, menu: Menu): Boolean

### Parameters
- **featureId** (Int) - Required - The feature ID.
- **view** (View?) - Optional - The view.
- **menu** (Menu) - Required - The menu.

### Returns
- **Boolean** - Whether the panel was prepared.
```

--------------------------------

### onGetLayoutInflater

Source: https://github.com/stripe/stripe-android/blob/master/docs/3ds2sdk/com.stripe.android.stripe3ds2.views/-challenge-progress-fragment/index.html

Called to get the LayoutInflater for the fragment. This can be overridden to return a custom LayoutInflater.

```APIDOC
## onGetLayoutInflater

### Description
Called to get the LayoutInflater for the fragment. This can be overridden to return a custom LayoutInflater.

### Method
onGetLayoutInflater

### Signature
open fun onGetLayoutInflater(savedInstanceState: Bundle?): LayoutInflater

### Parameters
- **savedInstanceState** (Bundle?) - Optional - If non-null, this fragment is being re-constructed from a previous saved state as given here.

### Returns
- **LayoutInflater** - The LayoutInflater to use for the fragment.
```

--------------------------------

### create(paymentMethodId: String, clientSecret: String, mandateData: MandateDataParams?, mandateId: String?): ConfirmSetupIntentParams

Source: https://github.com/stripe/stripe-android/blob/master/docs/payments-core/com.stripe.android.model/-confirm-setup-intent-params/-companion/index.html

Creates parameters for confirming a SetupIntent while attaching an existing PaymentMethod.

```APIDOC
## create(paymentMethodId: String, clientSecret: String, mandateData: MandateDataParams?, mandateId: String?): ConfirmSetupIntentParams

### Description
Creates the parameters necessary for confirming a SetupIntent while attaching a PaymentMethod that already exists.

### Method
fun create(paymentMethodId: String, clientSecret: String, mandateData: MandateDataParams? = null, mandateId: String? = null): ConfirmSetupIntentParams

### Parameters
- **paymentMethodId** (String) - Required - The ID of the existing PaymentMethod to attach.
- **clientSecret** (String) - Required - The client secret of the SetupIntent.
- **mandateData** (MandateDataParams?) - Optional - Data for the mandate. Defaults to null.
- **mandateId** (String?) - Optional - The ID of the mandate. Defaults to null.

### Returns
ConfirmSetupIntentParams - The parameters for confirming the SetupIntent.
```

--------------------------------

### getUrlForDensity

Source: https://github.com/stripe/stripe-android/blob/master/docs/3ds2sdk/com.stripe.android.stripe3ds2.transactions/-challenge-response-data/-image/get-url-for-density.html

Function to get the appropriate image URL based on screen density.

```APIDOC
## getUrlForDensity

### Description
Determines which of the 3 image URLs should be used to display the image based on the screen's density. If the density-appropriate URL is null, returns the highest fidelity URL.

### Method
fun getUrlForDensity(density: Int): String?

### Parameters
- **density** (Int) - Required - The device's screen density.

### Return
String? - The image URL most appropriate for the given density.
```

--------------------------------

### build

Source: https://github.com/stripe/stripe-android/blob/master/docs/connect/com.stripe.android.connect.appearance/-appearance/-builder/index.html

Builds the Appearance instance with the configured settings.

```APIDOC
## build

### Description
Builds the Appearance instance with the configured settings.

### Method
fun build(): Appearance

### Returns
Appearance - The constructed Appearance instance.
```

--------------------------------

### val current: String

Source: https://github.com/stripe/stripe-android/blob/master/docs/3ds2sdk/com.stripe.android.stripe3ds2.transaction/-message-version-registry/index.html

Gets the current message version supported by this registry.

```APIDOC
## val current: String

### Description
Returns the current message version string supported by the registry.

### Property
`current: String`

### Type
String

### Access
Read-only (val)

### Returns
The current message version as a String.
```

--------------------------------

### constructor(currency: String?, setupFutureUse: SetupFutureUse)

Source: https://github.com/stripe/stripe-android/blob/master/docs/paymentsheet/com.stripe.android.paymentsheet/-payment-sheet/-intent-configuration/-mode/-setup/-setup.html

Creates a Setup mode configuration for PaymentSheet.IntentConfiguration. The currency parameter filters payment methods by supported currency, and setupFutureUse indicates intent for future payments.

```APIDOC
## Setup

### Description
Creates a Setup mode configuration for PaymentSheet.IntentConfiguration. This constructor is used to configure a setup intent for future payments.

### Method
Constructor

### Endpoint
N/A - This is a Kotlin constructor, not an HTTP endpoint.

### Parameters
- **currency** (String?) - Optional - Three-letter ISO currency code. Filters out payment methods based on supported currency. See [our docs](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-currency) for more info.
- **setupFutureUse** (SetupFutureUse) - Required - Indicates that you intend to make future payments. See [our docs](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-setup_future_usage) for more info.

### Request Example
```kotlin
val setup = PaymentSheet.IntentConfiguration.Mode.Setup(
    currency = "USD",
    setupFutureUse = SetupFutureUse.OffSession
)
```

### Response
No response - this is a constructor call.
```

--------------------------------

### fun canceled(): CustomPaymentMethodResult

Source: https://github.com/stripe/stripe-android/blob/master/docs/paymentsheet/com.stripe.android.paymentelement/-custom-payment-method-result/-companion/canceled.html

Creates a CustomPaymentMethodResult representing a canceled payment or setup attempt.

```APIDOC
## canceled

### Description
Returns a [CustomPaymentMethodResult] indicating that the customer canceled the payment or setup attempt.

### Method
`fun canceled(): CustomPaymentMethodResult`

### Parameters
None

### Return Value
- **CustomPaymentMethodResult** - A result object representing a canceled payment or setup attempt.

### Example
```kotlin
val result = CustomPaymentMethodResult.canceled()
```
```

--------------------------------

### startActivityFromFragment(fragment: Fragment, intent: Intent?, requestCode: Int)

Source: https://github.com/stripe/stripe-android/blob/master/docs/financial-connections/com.stripe.android.financialconnections/-financial-connections-sheet-redirect-activity/index.html

Starts an activity from a fragment.

```APIDOC
## startActivityFromFragment(fragment: Fragment, intent: Intent?, requestCode: Int)

### Description
Starts an activity from a fragment.

### Parameters
- **fragment** (Fragment) - Required - The fragment that is starting the activity.
- **intent** (Intent?) - Required - The intent describing the activity to start.
- **requestCode** (Int) - Required - The request code to be returned in the result.

### Returns
Unit
```
Tokens:
Raw