STPPaymentContext Class Reference


                    
                    
                    -initWithCustomerContext:

This is a convenience initializer; it is equivalent to calling initWithCustomerContext:customerContext configuration:[STPPaymentConfiguration sharedConfiguration] theme:[STPTheme defaultTheme].

Declaration

Objective-C

- (nonnull instancetype)initWithCustomerContext:
    (nonnull STPCustomerContext *)customerContext;

Swift

init(customerContext: STPCustomerContext)

Parameters


                                customerContext

The customer context the payment context will use to fetch and modify its Stripe customer. - see: STPCustomerContext.h

Return Value

the newly-instantiated payment context

Show on GitHub


                    
                    
                    -initWithCustomerContext:configuration:theme:

Initializes a new Payment Context with the provided customer context, configuration, and theme. After this class is initialized, you should also make sure to set its delegate and hostViewController properties.

See

STPPaymentConfiguration.h

Declaration

Objective-C

- (nonnull instancetype)
initWithCustomerContext:(nonnull STPCustomerContext *)customerContext
          configuration:(nonnull STPPaymentConfiguration *)configuration
                  theme:(nonnull STPTheme *)theme;

Swift

init(customerContext: STPCustomerContext, configuration: STPPaymentConfiguration, theme: STPTheme)

Parameters

`customerContext`	The customer context the payment context will use to fetch and modify its Stripe customer. - see: STPCustomerContext.h
`configuration`	The configuration for the payment context to use. This lets you set your Stripe publishable API key, required billing address fields, etc.
`theme`	The theme describing the visual appearance of all UI that the payment context automatically creates for you. - see: STPTheme.h

Return Value

the newly-instantiated payment context

Show on GitHub


                    
                    
                    -initWithAPIAdapter:

Note: Instead of providing your own backend API adapter, we recommend using STPCustomerContext, which will manage retrieving and updating a Stripe customer for you. - see: STPCustomerContext.h

This is a convenience initializer; it is equivalent to calling initWithAPIAdapter:apiAdapter configuration:[STPPaymentConfiguration sharedConfiguration] theme:[STPTheme defaultTheme].

Declaration

Objective-C

- (nonnull instancetype)initWithAPIAdapter:
    (nonnull id<STPBackendAPIAdapter>)apiAdapter;

Swift

init(apiAdapter: STPBackendAPIAdapter)

Show on GitHub


                    
                    
                    -initWithAPIAdapter:configuration:theme:

Note: Instead of providing your own backend API adapter, we recommend using STPCustomerContext, which will manage retrieving and updating a Stripe customer for you. - see: STPCustomerContext.h

Initializes a new Payment Context with the provided API adapter and configuration. After this class is initialized, you should also make sure to set its delegate and hostViewController properties.

See

STPPaymentConfiguration.h

Declaration

Objective-C

- (nonnull instancetype)
initWithAPIAdapter:(nonnull id<STPBackendAPIAdapter>)apiAdapter
     configuration:(nonnull STPPaymentConfiguration *)configuration
             theme:(nonnull STPTheme *)theme;

Swift

init(apiAdapter: STPBackendAPIAdapter, configuration: STPPaymentConfiguration, theme: STPTheme)

Parameters

`apiAdapter`	The API adapter the payment context will use to fetch and modify its contents. You need to make a class conforming to this protocol that talks to your server. - see: STPBackendAPIAdapter.h
`configuration`	The configuration for the payment context to use. This lets you set your Stripe publishable API key, required billing address fields, etc.
`theme`	The theme describing the visual appearance of all UI that the payment context automatically creates for you. - see: STPTheme.h

Return Value

the newly-instantiated payment context

Show on GitHub


                    
                    
                    apiAdapter

Note: Instead of providing your own backend API adapter, we recommend using STPCustomerContext, which will manage retrieving and updating a Stripe customer for you. - see: STPCustomerContext.h

The API adapter the payment context will use to fetch and modify its contents. You need to make a class conforming to this protocol that talks to your server.

See

STPBackendAPIAdapter.h

Declaration

Objective-C

@property (readonly, nonatomic) id<STPBackendAPIAdapter> _Nonnull apiAdapter;

Swift

