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 an STPAPIClient callback.

    Declaration

    Objective-C

    - (nonnull instancetype)init;
  • The Stripe ID of the PaymentIntent.

    Declaration

    Objective-C

    @property (readonly, nonatomic) NSString *_Nonnull stripeId;

    Swift

    var stripeId: String { get }
  • The client secret used to fetch this PaymentIntent

    Declaration

    Objective-C

    @property (readonly, nonatomic) NSString *_Nonnull clientSecret;

    Swift

    var clientSecret: String { get }
  • Amount intended to be collected by this PaymentIntent.

    Declaration

    Objective-C

    @property (readonly, nonatomic) NSNumber *_Nonnull amount;

    Swift

    var amount: NSNumber { get }
  • If status is STPPaymentIntentStatusCanceled, when the PaymentIntent was canceled.

    Declaration

    Objective-C

    @property (readonly, nonatomic, nullable) NSDate *canceledAt;

    Swift

    var canceledAt: Date? { get }
  • Capture method of this PaymentIntent

    Declaration

    Objective-C

    @property (readonly, nonatomic) STPPaymentIntentCaptureMethod captureMethod;

    Swift

    var captureMethod: STPPaymentIntentCaptureMethod { get }
  • Confirmation method of this PaymentIntent

    Declaration

    Objective-C

    @property (readonly, nonatomic)
        STPPaymentIntentConfirmationMethod confirmationMethod;

    Swift

    var confirmationMethod: STPPaymentIntentConfirmationMethod { get }
  • When the PaymentIntent was created.

    Declaration

    Objective-C

    @property (readonly, nonatomic, nullable) NSDate *created;

    Swift

    var created: Date? { get }
  • The currency associated with the PaymentIntent.

    Declaration

    Objective-C

    @property (readonly, nonatomic) 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 (readonly, nonatomic, nullable) NSString *stripeDescription;

    Swift

    var stripeDescription: String? { get }
  • Whether or not this PaymentIntent was created in livemode.

    Declaration

    Objective-C

    @property (readonly, nonatomic) 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 (readonly, nonatomic, nullable) STPIntentAction *nextAction;

    Swift

    var nextAction: STPIntentAction? { get }
  • Email address that the receipt for the resulting payment will be sent to.

    Declaration

    Objective-C

    @property (readonly, nonatomic, nullable) NSString *receiptEmail;

    Swift

    var receiptEmail: String? { get }
  • The Stripe ID of the Source used in this PaymentIntent.

    Declaration

    Objective-C

    @property (readonly, nonatomic, nullable) NSString *sourceId;

    Swift

    var sourceId: String? { get }
  • The Stripe ID of the PaymentMethod used in this PaymentIntent.

    Declaration

    Objective-C

    @property (readonly, nonatomic, nullable) NSString *paymentMethodId;

    Swift

    var paymentMethodId: String? { get }
  • Status of the PaymentIntent

    Declaration

    Objective-C

    @property (readonly, nonatomic) 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 (readonly, nonatomic, nullable)
        NSArray<NSNumber *> *paymentMethodTypes;

    Swift

    var paymentMethodTypes: [NSNumber]? { get }
  • When provided, this property indicates how you intend to use the payment method that your customer provides after the current payment completes. If applicable, additional authentication may be performed to comply with regional legislation or network rules required to enable the usage of the same payment method for additional payments. Use on_session if you intend to only reuse the payment method when the customer is in your checkout flow. Use off_session if your customer may or may not be in your checkout flow.

    Declaration

    Objective-C

    @property (readonly, nonatomic)
        STPPaymentIntentSetupFutureUsage setupFutureUsage;

    Swift

    var setupFutureUsage: STPPaymentIntentSetupFutureUsage { get }
  • The payment error encountered in the previous PaymentIntent confirmation.

    Declaration

    Objective-C

    @property (readonly, nonatomic, nullable)
        STPPaymentIntentLastPaymentError *lastPaymentError;

    Swift

    var lastPaymentError: STPPaymentIntentLastPaymentError? { 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 (readonly, nonatomic, nullable) STPIntentAction *nextSourceAction;

    Swift

    var nextSourceAction: STPIntentAction? { get }