STPAPIClient Class Reference

+sharedClient
A shared singleton API client.

By default, the SDK uses this instance to make API requests eg in STPPaymentHandler, STPPaymentContext, STPCustomerContext, etc.
Declaration
Objective-C

+ (nonnull instancetype)sharedClient;
Swift

class func shared() -> Self
Show on GitHub


                    
                    
                    -initWithPublishableKey:

Initializes an API client with the given publishable key.

Declaration

Objective-C

- (nonnull instancetype)initWithPublishableKey:
    (nonnull NSString *)publishableKey;

Swift

init(publishableKey: String)

Parameters


                                publishableKey

The publishable key to use.

Return Value

An instance of STPAPIClient.

Show on GitHub

publishableKey
The client’s publishable key.

The default value is [Stripe defaultPublishableKey].
Declaration
Objective-C

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

var publishableKey: String? { get set }
Show on GitHub


                    
                    
                    configuration

The client’s configuration.

Defaults to [STPPaymentConfiguration sharedConfiguration].

Declaration

Objective-C

@property (readwrite, copy, nonatomic)
    STPPaymentConfiguration *_Nonnull configuration;

Swift

@NSCopying var configuration: STPPaymentConfiguration { get set }

Show on GitHub

stripeAccount
In order to perform API requests on behalf of a connected account, e.g. to create a Source or Payment Method on a connected account, set this property to the ID of the account for which this request is being made.

See
https://stripe.com/docs/connect/authentication#authentication-via-the-stripe-account-header
Declaration
Objective-C

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

var stripeAccount: String? { get set }
Show on GitHub
appInfo
Libraries wrapping the Stripe SDK should set this, so that Stripe can contact you about future issues or critical updates.

See
https://stripe.com/docs/building-plugins#setappinfo
Declaration
Objective-C

@property (assign, readwrite, nonatomic, nullable) STPAppInfo *appInfo;
Swift

var appInfo: STPAppInfo? { get set }
Show on GitHub

ApplePay


                    
                    
                    -createTokenWithPayment:completion:

Converts a PKPayment object into a Stripe token using the Stripe API.

Declaration

Objective-C

- (void)createTokenWithPayment:(nonnull PKPayment *)payment
                    completion:(nonnull STPTokenCompletionBlock)completion;

Swift

func createToken(with payment: PKPayment, completion: @escaping STPTokenCompletionBlock)

Parameters

`payment`	The user’s encrypted payment information as returned from a PKPaymentAuthorizationViewController. Cannot be nil.
`completion`	The callback to run with the returned Stripe token (and any errors that may have occurred).

Show on GitHub


                    
                    
                    -createSourceWithPayment:completion:

Converts a PKPayment object into a Stripe source using the Stripe API.

Declaration

Objective-C

- (void)createSourceWithPayment:(nonnull PKPayment *)payment
                     completion:(nonnull STPSourceCompletionBlock)completion;

Swift

func createSource(with payment: PKPayment, completion: @escaping STPSourceCompletionBlock)

Parameters

`payment`	The user’s encrypted payment information as returned from a PKPaymentAuthorizationViewController. Cannot be nil.
`completion`	The callback to run with the returned Stripe source (and any errors that may have occurred).

Show on GitHub


                    
                    
                    -createPaymentMethodWithPayment:completion:

Converts a PKPayment object into a Stripe Payment Method using the Stripe API.

Declaration

Objective-C

- (void)createPaymentMethodWithPayment:(nonnull PKPayment *)payment
                            completion:(nonnull STPPaymentMethodCompletionBlock)
                                           completion;

Swift

func createPaymentMethod(with payment: PKPayment, completion: @escaping STPPaymentMethodCompletionBlock)

Parameters

`payment`	The user’s encrypted payment information as returned from a PKPaymentAuthorizationViewController. Cannot be nil.
`completion`	The callback to run with the returned Stripe source (and any errors that may have occurred).

Show on GitHub


                    
                    
                    +pkPaymentErrorForStripeError:

Converts Stripe errors into the appropriate Apple Pay error, for use in PKPaymentAuthorizationResult. The error is displayed in the Apple Pay sheet, and the user can try again.

We can convert billing address related errors into a PKPaymentError that helpfully points to the billing address field in the Apple Pay sheet. All other errors map to PKPaymentUnknownError, resulting in a generic error message in the Apple Pay sheet.

Apple Pay should prevent most card errors (e.g. invalid CVC) when you add a card to the wallet.

See

ApplePayExampleViewController for an example of how to use this method in your Apple Pay integration.

