STPPaymentIntent
@interface STPPaymentIntent : NSObject <STPAPIResponseDecodable>
A PaymentIntent tracks the process of collecting a payment from your customer.
-
Unavailable
You cannot directly instantiate an STPPaymentIntent. You should only use one that has been returned from an STPAPIClient callback.
You cannot directly instantiate an
STPPaymentIntent
. You should only use one that has been returned from anSTPAPIClient
callback.Declaration
Objective-C
- (nonnull instancetype)init;
-
The Stripe ID of the PaymentIntent.
Declaration
Objective-C
@property (nonatomic, readonly) NSString *_Nonnull stripeId;
Swift
var stripeId: String { get }
-
The client secret used to fetch this PaymentIntent
Declaration
Objective-C
@property (nonatomic, readonly) NSString *_Nonnull clientSecret;
Swift
var clientSecret: String { get }
-
Amount intended to be collected by this PaymentIntent.
Declaration
Objective-C
@property (nonatomic, readonly) NSNumber *_Nonnull amount;
Swift
var amount: NSNumber { get }
-
If status is
STPPaymentIntentStatusCanceled
, when the PaymentIntent was canceled.Declaration
Objective-C
@property (nonatomic, readonly, nullable) NSDate *canceledAt;
Swift
var canceledAt: Date? { get }
-
Capture method of this PaymentIntent
Declaration
Objective-C
@property (nonatomic, readonly) STPPaymentIntentCaptureMethod captureMethod;
Swift
var captureMethod: STPPaymentIntentCaptureMethod { get }
-
Confirmation method of this PaymentIntent
Declaration
Objective-C
@property (nonatomic, readonly) STPPaymentIntentConfirmationMethod confirmationMethod;
Swift
var confirmationMethod: STPPaymentIntentConfirmationMethod { get }
-
When the PaymentIntent was created.
Declaration
Objective-C
@property (nonatomic, readonly, nullable) NSDate *created;
Swift
var created: Date? { get }
-
The currency associated with the PaymentIntent.
Declaration
Objective-C
@property (nonatomic, readonly) NSString *_Nonnull currency;
Swift
var currency: String { get }
-
The
description
field of the PaymentIntent. An arbitrary string attached to the object. Often useful for displaying to users.Declaration
Objective-C
@property (nonatomic, readonly, nullable) NSString *stripeDescription;
Swift
var stripeDescription: String? { get }
-
Whether or not this PaymentIntent was created in livemode.
Declaration
Objective-C
@property (nonatomic, readonly) BOOL livemode;
Swift
var livemode: Bool { get }
-
If
status == STPPaymentIntentStatusRequiresAction
, this property contains the next action to take for this PaymentIntent.Declaration
Objective-C
@property (nonatomic, readonly, nullable) STPPaymentIntentAction *nextAction;
Swift
var nextAction: STPPaymentIntentAction? { get }
-
Email address that the receipt for the resulting payment will be sent to.
Declaration
Objective-C
@property (nonatomic, readonly, nullable) NSString *receiptEmail;
Swift
var receiptEmail: String? { get }
-
The Stripe ID of the Source used in this PaymentIntent.
Declaration
Objective-C
@property (nonatomic, readonly, nullable) NSString *sourceId;
Swift
var sourceId: String? { get }
-
The Stripe ID of the PaymentMethod used in this PaymentIntent.
Declaration
Objective-C
@property (nonatomic, readonly, nullable) NSString *paymentMethodId;
Swift
var paymentMethodId: String? { get }
-
Status of the PaymentIntent
Declaration
Objective-C
@property (nonatomic, readonly) STPPaymentIntentStatus status;
Swift
var status: STPPaymentIntentStatus { get }
-
The list of payment method types (e.g.
@[@(STPPaymentMethodTypeCard)]
) that this PaymentIntent is allowed to use.Declaration
Objective-C
@property (nonatomic, readonly, nullable) NSArray<NSNumber *> *paymentMethodTypes;
Swift
var paymentMethodTypes: [NSNumber]? { get }
-
Deprecated
Use nextAction instead
If
status == STPPaymentIntentStatusRequiresAction
, this property contains the next source action to take for this PaymentIntent.@deprecated Use nextAction instead
Declaration
Objective-C
@property (nonatomic, readonly, nullable) STPPaymentIntentAction *nextSourceAction;
Swift
var nextSourceAction: STPPaymentIntentAction? { get }