Classes Reference


                    
                    
                    AccessibilityCloseButton

Undocumented

Declaration

Swift

final class AccessibilityCloseButton

extension AccessibilityCloseButton : CALayerDelegate, CVarArg, ContentView, CustomDebugStringConvertible, CustomStringConvertible, Equatable, Hashable, NSCoding, NSObjectProtocol, Sendable, StaticIdentifiable, UIAccessibilityIdentification, UIActivityItemsConfigurationProviding, UIAppearance, UIAppearanceContainer, UICoordinateSpace, UIDynamicItem, UIFocusEnvironment, UIFocusItem, UIFocusItemContainer, UILargeContentViewerItem, UIPasteConfigurationSupporting, UIPopoverPresentationControllerSourceItem, UIResponderStandardEditActions, UITraitEnvironment, UIUserActivityRestoring


                    
                    
                    AmountView

Undocumented

Declaration

Swift

class AmountView

extension AmountView : CALayerDelegate, CVarArg, ContentView, CustomDebugStringConvertible, CustomStringConvertible, Equatable, Hashable, NSCoding, NSObjectProtocol, Sendable, StaticIdentifiable, UIAccessibilityIdentification, UIActivityItemsConfigurationProviding, UIAppearance, UIAppearanceContainer, UICoordinateSpace, UIDynamicItem, UIFocusEnvironment, UIFocusItem, UIFocusItemContainer, UILargeContentViewerItem, UIPasteConfigurationSupporting, UIPopoverPresentationControllerSourceItem, UIResponderStandardEditActions, UITraitEnvironment, UIUserActivityRestoring


                    
                    
                    Approval

Encapsulates metadata after CheckoutConfig.onApprove is called. This meta information can be utilized to properly capture an order.

Declaration

Swift

@objc(PPCApproval)
@objcMembers
class Approval

extension Approval : CVarArg, CustomDebugStringConvertible, CustomStringConvertible, Equatable, Hashable, NSObjectProtocol


                    
                    
                    ApprovalActions

Provides an interface to make common order requests from within the PayPal Checkout SDK.

Declaration

Swift

@objc(PPCApprovalActions)
@objcMembers
class ApprovalActions

extension ApprovalActions : CVarArg, CustomDebugStringConvertible, CustomStringConvertible, Equatable, Hashable, NSObjectProtocol


                    
                    
                    ApprovalData

Data describing an approved order

Declaration

Swift

@objc(PPCApprovalData)
@objcMembers
class ApprovalData

extension ApprovalData : CVarArg, CustomDebugStringConvertible, CustomStringConvertible, Equatable, Hashable, NSObjectProtocol


                    
                    
                    ApproveWebCheckoutStep

Undocumented

Declaration

Swift

class ApproveWebCheckoutStep : Step

extension ApproveWebCheckoutStep : CustomStringConvertible, Identifiable


                    
                    
                    AspectRatioImageView

Undocumented

Declaration

Swift

class AspectRatioImageView

extension AspectRatioImageView : AlignableImageView, CALayerDelegate, CVarArg, ContentView, CustomDebugStringConvertible, CustomStringConvertible, Equatable, Hashable, NSCoding, NSObjectProtocol, StaticIdentifiable, UIAccessibilityContentSizeCategoryImageAdjusting, UIAccessibilityIdentification, UIActivityItemsConfigurationProviding, UIAppearance, UIAppearanceContainer, UICoordinateSpace, UIDynamicItem, UIFocusEnvironment, UIFocusItem, UIFocusItemContainer, UILargeContentViewerItem, UIPasteConfigurationSupporting, UIPopoverPresentationControllerSourceItem, UIResponderStandardEditActions, UITraitEnvironment, UIUserActivityRestoring


                    
                    
                    AuthConfig

A config that allows merchants to set authentication traits

Declaration

Swift

@objcMembers
class AuthConfig

extension AuthConfig : CVarArg, CustomDebugStringConvertible, CustomStringConvertible, Equatable, Hashable, NSCopying, NSObjectProtocol


                    
                    
                    AuthenticateStep

Undocumented

Declaration

Swift

class AuthenticateStep : Step

extension AuthenticateStep : CustomStringConvertible, Identifiable


                    
                    
                    AuthorizeActionSuccess

Object representing a successful Authorize action. Currently exclusively wraps the OrderActionData, but may be extended in the future.

Declaration

Swift

@objc(PPCAuthorizeActionSuccess)
@objcMembers
class AuthorizeActionSuccess

extension AuthorizeActionSuccess : CVarArg, CustomDebugStringConvertible, CustomStringConvertible, Equatable, Hashable, NSObjectProtocol


                    
                    
                    BackAction

Undocumented

Declaration

Swift

class BackAction

extension BackAction : CALayerDelegate, CVarArg, ContentView, CustomDebugStringConvertible, CustomStringConvertible, Equatable, Hashable, NSCoding, NSObjectProtocol, Sendable, StaticIdentifiable, UIAccessibilityContentSizeCategoryImageAdjusting, UIAccessibilityIdentification, UIActivityItemsConfigurationProviding, UIAppearance, UIAppearanceContainer, UIContextMenuInteractionDelegate, UICoordinateSpace, UIDynamicItem, UIFocusEnvironment, UIFocusItem, UIFocusItemContainer, UILargeContentViewerItem, UIPasteConfigurationSupporting, UIPopoverPresentationControllerSourceItem, UIResponderStandardEditActions, UISpringLoadedInteractionSupporting, UITraitEnvironment, UIUserActivityRestoring


                    
                    
                    Background

A specified parent class that indicates background views which are applied when specific pages are presented. These background views will be applied to the view controller where the paysheet itself is presented into.

Declaration

Swift

class Background

