STPPaymentIntent
public class STPPaymentIntent : NSObject
extension STPPaymentIntent: STPAPIResponseDecodable
A PaymentIntent tracks the process of collecting a payment from your customer.
-
The Stripe ID of the PaymentIntent.
Declaration
Swift
@objc public let stripeId: String
-
The client secret used to fetch this PaymentIntent
Declaration
Swift
@objc public let clientSecret: String
-
Amount intended to be collected by this PaymentIntent.
Declaration
Swift
@objc public let amount: Int
-
If status is
.canceled
, when the PaymentIntent was canceled.Declaration
Swift
@objc public let canceledAt: Date?
-
Capture method of this PaymentIntent
Declaration
Swift
@objc public let captureMethod: STPPaymentIntentCaptureMethod
-
Confirmation method of this PaymentIntent
Declaration
Swift
@objc public let confirmationMethod: STPPaymentIntentConfirmationMethod
-
When the PaymentIntent was created.
Declaration
Swift
@objc public let created: Date
-
The currency associated with the PaymentIntent.
Declaration
Swift
@objc public let currency: String
-
The
description
field of the PaymentIntent. An arbitrary string attached to the object. Often useful for displaying to users.Declaration
Swift
@objc public let stripeDescription: String?
-
Whether or not this PaymentIntent was created in livemode.
Declaration
Swift
@objc public let livemode: Bool
-
If
status == .requiresAction
, this property contains the next action to take for this PaymentIntent.Declaration
Swift
@objc public let nextAction: STPIntentAction?
-
Email address that the receipt for the resulting payment will be sent to.
Declaration
Swift
@objc public let receiptEmail: String?
-
The Stripe ID of the Source used in this PaymentIntent.
Declaration
Swift
@objc public let sourceId: String?
-
The Stripe ID of the PaymentMethod used in this PaymentIntent.
Declaration
Swift
@objc public let paymentMethodId: String?
-
Status of the PaymentIntent
Declaration
Swift
@objc public let status: STPPaymentIntentStatus
-
The list of payment method types (e.g.
[NSNumber(value: STPPaymentMethodType.card.rawValue)]
) that this PaymentIntent is allowed to use.Declaration
Swift
@objc public let paymentMethodTypes: [NSNumber]
-
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
Swift
@objc public let setupFutureUsage: STPPaymentIntentSetupFutureUsage
-
The payment error encountered in the previous PaymentIntent confirmation.
Declaration
Swift
@objc public let lastPaymentError: STPPaymentIntentLastPaymentError?
-
Shipping information for this PaymentIntent.
Declaration
Swift
@objc public let shipping: STPPaymentIntentShippingDetails?
-
Declaration
Swift
@objc public let allResponseFields: [AnyHashable : Any]
-
Declaration
Swift
@objc public class func decodedObject(fromAPIResponse response: [AnyHashable : Any]?) -> `Self`?
-
If
status == STPPaymentIntentStatusRequiresAction
, this property contains the next source action to take for this PaymentIntent. @deprecated Use nextAction insteadDeclaration
Swift
@available(*, deprecated, renamed: "nextAction", message: "Use nextAction instead") @objc public var nextSourceAction: STPIntentAction? { get }