-
If true, allows payment methods that do not move money at the end of the checkout. Defaults to false.
- Description: Some payment methods can’t guarantee you will receive funds from your customer at the end of the checkout because they take time to settle (eg. most bank debits, like SEPA or ACH) or require customer action to complete (e.g. OXXO, Konbini, Boleto). If this is set to true, make sure your integration listens to webhooks for notifications on whether a payment has succeeded or not.
Declaration
Swift
public var allowsDelayedPaymentMethods: Bool
-
If
true
, allows payment methods that require a shipping address, like Afterpay and Affirm. Defaults tofalse
. Set this totrue
if you collect shipping addresses and setConfiguration.shippingDetails
or setshipping
details directly on the PaymentIntent.Note
PaymentSheet considers this propertytrue
and allows payment methods that require a shipping address ifshipping
details are present on the PaymentIntent when PaymentSheet loads.Declaration
Swift
public var allowsPaymentMethodsRequiringShippingAddress: Bool
-
The APIClient instance used to make requests to Stripe
Declaration
Swift
public var apiClient: STPAPIClient
-
Configuration related to Apple Pay If set, PaymentSheet displays Apple Pay as a payment option
Declaration
Swift
public var applePay: ApplePayConfiguration?
-
The color of the Buy or Add button. Defaults to
.systemBlue
whennil
.Declaration
Swift
public var primaryButtonColor: UIColor? { get set }
-
The label to use for the primary button.
If not set, Payment Sheet will display suitable default labels for payment and setup intents.
Declaration
Swift
public var primaryButtonLabel: String?
-
The color styling to use for PaymentSheet UI Default value is SheetStyle.automatic @see SheetStyle
Declaration
Swift
@available(iOS 13.0, *) public var style: UserInterfaceStyle { get set }
-
Configuration related to the Stripe Customer If set, the customer can select a previously saved payment method within PaymentSheet
Declaration
Swift
public var customer: CustomerConfiguration?
-
Your customer-facing business name. This is used to display a “Pay (merchantDisplayName)” line item in the Apple Pay sheet The default value is the name of your app, using CFBundleDisplayName or CFBundleName
Declaration
Swift
public var merchantDisplayName: String
-
A URL that redirects back to your app that PaymentSheet can use to auto-dismiss web views used for additional authentication, e.g. 3DS2
Declaration
Swift
public var returnURL: String?
-
PaymentSheet pre-populates fields with the values provided.
Declaration
Swift
public var defaultBillingDetails: BillingDetails
-
PaymentSheet offers users an option to save some payment methods for later use. Default value is .automatic @see SavePaymentMethodOptInBehavior
Declaration
Swift
public var savePaymentMethodOptInBehavior: SavePaymentMethodOptInBehavior
-
Describes the appearance of PaymentSheet
Declaration
Swift
public var appearance: PaymentSheet.Appearance
-
A closure that returns the customer’s shipping details. This is used to display a “Billing address is same as shipping” checkbox if
defaultBillingDetails
is not provided Ifname
andline1
are populated, it’s also attached to the PaymentIntent during payment.Declaration
Swift
public var shippingDetails: () -> AddressViewController.AddressDetails?
-
Initializes a Configuration with default values
Declaration
Swift
public init()