extension Background : CALayerDelegate, CVarArg, CustomDebugStringConvertible, CustomStringConvertible, Equatable, Hashable, NSCoding, NSObjectProtocol, StaticIdentifiable, UIAccessibilityIdentification, UIActivityItemsConfigurationProviding, UIAppearance, UIAppearanceContainer, UICoordinateSpace, UIDynamicItem, UIFocusEnvironment, UIFocusItem, UIFocusItemContainer, UILargeContentViewerItem, UIPasteConfigurationSupporting, UIPopoverPresentationControllerSourceItem, UIResponderStandardEditActions, UITraitEnvironment, UIUserActivityRestoring


                    
                    
                    BillingActionData

Data vended in response to a successful OrderAction for executing a billing agreement

Declaration

Swift

@objc(PPCBillingActionData)
@objcMembers
class BillingActionData

extension BillingActionData : CVarArg, CustomDebugStringConvertible, CustomStringConvertible, Equatable, Hashable, NSObjectProtocol


                    
                    
                    BrandedBackgroundView

Undocumented

Declaration

Swift

@available(*, deprecated, message: "Please use the new backgrounds member in ExtendedCheckoutConfig")
final class BrandedBackgroundView

extension BrandedBackgroundView : CALayerDelegate, CVarArg, CustomDebugStringConvertible, CustomStringConvertible, Equatable, Hashable, NSCoding, NSObjectProtocol, UIAccessibilityIdentification, UIActivityItemsConfigurationProviding, UIAppearance, UIAppearanceContainer, UICoordinateSpace, UIDynamicItem, UIFocusEnvironment, UIFocusItem, UIFocusItemContainer, UILargeContentViewerItem, UIPasteConfigurationSupporting, UIPopoverPresentationControllerSourceItem, UIResponderStandardEditActions, UITraitEnvironment, UIUserActivityRestoring


                    
                    
                    CaptureActionSuccess

Object representing a successful capture action. Currently exclusively wraps the OrderActionData, but may be extended in the future.

Declaration

Swift

@objc(PPCCaptureActionSuccess)
@objcMembers
class CaptureActionSuccess

extension CaptureActionSuccess : CVarArg, CustomDebugStringConvertible, CustomStringConvertible, Equatable, Hashable, NSObjectProtocol


                    
                    
                    CardinalStep

Undocumented

Declaration

Swift

class CardinalStep : Step

extension CardinalStep : CustomStringConvertible, Identifiable


                    
                    
                    CarouselCell

The Carousel Cell class hold the FI image and labels, notification label and the preferred view

Declaration

Swift

class CarouselCell

extension CarouselCell : CALayerDelegate, CVarArg, ContentView, CustomDebugStringConvertible, CustomStringConvertible, Equatable, Hashable, NSCoding, NSObjectProtocol, StaticIdentifiable, UIAccessibilityIdentification, UIActivityItemsConfigurationProviding, UIAppearance, UIAppearanceContainer, UICoordinateSpace, UIDynamicItem, UIFocusEnvironment, UIFocusItem, UIFocusItemContainer, UILargeContentViewerItem, UIPasteConfigurationSupporting, UIPopoverPresentationControllerSourceItem, UIResponderStandardEditActions, UITraitEnvironment, UIUserActivityRestoring


                    
                    
                    CarouselView

The carousel view denotes the primary wallet and funding instrument selection component

Declaration

Swift

class CarouselView

extension CarouselView : CALayerDelegate, CVarArg, ContentView, CustomDebugStringConvertible, CustomStringConvertible, Equatable, Hashable, Identifiable, NSCoding, NSObjectProtocol, StaticIdentifiable, UIAccessibilityIdentification, UIActivityItemsConfigurationProviding, UIAppearance, UIAppearanceContainer, UICollectionViewDelegate, UICoordinateSpace, UIDynamicItem, UIFocusEnvironment, UIFocusItem, UIFocusItemContainer, UILargeContentViewerItem, UIPasteConfigurationSupporting, UIPopoverPresentationControllerSourceItem, UIResponderStandardEditActions, UIScrollViewDelegate, UITraitEnvironment, UIUserActivityRestoring, ViewModelView


                    
                    
                    CartDetailsView

Undocumented

Declaration

Swift

class CartDetailsView

extension CartDetailsView : CALayerDelegate, CVarArg, ContentView, CustomDebugStringConvertible, CustomStringConvertible, Equatable, Hashable, NSCoding, NSObjectProtocol, StaticIdentifiable, UIAccessibilityIdentification, UIActivityItemsConfigurationProviding, UIAppearance, UIAppearanceContainer, UICoordinateSpace, UIDynamicItem, UIFocusEnvironment, UIFocusItem, UIFocusItemContainer, UILargeContentViewerItem, UIPasteConfigurationSupporting, UIPopoverPresentationControllerSourceItem, UIResponderStandardEditActions, UITraitEnvironment, UIUserActivityRestoring


                    
                    
                    CheckDuplicateSessionStep

Undocumented

Declaration

Swift

final class CheckDuplicateSessionStep : Step

extension CheckDuplicateSessionStep : CustomStringConvertible, Identifiable


                    
                    
                    Checkout

The main interface where you can change or start behavior of the Checkout paysheet.

Declaration

Swift

@objc(PPCheckout)
@objcMembers
final class Checkout

extension Checkout : CVarArg, CustomDebugStringConvertible, CustomStringConvertible, Equatable, Hashable, NSObjectProtocol, StaticIdentifiable


                    
                    
                    CheckoutConfig

Holds all the configuration values required by checkout experiences and checkout flows. Modified and provided by the merchant, to start the checkout flow desired.

Declaration

Swift

@objc(PPCheckoutConfig)
@objcMembers
class CheckoutConfig

extension CheckoutConfig : CVarArg, CustomDebugStringConvertible, CustomStringConvertible, Equatable, Hashable, NSCopying, NSObjectProtocol


                    
                    
                    ConfigureUIStep

