PaymentSheet

public class PaymentSheet

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

Show on GitHub

  • This contains all configurable properties of PaymentSheet

    Declaration

    Swift

    public let configuration: Configuration
    Show on GitHub

  • The most recent error encountered by the customer, if any.

    Declaration

    Swift

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

  • 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

  • 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

  • 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

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

    See more

    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

  • A class that presents the individual steps of a payment flow

    See more

    Declaration

    Swift

    @available(iOSApplicationExtension, unavailable)
@available(macCatalystApplicationExtension, unavailable)
public class FlowController
    Show on GitHub

Configuration