Classes
The following classes are available globally.
-
A client for making connections to the Stripe API.
See moreDeclaration
Objective-C
@interface STPAPIClient : NSObject
Swift
class STPAPIClient : NSObject
-
A top-level class that imports the rest of the Stripe SDK.
See moreDeclaration
Objective-C
@interface Stripe : NSObject
Swift
class Stripe : 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 - see: STPFormTextFieldContainer
See moreDeclaration
Objective-C
@interface STPAUBECSDebitFormView : STPMultiFormTextField
Swift
class STPAUBECSDebitFormView : STPMultiFormTextField
-
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
Objective-C
@interface STPAddCardViewController : STPCoreTableViewController
Swift
class STPAddCardViewController : STPCoreTableViewController
-
STPAddress Contains an address as represented by the Stripe API.
See moreDeclaration
Objective-C
@interface STPAddress : NSObject <STPAPIResponseDecodable, STPFormEncodable, NSCopying>
Swift
class STPAddress : NSObject, STPAPIResponseDecodable, STPFormEncodable, 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
Objective-C
@interface STPAppInfo : NSObject
Swift
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
See
https://stripe.com/docs/apple-pay#native for a full guideSee
ApplePayExampleViewController for an exampleDeclaration
Objective-C
@interface STPApplePayContext : NSObject
Swift
class STPApplePayContext : NSObject
-
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. }
Declaration
Objective-C
@interface STPApplePayPaymentOption : NSObject <STPPaymentOption>
Swift
class STPApplePayPaymentOption : NSObject, STPPaymentOption
-
Representation of a user’s bank account details that have been tokenized with the Stripe API.
See moreDeclaration
Objective-C
@interface STPBankAccount : NSObject <STPAPIResponseDecodable, STPSourceProtocol>
Swift
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
Objective-C
@interface STPBankAccountParams : NSObject <STPFormEncodable>
Swift
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
Objective-C
@interface STPBankSelectionViewController : STPCoreTableViewController
Swift
class STPBankSelectionViewController : STPCoreTableViewController
-
Representation of a user’s credit card details that have been tokenized with the Stripe API
See moreDeclaration
Objective-C
@interface STPCard : NSObject <STPAPIResponseDecodable, STPPaymentOption, STPSourceProtocol>
Swift
class STPCard : NSObject, STPAPIResponseDecodable, STPPaymentOption, STPSourceProtocol
-
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
Objective-C
@interface STPCardParams : NSObject <STPFormEncodable, NSCopying>
Swift
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
Objective-C
@interface STPCardValidator : NSObject
Swift
class STPCardValidator : NSObject
-
Alipay options to pass to
See moreSTPConfirmPaymentMethodOptions
`Declaration
Objective-C
@interface STPConfirmAlipayOptions : NSObject <STPFormEncodable>
Swift
class STPConfirmAlipayOptions : NSObject, STPFormEncodable
-
Options to update a Card PaymentMethod during PaymentIntent confirmation.
See moreDeclaration
Objective-C
@interface STPConfirmCardOptions : NSObject <STPFormEncodable>
Swift
class STPConfirmCardOptions : NSObject, STPFormEncodable
-
Options to update the associated PaymentMethod during PaymentIntent confirmation.
See
https://stripe.com/docs/api/payment_intents/confirm#confirm_payment_intent-payment_method_optionsDeclaration
Objective-C
@interface STPConfirmPaymentMethodOptions : NSObject <STPFormEncodable>
Swift
class STPConfirmPaymentMethodOptions : NSObject, STPFormEncodable
-
An address to use with
See moreSTPConnectAccountParams
.Declaration
Objective-C
@interface STPConnectAccountAddress : NSObject <STPFormEncodable>
Swift
class STPConnectAccountAddress : NSObject, STPFormEncodable
-
Information about the company or business to use with
See moreSTPConnectAccountParams
.Declaration
Objective-C
@interface STPConnectAccountCompanyParams : NSObject <STPFormEncodable>
Swift
class STPConnectAccountCompanyParams : NSObject, STPFormEncodable
-
Information about the person represented by the account for use with
See moreSTPConnectAccountParams
.Declaration
Objective-C
@interface STPConnectAccountIndividualParams : NSObject <STPFormEncodable>
Swift
class STPConnectAccountIndividualParams : NSObject, STPFormEncodable
-
The individual’s verification document information for use with
See moreSTPConnectAccountIndividualParams
.Declaration
Objective-C
@interface STPConnectAccountIndividualVerification : NSObject <STPFormEncodable>
Swift
class STPConnectAccountIndividualVerification : NSObject, STPFormEncodable
-
An identifying document, either a passport or local ID card for use with
See moreSTPConnectAccountIndividualVerification
.Declaration
Objective-C
@interface STPConnectAccountVerificationDocument : NSObject <STPFormEncodable>
Swift
class STPConnectAccountVerificationDocument : NSObject, STPFormEncodable
-
An individual’s date of birth.
See https://stripe.com/docs/api/tokens/create_account#create_account_token-account-individual-dob
See moreDeclaration
Objective-C
@interface STPDateOfBirth : NSObject <STPFormEncodable>
Swift
class STPDateOfBirth : NSObject, STPFormEncodable
-
Parameters for creating a Connect Account token.
See moreDeclaration
Objective-C
@interface STPConnectAccountParams : NSObject <STPFormEncodable>
Swift
class STPConnectAccountParams : NSObject, STPFormEncodable
-
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.
Declaration
Objective-C
@interface STPCoreScrollViewController : STPCoreViewController
Swift
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.
Declaration
Objective-C
@interface STPCoreTableViewController : STPCoreScrollViewController
Swift
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
Objective-C
@interface STPCoreViewController : UIViewController
Swift
class STPCoreViewController : UIViewController
-
An
See moreSTPCustomer
represents a deserialized Customer object from the Stripe API. You shouldn’t need to instantiate anSTPCustomer
– you should instead useSTPCustomerContext
to manage retrieving and updating a customer.Declaration
Objective-C
@interface STPCustomer : NSObject <STPAPIResponseDecodable>
Swift
class STPCustomer : NSObject, STPAPIResponseDecodable
-
Use
See moreSTPCustomerDeserializer
to convert a response from the Stripe API into anSTPCustomer
object.STPCustomerDeserializer
expects the JSON response to be in the exact same format as the Stripe API.Declaration
Objective-C
@interface STPCustomerDeserializer : NSObject
Swift
class STPCustomerDeserializer : NSObject
-
An
See moreSTPCustomerContext
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 ofSTPCustomerContext
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.Declaration
Objective-C
@interface STPCustomerContext : NSObject <STPBackendAPIAdapter>
Swift
class STPCustomerContext : NSObject, STPBackendAPIAdapter
-
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 toSTPFakeAddPaymentPassViewController
in your app withPKAddPaymentPassViewController
and it will continue to function. For more information on developing against this API, please see https://stripe.com/docs/issuing/cards/digital-wallets .Declaration
Objective-C
@interface STPFakeAddPaymentPassViewController : UIViewController
Swift
class STPFakeAddPaymentPassViewController : UIViewController
-
Representation of a file upload object in the Stripe API.
See moreDeclaration
Objective-C
@interface STPFile : NSObject <STPAPIResponseDecodable>
Swift
class STPFile : NSObject, STPAPIResponseDecodable
-
This class lets you access card icons used by the Stripe SDK. All icons are 32 x 20 points.
See moreDeclaration
Objective-C
@interface STPImageLibrary : NSObject
Swift
class STPImageLibrary : NSObject
-
Next action details for
STPPaymentIntent
andSTPSetupIntent
.This is a container for the various types that are available. Check the
See moretype
to see which one it is, and then use the related property for the details necessary to handle it.Declaration
Objective-C
@interface STPIntentAction : NSObject <STPAPIResponseDecodable>
Swift
class STPIntentAction : NSObject, STPAPIResponseDecodable
-
Contains instructions for authenticating a payment by redirecting your customer to Alipay App or website.
See moreDeclaration
Objective-C
@interface STPIntentActionAlipayHandleRedirect : NSObject <STPAPIResponseDecodable>
Swift
class STPIntentActionAlipayHandleRedirect : NSObject, STPAPIResponseDecodable
-
Contains instructions for authenticating a payment by redirecting your customer to another page or application.
See moreDeclaration
Objective-C
@interface STPIntentActionRedirectToURL : NSObject <STPAPIResponseDecodable>
Swift
class STPIntentActionRedirectToURL : NSObject, STPAPIResponseDecodable
-
Information related to a Stripe Issuing card, including the PIN
See moreDeclaration
Objective-C
@interface STPIssuingCardPin : NSObject <STPAPIResponseDecodable>
Swift
class STPIssuingCardPin : NSObject, STPAPIResponseDecodable
-
An object representing a line item in a Klarna source.
See moreDeclaration
Objective-C
@interface STPKlarnaLineItem : NSObject
Swift
class STPKlarnaLineItem : NSObject
-
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
See moreDeclaration
Objective-C
@interface STPMandateCustomerAcceptanceParams : NSObject <STPFormEncodable>
Swift
class STPMandateCustomerAcceptanceParams : NSObject, STPFormEncodable
-
This object contains details about the Mandate to create. - see: https://stripe.com/docs/api/payment_intents/confirm#confirm_payment_intent-mandate_data
See moreDeclaration
Objective-C
@interface STPMandateDataParams : NSObject <STPFormEncodable>
Swift
class STPMandateDataParams : NSObject, STPFormEncodable
-
Contains details about a Mandate accepted online. - see: https://stripe.com/docs/api/payment_intents/confirm#confirm_payment_intent-mandate_data-customer_acceptance-online
See moreDeclaration
Objective-C
@interface STPMandateOnlineParams : NSObject <STPFormEncodable>
Swift
class STPMandateOnlineParams : NSObject, 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
Objective-C
@interface STPMultiFormTextField : UIView <STPFormTextFieldContainer>
Swift
class STPMultiFormTextField : UIView, STPFormTextFieldContainer
-
This class can be used wherever you’d use a
See moreUIActivityIndicatorView
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 thetintColor
property.Declaration
Objective-C
@interface STPPaymentActivityIndicatorView : UIView
Swift
class STPPaymentActivityIndicatorView : UIView
-
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.
See moreDeclaration
Objective-C
@interface STPPaymentCardTextField : UIControl <UIKeyInput>
Swift
class STPPaymentCardTextField : UIControl, UIKeyInput
-
An
STPPaymentConfiguration
represents all the options you can set or change around a payment.You provide an
See moreSTPPaymentConfiguration
object to yourSTPPaymentContext
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.Declaration
Objective-C
@interface STPPaymentConfiguration : NSObject <NSCopying>
Swift
class STPPaymentConfiguration : NSObject, NSCopying
-
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.
See moreSTPPaymentContext
saves information about a user’s payment methods to a Stripe customer object, and requires anSTPCustomerContext
to manage retrieving and modifying the customer.Declaration
Objective-C
@interface STPPaymentContext : NSObject <STPAuthenticationContext>
Swift
class STPPaymentContext : NSObject, STPAuthenticationContext
-
See moreSTPPaymentHandler
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).Declaration
Objective-C
@interface STPPaymentHandler : NSObject
Swift
class STPPaymentHandler : NSObject
-
A PaymentIntent tracks the process of collecting a payment from your customer.
See moreDeclaration
Objective-C
@interface STPPaymentIntent : NSObject <STPAPIResponseDecodable>
Swift
class STPPaymentIntent : NSObject, STPAPIResponseDecodable
-
The payment error encountered in the previous PaymentIntent confirmation.
See moreDeclaration
Objective-C
@interface STPPaymentIntentLastPaymentError : NSObject <STPAPIResponseDecodable>
Swift
class STPPaymentIntentLastPaymentError : NSObject, 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
STPPaymentMethodParams
orSTPSourceParams
object in thepaymentMethodParams
orsourceParams
field - a pre-existing PaymentMethod or Source can be associated by passing its id in the
paymentMethodId
orsourceId
field or already set via your backend, either when creating or updating the PaymentIntent
Declaration
Objective-C
@interface STPPaymentIntentParams : NSObject <NSCopying, STPFormEncodable>
Swift
class STPPaymentIntentParams : NSObject, NSCopying, STPFormEncodable
- created during confirmation, by passing in a
-
Shipping information for a PaymentIntent
See moreDeclaration
Objective-C
@interface STPPaymentIntentShippingDetails : NSObject <STPAPIResponseDecodable>
Swift
class STPPaymentIntentShippingDetails : NSObject, STPAPIResponseDecodable
-
Shipping address for a PaymentIntent’s shipping details.
See moreDeclaration
Objective-C
@interface STPPaymentIntentShippingDetailsAddress : NSObject <STPAPIResponseDecodable>
Swift
class STPPaymentIntentShippingDetailsAddress : NSObject, STPAPIResponseDecodable
-
Shipping address for a PaymentIntent’s shipping details.
See moreDeclaration
Objective-C
@interface STPPaymentIntentShippingDetailsAddressParams : NSObject <NSCopying, STPFormEncodable>
Swift
class STPPaymentIntentShippingDetailsAddressParams : NSObject, NSCopying, STPFormEncodable
-
Shipping information for a PaymentIntent
See moreDeclaration
Objective-C
@interface STPPaymentIntentShippingDetailsParams : NSObject <NSCopying, STPFormEncodable>
Swift
class STPPaymentIntentShippingDetailsParams : NSObject, NSCopying, STPFormEncodable
-
PaymentMethod objects represent your customer’s payment instruments. They can be used with PaymentIntents to collect payments.
See moreDeclaration
Objective-C
@interface STPPaymentMethod : NSObject <STPAPIResponseDecodable, STPPaymentOption>
Swift
class STPPaymentMethod : NSObject, STPAPIResponseDecodable, STPPaymentOption
-
An AU BECS Debit Payment Method.
See moreDeclaration
Objective-C
@interface STPPaymentMethodAUBECSDebit : NSObject <STPAPIResponseDecodable>
Swift
class STPPaymentMethodAUBECSDebit : NSObject, STPAPIResponseDecodable
-
An object representing parameters used to create an AU BECS Debit Payment Method
See moreDeclaration
Objective-C
@interface STPPaymentMethodAUBECSDebitParams : NSObject <STPFormEncodable>
Swift
class STPPaymentMethodAUBECSDebitParams : NSObject, STPFormEncodable
-
The billing address, a property on
See moreSTPPaymentMethodBillingDetails
Declaration
Objective-C
@interface STPPaymentMethodAddress : NSObject <STPAPIResponseDecodable, STPFormEncodable>
Swift
class STPPaymentMethodAddress : NSObject, STPAPIResponseDecodable, STPFormEncodable
-
Contains details for an Alipay Payment Method.
See moreDeclaration
Objective-C
@interface STPPaymentMethodAlipay : NSObject <STPAPIResponseDecodable>
Swift
class STPPaymentMethodAlipay : NSObject, STPAPIResponseDecodable
-
An object representing parameters used to create an Alipay Payment Method.
There are currently no parameters to pass.
Declaration
Objective-C
@interface STPPaymentMethodAlipayParams : NSObject <STPFormEncodable>
Swift
class STPPaymentMethodAlipayParams : NSObject, STPFormEncodable
-
A Bacs Debit Payment Method.
See moreDeclaration
Objective-C
@interface STPPaymentMethodBacsDebit : NSObject <STPAPIResponseDecodable>
Swift
class STPPaymentMethodBacsDebit : NSObject, STPAPIResponseDecodable
-
The user’s bank account details.
See moreDeclaration
Objective-C
@interface STPPaymentMethodBacsDebitParams : NSObject <STPFormEncodable>
Swift
class STPPaymentMethodBacsDebitParams : NSObject, STPFormEncodable
-
Declaration
Objective-C
@interface STPPaymentMethodBancontact : NSObject <STPAPIResponseDecodable>
Swift
class STPPaymentMethodBancontact : NSObject, STPAPIResponseDecodable
-
An object representing parameters used to create a Bancontact Payment Method
Declaration
Objective-C
@interface STPPaymentMethodBancontactParams : NSObject <STPFormEncodable>
Swift
class STPPaymentMethodBancontactParams : NSObject, STPFormEncodable
-
Billing information associated with a
See moreSTPPaymentMethod
that may be used or required by particular types of payment methods.Declaration
Objective-C
@interface STPPaymentMethodBillingDetails : NSObject <STPAPIResponseDecodable, STPFormEncodable>
Swift
class STPPaymentMethodBillingDetails : NSObject, STPAPIResponseDecodable, STPFormEncodable
-
Contains details about a user’s credit card.
See moreDeclaration
Objective-C
@interface STPPaymentMethodCard : NSObject <STPAPIResponseDecodable>
Swift
class STPPaymentMethodCard : NSObject, STPAPIResponseDecodable
-
Checks on Card address and CVC.
See moreDeclaration
Objective-C
@interface STPPaymentMethodCardChecks : NSObject <STPAPIResponseDecodable>
Swift
class STPPaymentMethodCardChecks : NSObject, STPAPIResponseDecodable
-
See moreSTPPaymentMethodCardNetworks
contains information about card networks that can be used to process a payment.Declaration
Objective-C
@interface STPPaymentMethodCardNetworks : NSObject <STPAPIResponseDecodable>
Swift
class STPPaymentMethodCardNetworks : NSObject, STPAPIResponseDecodable
-
The user’s card details.
See moreDeclaration
Objective-C
@interface STPPaymentMethodCardParams : NSObject <STPFormEncodable>
Swift
class STPPaymentMethodCardParams : NSObject, STPFormEncodable
-
Details about the Card Present payment method
Declaration
Objective-C
@interface STPPaymentMethodCardPresent : NSObject <STPAPIResponseDecodable>
Swift
class STPPaymentMethodCardPresent : NSObject, STPAPIResponseDecodable
-
A Card Wallet.
See moreDeclaration
Objective-C
@interface STPPaymentMethodCardWallet : NSObject <STPAPIResponseDecodable>
Swift
class STPPaymentMethodCardWallet : NSObject, STPAPIResponseDecodable
-
Declaration
Objective-C
@interface STPPaymentMethodCardWalletMasterpass : NSObject <STPAPIResponseDecodable>
Swift
class STPPaymentMethodCardWalletMasterpass : NSObject, STPAPIResponseDecodable
-
Declaration
Objective-C
@interface STPPaymentMethodCardWalletVisaCheckout : NSObject <STPAPIResponseDecodable>
Swift
class STPPaymentMethodCardWalletVisaCheckout : NSObject, STPAPIResponseDecodable
-
A EPS Payment Method.
See moreDeclaration
Objective-C
@interface STPPaymentMethodEPS : NSObject <STPAPIResponseDecodable>
Swift
class STPPaymentMethodEPS : NSObject, STPAPIResponseDecodable
-
An object representing parameters used to create a EPS Payment Method
Declaration
Objective-C
@interface STPPaymentMethodEPSParams : NSObject <STPFormEncodable>
Swift
class STPPaymentMethodEPSParams : NSObject, STPFormEncodable
-
An FPX Payment Method.
See moreDeclaration
Objective-C
@interface STPPaymentMethodFPX : NSObject <STPAPIResponseDecodable>
Swift
class STPPaymentMethodFPX : NSObject, STPAPIResponseDecodable
-
An object representing parameters used to create an FPX Payment Method
See moreDeclaration
Objective-C
@interface STPPaymentMethodFPXParams : NSObject <STPFormEncodable>
Swift
class STPPaymentMethodFPXParams : NSObject, STPFormEncodable
-
A giropay Payment Method.
See moreDeclaration
Objective-C
@interface STPPaymentMethodGiropay : NSObject <STPAPIResponseDecodable>
Swift
class STPPaymentMethodGiropay : NSObject, STPAPIResponseDecodable
-
An object representing parameters used to create a giropay Payment Method
Declaration
Objective-C
@interface STPPaymentMethodGiropayParams : NSObject <STPFormEncodable>
Swift
class STPPaymentMethodGiropayParams : NSObject, STPFormEncodable
-
An object representing parameters used to create a PaymentMethod object.
Note
To create a PaymentMethod from an Apple Pay PKPaymentToken, see
STPAPIClient createPaymentMethodWithPayment:completion:
Declaration
Objective-C
@interface STPPaymentMethodParams : NSObject <STPFormEncodable, STPPaymentOption>
Swift
class STPPaymentMethodParams : NSObject, STPFormEncodable, STPPaymentOption
-
Declaration
Objective-C
@interface STPPaymentMethodPrzelewy24 : NSObject <STPAPIResponseDecodable>
Swift
class STPPaymentMethodPrzelewy24 : NSObject, STPAPIResponseDecodable
-
An object representing parameters used to create a Przelewy24 Payment Method
Declaration
Objective-C
@interface STPPaymentMethodPrzelewy24Params : NSObject <STPFormEncodable>
Swift
class STPPaymentMethodPrzelewy24Params : NSObject, STPFormEncodable
-
A SEPA Debit Payment Method.
See moreDeclaration
Objective-C
@interface STPPaymentMethodSEPADebit : NSObject <STPAPIResponseDecodable>
Swift
class STPPaymentMethodSEPADebit : NSObject, STPAPIResponseDecodable
-
An object representing parameters used to create a SEPA Debit Payment Method
See moreDeclaration
Objective-C
@interface STPPaymentMethodSEPADebitParams : NSObject <STPFormEncodable>
Swift
class STPPaymentMethodSEPADebitParams : NSObject, STPFormEncodable
-
Contains details on how an
See moreSTPPaymentMethodCard
maybe be used for 3D Secure authentication.Declaration
Objective-C
@interface STPPaymentMethodThreeDSecureUsage : NSObject <STPAPIResponseDecodable>
Swift
class STPPaymentMethodThreeDSecureUsage : NSObject, STPAPIResponseDecodable
-
An iDEAL Payment Method.
See moreDeclaration
Objective-C
@interface STPPaymentMethodiDEAL : NSObject <STPAPIResponseDecodable>
Swift
class STPPaymentMethodiDEAL : NSObject, STPAPIResponseDecodable
-
An object representing parameters used to create an iDEAL Payment Method
See moreDeclaration
Objective-C
@interface STPPaymentMethodiDEALParams : NSObject <STPFormEncodable>
Swift
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 aUINavigationController
with anSTPPaymentOptionsViewController
as therootViewController
and then present theUINavigationController
, or push a newSTPPaymentOptionsViewController
onto an existingUINavigationController
‘s stack. You can also haveSTPPaymentContext
do this for you automatically, by callingpresentPaymentOptionsViewController
orpushPaymentOptionsViewController
on it.Declaration
Objective-C
@interface STPPaymentOptionsViewController : STPCoreViewController
Swift
class STPPaymentOptionsViewController : STPCoreViewController
-
When you’re using
See moreSTPPaymentContext
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.Declaration
Objective-C
@interface STPPaymentResult : NSObject
Swift
class STPPaymentResult : NSObject
-
STPAPIClient extensions to manage PIN on Stripe Issuing cards
See moreDeclaration
Objective-C
@interface STPPinManagementService : NSObject
Swift
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
Objective-C
@interface STPPushProvisioningContext : NSObject
Swift
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
Objective-C
@interface STPPushProvisioningDetailsParams : NSObject
Swift
class STPPushProvisioningDetailsParams : NSObject
-
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.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-practices
See moreDeclaration
Objective-C
@interface STPRedirectContext : NSObject
Swift
class STPRedirectContext : NSObject
-
A SetupIntent guides you through the process of setting up a customer’s payment credentials for future payments.
See moreDeclaration
Objective-C
@interface STPSetupIntent : NSObject <STPAPIResponseDecodable>
Swift
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 to[STPAPIClient confirmSetupIntent...]
directly, we recommend usingSTPPaymentHandler
to handle any additional steps for you.Declaration
Objective-C
@interface STPSetupIntentConfirmParams : NSObject <NSCopying, STPFormEncodable>
Swift
class STPSetupIntentConfirmParams : NSObject, NSCopying, STPFormEncodable
-
The error encountered in the previous SetupIntent confirmation.
See moreDeclaration
Objective-C
@interface STPSetupIntentLastSetupError : NSObject <STPAPIResponseDecodable>
Swift
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
Objective-C
@interface STPShippingAddressViewController : STPCoreTableViewController
Swift
class STPShippingAddressViewController : STPCoreTableViewController
-
Representation of a customer’s payment instrument created with the Stripe API. - see: https://stripe.com/docs/api#sources
See moreDeclaration
Objective-C
@interface STPSource : NSObject <STPAPIResponseDecodable, STPSourceProtocol, STPPaymentOption>
Swift
class STPSource : NSObject, STPAPIResponseDecodable, STPSourceProtocol, STPPaymentOption
-
This class provides typed access to the contents of an STPSource
See moredetails
dictionary for card sources.Declaration
Objective-C
@interface STPSourceCardDetails : NSObject <STPAPIResponseDecodable>
Swift
class STPSourceCardDetails : NSObject, STPAPIResponseDecodable
-
Details of a Klarna source.
See moreDeclaration
Objective-C
@interface STPSourceKlarnaDetails : NSObject <STPAPIResponseDecodable>
Swift
class STPSourceKlarnaDetails : NSObject, STPAPIResponseDecodable
-
Information about a source’s owner.
See moreDeclaration
Objective-C
@interface STPSourceOwner : NSObject <STPAPIResponseDecodable>
Swift
class STPSourceOwner : NSObject, STPAPIResponseDecodable
-
An object representing parameters used to create a Source object.
See moreDeclaration
Objective-C
@interface STPSourceParams : NSObject <STPFormEncodable, NSCopying>
Swift
class STPSourceParams : NSObject, STPFormEncodable, NSCopying
-
Information related to a source’s receiver flow.
See moreDeclaration
Objective-C
@interface STPSourceReceiver : NSObject <STPAPIResponseDecodable>
Swift
class STPSourceReceiver : NSObject, STPAPIResponseDecodable
-
Information related to a source’s redirect flow.
See moreDeclaration
Objective-C
@interface STPSourceRedirect : NSObject <STPAPIResponseDecodable>
Swift
class STPSourceRedirect : NSObject, STPAPIResponseDecodable
-
This class provides typed access to the contents of an STPSource
See moredetails
dictionary for SEPA Debit sources.Declaration
Objective-C
@interface STPSourceSEPADebitDetails : NSObject <STPAPIResponseDecodable>
Swift
class STPSourceSEPADebitDetails : NSObject, STPAPIResponseDecodable
-
Information related to a source’s verification flow.
See moreDeclaration
Objective-C
@interface STPSourceVerification : NSObject <STPAPIResponseDecodable>
Swift
class STPSourceVerification : NSObject, STPAPIResponseDecodable
-
Details of a WeChat Pay Source.
See moreDeclaration
Objective-C
@interface STPSourceWeChatPayDetails : NSObject <STPAPIResponseDecodable>
Swift
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
Objective-C
@interface STPTheme : NSObject <NSCopying>
Swift
class STPTheme : NSObject, NSCopying
-
A customization object to use to configure the UI of a button.
See moreDeclaration
Objective-C
@interface STPThreeDSButtonCustomization : NSObject
Swift
class STPThreeDSButtonCustomization : NSObject
-
See moreSTPThreeDSCustomizationSettings
provides customization options for 3DS2 authentication flows in your app.Declaration
Objective-C
@interface STPThreeDSCustomizationSettings : NSObject
Swift
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
Objective-C
@interface STPThreeDSFooterCustomization : NSObject
Swift
class STPThreeDSFooterCustomization : NSObject
-
A customization object to use to configure the UI of a text label.
See moreDeclaration
Objective-C
@interface STPThreeDSLabelCustomization : NSObject
Swift
class STPThreeDSLabelCustomization : NSObject
-
A customization object to use to configure a UINavigationBar.
See moreDeclaration
Objective-C
@interface STPThreeDSNavigationBarCustomization : NSObject
Swift
class STPThreeDSNavigationBarCustomization : NSObject
-
A customization object that configures the appearance of radio buttons and checkboxes.
See moreDeclaration
Objective-C
@interface STPThreeDSSelectionCustomization : NSObject
Swift
class STPThreeDSSelectionCustomization : NSObject
-
A customization object to use to configure the UI of a text field.
See moreDeclaration
Objective-C
@interface STPThreeDSTextFieldCustomization : NSObject
Swift
class STPThreeDSTextFieldCustomization : NSObject
-
The
STPThreeDSUICustomization
provides configuration for UI elements displayed during 3D Secure authentication.Note: It’s important to configure this object appropriately before calling any
See moreSTPPaymentHandler
APIs. The API makes a copy of the customization settings you provide; it ignores any subsequent changes you make to yourSTPThreeDSUICustomization
instance.Declaration
Objective-C
@interface STPThreeDSUICustomization : NSObject
Swift
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
Objective-C
@interface STPToken : NSObject <STPAPIResponseDecodable, STPSourceProtocol>
Swift
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 moreprefilledInformation
property onSTPPaymentContext
,STPAddCardViewController
, etc and it will pre-fill this information whenever possible.Declaration
Objective-C
@interface STPUserInformation : NSObject <NSCopying>
Swift
class STPUserInformation : NSObject, NSCopying