Classes

A client for making connections to the Stripe API.

A top-level class that imports the rest of the Stripe SDK.

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 UINavigationController.

STPAddress Contains an address as represented by the Stripe API.

Libraries wrapping the Stripe SDK should use this object to provide information about the library, and set it in on STPAPIClient. This information is passed to Stripe so that we can contact you about future issues or critical updates.

An empty class representing that the user wishes to pay via Apple Pay. This can be checked on an STPPaymentContext, e.g:

if ([paymentContext.selectedPaymentOption isKindOfClass:[STPApplePayPaymentOption class]]) {
   // Don't ask the user for their card number; they want to pay with apple pay.
}

Representation of a user’s bank account details that have been tokenized with the Stripe API.

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.

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.

Representation of a user’s credit card details that have been tokenized with the Stripe API

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.

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

Options to update a Card PaymentMethod during PaymentIntent confirmation.

Options to update the associated PaymentMethod during PaymentIntent confirmation.

An address to use with STPConnectAccountParams.

Information about the company or business to use with STPConnectAccountParams.

Information about the person represented by the account for use with STPConnectAccountParams.

The individual’s verification document information for use with STPConnectAccountIndividualParams.

An identifying document, either a passport or local ID card for use with STPConnectAccountIndividualVerification.

An individual’s date of birth.

See https://stripe.com/docs/api/tokens/create_account#create_account_token-account-individual-dob

Parameters for creating a Connect Account token.

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.

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.

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.

An STPCustomer represents a deserialized Customer object from the Stripe API. You shouldn’t need to instantiate an STPCustomer – you should instead use STPCustomerContext to manage retrieving and updating a customer.

Use STPCustomerDeserializer to convert a response from the Stripe API into an STPCustomer object. STPCustomerDeserializer expects the JSON response to be in the exact same format as the Stripe API.

An STPCustomerContext retrieves 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 of STPCustomerContext or 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.

This class is a piece of fake UI that is intended to mimic PKAddPaymentPassViewController. 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 as PKAddPaymentPassViewController, 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 to STPFakeAddPaymentPassViewController in your app with PKAddPaymentPassViewController and it will continue to function. For more information on developing against this API, please see https://stripe.com/docs/issuing/cards/digital-wallets .

Representation of a file upload object in the Stripe API.

This class lets you access card icons used by the Stripe SDK. All icons are 32 x 20 points.

Next action details for STPPaymentIntent and STPSetupIntent.

This is a container for the various types that are available. Check the type to see which one it is, and then use the related property for the details necessary to handle it.

Contains instructions for authenticating a payment by redirecting your customer to another page or application.

Information related to a Stripe Issuing card, including the PIN

An object representing a line item in a Klarna source.

An object that contains details about the customer acceptance of the Mandate. - see: https://stripe.com/docs/api/payment_intents/confirm#confirm_payment_intent-mandate_data-customer_acceptance

This object contains details about the Mandate to create. - see: https://stripe.com/docs/api/payment_intents/confirm#confirm_payment_intent-mandate_data

Contains details about a Mandate accepted online. - see: https://stripe.com/docs/api/payment_intents/confirm#confirm_payment_intent-mandate_data-customer_acceptance-online

This class can be used wherever you’d use a UIActivityIndicatorView and 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 the tintColor property.

STPPaymentCardTextField is a text field with similar properties to UITextField, but specialized for collecting 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.

An STPPaymentConfiguration represents all the options you can set or change around a payment.

You provide an STPPaymentConfiguration object to your STPPaymentContext when 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.

An STPPaymentContext keeps 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.

STPPaymentContext also 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.

STPPaymentContext saves information about a user’s payment methods to a Stripe customer object, and requires an STPCustomerContext to manage retrieving and modifying the customer.

STPPaymentHandler is 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).

A PaymentIntent tracks the process of collecting a payment from your customer.

