View on GitHub
Classes Reference
Classes
The following classes are available globally.
-
A drop-in class that presents a sheet for a customer to complete their payment
See moreDeclaration
Swift
public class PaymentSheet -
A client for making connections to the Stripe API.
See moreDeclaration
Swift
public class STPAPIClient : NSObject -
STPAUBECSDebitFormView is a subclass of UIControl that contains all of the necessary fields and legal text for collecting AU BECS Debit payments. For additional customization options - seealso: STPFormTextFieldContainer
See moreDeclaration
Swift
public class STPAUBECSDebitFormView: STPMultiFormTextField, STPMultiFormFieldDelegate, UITextViewDelegate -
This view controller contains a credit card entry form that the user can fill out. On submission, it will use the Stripe API to convert the user’s card details to a Stripe token. It renders a right bar button item that submits the form, so it must be shown inside a
See moreUINavigationController.Declaration
Swift
public class STPAddCardViewController: STPCoreTableViewController, STPAddressViewModelDelegate, STPCardScannerDelegate, STPPaymentCardTextFieldDelegate, UITableViewDelegate, UITableViewDataSource -
STPAddress Contains an address as represented by the Stripe API.
See moreDeclaration
Swift
public class STPAddress : NSObjectextension STPAddress: STPAPIResponseDecodableextension STPAddress: STPFormEncodableextension STPAddress: NSCopying -
Libraries wrapping the Stripe SDK should use this object to provide information about the library, and set it in on
See moreSTPAPIClient. This information is passed to Stripe so that we can contact you about future issues or critical updates.Declaration
Swift
public class STPAppInfo : NSObject -
A helper class that implements Apple Pay. Usage looks like this:
- Initialize this class with a PKPaymentRequest describing the payment request (amount, line items, required shipping info, etc)
- Call presentApplePayOnViewController:completion: to present the Apple Pay sheet and begin the payment process 3 (optional): If you need to respond to the user changing their shipping information/shipping method, implement the optional delegate methods
- When the user taps ‘Buy’, this class uses the PaymentIntent that you supply in the applePayContext:didCreatePaymentMethod:completion: delegate method to complete the payment
- After payment completes/errors and the sheet is dismissed, this class informs you in the applePayContext:didCompleteWithStatus: delegate method
Seealso
https://stripe.com/docs/apple-pay#native for a full guideSeealso
ApplePayExampleViewController for an exampleDeclaration
Swift
@available(iOSApplicationExtension, unavailable) @available(macCatalystApplicationExtension, unavailable) @objc public class STPApplePayContext : NSObject, PKPaymentAuthorizationControllerDelegate -
An empty class representing that the user wishes to pay via Apple Pay. This can be checked on an
STPPaymentContext, e.g:
See moreif paymentContext.selectedPaymentOption is STPApplePayPaymentOption { // Don't ask the user for their card number; they want to pay with apple pay. }Declaration
Swift
@objc public class STPApplePayPaymentOption : NSObject, STPPaymentOption -
Representation of a user’s bank account details that have been tokenized with the Stripe API.
See moreDeclaration
Swift
public class STPBankAccount : NSObject, STPAPIResponseDecodable, STPSourceProtocol -
Representation of a user’s bank account details. You can assemble these with information that your user enters and then create Stripe tokens with them using an STPAPIClient.
See moreDeclaration
Swift
public class STPBankAccountParams : NSObject, STPFormEncodable -
This view controller displays a list of banks of the specified type, allowing the user to select one to pay from. Once a bank is selected, it will return a PaymentMethodParams object, which you can use to confirm a PaymentIntent or inspect to obtain details about the selected bank.
See moreDeclaration
Swift
public class STPBankSelectionViewController: STPCoreTableViewController, UITableViewDataSource, UITableViewDelegate -
Representation of a user’s credit card details that have been tokenized with the Stripe API
See moreDeclaration
Swift
public class STPCard : NSObject, STPAPIResponseDecodable, STPPaymentOption, STPSourceProtocol -
Contains
See moreSTPStringFromCardBrandDeclaration
Swift
public class STPCardBrandUtilities : NSObject -
See moreSTPCardFormViewprovides a multiline interface for users to input their credit card details as well as billing postal code and provides an interface to access the createdSTPPaymentMethodParams.STPCardFormViewincludes both the input fields as well as an error label that is displayed when invalid input is detected.Declaration
Swift
public class STPCardFormView : STPFormView -
Representation of a user’s credit card details. You can assemble these with information that your user enters and then create Stripe tokens with them using an STPAPIClient.
See moreDeclaration
Swift
public class STPCardParams : NSObject, STPFormEncodable, NSCopying -
This class contains static methods to validate card numbers, expiration dates, and CVCs. For a list of test card numbers to use with this code, see https://stripe.com/docs/testing
See moreDeclaration
Swift
public class STPCardValidator : NSObject -
Alipay options to pass to
See moreSTPConfirmPaymentMethodOptions`Declaration
Swift
public class STPConfirmAlipayOptions : NSObjectextension STPConfirmAlipayOptions: STPFormEncodable -
BLIK options to pass to
See moreSTPConfirmPaymentMethodOptions`Declaration
Swift
public class STPConfirmBLIKOptions : NSObjectextension STPConfirmBLIKOptions: STPFormEncodable -
Options to update a Card PaymentMethod during PaymentIntent confirmation.
See moreDeclaration
Swift
public class STPConfirmCardOptions : NSObjectextension STPConfirmCardOptions: STPFormEncodable -
Options to update the associated PaymentMethod during PaymentIntent confirmation.
See moreSeealso
https://stripe.com/docs/api/payment_intents/confirm#confirm_payment_intent-payment_method_optionsDeclaration
Swift
public class STPConfirmPaymentMethodOptions : NSObjectextension STPConfirmPaymentMethodOptions: STPFormEncodable -
An address to use with
See moreSTPConnectAccountParams.Declaration
Swift
public class STPConnectAccountAddress : NSObjectextension STPConnectAccountAddress: STPFormEncodable -
Information about the company or business to use with
See moreSTPConnectAccountParams.Declaration
Swift
public class STPConnectAccountCompanyParams : NSObjectextension STPConnectAccountCompanyParams: STPFormEncodable -
Information about the person represented by the account for use with
See moreSTPConnectAccountParams.Declaration
Swift
public class STPConnectAccountIndividualParams : NSObjectextension STPConnectAccountIndividualParams: STPFormEncodable -
The individual’s verification document information for use with
See moreSTPConnectAccountIndividualParams.Declaration
Swift
public class STPConnectAccountIndividualVerification : NSObjectextension STPConnectAccountIndividualVerification: STPFormEncodable -
An identifying document, either a passport or local ID card for use with
See moreSTPConnectAccountIndividualVerification.Declaration
Swift
public class STPConnectAccountVerificationDocument : NSObjectextension STPConnectAccountVerificationDocument: STPFormEncodable
-
An individual’s date of birth. See https://stripe.com/docs/api/tokens/create_account#create_account_token-account-individual-dob
See moreDeclaration
-
Parameters for creating a Connect Account token.
See moreDeclaration
Swift
public class STPConnectAccountParams : NSObjectextension STPConnectAccountParams: STPFormEncodable -
Contains constants that represent different parts of a users contact/address information.
See moreDeclaration
Swift
@objc public class STPContactField : NSObject, RawRepresentable -
This is the base class for all Stripe scroll view controllers. It is intended for use only by Stripe classes, you should not subclass it yourself in your app.
See moreDeclaration
Swift
public class STPCoreScrollViewController : STPCoreViewController -
This is the base class for all Stripe scroll view controllers. It is intended for use only by Stripe classes, you should not subclass it yourself in your app. It inherits from STPCoreScrollViewController and changes the type of the created scroll view to UITableView, as well as other shared table view logic.
See moreDeclaration
Swift
public class STPCoreTableViewController : STPCoreScrollViewController -
This is the base class for all Stripe view controllers. It is intended for use only by Stripe classes, you should not subclass it yourself in your app. It theming, back/cancel button management, and other shared logic for Stripe view controllers.
See moreDeclaration
Swift
public class STPCoreViewController : UIViewController -
An
See moreSTPCustomerrepresents a deserialized Customer object from the Stripe API. You shouldn’t need to instantiate anSTPCustomer– you should instead useSTPCustomerContextto manage retrieving and updating a customer.Declaration
-
Use
See moreSTPCustomerDeserializerto convert a response from the Stripe API into anSTPCustomerobject.STPCustomerDeserializerexpects the JSON response to be in the exact same format as the Stripe API.Declaration
Swift
public class STPCustomerDeserializer : NSObject -
An
See moreSTPCustomerContextretrieves and updates a Stripe customer and their attached payment methods using an ephemeral key, a short-lived API key scoped to a specific customer object. If your current user logs out of your app and a new user logs in, be sure to either create a new instance ofSTPCustomerContextor clear the current instance’s cache. On your backend, be sure to create and return a new ephemeral key for the Customer object associated with the new user.Declaration
Swift
open class STPCustomerContext : NSObject, STPBackendAPIAdapter
-
Top-level class for Stripe error constants.
See moreDeclaration
Swift
public class STPError : NSObject -
Convenience methods for using FPX bank brands.
See moreDeclaration
Swift
public class STPFPXBank : NSObject -
This class is a piece of fake UI that is intended to mimic
See morePKAddPaymentPassViewController. That class is restricted to apps with a special entitlement from Apple, and as such can be difficult to build and test against. This class implements the same public API asPKAddPaymentPassViewController, and can be used to develop against the Stripe API in testmode only. (Obviously it will not actually place cards into the user’s Apple Pay wallet either.) When it’s time to go to production, you may simply replace all references toSTPFakeAddPaymentPassViewControllerin your app withPKAddPaymentPassViewControllerand it will continue to function. For more information on developing against this API, please see https://stripe.com/docs/issuing/cards/digital-wallets .Declaration
Swift
public class STPFakeAddPaymentPassViewController : UIViewController -
Representation of a file upload object in the Stripe API.
See moreDeclaration
Swift
public class STPFile : NSObject, STPAPIResponseDecodable -
STPFormViewis a base class for the Stripe SDK’s form input UI. You should use one of the available subclasses (STPCardFormView) rather than instantiating anSTPFormViewinstance directly.Declaration
Swift
public class STPFormView : UIView, STPFormInputValidationObserver -
This class lets you access card icons used by the Stripe SDK. All icons are 32 x 20 points.
See moreDeclaration
Swift
public class STPImageLibrary : NSObject -
Next action details for
See moreSTPPaymentIntentandSTPSetupIntent. This is a container for the various types that are available. Check thetypeto see which one it is, and then use the related property for the details necessary to handle it. You cannot directly instantiate anSTPIntentAction.Declaration
-
Contains instructions for authenticating a payment by redirecting your customer to Alipay App or website. You cannot directly instantiate an
See moreSTPPaymentIntentActionAlipayHandleRedirect.Declaration
Swift
public class STPIntentActionAlipayHandleRedirect : NSObjectextension STPIntentActionAlipayHandleRedirect: STPAPIResponseDecodable -
Contains OXXO details necessary for the customer to complete the payment.
See moreDeclaration
Swift
public class STPIntentActionOXXODisplayDetails : NSObject, STPAPIResponseDecodable -
Contains instructions for authenticating a payment by redirecting your customer to another page or application. You cannot directly instantiate an
See moreSTPIntentActionRedirectToURL.Declaration
Swift
public class STPIntentActionRedirectToURL : NSObjectextension STPIntentActionRedirectToURL: STPAPIResponseDecodable -
Information related to a Stripe Issuing card, including the PIN
See moreDeclaration
Swift
public class STPIssuingCardPin : NSObjectextension STPIssuingCardPin: STPAPIResponseDecodable -
An object representing a line item in a Klarna source.
See moreDeclaration
Swift
public class STPKlarnaLineItem : NSObject -
An object that contains details about the customer acceptance of the Mandate. - seealso: https://stripe.com/docs/api/payment_intents/confirm#confirm_payment_intent-mandate_data-customer_acceptance
See moreDeclaration
Swift
public class STPMandateCustomerAcceptanceParams : NSObject, STPFormEncodable -
This object contains details about the Mandate to create. - seealso: https://stripe.com/docs/api/payment_intents/confirm#confirm_payment_intent-mandate_data
See moreDeclaration
-
Contains details about a Mandate accepted online. - seealso: https://stripe.com/docs/api/payment_intents/confirm#confirm_payment_intent-mandate_data-customer_acceptance-online
See moreDeclaration
Swift
public class STPMandateOnlineParams : NSObjectextension STPMandateOnlineParams: STPFormEncodable -
STPMultiFormTextField is a lightweight UIView that wraps a collection of STPFormTextFields and can automatically move to the next form field when one is completed.
See moreDeclaration
Swift
public class STPMultiFormTextField: UIView, STPFormTextFieldContainer, UITextFieldDelegate, STPFormTextFieldDelegate -
This class can be used wherever you’d use a
See moreUIActivityIndicatorViewand is intended to have a similar API. It renders as a spinning circle with a gap in it, similar to what you see in the App Store app or in the Apple Pay dialog when making a purchase. To change its color, set thetintColorproperty.Declaration
Swift
public class STPPaymentActivityIndicatorView : UIView -
STPPaymentCardTextField is a text field with similar properties to UITextField, but specialized for credit/debit card information. It manages multiple UITextFields under the hood to collect this information. It’s designed to fit on a single line, and from a design perspective can be used anywhere a UITextField would be appropriate.
See moreDeclaration
Swift
@IBDesignable open class STPPaymentCardTextField : UIControl, UIKeyInput, STPFormTextFieldDelegate -
An
See moreSTPPaymentConfigurationrepresents all the options you can set or change around a payment. You provide anSTPPaymentConfigurationobject to yourSTPPaymentContextwhen making a charge. The configuration generally has settings that will not change from payment to payment and thus is reusable, while the context is specific to a single particular payment instance.Declaration
Swift
public class STPPaymentConfiguration : NSObject, NSCopying -
An
See moreSTPPaymentContextkeeps track of all of the state around a payment. It will manage fetching a user’s saved payment methods, tracking any information they select, and prompting them for required additional information before completing their purchase. It can be used to power your application’s “payment confirmation” page with just a few lines of code.STPPaymentContextalso provides a unified interface to multiple payment methods - for example, you can write a single integration to accept both credit card payments and Apple Pay.STPPaymentContextsaves information about a user’s payment methods to a Stripe customer object, and requires anSTPCustomerContextto manage retrieving and modifying the customer.Declaration
Swift
public class STPPaymentContext: NSObject, STPAuthenticationContext, STPPaymentOptionsViewControllerDelegate, STPShippingAddressViewControllerDelegate -
See moreSTPPaymentHandleris a utility class that confirms PaymentIntents/SetupIntents and handles any authentication required, such as 3DS1/3DS2 for Strong Customer Authentication. It can present authentication UI on top of your app or redirect users out of your app (to e.g. their banking app).Declaration
Swift
@available(iOSApplicationExtension, unavailable) @available(macCatalystApplicationExtension, unavailable) public class STPPaymentHandler : NSObject, SFSafariViewControllerDelegate, STPURLCallbackListener -
A PaymentIntent tracks the process of collecting a payment from your customer.
See moreDeclaration
-
Action details for an STPPaymentIntent. This is a container for the various types that are available. Check the
typeto see which one it is, and then use the related property for the details necessary to handle it. @deprecated UseSTPIntentActioninstead.Declaration
Swift
@available(*, deprecated, renamed: "STPIntentAction", message: "Use `STPIntentAction` instead.") @objc public final class STPPaymentIntentAction : STPIntentAction -
A value for
See morecodeindicating the provided payment method failed authentication./// The payment error encountered in the previous PaymentIntent confirmation.Declaration
Swift
public class STPPaymentIntentLastPaymentError : NSObjectextension STPPaymentIntentLastPaymentError: STPAPIResponseDecodable -
An object representing parameters used to confirm a PaymentIntent object. A PaymentIntent must have a PaymentMethod or Source associated in order to successfully confirm it. That PaymentMethod or Source can either be:
- created during confirmation, by passing in a
STPPaymentMethodParamsorSTPSourceParamsobject in thepaymentMethodParamsorsourceParamsfield - a pre-existing PaymentMethod or Source can be associated by passing its id in the
paymentMethodIdorsourceIdfield - or already set via your backend, either when creating or updating the PaymentIntent
Declaration
Swift
public class STPPaymentIntentParams : NSObjectextension STPPaymentIntentParams: STPFormEncodableextension STPPaymentIntentParams: NSCopying - created during confirmation, by passing in a
-
Shipping information for a PaymentIntent You cannot directly instantiate an
See moreSTPPaymentIntentShippingDetails. You should only use one that is part of an existingSTPPaymentMethodobject.Declaration
Swift
public class STPPaymentIntentShippingDetails : NSObjectextension STPPaymentIntentShippingDetails: STPAPIResponseDecodable -
Shipping address for a PaymentIntent’s shipping details. You cannot directly instantiate an
See moreSTPPaymentIntentShippingDetailsAddress. You should only use one that is part of an existingSTPPaymentMethodobject.Declaration
Swift
public class STPPaymentIntentShippingDetailsAddress : NSObjectextension STPPaymentIntentShippingDetailsAddress: STPAPIResponseDecodable -
Shipping address for a PaymentIntent’s shipping details.
See moreDeclaration
Swift
public class STPPaymentIntentShippingDetailsAddressParams : NSObjectextension STPPaymentIntentShippingDetailsAddressParams: STPFormEncodableextension STPPaymentIntentShippingDetailsAddressParams: NSCopying -
Shipping information for a PaymentIntent
See moreDeclaration
Swift
public class STPPaymentIntentShippingDetailsParams : NSObjectextension STPPaymentIntentShippingDetailsParams: STPFormEncodableextension STPPaymentIntentShippingDetailsParams: NSCopying -
PaymentMethod objects represent your customer’s payment instruments. They can be used with PaymentIntents to collect payments.
See moreDeclaration
Swift
public class STPPaymentMethod : NSObject, STPAPIResponseDecodable, STPPaymentOption -
An AU BECS Debit Payment Method.
See moreDeclaration
Swift
public class STPPaymentMethodAUBECSDebit : NSObject, STPAPIResponseDecodable -
An object representing parameters used to create an AU BECS Debit Payment Method
See moreDeclaration
Swift
public class STPPaymentMethodAUBECSDebitParams : NSObject, STPFormEncodable -
The billing address, a property on
See moreSTPPaymentMethodBillingDetailsDeclaration
Swift
public class STPPaymentMethodAddress : NSObject, STPAPIResponseDecodable, STPFormEncodable -
An AfterpayClearpay Payment Method.
See moreDeclaration
Swift
public class STPPaymentMethodAfterpayClearpay : NSObject, STPAPIResponseDecodable -
An object representing parameters used to create an AfterpayClearpay Payment Method
See moreDeclaration
Swift
public class STPPaymentMethodAfterpayClearpayParams : NSObject, STPFormEncodable -
Contains details for an Alipay Payment Method.
Declaration
Swift
public class STPPaymentMethodAlipay : NSObject, STPAPIResponseDecodable -
An object representing parameters used to create an Alipay Payment Method. There are currently no parameters to pass.
See moreDeclaration
Swift
public class STPPaymentMethodAlipayParams : NSObject, STPFormEncodable -
Contains details for a BLIK Payment Method.
Declaration
Swift
public class STPPaymentMethodBLIK : NSObject, STPAPIResponseDecodable -
An object representing parameters used to create a BLIK Payment Method There are currently no parameters to pass.
See moreDeclaration
Swift
@objc public class STPPaymentMethodBLIKParams : NSObject, STPFormEncodable -
A Bacs Debit Payment Method.
See moreDeclaration
Swift
public class STPPaymentMethodBacsDebit : NSObject, STPAPIResponseDecodable -
The user’s bank account details.
See moreDeclaration
Swift
public class STPPaymentMethodBacsDebitParams : NSObject, STPFormEncodable -
Declaration
Swift
public class STPPaymentMethodBancontact : NSObject, STPAPIResponseDecodable -
An object representing parameters used to create a Bancontact Payment Method
See moreDeclaration
Swift
public class STPPaymentMethodBancontactParams : NSObject, STPFormEncodable -
Billing information associated with a
See moreSTPPaymentMethodthat may be used or required by particular types of payment methods.Declaration
Swift
public class STPPaymentMethodBillingDetails : NSObject, STPAPIResponseDecodable, STPFormEncodable -
Contains details about a user’s credit card.
See moreDeclaration
Swift
public class STPPaymentMethodCard : NSObject, STPAPIResponseDecodable -
Checks on Card address and CVC.
See moreDeclaration
Swift
public class STPPaymentMethodCardChecks : NSObject, STPAPIResponseDecodable -
See moreSTPPaymentMethodCardNetworkscontains information about card networks that can be used to process a payment.Declaration
Swift
public class STPPaymentMethodCardNetworks : NSObject, STPAPIResponseDecodable -
The user’s card details.
See moreDeclaration
Swift
public class STPPaymentMethodCardParams : NSObject, STPFormEncodable -
Details about the Card Present payment method
See moreDeclaration
Swift
public class STPPaymentMethodCardPresent : NSObject, STPAPIResponseDecodable -
A Card Wallet.
See moreDeclaration
Swift
public class STPPaymentMethodCardWallet : NSObject, STPAPIResponseDecodable -
Declaration
Swift
public class STPPaymentMethodCardWalletMasterpass : NSObject, STPAPIResponseDecodable -
Declaration
Swift
public class STPPaymentMethodCardWalletVisaCheckout : NSObject, STPAPIResponseDecodable -
An EPS Payment Method.
See moreDeclaration
Swift
public class STPPaymentMethodEPS : NSObject, STPAPIResponseDecodable -
An object representing parameters used to create a EPS Payment Method
See moreDeclaration
Swift
public class STPPaymentMethodEPSParams : NSObject, STPFormEncodable -
An FPX Payment Method.
See moreDeclaration
Swift
public class STPPaymentMethodFPX : NSObject, STPAPIResponseDecodable -
An object representing parameters used to create an FPX Payment Method
See moreDeclaration
Swift
public class STPPaymentMethodFPXParams : NSObject, STPFormEncodable -
A giropay Payment Method.
See moreDeclaration
Swift
public class STPPaymentMethodGiropay : NSObject, STPAPIResponseDecodable -
An object representing parameters used to create a giropay Payment Method
See moreDeclaration
Swift
public class STPPaymentMethodGiropayParams : NSObject, STPFormEncodable -
A GrabPay PaymentMethod
See moreDeclaration
Swift
public class STPPaymentMethodGrabPay : NSObject, STPAPIResponseDecodable -
An object representing parameters used to create a GrabPay Payment Method
See moreDeclaration
Swift
public class STPPaymentMethodGrabPayParams : NSObject, STPFormEncodable -
A NetBanking Payment Method.
See moreDeclaration
Swift
public class STPPaymentMethodNetBanking : NSObject, STPAPIResponseDecodable -
An object representing parameters used to create a NetBanking Payment Method
See moreDeclaration
Swift
public class STPPaymentMethodNetBankingParams : NSObject, STPFormEncodable -
Declaration
Swift
public class STPPaymentMethodOXXO : NSObject, STPAPIResponseDecodable -
An object representing parameters used to create an OXXO Payment Method
See moreDeclaration
Swift
public class STPPaymentMethodOXXOParams : NSObject, STPFormEncodable -
An object representing parameters used to create a PaymentMethod object. @note To create a PaymentMethod from an Apple Pay PKPaymentToken, see
See moreSTPAPIClient createPaymentMethodWithPayment:completion:Declaration
Swift
public class STPPaymentMethodParams : NSObject, STPFormEncodable, STPPaymentOption -
Declaration
Swift
public class STPPaymentMethodPrzelewy24 : NSObject, STPAPIResponseDecodable -
An object representing parameters used to create a Przelewy24 Payment Method
See moreDeclaration
Swift
public class STPPaymentMethodPrzelewy24Params : NSObject, STPFormEncodable -
A SEPA Debit Payment Method.
See moreDeclaration
Swift
public class STPPaymentMethodSEPADebit : NSObject, STPAPIResponseDecodable -
An object representing parameters used to create a SEPA Debit Payment Method
See moreDeclaration
Swift
public class STPPaymentMethodSEPADebitParams : NSObject, STPFormEncodable -
A Sofort Payment Method.
See moreDeclaration
Swift
public class STPPaymentMethodSofort : NSObject, STPAPIResponseDecodable -
An object representing parameters used to create a Sofort Payment Method
See moreDeclaration
Swift
public class STPPaymentMethodSofortParams : NSObject, STPFormEncodable -
Contains details on how an
See moreSTPPaymentMethodCardmaybe be used for 3D Secure authentication.Declaration
Swift
public class STPPaymentMethodThreeDSecureUsage : NSObject, STPAPIResponseDecodable -
A UPI Payment Method.
See moreDeclaration
Swift
public class STPPaymentMethodUPI : NSObject, STPAPIResponseDecodable -
An object representing parameters used to create a UPI Payment Method
See moreDeclaration
Swift
public class STPPaymentMethodUPIParams : NSObject, STPFormEncodable -
An iDEAL Payment Method.
See moreDeclaration
Swift
public class STPPaymentMethodiDEAL : NSObject, STPAPIResponseDecodable -
An object representing parameters used to create an iDEAL Payment Method
See moreDeclaration
Swift
public class STPPaymentMethodiDEALParams : NSObject, STPFormEncodable -
This view controller presents a list of payment method options to the user, which they can select between. They can also add credit cards to the list. It must be displayed inside a
See moreUINavigationController, so you can either create aUINavigationControllerwith anSTPPaymentOptionsViewControlleras therootViewControllerand then present theUINavigationController, or push a newSTPPaymentOptionsViewControlleronto an existingUINavigationController‘s stack. You can also haveSTPPaymentContextdo this for you automatically, by callingpresentPaymentOptionsViewControllerorpushPaymentOptionsViewControlleron it.Declaration
Swift
public class STPPaymentOptionsViewController: STPCoreViewController, STPPaymentOptionsInternalViewControllerDelegate, STPAddCardViewControllerDelegate -
When you’re using
See moreSTPPaymentContextto request your user’s payment details, this is the object that will be returned to your application when they’ve successfully made a payment. See https://stripe.com/docs/mobile/ios/standard#submit-payment-intents.Declaration
Swift
public class STPPaymentResult : NSObject -
STPAPIClient extensions to manage PIN on Stripe Issuing cards
See moreDeclaration
Swift
public class STPPinManagementService : NSObject -
This class makes it easier to implement “Push Provisioning”, the process by which an end-user can add a card to their Apple Pay wallet without having to type their number. This process is mediated by an Apple class called
See morePKAddPaymentPassViewController; this class will help you implement that class’ delegate methods. Note that this flow requires a special entitlement from Apple; for more information please see https://stripe.com/docs/issuing/cards/digital-wallets .Declaration
Swift
public class STPPushProvisioningContext : NSObject -
A helper class for turning the raw certificate array, nonce, and nonce signature emitted by PKAddPaymentPassViewController into a format that is understandable by the Stripe API. If you are using STPPushProvisioningContext to implement your integration, you do not need to use this class.
See moreDeclaration
Swift
public class STPPushProvisioningDetailsParams : NSObject -
See more
Note
This API and the guide linked above require special permissions to use. Contact support@stripe.com if you’re interested.Declaration
Swift
public final class STPRadarSession : NSObject, STPAPIResponseDecodable -
This is a helper class for handling redirects associated with STPSource and STPPaymentIntents. Init and retain an instance with the Source or PaymentIntent you want to handle, then choose a redirect method. The context will fire the completion handler when the redirect completes. Due to the nature of iOS, very little concrete information can be gained during this process, as all actions take place in either the Safari app or the sandboxed SFSafariViewController class. The context attempts to detect when the user has completed the necessary redirect action by listening for both app foregrounds and url callbacks received in the app delegate. However, it is possible the when the redirect is “completed”, the user may have not actually completed the necessary actions to authorize the charge. You should not use either this class, nor
See moreSTPAPIClient, as a way to determine when you should charge the Source or to determine if the redirect was successful. Use Stripe webhooks on your backend server to listen for Source state changes and to make the charge. @note You must retain this instance for the duration of the redirect flow. This class dismisses any presented view controller upon deallocation. See https://stripe.com/docs/sources/best-practicesDeclaration
Swift
@available(iOSApplicationExtension, unavailable) @available(macCatalystApplicationExtension, unavailable) public class STPRedirectContext: NSObject, SFSafariViewControllerDelegate, STPURLCallbackListener, UIViewControllerTransitioningDelegate, STPSafariViewControllerDismissalDelegate -
A SetupIntent guides you through the process of setting up a customer’s payment credentials for future payments.
See moreDeclaration
Swift
public class STPSetupIntent : NSObject, STPAPIResponseDecodable -
An object representing parameters to confirm a SetupIntent object. For example, you would confirm a SetupIntent when a customer hits the “Save” button on a payment method management view in your app. If the selected payment method does not require any additional steps from the customer, the SetupIntent’s status will transition to
See moreSTPSetupIntentStatusSucceeded. Otherwise, it will transition toSTPSetupIntentStatusRequiresAction, and suggest additional actions vianextAction. Instead of passing this toSTPAPIClient.confirmSetupIntent(...)directly, we recommend usingSTPPaymentHandlerto handle any additional steps for you.Declaration
Swift
public class STPSetupIntentConfirmParams : NSObject, NSCopying, STPFormEncodable
-
A value for
See morecodeindicating the provided payment method failed authentication./// The error encountered in the previous SetupIntent confirmation.Declaration
Swift
public class STPSetupIntentLastSetupError : NSObject, STPAPIResponseDecodable -
This view controller contains a shipping address collection form. It renders a right bar button item that submits the form, so it must be shown inside a
See moreUINavigationController. Depending on your configuration’s shippingType, the view controller may present a shipping method selection form after the user enters an address.Declaration
Swift
public class STPShippingAddressViewController : STPCoreTableViewControllerextension STPShippingAddressViewController: STPAddressViewModelDelegate, UITableViewDelegate, UITableViewDataSource, STPShippingMethodsViewControllerDelegate -
Representation of a customer’s payment instrument created with the Stripe API. - seealso: https://stripe.com/docs/api#sources
See moreDeclaration
Swift
public class STPSource : NSObject, STPAPIResponseDecodable, STPSourceProtocol, STPPaymentOption -
This class provides typed access to the contents of an STPSource
See moredetailsdictionary for card sources.Declaration
Swift
public class STPSourceCardDetails : NSObject, STPAPIResponseDecodable -
Details of a Klarna source.
See moreDeclaration
Swift
public class STPSourceKlarnaDetails : NSObject, STPAPIResponseDecodable -
Information about a source’s owner.
See moreDeclaration
Swift
public class STPSourceOwner : NSObject, STPAPIResponseDecodable -
An object representing parameters used to create a Source object.
See moreDeclaration
Swift
public class STPSourceParams : NSObject, STPFormEncodable, NSCopying -
Information related to a source’s receiver flow.
See moreDeclaration
Swift
public class STPSourceReceiver : NSObject, STPAPIResponseDecodable -
Information related to a source’s redirect flow.
See moreDeclaration
Swift
public class STPSourceRedirect : NSObject, STPAPIResponseDecodable -
This class provides typed access to the contents of an STPSource
See moredetailsdictionary for SEPA Debit sources.Declaration
Swift
public class STPSourceSEPADebitDetails : NSObject, STPAPIResponseDecodable -
Information related to a source’s verification flow.
See moreDeclaration
Swift
public class STPSourceVerification : NSObject, STPAPIResponseDecodable -
Details of a WeChat Pay Source.
See moreDeclaration
Swift
public class STPSourceWeChatPayDetails : NSObject, STPAPIResponseDecodable -
STPTheme objects can be used to visually style Stripe-provided UI. See https://stripe.com/docs/mobile/ios/standard#theming for more information.
See moreDeclaration
Swift
final public class STPTheme : NSObjectextension STPTheme: NSCopying -
A customization object to use to configure the UI of a button.
See moreDeclaration
Swift
public class STPThreeDSButtonCustomization : NSObject -
See moreSTPThreeDSCustomizationSettingsprovides customization options for 3DS2 authentication flows in your app.Declaration
Swift
public class STPThreeDSCustomizationSettings : NSObject -
The Challenge view displays a footer with additional details that expand when tapped. This object configures the appearance of that view.
See moreDeclaration
Swift
public class STPThreeDSFooterCustomization : NSObject -
A customization object to use to configure the UI of a text label.
See moreDeclaration
Swift
public class STPThreeDSLabelCustomization : NSObject -
A customization object to use to configure a UINavigationBar.
See moreDeclaration
Swift
public class STPThreeDSNavigationBarCustomization : NSObject -
A customization object that configures the appearance of radio buttons and checkboxes.
See moreDeclaration
Swift
public class STPThreeDSSelectionCustomization : NSObject -
A customization object to use to configure the UI of a text field.
See moreDeclaration
Swift
public class STPThreeDSTextFieldCustomization : NSObject -
The
See moreSTPThreeDSUICustomizationprovides configuration for UI elements displayed during 3D Secure authentication. Note: It’s important to configure this object appropriately before calling anySTPPaymentHandlerAPIs. The API makes a copy of the customization settings you provide; it ignores any subsequent changes you make to yourSTPThreeDSUICustomizationinstance.Declaration
Swift
public class STPThreeDSUICustomization : NSObject -
A token returned from submitting payment details to the Stripe API. You should not have to instantiate one of these directly.
See moreDeclaration
Swift
public class STPToken : NSObject, STPAPIResponseDecodable, STPSourceProtocol -
You can use this class to specify information that you’ve already collected from your user. You can then set the
See moreprefilledInformationproperty onSTPPaymentContext,STPAddCardViewController, etc and it will pre-fill this information whenever possible.Declaration
Swift
public class STPUserInformation : NSObject, NSCopying -
A top-level class that imports the rest of the Stripe SDK.
See moreDeclaration
Swift
public class StripeAPI : NSObject