Undocumented

Declaration

Swift

class ConfigureUIStep : Step

extension ConfigureUIStep : CustomStringConvertible, Identifiable


                    
                    
                    ContentConfig

The Config used to determine UI customization, such as font and color customization

Declaration

Swift

class ContentConfig


                    
                    
                    ContentPage

Undocumented

Declaration

Swift

class ContentPage

extension ContentPage : Equatable, StaticIdentifiable


                    
                    
                    ContentRouter

The core navigation method within the SDK is the ContentRouter. Without this class not much could be accomplished and navigating from one page to another within the pay sheet would simply not be possible.

Declaration

Swift

class ContentRouter


                    
                    
                    CorrelationIDs

Correlation IDs are debug IDs that the PayPal team uses to track issues.

Declaration

Swift

@objc(PPCCorrelationIDs)
@objcMembers
final class CorrelationIDs

extension CorrelationIDs : CVarArg, CustomDebugStringConvertible, CustomStringConvertible, Equatable, Hashable, NSObjectProtocol


                    
                    
                    CountrySuggestion

Undocumented

Declaration

Swift

class CountrySuggestion

extension CountrySuggestion : Comparable, Equatable, Suggestion


                    
                    
                    CreateOrderAction

CreateOrderAction object to be passed in CreateOrderCallback, allowing merchants options to create order and obtain EC-Token (or Pay-Token or Order ID), either by their own means or using built in functions in the SDK.

Declaration

Swift

@objc(PPCCreateOrderAction)
@objcMembers
class CreateOrderAction

extension CreateOrderAction : CVarArg, CustomDebugStringConvertible, CustomStringConvertible, Equatable, Hashable, NSObjectProtocol


                    
                    
                    CryptoLegalInfoPage

A page that shows crypto legal information.

Declaration

Swift

class CryptoLegalInfoPage : ContentPage

extension CryptoLegalInfoPage : Equatable, StaticIdentifiable


                    
                    
                    CryptoRateView

Undocumented

Declaration

Swift

class CryptoRateView

extension CryptoRateView : CALayerDelegate, CVarArg, ContentView, CustomDebugStringConvertible, CustomStringConvertible, Equatable, Hashable, NSCoding, NSObjectProtocol, StaticIdentifiable, UIAccessibilityIdentification, UIActivityItemsConfigurationProviding, UIAppearance, UIAppearanceContainer, UICoordinateSpace, UIDynamicItem, UIFocusEnvironment, UIFocusItem, UIFocusItemContainer, UILargeContentViewerItem, UIPasteConfigurationSupporting, UIPopoverPresentationControllerSourceItem, UIResponderStandardEditActions, UITraitEnvironment, UIUserActivityRestoring, ViewModelView


                    
                    
                    CryptoRequestStep

Undocumented

Declaration

Swift

class CryptoRequestStep : Step

extension CryptoRequestStep : CustomStringConvertible, Identifiable


                    
                    
                    CurrencyConversionOptionPage

Undocumented

Declaration

Swift

class CurrencyConversionOptionPage : TitledContentPage

extension CurrencyConversionOptionPage : Equatable, StaticIdentifiable


                    
                    
                    DeliverySelectionPage

Undocumented

Declaration

Swift

class DeliverySelectionPage : TitledContentPage

extension DeliverySelectionPage : Equatable, StaticIdentifiable


                    
                    
                    DeliveryView

Undocumented

Declaration

Swift

class DeliveryView

extension DeliveryView : ActionableRow, CALayerDelegate, CVarArg, ContentView, CustomDebugStringConvertible, CustomStringConvertible, Equatable, Hashable, NSCoding, NSObjectProtocol, StaticIdentifiable, UIAccessibilityIdentification, UIActivityItemsConfigurationProviding, UIAppearance, UIAppearanceContainer, UICoordinateSpace, UIDynamicItem, UIFocusEnvironment, UIFocusItem, UIFocusItemContainer, UILargeContentViewerItem, UIPasteConfigurationSupporting, UIPopoverPresentationControllerSourceItem, UIResponderStandardEditActions, UITraitEnvironment, UIUserActivityRestoring, ViewModelView


                    
                    
                    DismissPaysheetStep

Undocumented

Declaration

Swift

class DismissPaysheetStep : Step

extension DismissPaysheetStep : CustomStringConvertible, Identifiable


                    
                    
                    EligibilityStep

Undocumented

Declaration

Swift

class EligibilityStep : Step

extension EligibilityStep : CustomStringConvertible, Identifiable


                    
                    
                    EnvironmentConfig

A config that toggles shims in the code for development purposes.

Declaration

Swift

@objcMembers
class EnvironmentConfig

extension EnvironmentConfig : CVarArg, CustomDebugStringConvertible, CustomStringConvertible, Equatable, Hashable, NSCopying, NSObjectProtocol


                    
                    
                    ErrorInfo

Encapsulates metadata after CheckoutConfig.onError is called. This meta information can be utilized to debug our checkout sessions.

Declaration

Swift

@objc(PPCErrorInfo)
@objcMembers
final class ErrorInfo

extension ErrorInfo : CVarArg, CustomDebugStringConvertible, CustomStringConvertible, Equatable, Hashable, NSObjectProtocol


                    
                    
                    Events

The Events manager. This is where all event payloads are being stored in memory as well as the listeners throughout the code. The class itself is a singleton but the public interfaces do not allow direct access to the single instance.

Declaration

Swift

class Events


                    
                    
                    ExtendedCheckoutConfig

This class should contain all the extended featurs privy to first party or implicity trusted host applications. Those not explicity validated to be on the whitelist for the PayPal iOS Checkout SDK will find that all extended features in this class are ignored.

Declaration

Swift

class ExtendedCheckoutConfig : CheckoutConfig

