paymentsheet/com.stripe.android.paymentsheet/PaymentSheet/Configuration

Configuration

data class Configuration @JvmOverloads constructor(val merchantDisplayName: String, val customer: PaymentSheet.CustomerConfiguration? = null, val googlePay: PaymentSheet.GooglePayConfiguration? = null, val primaryButtonColor: ColorStateList? = null, val defaultBillingDetails: PaymentSheet.BillingDetails? = null, val shippingDetails: AddressDetails? = null, val allowsDelayedPaymentMethods: Boolean = false, val allowsPaymentMethodsRequiringShippingAddress: Boolean = false, val appearance: PaymentSheet.Appearance = Appearance(), val primaryButtonLabel: String? = null) : Parcelable

Configuration for PaymentSheet

Constructors

Link copied to clipboard
@JvmOverloads
constructor(merchantDisplayName: String, customer: PaymentSheet.CustomerConfiguration? = null, googlePay: PaymentSheet.GooglePayConfiguration? = null, primaryButtonColor: ColorStateList? = null, defaultBillingDetails: PaymentSheet.BillingDetails? = null, shippingDetails: AddressDetails? = null, allowsDelayedPaymentMethods: Boolean = false, allowsPaymentMethodsRequiringShippingAddress: Boolean = false, appearance: PaymentSheet.Appearance = Appearance(), primaryButtonLabel: String? = null)

Types

Link copied to clipboard
class Builder(merchantDisplayName: String)

Configuration builder for cleaner object creation from Java.

Functions

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

Properties

Link copied to clipboard
val allowsDelayedPaymentMethods: Boolean = false

If true, allows payment methods that do not move money at the end of the checkout. Defaults to false.

val allowsPaymentMethodsRequiringShippingAddress: Boolean = false

If true, allows payment methods that require a shipping address, like Afterpay and Affirm. Defaults to false.

Link copied to clipboard
val appearance: PaymentSheet.Appearance

Describes the appearance of Payment Sheet.

Link copied to clipboard
val customer: PaymentSheet.CustomerConfiguration? = null

If set, the customer can select a previously saved payment method within PaymentSheet.

Link copied to clipboard
val defaultBillingDetails: PaymentSheet.BillingDetails? = null

The billing information for the customer.

Link copied to clipboard
val googlePay: PaymentSheet.GooglePayConfiguration? = null

Configuration related to the Stripe Customer making a payment.

Link copied to clipboard
val merchantDisplayName: String

Your customer-facing business name.

Link copied to clipboard
val primaryButtonColor: ColorStateList? = null

The color of the Pay or Add button. Keep in mind the text color is white.

Link copied to clipboard
val primaryButtonLabel: String? = null

The label to use for the primary button.

Link copied to clipboard
val shippingDetails: AddressDetails? = null

The shipping information for the customer. If set, PaymentSheet will pre-populate the form fields with the values provided. This is used to display a "Billing address is same as shipping" checkbox if defaultBillingDetails is not provided. If name and line1 are populated, it's also attached to the PaymentIntent during payment.