OPPCheckoutSettings

@interface 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.

Properties

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

    See

    OPPCheckoutThemeStyle

    Declaration

    Objective-C

    @property (nonatomic, readonly) OPPCheckoutTheme *_Nonnull theme;

    Swift

    var theme: OPPCheckoutTheme { get }

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

    Declaration

    Objective-C

    @property (nonatomic, copy, nullable) NSString *shopperResultURL;

    Swift

    var shopperResultURL: String? { get set }

  • The list of payment brands to be shown.

    Declaration

    Objective-C

    @property (nonatomic, copy) NSArray<NSString *> *_Nonnull paymentBrands;

    Swift

    var paymentBrands: [String] { get set }

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

    Declaration

    Objective-C

    @property (nonatomic) OPPCheckoutStorePaymentDetailsMode storePaymentDetails;

    Swift

    var storePaymentDetails: OPPCheckoutStorePaymentDetailsMode { get set }

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

    Declaration

    Objective-C

    @property (nonatomic) OPPCheckoutSkipCVVMode skipCVV;

    Swift

    var skipCVV: OPPCheckoutSkipCVVMode { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readwrite,
          getter=isCardHolderVisible) BOOL cardHolderVisible;

    Swift

    var isCardHolderVisible: Bool { get set }

  • List of possible numbers of installments.

    Declaration

    Objective-C

    @property (nonatomic, copy) NSArray<NSNumber *> *_Nonnull installmentOptions;

    Swift

    var installmentOptions: [NSNumber] { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readwrite,
          getter=isInstallmentEnabled) BOOL installmentEnabled;

    Swift

    var isInstallmentEnabled: Bool { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, copy, nullable) NSArray<OPPSecurityPolicy *> *securityPolicies;

    Swift

    var securityPolicies: [OPPSecurityPolicy]? { get set }

  • 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

    Objective-C

    @property (nonatomic, copy, nullable) NSString *language;

    Swift

    var language: String? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, nullable) PKPaymentRequest *applePayPaymentRequest;

    Swift

    var applePayPaymentRequest: PKPaymentRequest? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, nullable) OPPThreeDSConfig *threeDSConfig;

    Swift

    var threeDSConfig: OPPThreeDSConfig? { get set }

  • 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

    Objective-C

    @property (nonatomic, copy, nullable) NSString *klarnaCountry;

    Swift

    var klarnaCountry: String? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, nullable) NSDecimalNumber *klarnaInvoiceFee;

    Swift

    var klarnaInvoiceFee: NSDecimalNumber? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, nullable) NSDecimalNumber *klarnaInstallmentsFee;

    Swift

    var klarnaInstallmentsFee: NSDecimalNumber? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readwrite,
          getter=isIBANRequired) BOOL IBANRequired;

    Swift

    var isIBANRequired: Bool { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readwrite,
          getter=isSTCPayQrCodeRequired) BOOL STCPayQrCodeRequired;

    Swift

    var isSTCPayQrCodeRequired: Bool { get set }

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

    Declaration

    Objective-C

    @property (nonatomic) OPPCheckoutCardBrandsDisplayMode cardBrandsDisplayMode;

    Swift

    var cardBrandsDisplayMode: OPPCheckoutCardBrandsDisplayMode { get set }

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

    Declaration

    Objective-C

    @property (nonatomic) BOOL displayTotalAmount;

    Swift

    var displayTotalAmount: Bool { get set }

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

    Declaration

    Objective-C

    @property (nonatomic) OPPCheckoutBrandDetectionType brandDetectionType;

    Swift

    var brandDetectionType: OPPCheckoutBrandDetectionType { get set }

  • 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

    Objective-C

    @property (nonatomic, copy) NSArray<NSString *> *_Nonnull brandDetectionPriority;

    Swift

    var brandDetectionPriority: [String] { get set }

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

    Declaration

    Objective-C

    @property (nonatomic) OPPCheckoutBrandDetectionAppearanceStyle brandDetectionAppearanceStyle;

    Swift

    var brandDetectionAppearanceStyle: OPPCheckoutBrandDetectionAppearanceStyle { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, copy, nullable) NSDictionary<NSString *, UIImage *> *customLogos;

    Swift

    var customLogos: [String : UIImage]? { get set }

  • Property which holds billing address of the customer.

    Declaration

    Objective-C

    @property (nonatomic, nullable) OPPBillingAddress *billingAddress;

    Swift

    var billingAddress: OPPBillingAddress? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readwrite,
          getter=isPaymentBrandsOrderUsedForTokens)
    BOOL paymentBrandsOrderUsedForTokens;

    Swift

    var isPaymentBrandsOrderUsedForTokens: Bool { get set }

  • 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 ‘NO’.

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readwrite,
          getter=isShowBirthDateForRatePay) BOOL showBirthDateForRatePay;

    Swift

    var isShowBirthDateForRatePay: Bool { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readwrite,
          getter=isBackButtonAvailable) BOOL backButtonAvailable;

    Swift

    var isBackButtonAvailable: Bool { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readwrite,
          getter=isCardScanningEnabled) BOOL cardScanButtonAvailable;

    Swift

    var isCardScanningEnabled: Bool { get set }

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

    Declaration

    Objective-C

    @property (nonatomic) PKPaymentButtonType applePayType;

    Swift

    var applePayType: PKPaymentButtonType { get set }

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

    Declaration

    Objective-C

    @property (nonatomic) BOOL disableCardExpiryDateValidation;

    Swift

    var disableCardExpiryDateValidation: Bool { get set }

  • WPWL Java Script options for CopyAndPay integration.

    Declaration

    Objective-C

    @property (nonatomic, copy) NSDictionary<NSString *, OPPWpwlOptions *> *_Nonnull wpwlOptions;

    Swift

    var wpwlOptions: [String : OPPWpwlOptions] { get set }

  • Property which holds MBWay brand specific configuration.

    Declaration

    Objective-C

    @property (nonatomic, copy) OPPMBWayConfig *_Nonnull mbwayConfig;

    Swift

    @NSCopying 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

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readwrite,
          getter=isShowOtpEnabled) BOOL showOtpEnabled;

    Swift

    var isShowOtpEnabled: Bool { get set }

  • 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

    Objective-C

    @property (nonatomic, copy) NSString *_Nonnull aciInstantPayCountry;

    Swift

    var aciInstantPayCountry: String { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong, nullable) OPPAfterpayConfig *afterpayConfig;

    Swift

    var afterpayConfig: OPPAfterpayConfig? { get set }

  • The payment parameters for IDEAL 2.0 payment brand.

    Declaration

    Objective-C

    @property (nonatomic, copy, nullable) NSString *idealBankAccountCountry;

    Swift

    var idealBankAccountCountry: String? { get set }

  • The bit mask holding Apple Pay contacts types.

    Declaration

    Objective-C

    @property (nonatomic) OPPCheckoutApplePayContactType applePayContactTypes;

    Swift

    var applePayContactTypes: OPPCheckoutApplePayContactType { get set }

  • Undocumented

    Declaration

    Objective-C

    @property (nonatomic, copy) NSDictionary<OPPViewController, UIViewController *> *customControllers

    Swift

    var customControllers: [OPPViewController : UIViewController] { get set }

  • Configure view controllers for UI Component integration.

    Declaration

    Objective-C

    - (BOOL)customController:(nonnull OPPViewController)controllerType
        withUiController:(nonnull UIViewController *)controller;

    Swift

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

  • Undocumented

    Declaration

    Objective-C

    - (void)setBrandConfig:(OPPBrandConfig *)brandConfig;

    Swift

    func setBrandConfig(_ brandConfig: OPPBrandConfig)