extension ExtendedCheckoutConfig : CVarArg, CustomDebugStringConvertible, CustomStringConvertible, Equatable, Hashable, NSCopying, NSObjectProtocol


                    
                    
                    GQLQuery

GraphQL Query

Declaration

Swift

class GQLQuery<QuerySuccess> where QuerySuccess : Decodable

extension GQLQuery : Encodable


                    
                    
                    GetFeatureFlagsStep

Undocumented

Declaration

Swift

class GetFeatureFlagsStep : Step

extension GetFeatureFlagsStep : CustomStringConvertible, Identifiable


                    
                    
                    GraphQLMutationState

This class represents the contents of the data sent back to the GraphQL back end for any payment options that were changed during the usage of the SDK. The state is meant to be low maintenance, updating via event listeners, and translating the UI/viewmodel events into the GQL values:

gqlPayload updates all values
shippingAddressChanged updates the selectedAddress
uiCurrencyConversionChanged updates currencyConversion

selectedPlan, preferredFundingOption still need hookups.

Note

this can likely be swapped out with the Codeables that will be used in the mutation

Declaration

Swift

class GraphQLMutationState


                    
                    
                    HomePage

Undocumented

Declaration

Swift

class HomePage : ContentPage

extension HomePage : Equatable, StaticIdentifiable


                    
                    
                    InboundNetworkStep

Undocumented

Declaration

Swift

class InboundNetworkStep : Step

extension InboundNetworkStep : CustomStringConvertible, Identifiable


                    
                    
                    InitializeFirebaseStep

Undocumented

Declaration

Swift

class InitializeFirebaseStep : Step

extension InitializeFirebaseStep : CustomStringConvertible, Identifiable


                    
                    
                    InitializeUIStep

Undocumented

Declaration

Swift

class InitializeUIStep : Step

extension InitializeUIStep : CustomStringConvertible, Identifiable


                    
                    
                    JWTStep

Undocumented

Declaration

Swift

class JWTStep : Step

extension JWTStep : CustomStringConvertible, Identifiable


                    
                    
                    LSATUpgradeTask

Undocumented

Declaration

Swift

class LSATUpgradeTask : Step

extension LSATUpgradeTask : CustomStringConvertible, Identifiable


                    
                    
                    Legalese

Undocumented

Declaration

Swift

class Legalese

extension Legalese : CALayerDelegate, CVarArg, ContentView, CustomDebugStringConvertible, CustomStringConvertible, Equatable, Hashable, NSCoding, NSObjectProtocol, Sendable, StaticIdentifiable, UIAccessibilityIdentification, UIActivityItemsConfigurationProviding, UIAppearance, UIAppearanceContainer, UICoordinateSpace, UIDynamicItem, UIFocusEnvironment, UIFocusItem, UIFocusItemContainer, UILargeContentViewerItem, UIPasteConfigurationSupporting, UIPopoverPresentationControllerSourceItem, UIResponderStandardEditActions, UITraitEnvironment, UIUserActivityRestoring, ViewModelView


                    
                    
                    LineItemContainerView

Undocumented

Declaration

Swift

class LineItemContainerView

extension LineItemContainerView : CALayerDelegate, CVarArg, ContentView, CustomDebugStringConvertible, CustomStringConvertible, Equatable, Hashable, NSCoding, NSObjectProtocol, Sendable, StaticIdentifiable, UIAccessibilityIdentification, UIActivityItemsConfigurationProviding, UIAppearance, UIAppearanceContainer, UICoordinateSpace, UIDynamicItem, UIFocusEnvironment, UIFocusItem, UIFocusItemContainer, UILargeContentViewerItem, UIPasteConfigurationSupporting, UIPopoverPresentationControllerSourceItem, UIResponderStandardEditActions, UITraitEnvironment, UIUserActivityRestoring


                    
                    
                    LoadingPage

Undocumented

Declaration

Swift

class LoadingPage<Kind> : ContentPage where Kind : StaticIdentifiable

extension LoadingPage : Equatable, StaticIdentifiable, Transitionable


                    
                    
                    LogoImageView

Undocumented

Declaration

Swift

class LogoImageView

extension LogoImageView : CALayerDelegate, CVarArg, ContentView, CustomDebugStringConvertible, CustomStringConvertible, Equatable, Hashable, NSCoding, NSObjectProtocol, Sendable, StaticIdentifiable, UIAccessibilityContentSizeCategoryImageAdjusting, UIAccessibilityIdentification, UIActivityItemsConfigurationProviding, UIAppearance, UIAppearanceContainer, UICoordinateSpace, UIDynamicItem, UIFocusEnvironment, UIFocusItem, UIFocusItemContainer, UILargeContentViewerItem, UIPasteConfigurationSupporting, UIPopoverPresentationControllerSourceItem, UIResponderStandardEditActions, UITraitEnvironment, UIUserActivityRestoring


                    
                    
                    LogoutStep

Undocumented

Declaration

Swift

class LogoutStep : Step

extension LogoutStep : CustomStringConvertible, Identifiable


                    
                    
                    MoveToErrorPageStep

Undocumented

Declaration

Swift

class MoveToErrorPageStep : Step

extension MoveToErrorPageStep : CustomStringConvertible, Identifiable


                    
                    
                    MoveToFinishingPage

Undocumented

Declaration

Swift

class MoveToFinishingPage : Step

extension MoveToFinishingPage : CustomStringConvertible, Identifiable


                    
                    
                    MoveToHomepageStep

Undocumented

Declaration

Swift

class MoveToHomepageStep : Step

extension MoveToHomepageStep : CustomStringConvertible, Identifiable


                    
                    
                    MoveToShutdownPage

Undocumented

Declaration

Swift

class MoveToShutdownPage : Step

extension MoveToShutdownPage : CustomStringConvertible, Identifiable


                    
                    
                    OrderActionData