Declaration

Objective-C

+ (nullable NSError *)pkPaymentErrorForStripeError:
    (nullable NSError *)stripeError;

Swift

class func pkPaymentError(forStripeError stripeError: Error?) -> Error?

Parameters


                                stripeError

An error from the Stripe SDK.

Show on GitHub

BankAccounts


                    
                    
                    -createTokenWithBankAccount:completion:

Converts an STPBankAccount object into a Stripe token using the Stripe API.

Declaration

Objective-C

- (void)createTokenWithBankAccount:(nonnull STPBankAccountParams *)bankAccount
                        completion:
                            (STPTokenCompletionBlock _Nullable)completion;

Swift

func createToken(withBankAccount bankAccount: STPBankAccountParams, completion: STPTokenCompletionBlock? = nil)

Parameters

`bankAccount`	The user’s bank account details. Cannot be nil. - see: https://stripe.com/docs/api#create_bank_account_token
`completion`	The callback to run with the returned Stripe token (and any errors that may have occurred).

Show on GitHub

PII


                    
                    
                    -createTokenWithPersonalIDNumber:completion:

Converts a personal identification number into a Stripe token using the Stripe API.

Declaration

Objective-C

- (void)createTokenWithPersonalIDNumber:(nonnull NSString *)pii
                             completion:
                                 (STPTokenCompletionBlock _Nullable)completion;

Swift

func createToken(withPersonalIDNumber pii: String, completion: STPTokenCompletionBlock? = nil)

Parameters

`pii`	The user’s personal identification number. Cannot be nil. - see: https://stripe.com/docs/api#create_pii_token
`completion`	The callback to run with the returned Stripe token (and any errors that may have occurred).

Show on GitHub


                    
                    
                    -createTokenWithSSNLast4:completion:

Converts the last 4 SSN digits into a Stripe token using the Stripe API.

Declaration

Objective-C

- (void)createTokenWithSSNLast4:(nonnull NSString *)ssnLast4
                     completion:(nonnull STPTokenCompletionBlock)completion;

Swift

func createToken(withSSNLast4 ssnLast4: String, completion: @escaping STPTokenCompletionBlock)

Parameters

`ssnLast4`	The last 4 digits of the user’s SSN. Cannot be nil.
`completion`	The callback to run with the returned Stripe token (and any errors that may have occurred).

Show on GitHub

ConnectAccounts


                    
                    
                    -createTokenWithConnectAccount:completion:

Converts an STPConnectAccountParams object into a Stripe token using the Stripe API.

This allows the connected account to accept the Terms of Service, and/or send Legal Entity information.

Declaration

Objective-C

- (void)createTokenWithConnectAccount:(nonnull STPConnectAccountParams *)account
                           completion:
                               (STPTokenCompletionBlock _Nullable)completion;

Swift

func createToken(withConnectAccount account: STPConnectAccountParams, completion: STPTokenCompletionBlock? = nil)

Parameters

`account`	The Connect Account parameters. Cannot be nil.
`completion`	The callback to run with the returned Stripe token (and any errors that may have occurred).

Show on GitHub

Upload


                    
                    
                    -uploadImage:purpose:completion:

Uses the Stripe file upload API to upload an image. This can be used for identity verification and evidence disputes.

See

https://stripe.com/docs/file-upload

Declaration

Objective-C

- (void)uploadImage:(nonnull UIImage *)image
            purpose:(STPFilePurpose)purpose
         completion:(nullable STPFileCompletionBlock)completion;

Swift

func uploadImage(_ image: UIImage, purpose: STPFilePurpose, completion: STPFileCompletionBlock? = nil)

Parameters

`image`	The image to be uploaded. The maximum allowed file size is 4MB for identity documents and 8MB for evidence disputes. Cannot be nil. Your image will be automatically resized down if you pass in one that is too large
`purpose`	The purpose of this file. This can be either an identifing document or an evidence dispute.
`completion`	The callback to run with the returned Stripe file (and any errors that may have occurred).

Show on GitHub

CreditCards


                    
                    
                    -createTokenWithCard:completion:

Converts an STPCardParams object into a Stripe token using the Stripe API.

Declaration

Objective-C

- (void)createTokenWithCard:(nonnull STPCardParams *)card
                 completion:(nullable STPTokenCompletionBlock)completion;

Swift

func createToken(withCard card: STPCardParams, completion: STPTokenCompletionBlock? = nil)

Parameters

