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.

https://stripe.com/docs/api/payment_intents

  • 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.

    See

    https://stripe.com/docs/currencies#zero-decimal

    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 }

  • Charges that were created by this PaymentIntent, if any.

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSArray<SCPCharge *> *_Nonnull charges;

    Swift

    var charges: [SCPCharge] { 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;