Data vended in response to a successful OrderAction for capturing/authorizing funds

Declaration

Swift

@objc(PPCOrderActionData)
@objcMembers
class OrderActionData

extension OrderActionData : CVarArg, CustomDebugStringConvertible, CustomStringConvertible, Equatable, Hashable, NSObjectProtocol


                    
                    
                    OrderAddress

Describes an address.

Should be used in the creation of the folowing objects

Declaration

Swift

@objc(PPCOrderAddress)
@objcMembers
class OrderAddress

extension OrderAddress : CVarArg, CustomDebugStringConvertible, CustomStringConvertible, Decodable, Encodable, Equatable, Hashable, NSObjectProtocol


                    
                    
                    OrderApplicationContext

A class that represents the possible values to be passed as part of the application context object. OrderApplicationContext object documentation guide

Declaration

Swift

@objc(PPCOrderApplicationContext)
@objcMembers
class OrderApplicationContext

extension OrderApplicationContext : CVarArg, CustomDebugStringConvertible, CustomStringConvertible, Encodable, Equatable, Hashable, NSObjectProtocol


                    
                    
                    OrderDetails

Data vended in response to a successful OrderAction for getting the current details of an existing order The Payer and PurchaseUnits properties contain most of the information related to a specific order.

Declaration

Swift

@objc(PPCOrderDetails)
@objcMembers
class OrderDetails : OrderActionData

extension OrderDetails : CVarArg, CustomDebugStringConvertible, CustomStringConvertible, Decodable, Equatable, Hashable, NSObjectProtocol


                    
                    
                    OrderPayer

A class that represents the possible values to be passed as part of the payer object. Payer object documentation guide

Declaration

Swift

@objc(PPCOrderPayer)
@objcMembers
class OrderPayer

extension OrderPayer : CVarArg, CustomDebugStringConvertible, CustomStringConvertible, Decodable, Encodable, Equatable, Hashable, NSObjectProtocol


                    
                    
                    OrderRequest

The order request object is used to format the orderRequest for the CreateOrderAction Create order documentation

Note

This class is for use exclusively with the order v2 API

Declaration

Swift

@objc(PPCOrderRequest)
@objcMembers
class OrderRequest

extension OrderRequest : CVarArg, CustomDebugStringConvertible, CustomStringConvertible, Encodable, Equatable, Hashable, NSObjectProtocol


                    
                    
                    OutboundNetworkStep

Undocumented

Declaration

Swift

class OutboundNetworkStep : Step

extension OutboundNetworkStep : CustomStringConvertible, Identifiable


                    
                    
                    PatchActionSuccess

A successful request returns the HTTP 204 No Content status code with an empty object in the JSON response body.

Declaration

Swift

@objc(PPCPatchActionSuccess)
class PatchActionSuccess

extension PatchActionSuccess : CVarArg, CustomDebugStringConvertible, CustomStringConvertible, Equatable, Hashable, NSObjectProtocol


                    
                    
                    PatchRequest

Represents each operation and their accepted path, as well as the paths accepted value for each type. Patch Order Documentation

Note

To make an update, you may optionally provide a reference_id. If you omit a reference_id, PayPal defaults to a reference_id of default.

Declaration

Swift

@objc(PPCPatchRequest)
@objcMembers
class PatchRequest

extension PatchRequest : CVarArg, CustomDebugStringConvertible, CustomStringConvertible, Equatable, Hashable, NSObjectProtocol


                    
                    
                    PayLaterButtonUIConfiguration

Configuration for Pay Later Smart Payment Button.

Declaration

Swift

@objc(PPCPayLaterButtonUIConfiguration)
@objcMembers
class PayLaterButtonUIConfiguration

extension PayLaterButtonUIConfiguration : CVarArg, CustomDebugStringConvertible, CustomStringConvertible, Equatable, Hashable, NSObjectProtocol


                    
                    
                    PayPalButton

PayPalButton provides a PayPal button with the ability to modify color, edges, size, insets and label. Tapping on PayPalButton will start checkout with Native Checkout SDK Paysheet.

Declaration

Swift

@available(*, deprecated, message: "Use PaymentButtonContainer(﹚ instead.")
@objc(PPCPayPalButton)
class PayPalButton : PaymentButton

extension PayPalButton : CALayerDelegate, CVarArg, CustomDebugStringConvertible, CustomStringConvertible, Equatable, Hashable, NSCoding, NSObjectProtocol, Sendable, UIAccessibilityContentSizeCategoryImageAdjusting, UIAccessibilityIdentification, UIActivityItemsConfigurationProviding, UIAppearance, UIAppearanceContainer, UIContextMenuInteractionDelegate, UICoordinateSpace, UIDynamicItem, UIFocusEnvironment, UIFocusItem, UIFocusItemContainer, UILargeContentViewerItem, UIPasteConfigurationSupporting, UIPopoverPresentationControllerSourceItem, UIResponderStandardEditActions, UISpringLoadedInteractionSupporting, UITraitEnvironment, UIUserActivityRestoring


                    
                    
                    PayPalButtonUIConfiguration

Configuration for PayPal Smart Payment Button.

Declaration

Swift

@objc(PPCPayPalButtonUIConfiguration)
@objcMembers
class PayPalButtonUIConfiguration

extension PayPalButtonUIConfiguration : CVarArg, CustomDebugStringConvertible, CustomStringConvertible, Equatable, Hashable, NSObjectProtocol


                    
                    
                    PayPalCreditButton

PayPalCreditButton provides a PayPal Credit button with the ability to modify color, edges, size and insets. Tapping on PayPalCreditButton will bring users to checkout with PayPalCredit on web.

Declaration

Swift

@available(*, deprecated, message: "Use PaymentButtonContainer(﹚ instead.")
@objc(PPCPayPalCreditButton)
class PayPalCreditButton : PaymentButton