`card`	The user’s card details. Cannot be nil. - see: https://stripe.com/docs/api#create_card_token
`completion`	The callback to run with the returned Stripe token (and any errors that may have occurred).

Show on GitHub


                    
                    
                    -createTokenForCVCUpdate:completion:

Converts a CVC string into a Stripe token using the Stripe API.

Declaration

Objective-C

- (void)createTokenForCVCUpdate:(nonnull NSString *)cvc
                     completion:(nullable STPTokenCompletionBlock)completion;

Swift

func createToken(forCVCUpdate cvc: String, completion: STPTokenCompletionBlock? = nil)

Parameters

`cvc`	The CVC/CVV number used to create the token. Cannot be nil.
`completion`	The callback to run with the returned Stripe token (and any errors that may have occurred).

Show on GitHub

Sources


                    
                    
                    -createSourceWithParams:completion:

Creates a Source object using the provided details. Note: in order to create a source on a connected account, you can set your API client’s stripeAccount property to the ID of the account.

See

https://stripe.com/docs/sources/connect#creating-direct-charges

Declaration

Objective-C

- (void)createSourceWithParams:(nonnull STPSourceParams *)params
                    completion:(nonnull STPSourceCompletionBlock)completion;

Swift

func createSource(with params: STPSourceParams, completion: @escaping STPSourceCompletionBlock)

Parameters

`params`	The details of the source to create. Cannot be nil. - see: https://stripe.com/docs/api#create_source
`completion`	The callback to run with the returned Source object, or an error.

Show on GitHub


                    
                    
                    -retrieveSourceWithId:clientSecret:completion:

Retrieves the Source object with the given ID. - see: https://stripe.com/docs/api#retrieve_source

Declaration

Objective-C

- (void)retrieveSourceWithId:(nonnull NSString *)identifier
                clientSecret:(nonnull NSString *)secret
                  completion:(nonnull STPSourceCompletionBlock)completion;

Swift

func retrieveSource(withId identifier: String, clientSecret secret: String, completion: @escaping STPSourceCompletionBlock)

Parameters

`identifier`	The identifier of the source to be retrieved. Cannot be nil.
`secret`	The client secret of the source. Cannot be nil.
`completion`	The callback to run with the returned Source object, or an error.

Show on GitHub


                    
                    
                    -startPollingSourceWithId:clientSecret:timeout:completion:

Deprecated

You should poll your own backend to update based on source status change webhook events it may receive.

Starts polling the Source object with the given ID. For payment methods that require additional customer action (e.g. authorizing a payment with their bank), polling allows you to determine if the action was successful. Polling will stop and the provided callback will be called once the source’s status is no longer pending, or if the given timeout is reached and the source is still pending. If polling stops due to an error, the callback will be fired with the latest retrieved source and the error.

Note that if a poll is already running for a source, subsequent calls to startPolling with the same source ID will do nothing.

Declaration

Objective-C

- (void)startPollingSourceWithId:(nonnull NSString *)identifier
                    clientSecret:(nonnull NSString *)secret
                         timeout:(NSTimeInterval)timeout
                      completion:(nonnull STPSourceCompletionBlock)completion;

Swift

func startPollingSource(withId identifier: String, clientSecret secret: String, timeout: TimeInterval, completion: @escaping STPSourceCompletionBlock)

Parameters

`identifier`	The identifier of the source to be retrieved. Cannot be nil.
`secret`	The client secret of the source. Cannot be nil.
`timeout`	The timeout for the polling operation, in seconds. Timeouts are capped at 5 minutes.
`completion`	The callback to run with the returned Source object, or an error.

Show on GitHub


                    
                    
                    -stopPollingSourceWithId:

Deprecated

Stops polling the Source object with the given ID. Note that the completion block passed to startPolling will not be fired when stopPolling is called.

Declaration

Objective-C

- (void)stopPollingSourceWithId:(nonnull NSString *)identifier;

Swift

func stopPollingSource(withId identifier: String)

Parameters


                                identifier

The identifier of the source to be retrieved. Cannot be nil.

Show on GitHub

PaymentIntents


                    
                    
                    -retrievePaymentIntentWithClientSecret:completion:

Retrieves the PaymentIntent object using the given secret. - see: https://stripe.com/docs/api#retrieve_payment_intent

Declaration

Objective-C

- (void)retrievePaymentIntentWithClientSecret:(nonnull NSString *)secret
                                   completion:
                                       (nonnull STPPaymentIntentCompletionBlock)
                                           completion;

Swift

func retrievePaymentIntent(withClientSecret secret: String, completion: @escaping STPPaymentIntentCompletionBlock)

