SCPPaymentMethod

Objective-C


@interface SCPPaymentMethod : NSObject <SCPJSONDecodable>

Swift

class PaymentMethod : NSObject, JSONDecodable

PaymentMethod objects represent your customer’s payment instruments. They can be used with PaymentIntents to collect payments, or saved to Customer objects to store instrument details for future payments.

See

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

See

https://stripe.com/docs/payments/payment-methods/saving#attach-method

  • The unique identifier for the PaymentMethod

    Declaration

    Objective-C

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

    Swift

    var stripeId: String { get }

  • Time at which the object was created. Measured in seconds since the Unix epoch.

    Declaration

    Objective-C

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

    Swift

    var created: Date? { get }

  • The type of the PaymentMethod. The corresponding, similarly named property contains additional information specific to the PaymentMethod type. e.g. if the type is SCPPaymentMethodTypeCard, the card property is also populated.

    Declaration

    Objective-C

    @property (nonatomic, readonly) SCPPaymentMethodType type;

    Swift

    var type: PaymentMethodType { get }

  • If this is a card PaymentMethod (ie self.type == SCPPaymentMethodTypeCard), this contains additional details.

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) SCPCardDetails *card;

    Swift

    var card: SCPCardDetails? { get }

  • If this is a card_present PaymentMethod (ie self.type == SCPPaymentMethodTypeCardPresent), this contains additional details.

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) SCPCardPresentDetails *cardPresent;

    Swift

    var cardPresent: SCPCardPresentDetails? { get }

  • If this is an Interac_present PaymentMethod (ie self.type == SCPPaymentMethodTypeInteracPresent), this contains additional details.

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) SCPCardPresentDetails *interacPresent;

    Swift

    var interacPresent: SCPCardPresentDetails? { get }

  • If this is a wechat_pay PaymentMethod (ie self.type == SCPPaymentMethodTypeWechatPay), this contains additional details.

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) SCPWechatPayDetails *wechatPay;

    Swift

    var wechatPay: SCPWechatPayDetails? { get }

  • If this is a affirm PaymentMethod (ie self.type == SCPPaymentMethodTypeAffirm), this contains additional details.

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) SCPAffirmDetails *affirm;

    Swift

    var affirm: SCPAffirmDetails? { get }

  • The Customer that this PaymentMethod is attached to, or nil.

    Declaration

    Objective-C

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

    Swift

    var customer: String? { get }

  • Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

    See

    https://stripe.com/docs/api#metadata

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSDictionary<NSString *, NSString *> *_Nonnull metadata;

    Swift

    var metadata: [String : String] { get }

  • Unavailable

    You cannot directly instantiate this class.

    Declaration

    Objective-C

    - (nonnull instancetype)init;

  • Unavailable

    You cannot directly instantiate this class.

    Declaration

    Objective-C

    + (nonnull instancetype)new;