extension PayPalCreditButton : CALayerDelegate, CVarArg, CustomDebugStringConvertible, CustomStringConvertible, Equatable, Hashable, NSCoding, NSObjectProtocol, Sendable, UIAccessibilityContentSizeCategoryImageAdjusting, UIAccessibilityIdentification, UIActivityItemsConfigurationProviding, UIAppearance, UIAppearanceContainer, UIContextMenuInteractionDelegate, UICoordinateSpace, UIDynamicItem, UIFocusEnvironment, UIFocusItem, UIFocusItemContainer, UILargeContentViewerItem, UIPasteConfigurationSupporting, UIPopoverPresentationControllerSourceItem, UIResponderStandardEditActions, UISpringLoadedInteractionSupporting, UITraitEnvironment, UIUserActivityRestoring


                    
                    
                    PayPalCreditButtonUIConfiguration

Configuration for PayPal Credit Smart Payment Button.

Declaration

Swift

@objc(PPCPayPalCreditButtonUIConfiguration)
@objcMembers
class PayPalCreditButtonUIConfiguration

extension PayPalCreditButtonUIConfiguration : CVarArg, CustomDebugStringConvertible, CustomStringConvertible, Equatable, Hashable, NSObjectProtocol


                    
                    
                    PayPalPayLaterButton

PayPalPayLaterButton provides a Pay in 4 with PayPal button with the ability to modify color, edges, size and insets. Tapping on PayPalPayLaterButton will bring users to checkout with Pay in 4 on web, where users can apply for and pay with Pay in 4.

Declaration

Swift

@available(*, deprecated, message: "Use PaymentButtonContainer(﹚ instead.")
@objc(PPCPayPalPayLaterButton)
class PayPalPayLaterButton : PaymentButton

extension PayPalPayLaterButton : CALayerDelegate, CVarArg, CustomDebugStringConvertible, CustomStringConvertible, Equatable, Hashable, NSCoding, NSObjectProtocol, UIAccessibilityContentSizeCategoryImageAdjusting, UIAccessibilityIdentification, UIActivityItemsConfigurationProviding, UIAppearance, UIAppearanceContainer, UIContextMenuInteractionDelegate, UICoordinateSpace, UIDynamicItem, UIFocusEnvironment, UIFocusItem, UIFocusItemContainer, UILargeContentViewerItem, UIPasteConfigurationSupporting, UIPopoverPresentationControllerSourceItem, UIResponderStandardEditActions, UISpringLoadedInteractionSupporting, UITraitEnvironment, UIUserActivityRestoring


                    
                    
                    PaymentButton

The PaymentButton is utilized to provide a seamless integration for a checkout experience similar to how the web handles PayPal checkout experiences.

Declaration

Swift

@available(*, deprecated, message: "Use PaymentButtonContainer(﹚ instead.")
@objc(PPCPaymentButton)
@objcMembers
class PaymentButton

extension PaymentButton : CALayerDelegate, CVarArg, CustomDebugStringConvertible, CustomStringConvertible, Equatable, Hashable, NSCoding, NSObjectProtocol, UIAccessibilityContentSizeCategoryImageAdjusting, UIAccessibilityIdentification, UIActivityItemsConfigurationProviding, UIAppearance, UIAppearanceContainer, UIContextMenuInteractionDelegate, UICoordinateSpace, UIDynamicItem, UIFocusEnvironment, UIFocusItem, UIFocusItemContainer, UILargeContentViewerItem, UIPasteConfigurationSupporting, UIPopoverPresentationControllerSourceItem, UIResponderStandardEditActions, UISpringLoadedInteractionSupporting, UITraitEnvironment, UIUserActivityRestoring


                    
                    
                    PaymentButtonAttributes

These are different attributes to configure the native Smart Payment Button style.

Declaration

Swift

@objc(PPCPaymentButtonAttributes)
@objcMembers
class PaymentButtonAttributes

extension PaymentButtonAttributes : CVarArg, CustomDebugStringConvertible, CustomStringConvertible, Equatable, Hashable, NSObjectProtocol


                    
                    
                    PaymentButtonContainer

A container UI element that groups all the PayPal buttons (PayPal, PayLater, Credit). PaymentButtonContainer provides PayPal buttons with the ability to modify the PayPalButtonUI, PayPalCreditButtonUI, and PayLaterButtonUI, their attributes, and implement the PaymentButtonContainerDelegate

Declaration

Swift

@objc(PPCPaymentButtonContainer)
@objcMembers
class PaymentButtonContainer

extension PaymentButtonContainer : CALayerDelegate, CVarArg, CustomDebugStringConvertible, CustomStringConvertible, Equatable, Hashable, NSCoding, NSObjectProtocol, PaymentButtonDelegate, Sendable, UIAccessibilityIdentification, UIActivityItemsConfigurationProviding, UIAppearance, UIAppearanceContainer, UICoordinateSpace, UIDynamicItem, UIFocusEnvironment, UIFocusItem, UIFocusItemContainer, UILargeContentViewerItem, UIPasteConfigurationSupporting, UIPopoverPresentationControllerSourceItem, UIResponderStandardEditActions, UITraitEnvironment, UIUserActivityRestoring


                    
                    
                    PaymentFundingEligibilityState

PaymentFundingEligibilityState is a model to provide the eligibility response for each Funding Each funding will have the reasons for eligibility/ineligibility

Declaration

Swift

@objc(PPCPaymentFundingEligibilityState)
@objcMembers
class PaymentFundingEligibilityState

extension PaymentFundingEligibilityState : CVarArg, CustomDebugStringConvertible, CustomStringConvertible, Equatable, Hashable, NSObjectProtocol


                    
                    
                    PreAuthWebFallbackStep

Undocumented

Declaration

Swift

final class PreAuthWebFallbackStep : Step

