SCPPaymentIntent
Objective-C
@interface SCPPaymentIntent : NSObject <SCPJSONDecodable, NSCopying>
Swift
class PaymentIntent : NSObject, JSONDecodable, NSCopying
A PaymentIntent tracks the process of collecting a payment from your customer. We recommend that you create exactly one PaymentIntent for each order or customer session in your system. You can reference the PaymentIntent later to see the history of payment attempts for a particular session.
A PaymentIntent transitions through multiple statuses throughout its lifetime and ultimately creates at most one successful charge.
-
The unique identifier for the intent.
Declaration
Objective-C
@property (nonatomic, readonly) NSString *_Nonnull stripeId;
Swift
var stripeId: String { get }
-
When the intent was created.
Declaration
Objective-C
@property (nonatomic, readonly) NSDate *_Nonnull created;
Swift
var created: Date { get }
-
The status of the PaymentIntent.
Declaration
Objective-C
@property (nonatomic, readonly) SCPPaymentIntentStatus status;
Swift
var status: PaymentIntentStatus { get }
-
The amount to be collected by this PaymentIntent, provided in the currency’s smallest unit.
Declaration
Objective-C
@property (nonatomic, readonly) NSUInteger amount;
Swift
var amount: UInt { get }
-
The currency of the payment.
Declaration
Objective-C
@property (nonatomic, readonly) NSString *_Nonnull currency;
Swift
var currency: String { get }
-
Set of key-value pairs attached to the object.
Declaration
Objective-C
@property (nonatomic, readonly, nullable) NSDictionary *metadata;
Swift
var metadata: [AnyHashable : Any]? { get }
-
Unavailable
You cannot directly instantiate
SCPPaymentIntent
. You should only use one that has been returned by our SDK.Declaration
Objective-C
- (nonnull instancetype)init;
-
Unavailable
You cannot directly instantiate
SCPPaymentIntent
. You should only use one that has been returned by our SDK.Declaration
Objective-C
+ (nonnull instancetype)new;