SCPPaymentMethodSelectionInteraction

Objective-C


@interface SCPPaymentMethodSelectionInteraction : SCPPaymentInteraction

Swift

class PaymentMethodSelectionInteraction : PaymentInteraction

An interaction that requires the customer to select a payment method during payment collection.

  • The PaymentIntent being processed.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) SCPPaymentIntent *_Nonnull paymentIntent;

    Swift

    var paymentIntent: SCPPaymentIntent { get }
  • The payment options available for selection.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly) NSArray<SCPPaymentOption *> *_Nonnull availableOptions;

    Swift

    var availableOptions: [SCPPaymentOption] { get }
  • Completes the interaction with either the selected payment option or an error.

    Declaration

    Objective-C

    - (void)completeWithPaymentOption:(nullable SCPPaymentOption *)paymentOption
                                error:(nullable NSError *)error;

    Swift

    func complete(paymentOption: SCPPaymentOption?, error: (any Error)?)

    Parameters

    paymentOption

    The selected payment option, or nil if selection failed.

    error

    An error if selection failed, or nil if successful.