SCPCharge

Objective-C


@interface SCPCharge : NSObject

Swift

class Charge : NSObject

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 }

  • Amount in cents refunded (can be less than the amount attribute on the charge if a partial refund was issued).

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSUInteger amountRefunded;

    Swift

    var amountRefunded: UInt { 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 }

  • Whether the charge has been captured.

    Declaration

    Objective-C

    @property (nonatomic, readonly) BOOL captured;

    Swift

    var captured: Bool { get }

  • Whether the charge succeeded.

    Declaration

    Objective-C

    @property (nonatomic, readonly) BOOL paid;

    Swift

    var paid: Bool { get }

  • Whether the charge has been fully refunded. If the charge is only partially refunded, this attribute will still be false.

    Declaration

    Objective-C

    @property (nonatomic, readonly) BOOL refunded;

    Swift

    var refunded: Bool { get }

  • ID of the customer this charge is for if one exists.

    Declaration

    Objective-C

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

    Swift

    var customer: String? { get }

  • ID of the PaymentIntent associated with this charge, if one exists.

    Declaration

    Objective-C

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

    Swift

    var paymentIntentId: String? { get }

  • This is the email address that the receipt for this charge was sent to.

    Declaration

    Objective-C

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

    Swift

    var receiptEmail: String? { get }

  • This is the transaction number that appears on email receipts sent for this charge.

    Declaration

    Objective-C

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

    Swift

    var receiptNumber: String? { get }

  • This is the URL to view the receipt for this charge.

    Declaration

    Objective-C

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

    Swift

    var receiptUrl: String? { get }

  • ID of the balance transaction that describes the impact of this charge on your account balance.

    Declaration

    Objective-C

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

    Swift

    var balanceTransaction: String? { get }

  • The application fee (if any) for the charge.

    Declaration

    Objective-C

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

    Swift

    var applicationFee: String? { get }

  • The amount of the application fee (if any) requested for the charge.

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) NSNumber *applicationFeeAmount;

    Swift

    var applicationFeeAmount: NSNumber? { get }

  • The account (if any) the charge was made on behalf of without triggering an automatic transfer.

    Declaration

    Objective-C

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

    Swift

    var onBehalfOf: String? { get }

  • Whether the charge was created in live mode or test mode.

    Declaration

    Objective-C

    @property (nonatomic, readonly) BOOL livemode;

    Swift

    var livemode: Bool { get }

  • Details of the original PaymentMethod that created this object.

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) SCPGeneratedFrom *generatedFrom;

    Swift

    var generatedFrom: SCPGeneratedFrom? { 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;