var apiAdapter: STPBackendAPIAdapter { get }

Show on GitHub


                    
                    
                    configuration

The configuration for the payment context to use internally. - see: STPPaymentConfiguration.h

Declaration

Objective-C

@property (readonly, nonatomic) STPPaymentConfiguration *_Nonnull configuration;

Swift

var configuration: STPPaymentConfiguration { get }

Show on GitHub


                    
                    
                    theme

The visual appearance that will be used by any views that the context generates. - see: STPTheme.h

Declaration

Objective-C

@property (readonly, nonatomic) STPTheme *_Nonnull theme;

Swift

var theme: STPTheme { get }

Show on GitHub


                    
                    
                    prefilledInformation

If you’ve already collected some information from your user, you can set it here and it’ll be automatically filled out when possible/appropriate in any UI that the payment context creates.

Declaration

Objective-C

@property (readwrite, strong, nonatomic, nullable)
    STPUserInformation *prefilledInformation;

Swift

var prefilledInformation: STPUserInformation? { get set }

Show on GitHub


                    
                    
                    hostViewController

The view controller that any additional UI will be presented on. If you have a “checkout view controller” in your app, that should be used as the host view controller.

Declaration

Objective-C

@property (readwrite, nonatomic, nullable) UIViewController *hostViewController;

Swift

weak var hostViewController: UIViewController? { get set }

Show on GitHub


                    
                    
                    delegate

This delegate will be notified when the payment context’s contents change. - see: STPPaymentContextDelegate

Declaration

Objective-C

@property (readwrite, nonatomic, nullable) id<STPPaymentContextDelegate>
    delegate;

Swift

weak var delegate: STPPaymentContextDelegate? { get set }

Show on GitHub


                    
                    
                    loading

Whether or not the payment context is currently loading information from the network.

Declaration

Objective-C

@property (readonly, nonatomic) BOOL loading;

Swift

var loading: Bool { get }

Show on GitHub


                    
                    
                    defaultPaymentMethod

Note

This is no longer recommended as of v18.3.0 - the SDK automatically saves the Stripe ID of the last selected payment method using NSUserDefaults and displays it as the default pre-selected option. You can override this behavior by setting this property.

The Stripe ID of a payment method to display as the default pre-selected option.

Note

Set this property immediately after initializing STPPaymentContext, or call retryLoading afterwards.

Declaration

Objective-C

@property (readwrite, copy, nonatomic, nullable) NSString *defaultPaymentMethod;

Swift

var defaultPaymentMethod: String? { get set }

Show on GitHub


                    
                    
                    selectedPaymentOption

The user’s currently selected payment option. May be nil.

Declaration

Objective-C

@property (readonly, nonatomic, nullable) id<STPPaymentOption>
    selectedPaymentOption;

Swift

var selectedPaymentOption: STPPaymentOption? { get }

Show on GitHub


                    
                    
                    paymentOptions

The available payment options the user can choose between. May be nil.

Declaration

Objective-C

@property (readonly, nonatomic, nullable)
    NSArray<id<STPPaymentOption>> *paymentOptions;

Swift

var paymentOptions: [STPPaymentOption]? { get }

Show on GitHub


                    
                    
                    selectedShippingMethod

The user’s currently selected shipping method. May be nil.

Declaration

Objective-C

@property (readonly, nonatomic, nullable)
    PKShippingMethod *selectedShippingMethod;

Swift

var selectedShippingMethod: PKShippingMethod? { get }

Show on GitHub


                    
                    
                    shippingMethods

An array of STPShippingMethod objects that describe the supported shipping methods. May be nil.

Declaration

Objective-C

@property (readonly, nonatomic, nullable)
    NSArray<PKShippingMethod *> *shippingMethods;

Swift

var shippingMethods: [PKShippingMethod]? { get }

Show on GitHub


                    
                    
                    shippingAddress

The user’s shipping address. May be nil. If you’ve already collected a shipping address from your user, you may prefill it by setting a shippingAddress in PaymentContext’s prefilledInformation. When your user enters a new shipping address, PaymentContext will save it to the current customer object. When PaymentContext loads, if you haven’t manually set a prefilled value, any shipping information saved on the customer will be used to prefill the shipping address form. Note that because your customer’s email may not be the same as the email provided with their shipping info, PaymentContext will not prefill the shipping form’s email using your customer’s email.

