OPPCheckoutSettings

@objc
public final class OPPCheckoutSettings : NSObject

Class which encapsulates settings for the built-in in-App payment page. Use this to customize both the visual elements of the payment pages as well as functionality. This includes changing colors and texts, defining payment methods.

  • The custom theme for the payment forms. Default is OPPCheckoutThemeStyleLight. @see OPPCheckoutThemeStyle

    Declaration

    Swift

    @objc
public private(set) lazy var theme: OPPCheckoutTheme { get set }

  • This URL will receive the result of an asynchronous payment. Must be sent URL encoded.

    Declaration

    Swift

    @objc
public var shopperResultURL: String?

  • The list of payment brands to be shown.

    Declaration

    Swift

    @objc
public var paymentBrands: [String]

  • A constant that specifies the store payment details mode. Default is OPPCheckoutStorePaymentDetailsModeNever.

    Declaration

    Swift

    @objc
public var storePaymentDetails: OPPCheckoutStorePaymentDetailsMode

  • A constant that specifies whether request CVV or not. Default is OPPCheckoutSkipCVVModeNever.

    Declaration

    Swift

    @objc
public var skipCVV: OPPCheckoutSkipCVVMode

  • A flag that specifies whether show card holder name in the card detail view or not. Default is true.

    Declaration

    Swift

    @objc
public var isCardHolderVisible: Bool

  • List of possible numbers of installments.

    Declaration

    Swift

    @objc
public var installmentOptions: [NSNumber] { get set }

  • A flag that specifies whether payment should be split into installments.

    Declaration

    Swift

    @objc
public var isInstallmentEnabled: Bool

  • Set of security policies to confirm payment. Increase security for tokens or specific payment methods with Touch ID/Face ID or passcode.

    Declaration

    Swift

    @objc
public var securityPolicies: [OPPSecurityPolicy]?

  • The language used for language specific labels in ISO 639-1 language identifier. If the language is not supported English will be used. If language is nil, app wil use the first supported language from language settings.

    Declaration

    Swift

    @objc
public var language: String? { get set }

  • Encapsulates a request for payment, including information about payment processing capabilities and the payment amount.

    Declaration

    Swift

    @objc
public var applePayPaymentRequest: PKPaymentRequest?

  • Class that contains all possible settings used for additional configuration of the ipworks3ds_sdk.

    Declaration

    Swift

    @objc
public var threeDSConfig: OPPThreeDSConfig?

  • Sets the country to be used for Klarna checkout in ISO 3166-1 alpha-2 country identifier. By default, uses countryCode from device locale if supported. Otherwise, use DE.

    Declaration

    Swift

    @objc
public var klarnaCountry: String? { get set }

  • Sets the fee to be used for the “Billing agreement” link during a Klarna Invoice checkout.

    Declaration

    Swift

    @objc
public var klarnaInvoiceFee: NSDecimalNumber? { get set }

  • Sets the fee to be used for the “Read more” link during a Klarna Installments checkout.

    Declaration

    Swift

    @objc
public var klarnaInstallmentsFee: NSDecimalNumber? { get set }

  • A flag that specifies whether show IBAN field on the Giropay payment form or not. Default is false.

    Declaration

    Swift

    @objc
public var isIBANRequired: Bool

  • A flag that specifies whether show QR-Code field on the STC Pay payment form or not. Default is true.

    Declaration

    Swift

    @objc
public var isSTCPayQrCodeRequired: Bool

  • A mode that specifies how to display card brands on payment method selection screen. Default is OPPCheckoutCardBrandsDisplayModeGrouped.

    Declaration

    Swift

    @objc
public var cardBrandsDisplayMode: OPPCheckoutCardBrandsDisplayMode

  • A flag that specifies whether show total amount in the checkout or not. If true, amount is shown on the payment method selection screen and in the ‘Pay’ buttons. Default is false.

    Declaration

    Swift

    @objc
public var displayTotalAmount: Bool

  • Type of automatic card brand detection to be used. Default is OPPCheckoutBrandDetectionTypeRegex.

    Declaration

    Swift

    @objc