Parameters

`secret`	The client secret of the payment intent to be retrieved. Cannot be nil.
`completion`	The callback to run with the returned PaymentIntent object, or an error.

Show on GitHub


                    
                    
                    -confirmPaymentIntentWithParams:completion:

Confirms the PaymentIntent object with the provided params object.

At a minimum, the params object must include the clientSecret.

See

https://stripe.com/docs/api#confirm_payment_intent

Note

Use the confirmPayment:withAuthenticationContext:completion: method on STPPaymentHandler instead of calling this method directly. It handles any authentication necessary for you. - see: https://stripe.com/docs/mobile/ios/authentication

Declaration

Objective-C

- (void)confirmPaymentIntentWithParams:
            (nonnull STPPaymentIntentParams *)paymentIntentParams
                            completion:(nonnull STPPaymentIntentCompletionBlock)
                                           completion;

Swift

func confirmPaymentIntent(with paymentIntentParams: STPPaymentIntentParams, completion: @escaping STPPaymentIntentCompletionBlock)

Parameters

`paymentIntentParams`	The `STPPaymentIntentParams` to pass to `/confirm`
`completion`	The callback to run with the returned PaymentIntent object, or an error.

Show on GitHub

SetupIntents


                    
                    
                    -retrieveSetupIntentWithClientSecret:completion:

Retrieves the SetupIntent object using the given secret. - see: https://stripe.com/docs/api/setup_intents/retrieve

Declaration

Objective-C

- (void)retrieveSetupIntentWithClientSecret:(nonnull NSString *)secret
                                 completion:
                                     (nonnull STPSetupIntentCompletionBlock)
                                         completion;

Swift

func retrieveSetupIntent(withClientSecret secret: String, completion: @escaping STPSetupIntentCompletionBlock)

Parameters

`secret`	The client secret of the SetupIntent to be retrieved. Cannot be nil.
`completion`	The callback to run with the returned SetupIntent object, or an error.

Show on GitHub


                    
                    
                    -confirmSetupIntentWithParams:completion:

Confirms the SetupIntent object with the provided params object.

At a minimum, the params object must include the clientSecret.

See

https://stripe.com/docs/api/setup_intents/confirm

Note

Use the confirmSetupIntent:withAuthenticationContext:completion: method on STPPaymentHandler instead of calling this method directly. It handles any authentication necessary for you. - see: https://stripe.com/docs/mobile/ios/authentication

Declaration

Objective-C

- (void)confirmSetupIntentWithParams:
            (nonnull STPSetupIntentConfirmParams *)setupIntentParams
                          completion:
                              (nonnull STPSetupIntentCompletionBlock)completion;

Swift

func confirmSetupIntent(with setupIntentParams: STPSetupIntentConfirmParams, completion: @escaping STPSetupIntentCompletionBlock)

Parameters

`setupIntentParams`	The `STPSetupIntentConfirmParams` to pass to `/confirm`
`completion`	The callback to run with the returned PaymentIntent object, or an error.

Show on GitHub

PaymentMethods


                    
                    
                    -createPaymentMethodWithParams:completion:

Creates a PaymentMethod object with the provided params object.

See

https://stripe.com/docs/api/payment_methods/create

Declaration

Objective-C

- (void)createPaymentMethodWithParams:
            (nonnull STPPaymentMethodParams *)paymentMethodParams
                           completion:(nonnull STPPaymentMethodCompletionBlock)
                                          completion;

Swift

func createPaymentMethod(with paymentMethodParams: STPPaymentMethodParams, completion: @escaping STPPaymentMethodCompletionBlock)

Parameters

`paymentMethodParams`	The `STPPaymentMethodParams` to pass to `/v1/payment_methods`. Cannot be nil.
`completion`	The callback to run with the returned PaymentMethod object, or an error.

Show on GitHub

Deprecated


                    
                    
                    -initWithConfiguration:

Deprecated

This initializer previously configured publishableKey and stripeAccount via the STPPaymentConfiguration instance. This behavior is deprecated; set the STPAPIClient configuration, publishableKey, and stripeAccount properties directly on the STPAPIClient instead.

Initializes an API client with the given configuration.

Declaration

Objective-C

- (nonnull instancetype)initWithConfiguration:
    (nonnull STPPaymentConfiguration *)configuration;

Swift

init(configuration: STPPaymentConfiguration)

Parameters


                                configuration

The configuration to use.

Return Value

An instance of STPAPIClient.

Show on GitHub