extension PreAuthWebFallbackStep : CustomStringConvertible, Identifiable


                    
                    
                    ProfileImageBubble

Undocumented

Declaration

Swift

class ProfileImageBubble

extension ProfileImageBubble : CALayerDelegate, CVarArg, ContentView, CustomDebugStringConvertible, CustomStringConvertible, Equatable, Hashable, NSCoding, NSObjectProtocol, StaticIdentifiable, UIAccessibilityContentSizeCategoryImageAdjusting, UIAccessibilityIdentification, UIActivityItemsConfigurationProviding, UIAppearance, UIAppearanceContainer, UICoordinateSpace, UIDynamicItem, UIFocusEnvironment, UIFocusItem, UIFocusItemContainer, UILargeContentViewerItem, UIPasteConfigurationSupporting, UIPopoverPresentationControllerSourceItem, UIResponderStandardEditActions, UITraitEnvironment, UIUserActivityRestoring


                    
                    
                    ProfilePage

Undocumented

Declaration

Swift

class ProfilePage : ContentPage

extension ProfilePage : Equatable, StaticIdentifiable


                    
                    
                    PurchaseUnit

A class that represents the possible values to be passed as part of the purchase unit object. Purchase units request documentation guide

Declaration

Swift

@objc(PPCPurchaseUnit)
@objcMembers
class PurchaseUnit

extension PurchaseUnit : CVarArg, CustomDebugStringConvertible, CustomStringConvertible, Decodable, Encodable, Equatable, Hashable, NSObjectProtocol


                    
                    
                    RateChangeView

Undocumented

Declaration

Swift

class RateChangeView

extension RateChangeView : ActionableRow, CALayerDelegate, CVarArg, ContentView, CustomDebugStringConvertible, CustomStringConvertible, Equatable, FadingContentView, Hashable, NSCoding, NSObjectProtocol, StaticIdentifiable, UIAccessibilityIdentification, UIActivityItemsConfigurationProviding, UIAppearance, UIAppearanceContainer, UICoordinateSpace, UIDynamicItem, UIFocusEnvironment, UIFocusItem, UIFocusItemContainer, UILargeContentViewerItem, UIPasteConfigurationSupporting, UIPopoverPresentationControllerSourceItem, UIResponderStandardEditActions, UITraitEnvironment, UIUserActivityRestoring, ViewModelView


                    
                    
                    RateProtectionInfoPage

Undocumented

Declaration

Swift

class RateProtectionInfoPage : TitledContentPage

extension RateProtectionInfoPage : Equatable, StaticIdentifiable


                    
                    
                    ResetEnvironmentStep

Undocumented

Declaration

Swift

class ResetEnvironmentStep : Step

extension ResetEnvironmentStep : CustomStringConvertible, Identifiable


                    
                    
                    ResolveThreeDSStep

Undocumented

Declaration

Swift

class ResolveThreeDSStep : Step

extension ResolveThreeDSStep : CustomStringConvertible, Identifiable


                    
                    
                    SDKEligibilityStep

Undocumented

Declaration

Swift

class SDKEligibilityStep : Step

extension SDKEligibilityStep : CustomStringConvertible, Identifiable


                    
                    
                    SecondaryApprovalStep

Undocumented

Declaration

Swift

class SecondaryApprovalStep : Step

extension SecondaryApprovalStep : CustomStringConvertible, Identifiable


                    
                    
                    SequenceProcessor

The SequenceProcessor is designed to take a list of callback instances and execute the first one while providing it the ability to execute the next item in the list. This style of sequencing allows for truly asynchronous execution with each closure either passing the Next instance off to another function or class to be executed later or to be ignored if logic in that step indicates that progress should not continue.

Each closure must execute the Next closure for the chain to continue. Passing an error to the closure will cause execution to halt.

Declaration

Swift

class SequenceProcessor<Context>

extension SequenceProcessor : CheckoutProcess where Context == State


                    
                    
                    SessionIdentifiers

Unique identifiers for an SDK session/checkout session

Declaration

Swift

@objc(PPCSessionIDs)
@objcMembers
final class SessionIdentifiers

extension SessionIdentifiers : CVarArg, CustomDebugStringConvertible, CustomStringConvertible, Equatable, Hashable, NSObjectProtocol


                    
                    
                    ShippingChange

Undocumented

Declaration

Swift

@objc(PPCShippingChange)
@objcMembers
final class ShippingChange

extension ShippingChange : CVarArg, CustomDebugStringConvertible, CustomStringConvertible, Equatable, Hashable, NSObjectProtocol


                    
                    
                    ShippingChangeAction

Undocumented

Declaration

Swift

@objc(PPCShippingChangeAction)
@objcMembers
class ShippingChangeAction

extension ShippingChangeAction : CVarArg, CustomDebugStringConvertible, CustomStringConvertible, Equatable, Hashable, NSObjectProtocol


                    
                    
                    ShippingChangeAddress

Undocumented

Declaration

Swift

@objc(PPCShippingChangeAddress)
@objcMembers
final class ShippingChangeAddress

extension ShippingChangeAddress : CVarArg, CustomDebugStringConvertible, CustomStringConvertible, Equatable, Hashable, NSObjectProtocol


                    
                    
                    ShippingDetailsPage

Undocumented

Declaration

Swift

class ShippingDetailsPage : ContentPage

extension ShippingDetailsPage : Equatable, ShippingSegmentedControlDelegate, StaticIdentifiable


                    
                    
                    ShippingMethod

Shipping option for an order used when creating an order with Orders API. If you want to show your shipping options in our Paysheet, you should provide purchaseUnits[].shipping.options, otherwise, our Paysheet won’t display any shipping options.

Declaration

Swift

@objc(PPCShippingMethod)
@objcMembers
final class ShippingMethod

