SCPRefundParameters
Objective-C
@interface SCPRefundParameters : NSObject
Swift
class RefundParameters : NSObject
Parameters for creating an SCPRefund
.
-
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.
Declaration
Objective-C
@property (nonatomic, copy, nullable) NSDictionary *metadata;
Swift
var metadata: [AnyHashable : Any]? { get set }
-
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 representstrue
.Declaration
Objective-C
@property (nonatomic, nullable) NSNumber *reverseTransfer;
Swift
var reverseTransfer: NSNumber? { get set }
-
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 representstrue
.Declaration
Objective-C
@property (nonatomic, nullable) NSNumber *refundApplicationFee;
Swift
var refundApplicationFee: NSNumber? { get set }
-
Initializes
SCPRefundParameters
with the given charge, amount, and currency.Declaration
Objective-C
- (nonnull instancetype)initWithChargeId:(nonnull NSString *)chargeId amount:(NSUInteger)amount currency:(nonnull NSString *)currency;
Swift
init(chargeId: String, amount: UInt, currency: String)
Parameters
chargeId
The ID of the charge to be refunded.
amount
The amount to be refunded, provided in the currency’s smallest unit.
currency
The currency of the original charge. You cannot refund a charge with a different currency than the currency that was used to create the charge.
-
Unavailable
Use
initWithChargeId:amount:currency:
Declaration
Objective-C
- (nonnull instancetype)init;
-
Unavailable
Use
initWithChargeId:amount:currency:
Declaration
Objective-C
+ (nonnull instancetype)new;