You should not rely on the shipping information stored on the Stripe customer for order fulfillment, as your user may change this information if they make multiple purchases. We recommend adding shipping information when you create a charge (which can also help prevent fraud), or saving it to your own database. https://stripe.com/docs/api/payment_intents/create#create_payment_intent-shipping

Note: by default, your user will still be prompted to verify a prefilled shipping address. To change this behavior, you can set verifyPrefilledShippingAddress to NO in your STPPaymentConfiguration.

Declaration

Objective-C

@property (readonly, nonatomic, nullable) STPAddress *shippingAddress;

Swift

var shippingAddress: STPAddress? { get }

Show on GitHub


                    
                    
                    paymentAmount

The amount of money you’re requesting from the user, in the smallest currency unit for the selected currency. For example, to indicate $10 USD, use 1000 (i.e. 1000 cents). For more information, see https://stripe.com/docs/api/payment_intents/create#create_payment_intent-amount

Note

This value must be present and greater than zero in order for Apple Pay to be automatically enabled.

Note

You should only set either this or paymentSummaryItems, not both. The other will be automatically calculated on demand using your paymentCurrency.

Declaration

Objective-C

@property (assign, readwrite, nonatomic) NSInteger paymentAmount;

Swift

var paymentAmount: Int { get set }

Show on GitHub


                    
                    
                    paymentCurrency

The three-letter currency code for the currency of the payment (i.e. USD, GBP, JPY, etc). Defaults to “USD”.

Note

Changing this property may change the return value of paymentAmount or paymentSummaryItems (whichever one you didn’t directly set yourself).

Declaration

Objective-C

@property (readwrite, copy, nonatomic) NSString *_Nonnull paymentCurrency;

Swift

var paymentCurrency: String { get set }

Show on GitHub


                    
                    
                    paymentCountry

The two-letter country code for the country where the payment will be processed. You should set this to the country your Stripe account is in. Defaults to “US”.

Note

Changing this property will change the countryCode of your Apple Pay payment requests.

See

PKPaymentRequest for more information.

Declaration

Objective-C

@property (readwrite, copy, nonatomic) NSString *_Nonnull paymentCountry;

Swift

var paymentCountry: String { get set }

Show on GitHub


                    
                    
                    paymentSummaryItems

If you support Apple Pay, you can optionally set the PKPaymentSummaryItems you want to display here instead of using paymentAmount. Note that the grand total (the amount of the last summary item) must be greater than zero. If not set, a single summary item will be automatically generated using paymentAmount and your configuration’s companyName.

See

PKPaymentRequest for more information

Note

You should only set either this or paymentAmount, not both. The other will be automatically calculated on demand using your paymentCurrency.

Declaration

Objective-C

@property (readwrite, copy, nonatomic)
    NSArray<PKPaymentSummaryItem *> *_Nonnull paymentSummaryItems;

Swift

var paymentSummaryItems: [PKPaymentSummaryItem] { get set }

Show on GitHub


                    
                    
                    modalPresentationStyle

The presentation style used for all view controllers presented modally by the context. Since custom transition styles are not supported, you should set this to either UIModalPresentationFullScreen, UIModalPresentationPageSheet, or UIModalPresentationFormSheet. The default value is UIModalPresentationFullScreen.

Declaration

Objective-C

@property (assign, readwrite, nonatomic)
    UIModalPresentationStyle modalPresentationStyle;

Swift

var modalPresentationStyle: UIModalPresentationStyle { get set }

Show on GitHub


                    
                    
                    largeTitleDisplayMode

The mode to use when displaying the title of the navigation bar in all view controllers presented by the context. The default value is automatic, which causes the title to use the same styling as the previously displayed navigation item (if the view controller is pushed onto the hostViewController).

If the prefersLargeTitles property of the hostViewController‘s navigation bar is false, this property has no effect and the navigation item’s title is always displayed as a small title.

If the view controller is presented modally, automatic and never always result in a navigation bar with a small title.

Declaration

Objective-C