extension ShippingMethod : CVarArg, CustomDebugStringConvertible, CustomStringConvertible, Decodable, Encodable, Equatable, Hashable, NSObjectProtocol


                    
                    
                    ShippingView

Undocumented

Declaration

Swift

class ShippingView

extension ShippingView : ActionableRow, CALayerDelegate, CVarArg, ContentView, CustomDebugStringConvertible, CustomStringConvertible, Equatable, Hashable, NSCoding, NSObjectProtocol, Sendable, StaticIdentifiable, UIAccessibilityIdentification, UIActivityItemsConfigurationProviding, UIAppearance, UIAppearanceContainer, UICoordinateSpace, UIDynamicItem, UIFocusEnvironment, UIFocusItem, UIFocusItemContainer, UILargeContentViewerItem, UIPasteConfigurationSupporting, UIPopoverPresentationControllerSourceItem, UIResponderStandardEditActions, UITraitEnvironment, UIUserActivityRestoring, ViewModelView


                    
                    
                    ShutdownFirebaseStep

Undocumented

Declaration

Swift

class ShutdownFirebaseStep : Step

extension ShutdownFirebaseStep : CustomStringConvertible, Identifiable


                    
                    
                    State

State container for the Checkout SDK. Is evaluated for tokens, merchant values and other transient session data.

Declaration

Swift

class State


                    
                    
                    Step

The type defining the callback that each closure should conform to

Declaration

Swift

class Step<Context>

extension Step : CustomStringConvertible, Identifiable


                    
                    
                    SuggestionsView

Undocumented

Declaration

Swift

final class SuggestionsView

extension SuggestionsView : CALayerDelegate, CVarArg, ContentView, CustomDebugStringConvertible, CustomStringConvertible, Equatable, Hashable, NSCoding, NSObjectProtocol, Sendable, StaticIdentifiable, UIAccessibilityIdentification, UIActivityItemsConfigurationProviding, UIAppearance, UIAppearanceContainer, UICollectionViewDelegate, UICollectionViewDelegateFlowLayout, UICoordinateSpace, UIDynamicItem, UIFocusEnvironment, UIFocusItem, UIFocusItemContainer, UILargeContentViewerItem, UIPasteConfigurationSupporting, UIPopoverPresentationControllerSourceItem, UIResponderStandardEditActions, UIScrollViewDelegate, UITraitEnvironment, UIUserActivityRestoring


                    
                    
                    TitledContentPage

A content page that comes with a basic header including a back arrow and a title.

Declaration

Swift

class TitledContentPage : ContentPage

extension TitledContentPage : Equatable, StaticIdentifiable


                    
                    
                    TransitionLabel

Undocumented

Declaration

Swift

class TransitionLabel

extension TransitionLabel : CALayerDelegate, CVarArg, ContentView, CustomDebugStringConvertible, CustomStringConvertible, Equatable, Hashable, NSCoding, NSObjectProtocol, Sendable, StaticIdentifiable, UIAccessibilityIdentification, UIActivityItemsConfigurationProviding, UIAppearance, UIAppearanceContainer, UIContentSizeCategoryAdjusting, UICoordinateSpace, UIDynamicItem, UIFocusEnvironment, UIFocusItem, UIFocusItemContainer, UILargeContentViewerItem, UIPasteConfigurationSupporting, UIPopoverPresentationControllerSourceItem, UIResponderStandardEditActions, UITraitEnvironment, UIUserActivityRestoring


                    
                    
                    UnconstrainedTextLabel

Undocumented

Declaration

Swift

class UnconstrainedTextLabel

extension UnconstrainedTextLabel : CALayerDelegate, CVarArg, ContentView, CustomDebugStringConvertible, CustomStringConvertible, Equatable, Hashable, NSCoding, NSObjectProtocol, StaticIdentifiable, UIAccessibilityIdentification, UIActivityItemsConfigurationProviding, UIAppearance, UIAppearanceContainer, UIContentSizeCategoryAdjusting, UICoordinateSpace, UIDynamicItem, UIFocusEnvironment, UIFocusItem, UIFocusItemContainer, UILargeContentViewerItem, UIPasteConfigurationSupporting, UIPopoverPresentationControllerSourceItem, UIResponderStandardEditActions, UITraitEnvironment, UIUserActivityRestoring


                    
                    
                    UndefinedPage

This is a singleton that represents a page that does not exist. Routing to it should cause an error in all cases.

Declaration

Swift

class UndefinedPage : ContentPage

extension UndefinedPage : Equatable, StaticIdentifiable


                    
                    
                    UnitAmount

UnitAmount should be used for the following objects:

all breakdown.amount objects - https://developer.paypal.com/docs/api/orders/v2#definition-amount_breakdown
item.unitAmount - https://developer.paypal.com/docs/api/orders/v2#definition-item
shipping.options.amount - https://developer.paypal.com/docs/api/orders/v2/#definition-shipping_detail

Declaration

Swift

@objc(PPCUnitAmount)
@objcMembers
class UnitAmount

extension UnitAmount : CVarArg, Comparable, CustomDebugStringConvertible, CustomStringConvertible, Decodable, Encodable, Equatable, Hashable, NSObjectProtocol


                    
                    
                    UpdateClientConfigStep

Undocumented

Declaration

Swift

class UpdateClientConfigStep : Step

extension UpdateClientConfigStep : CustomStringConvertible, Identifiable


                    
                    
                    VaultData

Data describing an approved vault flow

Declaration

Swift

@objc(PPCVaultData)
@objcMembers
class VaultData

extension VaultData : CVarArg, CustomDebugStringConvertible, CustomStringConvertible, Equatable, Hashable, NSObjectProtocol


                    
                    
                    WebViewPage

Undocumented

Declaration

Swift

class WebViewPage : TitledContentPage

extension WebViewPage : Equatable, StaticIdentifiable