public var brandDetectionType: OPPCheckoutBrandDetectionType

  • Sets the preferred order of the detected card brands to be shown under the card number text field. By default order from paymentBrands is used.

    Declaration

    Swift

    @objc
public var brandDetectionPriority: [String]

  • A constant that control multiple detected brands under card number appearance style. Default is OPPCheckoutBrandDetectionAppearanceStyleActive.

    Declaration

    Swift

    @objc
public var brandDetectionAppearanceStyle: OPPCheckoutBrandDetectionAppearanceStyle

  • Sets custom logo to be presented at the checkout for the specified payment brands.

    Declaration

    Swift

    @objc
public var customLogos: [String : UIImage]?

  • Property which holds billing address of the customer.

    Declaration

    Swift

    @objc
public var billingAddress: OPPBillingAddress?

  • A flag that specifies whether payment brands order is used for tokens on payment method selection screen. Default is false.

    Declaration

    Swift

    @objc
public var isPaymentBrandsOrderUsedForTokens: Bool

  • A flag that enable/disable Show Date of Birth of Customer to be presented at the checkout is used for RatePay payment brand. Default is ‘false’.

    Declaration

    Swift

    @objc
public var isShowBirthDateForRatePay: Bool

  • A flag that enable/disable back button to be presented on the Payment Details. Default is ‘true’.

    Declaration

    Swift

    @objc
public var isBackButtonAvailable: Bool

  • A flag that enable/disable card scan button to be presented on the Payment Details. Default is ‘true’.

    Declaration

    Swift

    @objc
public var isCardScanningEnabled: Bool

  • A flag that is used to set the Apple Pay Button Type. Default is ‘PKPaymentButtonTypePlain’.

    Declaration

    Swift

    @objc
public var applePayType: PKPaymentButtonType

  • A flag that Disable’s Card expiry date validation. Default is ‘false’.

    Declaration

    Swift

    @objc
public var disableCardExpiryDateValidation: Bool

  • WPWL Java Script options for CopyAndPay integration.

    Declaration

    Swift

    @objc
public var wpwlOptions: [String : OPPWpwlOptions]

  • Property which holds MBWay brand specific configuration.

    Declaration

    Swift

    @objc
public lazy var mbwayConfig: OPPMBWayConfig { get set }

  • A flag that enable/disable OTP field to be presented on the Payment Details for BLIK. Default is ‘YES’.

    Declaration

    Swift

    @objc
public var isShowOtpEnabled: Bool

  • The country for ACI Instant Pay payment method. It should be one of these values NL, DE, FR, BE, LV, EE, LT, ES, AT, IT, PT, GB, US. Default is ‘US’.

    Declaration

    Swift

    @objc
public var aciInstantPayCountry: String

  • The configuration for AFTERPAY_PACIFIC payment method if it is set.

    Declaration

    Swift

    @objc
public var afterpayConfig: OPPAfterpayConfig? { get set }

  • The configuration for AmazonPay payment method if it is set.

    Declaration

    Swift

    @objc
public var amazonPayConfig: OPPAmazonPayConfig? { get set }

  • The payment parameters for IDEAL 2.0 payment brand.

    Declaration

    Swift

    @objc
public var idealBankAccountCountry: String?

  • The bit mask holding Apple Pay contacts types.

    Declaration

    Swift

    @objc
public var applePayContactTypes: OPPCheckoutApplePayContactType

  • Custom controllers for UI Component integration.

    Declaration

    Swift

    @objc
public var customControllers: [OPPViewController : UIViewController]

  • Undocumented

    Declaration

    Swift

    public override init()

  • Configure view controllers for UI Component integration.

    Declaration

    Swift

    @objc
public func customController(_ controllerType: OPPViewController, withUiController controller: UIViewController) -> Bool

  • Set brand configuration.

    Declaration

    Swift

    @objc
public func setBrandConfig(_ brandConfig: OPPBrandConfig)