STPSetupIntent
@interface STPSetupIntent : NSObject <STPAPIResponseDecodable>
A SetupIntent guides you through the process of setting up a customer’s payment credentials for future payments.
-
The Stripe ID of the SetupIntent.
Declaration
Objective-C
@property (readonly, nonatomic) NSString *_Nonnull stripeID;
Swift
var stripeID: String { get }
-
The client secret of this SetupIntent. Used for client-side retrieval using a publishable key.
Declaration
Objective-C
@property (readonly, nonatomic) NSString *_Nonnull clientSecret;
Swift
var clientSecret: String { get }
-
Time at which the object was created.
Declaration
Objective-C
@property (readonly, nonatomic) NSDate *_Nonnull created;
Swift
var created: Date { get }
-
ID of the Customer this SetupIntent belongs to, if one exists.
Declaration
Objective-C
@property (readonly, nonatomic, nullable) NSString *customerID;
Swift
var customerID: String? { get }
-
An arbitrary string attached to the object. Often useful for displaying to users.
Declaration
Objective-C
@property (readonly, nonatomic, nullable) NSString *stripeDescription;
Swift
var stripeDescription: String? { get }
-
Has the value
YES
if the object exists in live mode or the valueNO
if the object exists in test mode.Declaration
Objective-C
@property (readonly, nonatomic) BOOL livemode;
Swift
var livemode: Bool { get }
-
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
Declaration
Objective-C
@property (readonly, nonatomic, nullable) NSDictionary<NSString *, NSString *> *metadata;
Swift
var metadata: [String : String]? { get }
-
If present, this property tells you what actions you need to take in order for your customer to set up this payment method.
Declaration
Objective-C
@property (readonly, nonatomic, nullable) STPIntentAction *nextAction;
Swift
var nextAction: STPIntentAction? { get }
-
ID of the payment method used with this SetupIntent.
Declaration
Objective-C
@property (readonly, nonatomic, nullable) NSString *paymentMethodID;
Swift
var paymentMethodID: String? { get }
-
The list of payment method types (e.g.
@[@(STPPaymentMethodTypeCard)]
) that this SetupIntent is allowed to set up.Declaration
Objective-C
@property (readonly, nonatomic) NSArray<NSNumber *> *_Nonnull paymentMethodTypes;
Swift
var paymentMethodTypes: [NSNumber] { get }
-
Status of this SetupIntent.
Declaration
Objective-C
@property (readonly, nonatomic) STPSetupIntentStatus status;
Swift
var status: STPSetupIntentStatus { get }
-
Indicates how the payment method is intended to be used in the future.
Declaration
Objective-C
@property (readonly, nonatomic) STPSetupIntentUsage usage;
Swift
var usage: STPSetupIntentUsage { get }
-
The setup error encountered in the previous SetupIntent confirmation.
Declaration
Objective-C
@property (readonly, nonatomic, nullable) STPSetupIntentLastSetupError *lastSetupError;
Swift
var lastSetupError: STPSetupIntentLastSetupError? { get }