SCPProcessRefundParametersBuilder

Objective-C


@interface SCPProcessRefundParametersBuilder
    : SCPBuilder <SCPProcessRefundParameters *>

Swift

class ProcessRefundParametersBuilder : SCPBuilder<ProcessRefundParameters>

Builder class for SCPProcessRefundParameters.

  • Initializes SCPProcessRefundParametersBuilder with the given payment intent, client secret, amount, and currency.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithPaymentIntentId:
                            (nonnull NSString *)paymentIntentId
                                   clientSecret:(nonnull NSString *)clientSecret
                                         amount:(NSUInteger)amount
                                       currency:(nonnull NSString *)currency;

    Swift

    init(paymentIntentId: String, clientSecret: String, amount: UInt, currency: String)

    Parameters

    paymentIntentId

    The ID of the PaymentIntent to be refunded.
    clientSecret

    The client secret for the PaymentIntent.
    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.

  • Initializes SCPProcessRefundParametersBuilder 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.

  • See

    SCPProcessRefundParameters.chargeId

    Declaration

    Objective-C

    - (nonnull SCPProcessRefundParametersBuilder *)setChargeId:
    (nonnull NSString *)chargeId;

    Swift

    func setChargeId(_ chargeId: String) -> ProcessRefundParametersBuilder

  • See

    SCPProcessRefundParameters.paymentIntentId

    Declaration

    Objective-C

    - (nonnull SCPProcessRefundParametersBuilder *)setPaymentIntentId:
    (nonnull NSString *)paymentIntentId;

    Swift

    func setPaymentIntentId(_ paymentIntentId: String) -> ProcessRefundParametersBuilder

  • See

    SCPProcessRefundParameters.clientSecret

    Declaration

    Objective-C

    - (nonnull SCPProcessRefundParametersBuilder *)setClientSecret:
    (nonnull NSString *)clientSecret;

    Swift

    func setClientSecret(_ clientSecret: String) -> ProcessRefundParametersBuilder

  • See

    SCPProcessRefundParameters.amount

    Declaration

    Objective-C

    - (nonnull SCPProcessRefundParametersBuilder *)setAmount:(NSUInteger)amount;

    Swift

    func setAmount(_ amount: UInt) -> ProcessRefundParametersBuilder

  • See

    SCPProcessRefundParameters.currency

    Declaration

    Objective-C

    - (nonnull SCPProcessRefundParametersBuilder *)setCurrency:
    (nonnull NSString *)currency;

    Swift

    func setCurrency(_ currency: String) -> ProcessRefundParametersBuilder

  • See

    SCPProcessRefundParameters.metadata

    Declaration

    Objective-C

    - (nonnull SCPProcessRefundParametersBuilder *)setMetadata:
    (nullable NSDictionary<NSString *, NSString *> *)metadata;

    Swift

    func setMetadata(_ metadata: [String : String]?) -> ProcessRefundParametersBuilder

  • See

    SCPProcessRefundParameters.reverseTransfer

    Declaration

    Objective-C

    - (nonnull SCPProcessRefundParametersBuilder *)setReverseTransfer:
    (BOOL)reverseTransfer;

    Swift

    func setReverseTransfer(_ reverseTransfer: Bool) -> ProcessRefundParametersBuilder

  • See

    SCPProcessRefundParameters.refundApplicationFee

    Declaration

    Objective-C

    - (nonnull SCPProcessRefundParametersBuilder *)setRefundApplicationFee:
    (BOOL)refundApplicationFee;

    Swift

    func setRefundApplicationFee(_ refundApplicationFee: Bool) -> ProcessRefundParametersBuilder

  • Unavailable

    Use initWithChargeId:amount:currency: or initWithPaymentIntentId:clientSecret:amount:currency:

    Declaration

    Objective-C

    - (nonnull instancetype)init;

  • Unavailable

    Use initWithChargeId:amount:currency:

    Declaration

    Objective-C

    + (nonnull instancetype)new;