SCPConfirmRefundParametersBuilder

Objective-C


@interface SCPConfirmRefundParametersBuilder
    : SCPBuilder <SCPConfirmRefundParameters *>

Swift

class ConfirmRefundParametersBuilder : SCPBuilder<ConfirmRefundParameters>

Builder class for SCPConfirmRefundParameters.

  • Initializes the builder with the PaymentIntent to refund.

    Declaration

    Objective-C

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

    Swift

    init(paymentIntentId: String, clientSecret: String)

    Parameters

    paymentIntentId

    The ID of the PaymentIntent to refund.
    clientSecret

    The client secret for the PaymentIntent.

  • See

    SCPConfirmRefundParameters.amount

    Declaration

    Objective-C

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

    Swift

    func setAmount(_ amount: UInt) -> ConfirmRefundParametersBuilder

  • See

    SCPConfirmRefundParameters.reason

    Declaration

    Objective-C

    - (nonnull SCPConfirmRefundParametersBuilder *)setReason:
    (nullable SCPRefundReason)reason;

    Swift

    func setReason(_ reason: RefundReason?) -> ConfirmRefundParametersBuilder

  • See

    SCPConfirmRefundParameters.metadata

    Declaration

    Objective-C

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

    Swift

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

  • See

    SCPConfirmRefundParameters.reverseTransfer

    Declaration

    Objective-C

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

    Swift

    func setReverseTransfer(_ reverseTransfer: Bool) -> ConfirmRefundParametersBuilder

  • See

    SCPConfirmRefundParameters.refundApplicationFee

    Declaration

    Objective-C

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

    Swift

    func setRefundApplicationFee(_ refundApplicationFee: Bool) -> ConfirmRefundParametersBuilder

  • See

    SCPConfirmRefundParameters.instructionsEmail

    Declaration

    Objective-C

    - (nonnull SCPConfirmRefundParametersBuilder *)setInstructionsEmail:
    (nullable NSString *)instructionsEmail;

    Swift

    func setInstructionsEmail(_ instructionsEmail: String?) -> ConfirmRefundParametersBuilder

  • Unavailable

    Use initWithPaymentIntentId:clientSecret:.

    Declaration

    Objective-C

    - (nonnull instancetype)init;

  • Unavailable

    Use initWithPaymentIntentId:clientSecret:.

    Declaration

    Objective-C

    + (nonnull instancetype)new;