The payment error encountered in the previous PaymentIntent confirmation.

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 STPPaymentMethodParams or STPSourceParams object in the paymentMethodParams or sourceParams field
• a pre-existing PaymentMethod or Source can be associated by passing its id in the paymentMethodId or sourceId field

• or already set via your backend, either when creating or updating the PaymentIntent

PaymentMethod objects represent your customer’s payment instruments. They can be used with PaymentIntents to collect payments.

The billing address, a property on STPPaymentMethodBillingDetails

Billing information associated with a STPPaymentMethod that may be used or required by particular types of payment methods.

Contains details about a user’s credit card.

Checks on Card address and CVC.

The user’s card details.

Details about the Card Present payment method

A Card Wallet.

A Masterpass Card Wallet

A Visa Checkout Card Wallet

An FPX Payment Method.

An object representing parameters used to create an FPX Payment Method

An object representing parameters used to create a PaymentMethod object.

A SEPA Debit Payment Method.

An object representing parameters used to create a SEPA Debit Payment Method

Contains details on how an STPPaymentMethodCard maybe be used for 3D Secure authentication.

An iDEAL Payment Method.

An object representing parameters used to create an iDEAL Payment Method

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 UINavigationController, so you can either create a UINavigationController with an STPPaymentOptionsViewController as the rootViewController and then present the UINavigationController, or push a new STPPaymentOptionsViewController onto an existing UINavigationController‘s stack. You can also have STPPaymentContext do this for you automatically, by calling presentPaymentOptionsViewController or pushPaymentOptionsViewController on it.

When you’re using STPPaymentContext to 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.

STPAPIClient extensions to manage PIN on Stripe Issuing cards

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 PKAddPaymentPassViewController; 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 .

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.

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 STPAPIClient, 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.

See https://stripe.com/docs/sources/best-practices

A SetupIntent guides you through the process of setting up a customer’s payment credentials for future payments.

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 STPSetupIntentStatusSucceeded. Otherwise, it will transition to STPSetupIntentStatusRequiresAction, and suggest additional actions via nextAction. Instead of passing this to [STPAPIClient confirmSetupIntent...] directly, we recommend using STPPaymentHandler to handle any additional steps for you.

The error encountered in the previous SetupIntent confirmation.

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 UINavigationController. Depending on your configuration’s shippingType, the view controller may present a shipping method selection form after the user enters an address.

Representation of a customer’s payment instrument created with the Stripe API. - see: https://stripe.com/docs/api#sources

This class provides typed access to the contents of an STPSource details dictionary for card sources.

Details of a Klarna source.

Information about a source’s owner.

An object representing parameters used to create a Source object.

Information related to a source’s receiver flow.

Information related to a source’s redirect flow.

This class provides typed access to the contents of an STPSource details dictionary for SEPA Debit sources.

Information related to a source’s verification flow.

Details of a WeChat Pay Source.

STPTheme objects can be used to visually style Stripe-provided UI. See https://stripe.com/docs/mobile/ios/standard#theming for more information.

A customization object to use to configure the UI of a button.

STPThreeDSCustomizationSettings provides customization options for 3DS2 authentication flows in your app.

The Challenge view displays a footer with additional details that expand when tapped. This object configures the appearance of that view.

A customization object to use to configure the UI of a text label.

A customization object to use to configure a UINavigationBar.

A customization object that configures the appearance of radio buttons and checkboxes.

A customization object to use to configure the UI of a text field.

The STPThreeDSUICustomization provides configuration for UI elements displayed during 3D Secure authentication.

Note: It’s important to configure this object appropriately before calling any STPPaymentHandler APIs. The API makes a copy of the customization settings you provide; it ignores any subsequent changes you make to your STPThreeDSUICustomization instance.

A token returned from submitting payment details to the Stripe API. You should not have to instantiate one of these directly.

You can use this class to specify information that you’ve already collected from your user. You can then set the prefilledInformation property on STPPaymentContext, STPAddCardViewController, etc and it will pre-fill this information whenever possible.