PaymentSheet

public class PaymentSheet

A drop-in class that presents a sheet for a customer to complete their payment

Show on GitHub

configuration
This contains all configurable properties of PaymentSheet
Declaration
Swift

public let configuration: Configuration
Show on GitHub
mostRecentError
The most recent error encountered by the customer, if any.
Declaration
Swift

public private(set) var mostRecentError: Error? { get }
Show on GitHub


                    
                    
                    init(paymentIntentClientSecret:configuration:)

Initializes a PaymentSheet

Note

This can be used to complete a payment - don’t log it, store it, or expose it to anyone other than the customer.

Declaration

Swift

public convenience init(paymentIntentClientSecret: String, configuration: Configuration)

Parameters

`paymentIntentClientSecret`	The client secret of a Stripe PaymentIntent object
`configuration`	Configuration for the PaymentSheet. e.g. your business name, Customer details, etc.

Show on GitHub


                    
                    
                    init(setupIntentClientSecret:configuration:)

Initializes a PaymentSheet

Declaration

Swift

public convenience init(setupIntentClientSecret: String, configuration: Configuration)

Parameters

`setupIntentClientSecret`	The client secret of a Stripe SetupIntent object
`configuration`	Configuration for the PaymentSheet. e.g. your business name, Customer details, etc.

Show on GitHub


                    
                    
                    present(from:completion:)

Presents a sheet for a customer to complete their payment

Declaration

Swift

@available(iOSApplicationExtension, unavailable)
@available(macCatalystApplicationExtension, unavailable)
public func present(
    from presentingViewController: UIViewController,
    completion: @escaping (PaymentSheetResult) -> ()
)

Parameters

`presentingViewController`	The view controller to present a payment sheet
`completion`	Called with the result of the payment after the payment sheet is dismissed

Show on GitHub

Configuration

Configuration
Configuration for PaymentSheet
See more
Declaration
Swift

public struct Configuration
Show on GitHub


                    
                    
                    PaymentButton

A button which presents a sheet for a customer to complete their payment. This is a convenience wrapper for the .paymentSheet() ViewModifier.

Declaration

Swift

public struct PaymentButton<Content> : View where Content : View

Parameters

`paymentSheet`	A PaymentSheet to present.
`onCompletion`	Called with the result of the payment after the payment sheet is dismissed.
`content`	The content of the view.

Show on GitHub


                    
                    
                    FlowController

A class that presents the individual steps of a payment flow

Declaration

Swift

@available(iOSApplicationExtension, unavailable)
@available(macCatalystApplicationExtension, unavailable)
public class FlowController

Show on GitHub

Appearance
Describes the appearance of PaymentSheet
See more
Declaration
Swift

struct Appearance : Equatable
Show on GitHub
UserInterfaceStyle
Style options for colors in PaymentSheet
See more
Declaration
Swift

@available(iOS 13.0, *) public enum UserInterfaceStyle : Int
Show on GitHub
SavePaymentMethodOptInBehavior
Options for the default state of save payment method controls @note Some jurisdictions may have rules governing the ability to default to opt-out behaviors
See more
Declaration
Swift

public enum SavePaymentMethodOptInBehavior
Show on GitHub
CustomerConfiguration
Configuration related to the Stripe Customer
See more
Declaration
Swift

public struct CustomerConfiguration
Show on GitHub
ApplePayConfiguration
Configuration related to Apple Pay
See more
Declaration
Swift

public struct ApplePayConfiguration
Show on GitHub
Address
An address.
See more
Declaration
Swift

public struct Address : Equatable
Show on GitHub
BillingDetails
Billing details of a customer
See more
Declaration
Swift

public struct BillingDetails : Equatable
Show on GitHub