SCPRefundParametersBuilder

Objective-C


@interface SCPRefundParametersBuilder : SCPBuilder <SCPRefundParameters *>

Swift

class RefundParametersBuilder : SCPBuilder<RefundParameters>

Builder class for SCPRefundParameters.

  • Initializes SCPRefundParametersBuilder 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 SCPRefundParametersBuilder 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

    SCPRefundParameters.chargeId

    Declaration

    Objective-C

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

    Swift

    func setChargeId(_ chargeId: String) -> RefundParametersBuilder

  • See

    SCPRefundParameters.paymentIntentId

    Declaration

    Objective-C

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

    Swift

    func setPaymentIntentId(_ paymentIntentId: String) -> RefundParametersBuilder

  • See

    SCPRefundParameters.clientSecret

    Declaration

    Objective-C

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

    Swift

    func setClientSecret(_ clientSecret: String) -> RefundParametersBuilder

  • See

    SCPRefundParameters.amount

    Declaration

    Objective-C

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

    Swift

    func setAmount(_ amount: UInt) -> RefundParametersBuilder

  • See

    SCPRefundParameters.currency

    Declaration

    Objective-C

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

    Swift

    func setCurrency(_ currency: String) -> RefundParametersBuilder

  • See

    SCPRefundParameters.metadata

    Declaration

    Objective-C

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

    Swift

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

  • See

    SCPRefundParameters.reverseTransfer

    Declaration

    Objective-C

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

    Swift

    func setReverseTransfer(_ reverseTransfer: Bool) -> RefundParametersBuilder

  • See

    SCPRefundParameters.refundApplicationFee

    Declaration

    Objective-C

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

    Swift

    func setRefundApplicationFee(_ refundApplicationFee: Bool) -> RefundParametersBuilder

  • 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;