SCPConfirmRefundParameters

Objective-C


@interface SCPConfirmRefundParameters : NSObject

Swift

class ConfirmRefundParameters : NSObject

Parameters for confirming a refund without collecting a payment method.

Note

This feature is in private preview and is subject to change.

See

https://docs.stripe.com/api/refunds/create

  • The ID of the PaymentIntent to refund.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly) NSString *_Nonnull paymentIntentId;

    Swift

    var paymentIntentId: String { get }

  • The client secret for the PaymentIntent.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly) NSString *_Nonnull clientSecret;

    Swift

    var clientSecret: String { get }

  • The amount to refund, in the currency’s smallest unit.

    If omitted, the entire remaining refundable amount is refunded.

    Declaration

    Objective-C

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

    Swift

    var amount: NSNumber? { get }

  • The reason for the refund.

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) SCPRefundReason reason;

    Swift

    var reason: RefundReason? { get }

  • Set of key-value pairs to attach to the Refund.

    See

    https://docs.stripe.com/api/refunds/create#create_refund-metadata

    Declaration

    Objective-C

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

    Swift

    var metadata: [String : String]? { get }

  • Connect only: Whether to reverse the transfer when refunding this payment.

    This nullable NSNumber represents a nullable Boolean. A value of 0 represents false, while any non-zero value represents true.

    Declaration

    Objective-C

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

    Swift

    var reverseTransfer: NSNumber? { get }

  • Connect only: Whether to refund the application fee when refunding this payment.

    This nullable NSNumber represents a nullable Boolean. A value of 0 represents false, while any non-zero value represents true.

    Declaration

    Objective-C

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

    Swift

    var refundApplicationFee: NSNumber? { get }

  • Email address to send refund instructions to.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly, nullable) NSString *instructionsEmail;

    Swift

    var instructionsEmail: String? { get }

  • Unavailable

    Use SCPConfirmRefundParametersBuilder.

    Declaration

    Objective-C

    - (nonnull instancetype)init;

  • Unavailable

    Use SCPConfirmRefundParametersBuilder.

    Declaration

    Objective-C

    + (nonnull instancetype)new;