BTPayPalVaultRequest

@objcMembers
public class BTPayPalVaultRequest : BTPayPalVaultBaseRequest

Options for the PayPal Vault flow.

Public Properties

  • Optional: User email to initiate a quicker authentication flow in cases where the user has a PayPal Account with the same email.

    Declaration

    Swift

    public var userAuthenticationEmail: String?

Initializers

  • Initializes a PayPal Vault request for the PayPal App Switch flow

    Warning

    This initializer should be used for merchants using the PayPal App Switch flow. This feature is currently in beta and may change or be removed in future releases.

    Note

    The PayPal App Switch flow currently only supports the production environment.

    Declaration

    Swift

    public convenience init(
        userAuthenticationEmail: String,
        enablePayPalAppSwitch: Bool,
        offerCredit: Bool = false
    )

    Parameters

    userAuthenticationEmail

    Required: User email to initiate a quicker authentication flow in cases where the user has a PayPal Account with the same email.

    enablePayPalAppSwitch

    Required: Used to determine if the customer will use the PayPal app switch flow.

    offerCredit

    Optional: Offers PayPal Credit if the customer qualifies. Defaults to false.

  • Initializes a PayPal Vault request

    Declaration

    Swift

    public init(
        offerCredit: Bool = false,
        recurringBillingDetails: BTPayPalRecurringBillingDetails? = nil,
        recurringBillingPlanType: BTPayPalRecurringBillingPlanType? = nil,
        userAuthenticationEmail: String? = nil
    )

    Parameters

    offerCredit

    Optional: Offers PayPal Credit if the customer qualifies. Defaults to false.

    recurringBillingDetails

    Optional: Recurring billing product details.

    recurringBillingPlanType

    Optional: Recurring billing plan type, or charge pattern.

    userAuthenticationEmail

    Optional: User email to initiate a quicker authentication flow in cases where the user has a PayPal Account with the same email.

  • Declaration

    Swift

    public override func parameters(
        with configuration: BTConfiguration,
        universalLink: URL? = nil,
        isPayPalAppInstalled: Bool = false
    ) -> [String: Any]