View on GitHub
STPAPIClient Class Reference
STPAPIClient
@interface STPAPIClient : NSObjectA client for making connections to the Stripe API.
-
A shared singleton API client. Its API key will be initially equal to [Stripe defaultPublishableKey].
Declaration
Objective-C
+ (nonnull instancetype)sharedClient;Swift
class func shared() -> Self -
Initializes an API client with the given configuration. Its API key will be set to the configuration’s publishable key.
Declaration
Objective-C
- (nonnull instancetype)initWithConfiguration: (nonnull STPPaymentConfiguration *)configuration;Swift
init(configuration: STPPaymentConfiguration)Parameters
configurationThe configuration to use.
Return Value
An instance of STPAPIClient.
-
Initializes an API client with the given publishable key.
Declaration
Objective-C
- (nonnull instancetype)initWithPublishableKey: (nonnull NSString *)publishableKey;Swift
convenience init(publishableKey: String)Parameters
publishableKeyThe publishable key to use.
Return Value
An instance of STPAPIClient.
-
The client’s publishable key.
Declaration
Objective-C
@property (readwrite, copy, nonatomic, nullable) NSString *publishableKey;Swift
var publishableKey: String? { get set } -
The client’s configuration.
Declaration
Objective-C
@property (readwrite, copy, nonatomic) STPPaymentConfiguration *_Nonnull configuration;Swift
@NSCopying var configuration: STPPaymentConfiguration { get set } -
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.
Declaration
Objective-C
@property (readwrite, copy, nonatomic, nullable) NSString *stripeAccount;Swift
var stripeAccount: String? { get set } -
Libraries wrapping the Stripe SDK should set this, so that Stripe can contact you about future issues or critical updates.
Declaration
Objective-C
@property (assign, readwrite, nonatomic, nullable) STPAppInfo *appInfo;Swift
var appInfo: STPAppInfo? { get set }
-
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
paymentThe user’s encrypted payment information as returned from a PKPaymentAuthorizationViewController. Cannot be nil.
completionThe callback to run with the returned Stripe token (and any errors that may have occurred).
-
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
paymentThe user’s encrypted payment information as returned from a PKPaymentAuthorizationViewController. Cannot be nil.
completionThe callback to run with the returned Stripe source (and any errors that may have occurred).
-
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
paymentThe user’s encrypted payment information as returned from a PKPaymentAuthorizationViewController. Cannot be nil.
completionThe callback to run with the returned Stripe source (and any errors that may have occurred).
-
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
bankAccountThe user’s bank account details. Cannot be nil. - see: https://stripe.com/docs/api#create_bank_account_token
completionThe callback to run with the returned Stripe token (and any errors that may have occurred).
-
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
piiThe user’s personal identification number. Cannot be nil. - see: https://stripe.com/docs/api#create_pii_token
completionThe callback to run with the returned Stripe token (and any errors that may have occurred).
-
Converts an
STPConnectAccountParamsobject 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
accountThe Connect Account parameters. Cannot be nil.
completionThe callback to run with the returned Stripe token (and any errors that may have occurred).
-
Uses the Stripe file upload API to upload an image. This can be used for identity verification and evidence disputes.
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
imageThe 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
purposeThe purpose of this file. This can be either an identifing document or an evidence dispute.
completionThe callback to run with the returned Stripe file (and any errors that may have occurred).
-
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
cardThe user’s card details. Cannot be nil. - see: https://stripe.com/docs/api#create_card_token
completionThe callback to run with the returned Stripe token (and any errors that may have occurred).
-
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
cvcThe CVC/CVV number used to create the token. Cannot be nil.
completionThe callback to run with the returned Stripe token (and any errors that may have occurred).
-
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
stripeAccountproperty to the ID of the account.Declaration
Objective-C
- (void)createSourceWithParams:(nonnull STPSourceParams *)params completion:(nonnull STPSourceCompletionBlock)completion;Swift
func createSource(with params: STPSourceParams, completion: @escaping STPSourceCompletionBlock)Parameters
paramsThe details of the source to create. Cannot be nil. - see: https://stripe.com/docs/api#create_source
completionThe callback to run with the returned Source object, or an error.
-
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
identifierThe identifier of the source to be retrieved. Cannot be nil.
secretThe client secret of the source. Cannot be nil.
completionThe callback to run with the returned Source object, or an error.
-
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 stillpending. 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
startPollingwith 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
identifierThe identifier of the source to be retrieved. Cannot be nil.
secretThe client secret of the source. Cannot be nil.
timeoutThe timeout for the polling operation, in seconds. Timeouts are capped at 5 minutes.
completionThe callback to run with the returned Source object, or an error.
-
Deprecated
Stops polling the Source object with the given ID. Note that the completion block passed to
startPollingwill not be fired whenstopPollingis called.Declaration
Objective-C
- (void)stopPollingSourceWithId:(nonnull NSString *)identifier;Swift
func stopPollingSource(withId identifier: String)Parameters
identifierThe identifier of the source to be retrieved. Cannot be nil.
-
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
secretThe client secret of the payment intent to be retrieved. Cannot be nil.
completionThe callback to run with the returned PaymentIntent object, or an error.
-
Confirms the PaymentIntent object with the provided params object.
At a minimum, the params object must include the
clientSecret.Note
Use the
confirmPayment:withAuthenticationContext:completion:method onSTPPaymentHandlerinstead of calling this method directly. It handles any authentication necessary for you. - see: https://stripe.com/docs/mobile/ios/authenticationDeclaration
Objective-C
- (void)confirmPaymentIntentWithParams: (nonnull STPPaymentIntentParams *)paymentIntentParams completion:(nonnull STPPaymentIntentCompletionBlock) completion;Swift
func confirmPaymentIntent(with paymentIntentParams: STPPaymentIntentParams, completion: @escaping STPPaymentIntentCompletionBlock)Parameters
paymentIntentParamsThe
STPPaymentIntentParamsto pass to/confirmcompletionThe callback to run with the returned PaymentIntent object, or an error.
-
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
secretThe client secret of the SetupIntent to be retrieved. Cannot be nil.
completionThe callback to run with the returned SetupIntent object, or an error.
-
Confirms the SetupIntent object with the provided params object.
At a minimum, the params object must include the
clientSecret.Note
Use the
confirmSetupIntent:withAuthenticationContext:completion:method onSTPPaymentHandlerinstead of calling this method directly. It handles any authentication necessary for you. - see: https://stripe.com/docs/mobile/ios/authenticationDeclaration
Objective-C
- (void)confirmSetupIntentWithParams: (nonnull STPSetupIntentConfirmParams *)setupIntentParams completion: (nonnull STPSetupIntentCompletionBlock)completion;Swift
func confirmSetupIntent(with setupIntentParams: STPSetupIntentConfirmParams, completion: @escaping STPSetupIntentCompletionBlock)Parameters
setupIntentParamsThe
STPSetupIntentParamsto pass to/confirmcompletionThe callback to run with the returned PaymentIntent object, or an error.
-
Creates a PaymentMethod object with the provided params object.
Declaration
Objective-C
- (void)createPaymentMethodWithParams: (nonnull STPPaymentMethodParams *)paymentMethodParams completion:(nonnull STPPaymentMethodCompletionBlock) completion;Swift
func createPaymentMethod(with paymentMethodParams: STPPaymentMethodParams, completion: @escaping STPPaymentMethodCompletionBlock)Parameters
paymentMethodParamsThe
STPPaymentMethodParamsto pass to/v1/payment_methods. Cannot be nil.completionThe callback to run with the returned PaymentMethod object, or an error.