SCPCharge

Objective-C


@interface SCPCharge : NSObject <SCPJSONDecodable>

Swift

class Charge : NSObject, JSONDecodable

An object representing a Stripe charge.

See

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

  • The amount of the charge.

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSUInteger amount;

    Swift

    var amount: UInt { get }

  • The currency of the charge.

    Declaration

    Objective-C

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

    Swift

    var currency: String { get }

  • The status of the charge.

    Declaration

    Objective-C

    @property (nonatomic, readonly) SCPChargeStatus status;

    Swift

    var status: ChargeStatus { get }

  • The payment method details associated with the charge.

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) SCPPaymentMethodDetails *paymentMethodDetails;

    Swift

    var paymentMethodDetails: SCPPaymentMethodDetails? { get }

  • A string describing the charge, displayed in the Stripe dashboard and in email receipts.

    Declaration

    Objective-C

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

    Swift

    var stripeDescription: String? { get }

  • Metadata associated with the charge.

    See

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

    Declaration

    Objective-C

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

    Swift

    var metadata: [String : String] { get }

  • The unique identifier for the charge.

    Declaration

    Objective-C

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

    Swift

    var stripeId: String { get }

  • Extra dynamic information about a Charge. This will appear concatenated with the statementDescriptor on your customer’s credit card’s statement.

    Declaration

    Objective-C

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

    Swift

    var statementDescriptorSuffix: String? { get }

  • The full statement descriptor that is displayed on your customer’s credit card’s statement, after the static statementDescriptor and dynamic statementDescriptorSuffix portions are combined.

    Declaration

    Objective-C

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

    Swift

    var calculatedStatementDescriptor: String? { get }

  • 6 digit authorization code for this charge.

    Declaration

    Objective-C

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

    Swift

    var authorizationCode: 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;