@property (assign, readwrite, nonatomic)
    UINavigationItemLargeTitleDisplayMode largeTitleDisplayMode;

Swift

var largeTitleDisplayMode: UINavigationItem.LargeTitleDisplayMode { get set }

Show on GitHub


                    
                    
                    paymentOptionsViewControllerFooterView

A view that will be placed as the footer of the payment options selection view controller.

When the footer view needs to be resized, it will be sent a sizeThatFits: call. The view should respond correctly to this method in order to be sized and positioned properly.

Declaration

Objective-C

@property (readwrite, strong, nonatomic)
    UIView *_Nonnull paymentOptionsViewControllerFooterView;

Swift

var paymentOptionsViewControllerFooterView: UIView { get set }

Show on GitHub


                    
                    
                    addCardViewControllerFooterView

A view that will be placed as the footer of the add card view controller.

When the footer view needs to be resized, it will be sent a sizeThatFits: call. The view should respond correctly to this method in order to be sized and positioned properly.

Declaration

Objective-C

@property (readwrite, strong, nonatomic)
    UIView *_Nonnull addCardViewControllerFooterView;

Swift

var addCardViewControllerFooterView: UIView { get set }

Show on GitHub


                    
                    
                    -retryLoading

If paymentContext:didFailToLoadWithError: is called on your delegate, you can in turn call this method to try loading again (if that hasn’t been called, calling this will do nothing). If retrying in turn fails, paymentContext:didFailToLoadWithError: will be called again (and you can again call this to keep retrying, etc).

Declaration

Objective-C

- (void)retryLoading;

Swift

func retryLoading()

Show on GitHub


                    
                    
                    -presentPaymentOptionsViewController

This creates, configures, and appropriately presents an STPPaymentOptionsViewController on top of the payment context’s hostViewController. It’ll be dismissed automatically when the user is done selecting their payment method.

Note

This method will do nothing if it is called while STPPaymentContext is already showing a view controller or in the middle of requesting a payment.

Declaration

Objective-C

- (void)presentPaymentOptionsViewController;

Swift

func presentPaymentOptionsViewController()

Show on GitHub


                    
                    
                    -pushPaymentOptionsViewController

This creates, configures, and appropriately pushes an STPPaymentOptionsViewController onto the navigation stack of the context’s hostViewController. It’ll be popped automatically when the user is done selecting their payment method.

Note

This method will do nothing if it is called while STPPaymentContext is already showing a view controller or in the middle of requesting a payment.

Declaration

Objective-C

- (void)pushPaymentOptionsViewController;

Swift

func pushPaymentOptionsViewController()

Show on GitHub


                    
                    
                    -presentShippingViewController

This creates, configures, and appropriately presents a view controller for collecting shipping address and shipping method on top of the payment context’s hostViewController. It’ll be dismissed automatically when the user is done entering their shipping info.

Note

This method will do nothing if it is called while STPPaymentContext is already showing a view controller or in the middle of requesting a payment.

Declaration

Objective-C

- (void)presentShippingViewController;

Swift

func presentShippingViewController()

Show on GitHub


                    
                    
                    -pushShippingViewController

This creates, configures, and appropriately pushes a view controller for collecting shipping address and shipping method onto the navigation stack of the context’s hostViewController. It’ll be popped automatically when the user is done entering their shipping info.

Note

This method will do nothing if it is called while STPPaymentContext is already showing a view controller, or in the middle of requesting a payment.

Declaration

Objective-C

- (void)pushShippingViewController;

Swift

func pushShippingViewController()

Show on GitHub


                    
                    
                    -requestPayment

Requests payment from the user. This may need to present some supplemental UI to the user, in which case it will be presented on the payment context’s hostViewController. For instance, if they’ve selected Apple Pay as their payment method, calling this method will show the payment sheet. If the user has a card on file, this will use that without presenting any additional UI. After this is called, the paymentContext:didCreatePaymentResult:completion: and paymentContext:didFinishWithStatus:error: methods will be called on the context’s delegate.

Note

This method will do nothing if it is called while STPPaymentContext is already showing a view controller, or in the middle of requesting a payment.

Declaration

Objective-C

- (void)requestPayment;

Swift

func requestPayment()

Show on GitHub