SCPRefundParameters

Objective-C


@interface SCPRefundParameters : NSObject

Swift

class RefundParameters : NSObject

Parameters for creating an SCPRefund.

See

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

  • The ID of the payment intent to be refunded.

    Declaration

    Objective-C

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

    Swift

    var paymentIntentId: String? { get }

  • The ID of the charge to be refunded.

    Declaration

    Objective-C

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

    Swift

    var chargeId: String? { get }

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

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSUInteger amount;

    Swift

    var amount: UInt { get }

  • Three-letter ISO currency code. Must be a supported currency.

    Declaration

    Objective-C

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

    Swift

    var currency: 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.

    Note

    The metadata property is not set when issuing refunds with the Verifone P400 reader.

    See

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

    Declaration

    Objective-C

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

    Swift

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

  • Connect only: Nullable boolean indicating whether the transfer should be reversed when refunding this charge. The transfer will be reversed proportionally to the amount being refunded (either the entire or partial amount).

    Note

    This property is a nullable NSNumber being used to represent a nullable boolean. A value of 0 represents false, while any non-zero value represents true.

    See

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

    Declaration

    Objective-C

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

    Swift

    var reverseTransfer: NSNumber? { get }

  • Connect only: Nullable boolean indicating whether the application fee should be refunded when refunding this charge. If a full charge refund is given, the full application fee will be refunded. Otherwise, the application fee will be refunded in an amount proportional to the amount of the charge refunded.

    Note

    This property is a nullable NSNumber being used to represent a nullable boolean. A value of 0 represents false, while any non-zero value represents true.

    See

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

    Declaration

    Objective-C

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

    Swift

    var refundApplicationFee: NSNumber? { get }

  • Unavailable

    Use SCPRefundParametersBuilder

    Declaration

    Objective-C

    - (nonnull instancetype)init;

  • Unavailable

    Use SCPRefundParametersBuilder

    Declaration

    Objective-C

    + (nonnull instancetype)new;