react-native-hyperpay-sdk 0.1.0

package/OPPWAMobile.framework/Versions/Current/Headers/OPPCheckoutInfo.h

@@ -0,0 +1,130 @@
+//
+// Copyright (c) 2019 by ACI Worldwide, Inc.
+// All rights reserved.
+//
+// This software is the confidential and proprietary information
+// of ACI Worldwide Inc ("Confidential Information"). You shall
+// not disclose such Confidential Information and shall use it
+// only in accordance with the terms of the license agreement
+// you entered with ACI Worldwide Inc.
+//
+
+#import <Foundation/Foundation.h>
+@class OPPToken;
+@class OPPPaymentBrandsConfig;
+
+/** Class to encapsulate the parameters related to the checkout. */
+
+NS_ASSUME_NONNULL_BEGIN
+@interface OPPCheckoutInfo : NSObject
+
+/// @name Properties
+
+/** The amount of the transaction in the specified currency. */
+@property (nonatomic) NSDecimalNumber *amount;
+
+/** ISO 4217 currency code. */
+@property (nonatomic, copy) NSString *currencyCode;
+
+/** Tokens related to the checkout. */
+@property (nonatomic, copy, nullable) NSArray<OPPToken *> *tokens;
+
+/** Brand configuration parameters from the Server. */
+@property (nonatomic, nullable) OPPPaymentBrandsConfig *paymentBrandsConfig;
+
+/** The endpoint where the transaction will be sent to. */
+@property (nonatomic, copy) NSString *endpoint;
+
+/** Relative path to get status of transaction. */
+@property (nonatomic, copy) NSString *resourcePath;
+
+/** The merchant IDs related to Klarna Invoice and Klarna Installments. */
+@property (nonatomic, copy, nullable) NSArray<NSString *> *klarnaMerchantIDs;
+
+/** Shows if ReD Shield Device Id collecting is enabled or disabled. */
+@property (nonatomic) BOOL collectRedShieldDeviceId;
+
+/// @name Initialization
+
+/**
+ Creates checkout info object from the JSON that can be received from the Server by checkout ID.
+ @param JSON A dictionary with parameters received from the Server.
+ @param error An error if JSON is invalid.
+ @return Returns an `OPPCheckoutInfo` object, or `nil` if JSON is invalid.
+ */
++ (nullable instancetype)checkoutInfoFromJSON:(NSDictionary *)JSON error:(NSError * _Nullable *)error;
+
+/**
+ Creates checkout info object with the provided values.
+ @param amount The amount of the transaction in the specified currency.
+ @param currencyCode ISO 4217 currency code.
+ @param tokens Tokens related to the checkout.
+ @param paymentBrandsConfig Brand configuration parameters from the Server.
+ @param klarnaMerchantIDs Klarna merchant IDs.
+ @return an `OPPCheckoutInfo` object, or `nil` if parameters are invalid.
+ */
++ (nullable instancetype)checkoutInfoWithAmount:(NSDecimalNumber *)amount
+                                   currencyCode:(NSString *)currencyCode
+                                         tokens:(nullable NSArray<OPPToken *> *)tokens
+                            paymentBrandsConfig:(nullable OPPPaymentBrandsConfig *)paymentBrandsConfig
+                              klarnaMerchantIDs:(nullable NSArray<NSString *> *)klarnaMerchantIDs;
+
+/**
+ Creates checkout info object with the provided values.
+ @param amount The amount of the transaction in the specified currency.
+ @param currencyCode ISO 4217 currency code.
+ @param tokens Tokens related to the checkout.
+ @param paymentBrandsConfig Brand configuration parameters from the Server.
+ @param klarnaMerchantIDs Klarna merchant IDs.
+ @return an `OPPCheckoutInfo` object, or `nil` if parameters are invalid.
+ */
+- (nullable instancetype)initWithAmount:(NSDecimalNumber *)amount
+                           currencyCode:(NSString *)currencyCode
+                                 tokens:(nullable NSArray<OPPToken *> *)tokens
+                    paymentBrandsConfig:(nullable OPPPaymentBrandsConfig *)paymentBrandsConfig
+                      klarnaMerchantIDs:(nullable NSArray<NSString *> *)klarnaMerchantIDs;
+
+@end
+
+/// Deprecated methods
+@interface OPPCheckoutInfo (Deprecated)
+
+/**
+ Creates checkout info object with the provided values.
+ @param amount The amount of the transaction in the specified currency.
+ @param currencyCode ISO 4217 currency code.
+ @param tokens Tokens related to the checkout.
+ @param paymentBrandsConfig Brand configuration parameters from the Server.
+ @return an `OPPCheckoutInfo` object, or `nil` if parameters are invalid.
+ 
+ @warning **Deprecated:** Use `+checkoutInfoWithAmount:currencyCode:tokens:paymentBrandsConfig:klarnaMerchantIDs:` instead.
+ */
++ (nullable instancetype)checkoutInfoWithAmount:(NSDecimalNumber *)amount
+                                   currencyCode:(NSString *)currencyCode
+                                         tokens:(nullable NSArray<OPPToken *> *)tokens
+                            paymentBrandsConfig:(nullable OPPPaymentBrandsConfig *)paymentBrandsConfig DEPRECATED_MSG_ATTRIBUTE("- Use +checkoutInfoWithAmount:currencyCode:tokens:paymentBrandsConfig:klarnaMerchantIDs: instead.");
+
+/**
+ Creates checkout info object with the provided values.
+ @param amount The amount of the transaction in the specified currency.
+ @param currencyCode ISO 4217 currency code.
+ @param tokens Tokens related to the checkout.
+ @param paymentBrandsConfig Brand configuration parameters from the Server.
+ @return an `OPPCheckoutInfo` object, or `nil` if parameters are invalid.
+ @warning **Deprecated:** Use `-initWithAmount:currencyCode:tokens:paymentBrandsConfig:klarnaMerchantIDs:` instead.
+ */
+- (nullable instancetype)initWithAmount:(NSDecimalNumber *)amount
+                           currencyCode:(NSString *)currencyCode
+                                 tokens:(nullable NSArray<OPPToken *> *)tokens
+                    paymentBrandsConfig:(nullable OPPPaymentBrandsConfig *)paymentBrandsConfig DEPRECATED_MSG_ATTRIBUTE("- Use -initWithAmount:currencyCode:tokens:paymentBrandsConfig:klarnaMerchantIDs: instead.");
+
+/**
+ Creates checkout info object from the JSON that can be received from the Server by checkout ID.
+ @param JSON A dictionary with parameters received from the Server.
+ @return Returns an `OPPCheckoutInfo` object, or `nil` if JSON is invalid.
+ @warning **Deprecated:** Use `+checkoutInfoFromJSON:error:` instead
+ */
++ (nullable instancetype)checkoutInfoFromJSON:(NSDictionary *)JSON DEPRECATED_MSG_ATTRIBUTE("- Use +checkoutInfoFromJSON:error: instead.");
+
+@end
+NS_ASSUME_NONNULL_END

package/OPPWAMobile.framework/Versions/Current/Headers/OPPCheckoutPaymentMethod.h

@@ -0,0 +1,51 @@
+//
+// Copyright (c) 2019 by ACI Worldwide, Inc.
+// All rights reserved.
+//
+// This software is the confidential and proprietary information
+// of ACI Worldwide Inc ("Confidential Information"). You shall
+// not disclose such Confidential Information and shall use it
+// only in accordance with the terms of the license agreement
+// you entered with ACI Worldwide Inc.
+//
+
+__deprecated_msg("The OPPCheckoutPaymentMethod class is formally deprecated. Use string values for the payment brands.")
+/**
+ An enumeration for the possible payment methods.
+ 
+ @warning **Deprecated:** The `OPPCheckoutPaymentMethod` class is formally deprecated. Use string values for the payment brands.
+ */
+typedef NS_ENUM(NSInteger, OPPCheckoutPaymentMethod) {
+    /// VISA payment system.
+    OPPCheckoutPaymentMethodVISA __deprecated_enum_msg("The attribute is no longer used. Please use string value \"VISA\" instead of."),
+    /// MasterCard payment system.
+    OPPCheckoutPaymentMethodMasterCard __deprecated_enum_msg("The attribute is no longer used. Please use string value \"MASTER\" instead of."),
+    /// AMEX payment system.
+    OPPCheckoutPaymentMethodAMEX __deprecated_enum_msg("The attribute is no longer used. Please use string value \"AMEX\" instead of."),
+    /// Diners Club payment system.
+    OPPCheckoutPaymentMethodDinersClub __deprecated_enum_msg("The attribute is no longer used. Please use string value \"DINERS\" instead of."),
+    /// Discover payment system.
+    OPPCheckoutPaymentMethodDiscover __deprecated_enum_msg("The attribute is no longer used. Please use string value \"DISCOVER\" instead of."),
+    /// UnionPay payment system.
+    OPPCheckoutPaymentMethodUnionPay __deprecated_enum_msg("The attribute is no longer used. Please use string value \"UNIONPAY\" instead of."),
+    /// JCB payment system.
+    OPPCheckoutPaymentMethodJCB __deprecated_enum_msg("The attribute is no longer used. Please use string value \"JCB\" instead of."),
+    /// SEPA Direct Debit payment system.
+    OPPCheckoutPaymentMethodDirectDebitSEPA __deprecated_enum_msg("The attribute is no longer used. Please use string value \"DIRECTDEBIT_SEPA\" instead of."),
+    /// BOLETO payment system.
+    OPPCheckoutPaymentMethodBOLETO __deprecated_enum_msg("The attribute is no longer used. Please use string value \"BOLETO\" instead of."),
+    /// Apple Pay payment system.
+    OPPCheckoutPaymentMethodApplePay __deprecated_enum_msg("The attribute is no longer used. Please use string value \"APPLEPAY\" instead of."),
+    /// SOFORT Banking payment system.
+    OPPCheckoutPaymentMethodSOFORTBanking __deprecated_enum_msg("The attribute is no longer used. Please use string value \"SOFORTUEBERWEISUNG\" instead of."),
+    /// PayPal payment system.
+    OPPCheckoutPaymentMethodPayPal __deprecated_enum_msg("The attribute is no longer used. Please use string value \"PAYPAL\" instead of."),
+    /// Alipay payment system.
+    OPPCheckoutPaymentMethodAlipay __deprecated_enum_msg("The attribute is no longer used. Please use string value \"ALIPAY\" instead of."),
+    /// China UnionPay (UPOP) payment system.
+    OPPCheckoutPaymentMethodChinaUnionPay __deprecated_enum_msg("The attribute is no longer used. Please use string value \"CHINAUNIONPAY\" instead of."),
+    /// IDEAL payment system.
+    OPPCheckoutPaymentMethodIDEAL __deprecated_enum_msg("The attribute is no longer used. Please use string value \"IDEAL\" instead of."),
+    /// Unsupported payment system.
+    OPPCheckoutPaymentMethodUnsupported __deprecated_enum_msg("The attribute is no longer used.")
+};

package/OPPWAMobile.framework/Versions/Current/Headers/OPPCheckoutProvider.h

@@ -0,0 +1,197 @@
+//
+// Copyright (c) 2019 by ACI Worldwide, Inc.
+// All rights reserved.
+//
+// This software is the confidential and proprietary information
+// of ACI Worldwide Inc ("Confidential Information"). You shall
+// not disclose such Confidential Information and shall use it
+// only in accordance with the terms of the license agreement
+// you entered with ACI Worldwide Inc.
+//
+
+@import Foundation;
+@import PassKit;
+@class OPPPaymentProvider;
+@class OPPTransaction;
+@class OPPCheckoutSettings;
+@class OPPCheckoutProvider;
+@class OPPApplePayRequestAuthorizationResult;
+@class OPPApplePayRequestShippingContactUpdate;
+@class OPPApplePayRequestShippingMethodUpdate;
+@protocol OPPCheckoutProviderDelegate;
+#import "OPPCheckoutPaymentMethod.h"
+
+NS_ASSUME_NONNULL_BEGIN
+
+/**
+ A protocol for additional checkout callbacks.
+ */
+@protocol OPPCheckoutProviderDelegate <NSObject>
+@optional
+
+/// @name Validation methods
+
+/**
+ Called before submitting a transaction to the Server.
+ Use this callback to recreate checkout for specific payment brand or abort transaction.
+ @param checkoutProvider The instance of `OPPCheckoutProvider` that is calling delegate method.
+ @param transaction The transaction with masked sensitive data.
+ @param completion The completion block you should call to continue submitting transaction or abort it. In case of abortion checkout will be closed with error `OPPErrorCodeTransactionAborted`.
+ */
+- (void)checkoutProvider:(OPPCheckoutProvider *)checkoutProvider continueSubmitting:(OPPTransaction *)transaction completion:(void (^)(NSString * _Nullable checkoutID, BOOL abort))completion;
+
+/**
+ Called when card holder text field was changed or pressed Pay button on the payment detail view.
+ Use this callback to override the internal card holder validation.
+ @param checkoutProvider The instance of `OPPCheckoutProvider` that is calling delegate method.
+ @param cardHolder The card holder value.
+ @return `YES` if the card holder is valid, otherwise `NO`.
+ */
+- (BOOL)checkoutProvider:(OPPCheckoutProvider *)checkoutProvider validateCardHolder:(nullable NSString *)cardHolder;
+
+/// @name Safari services methods
+
+/**
+ Called when the user taps the 'Done' button on SFSafariViewController.
+ @param checkoutProvider The instance of `OPPCheckoutProvider` that is calling delegate method.
+ */
+- (void)checkoutProviderDidFinishSafariViewController:(OPPCheckoutProvider *)checkoutProvider;
+
+/// @name Apple Pay methods
+
+/**
+ Called when a new shipping method was selected.
+ The delegate must invoke the completion block with an updated array of `PKPaymentSummaryItem` objects.
+ @param checkoutProvider The instance of `OPPCheckoutProvider` that is calling delegate method.
+ @param shippingMethod The shipping method for this transaction.
+ @param completion The completion block you should call to update the shipping costs based on the shipping method.
+*/
+- (void)checkoutProvider:(OPPCheckoutProvider *)checkoutProvider applePayDidSelectShippingMethod:(PKShippingMethod *)shippingMethod handler:(void (^)(OPPApplePayRequestShippingMethodUpdate *update))completion;
+
+/**
+ Called when a new shipping address was selected.
+ The delegate must invoke the completion block with an updated array of `PKPaymentSummaryItem` objects.
+ @param checkoutProvider The instance of `OPPCheckoutProvider` that is calling delegate method.
+ @param contact The contact information needed for shipping.
+ @param completion The completion block you should call to update the shipping address.
+ */
+- (void)checkoutProvider:(OPPCheckoutProvider *)checkoutProvider applePayDidSelectShippingContact:(PKContact *)contact handler:(void (^)(OPPApplePayRequestShippingContactUpdate *update))completion;
+
+
+/**
+ Called when the payment request was authorized.
+ The delegate must invoke the completion block with an appropriate authorization status.
+ @param checkoutProvider The instance of `OPPCheckoutProvider` that is calling delegate method.
+ @param payment The result of authorizing a payment request and contains payment information, encrypted in the payment token.
+ @param completion The completion block you should call with an appropriate authorization status.
+ */
+- (void)checkoutProvider:(OPPCheckoutProvider *)checkoutProvider applePayDidAuthorizePayment:(PKPayment *)payment handler:(void (^)(OPPApplePayRequestAuthorizationResult *result))completion;
+
+@end
+
+
+/**
+ Abstract class for displaying an in-App payment page.
+ */
+@interface OPPCheckoutProvider : NSObject
+
+/// @name Properties
+
+/**
+ Checkout provider delegate.
+ */
+@property (nonatomic, weak) id<OPPCheckoutProviderDelegate> delegate;
+
+/// @name Initialization
+
+/**
+ Factory method to generate an `OPPCheckoutProvider` used for displaying an in-App payment pages.
+ @param provider The OPPPaymentProvider which is used for performing the transaction once all the data from the user is collected.
+ @param checkoutID The checkout Id of the transaction. Must be not `nil` or empty.
+ @param settings The `OPPCheckoutSettings` used for these payment pages. These settings are provided to customize the appearance and functionality of the payment pages. If `nil`, default settings will be created.
+
+ @return Returns an `OPPCheckoutProvider` for displaying in-App payment pages. Returns `nil` if `provider` or `checkoutID` are not set.
+ */
++ (nullable instancetype)checkoutProviderWithPaymentProvider:(OPPPaymentProvider *)provider checkoutID:(NSString *)checkoutID settings:(nullable OPPCheckoutSettings *)settings;
+
+/**
+ Designated initializer method to generate an `OPPCheckoutProvider` used for displaying an in-App payment pages.
+ @param provider The OPPPaymentProvider which is used for performing the transaction once all the data from the user is collected.
+ @param checkoutID The checkout Id of the transaction. Must be not `nil` or empty.
+ @param settings The `OPPCheckoutSettings` used for these payment pages. These settings are provided to customize the appearance and functionality of the payment pages. If `nil`, default settings will be created.
+ @return Returns an `OPPCheckoutProvider` for displaying in-App payment pages. Returns `nil` if `provider` or `checkoutID` are not set.
+ */
+- (nullable instancetype)initWithPaymentProvider:(OPPPaymentProvider *)provider checkoutID:(NSString *)checkoutID settings:(nullable OPPCheckoutSettings *)settings;
+
+/// @name Presenting checkout
+
+/**
+ Opens an in-App payment page for collecting user input and submitting a transaction. First the list of payment methods from the checkout settings will be displayed.
+ @param completionHandler A block executed when the transaction is completed. You need to send the request to your server to get the transaction status.
+ @param cancelHandler A block executed if the user closes the payment page prematurely.
+ */
+- (void)presentCheckoutForSubmittingTransactionCompletionHandler:(void (^)(OPPTransaction * _Nullable transaction, NSError * _Nullable error))completionHandler
+                                                   cancelHandler:(void (^ _Nullable )(void))cancelHandler;
+
+/**
+ Opens an in-App payment page for collecting user input and submitting a transaction.
+ Payment form for the choosen payment method will be opened. If no user input is required in app (e.g. PayPal), shopper will be redirected directly to the issuer web page.
+ @param paymentBrand The payment brand for transaction.
+ @param loadingHandler A block executed whenever SDK sends request to the server or receives the response. You can start or stop loading animation based on `inProgress` parameter.
+ @param completionHandler A block executed when the transaction is completed. You need to send the request to your server to get the transaction status.
+ @param cancelHandler A block executed if the user closes the payment page prematurely.
+ */
+- (void)presentCheckoutWithPaymentBrand:(NSString *)paymentBrand
+                         loadingHandler:(void (^ _Nullable )(BOOL inProgress))loadingHandler
+                      completionHandler:(void (^)(OPPTransaction * _Nullable transaction, NSError * _Nullable error))completionHandler
+                          cancelHandler:(void (^ _Nullable )(void))cancelHandler;
+
+/**
+ Closes the in-App payment page. The delegate is not informed if this method is being called.
+ @param animated Specifies whether the payment page should be dismissed using an animation or immediately without an animation.
+ @param completion The completion handler, if provided, will be invoked after the checkout screen will be dismissed.
+ */
+- (void)dismissCheckoutAnimated:(BOOL)animated completion: (void (^ __nullable)(void))completion;
+
+@end
+
+/// Deprecated methods
+@interface OPPCheckoutProvider (Deprecated)
+
+/**
+ Opens an in-App payment page for collecting user input and submitting a transaction. First the list of payment methods from the checkout settings will be displayed.
+ @param completionHandler A block executed when the transaction is completed. You need to send the request to your server to get the transaction status.
+ @param paymentBrandSelectedHandler A block executed when the shopper selected payment brand. You need to obtain a new checkout Id if the selected payment brand requires another payment type and return the value to SDK or `nil` in case of error using completion block.
+ @param cancelHandler A block executed if the user closes the payment page prematurely.
+ @warning **Deprecated:** Use `-presentCheckoutForSubmittingTransactionCompletionHandler:cancelHandler:` instead. Use `-[OPPCheckoutProviderDelegate checkoutProvider:continueSubmitting:completion:]` instead of implementing `paymentBrandSelectedHandler`.
+ */
+- (void)presentCheckoutForSubmittingTransactionCompletionHandler:(void (^)(OPPTransaction * _Nullable transaction, NSError * _Nullable error))completionHandler
+                                     paymentBrandSelectedHandler:(void (^ _Nullable )(NSString * _Nonnull paymentBrand, void (^completion)(NSString * _Nullable checkoutID)))paymentBrandSelectedHandler
+                                                   cancelHandler:(void (^ _Nullable )(void))cancelHandler DEPRECATED_MSG_ATTRIBUTE("- Use -presentCheckoutForSubmittingTransactionCompletionHandler:cancelHandler: instead.");
+
+/**
+ Opens an in-App payment page for collecting user input and submitting a transaction. First the list of payment methods from the checkout settings will be displayed.
+ @param completionHandler A block executed when the transaction is completed. You need to send the request to your server to get the transaction status.
+ @param paymentMethodSelectedHandler A block executed when the shopper selected payment brand. You need to obtain a new checkout Id if the selected payment brand requires another payment type and return the value to SDK or `nil` in case of error using completion block.
+ @param cancelHandler A block executed if the user closes the payment page prematurely.
+ @warning **Deprecated:** Use `-presentCheckoutForSubmittingTransactionCompletionHandler:paymentBrandSelectedHandler:cancelHandler:` instead
+ */
+- (void)presentCheckoutForSubmittingTransactionCompletionHandler:(void (^)(OPPTransaction * _Nullable transaction, NSError * _Nullable error))completionHandler
+                                    paymentMethodSelectedHandler:(void (^ _Nullable )(OPPCheckoutPaymentMethod paymentMethod, void (^completion)(NSString * _Nullable checkoutID)))paymentMethodSelectedHandler
+                                                   cancelHandler:(void (^ _Nullable )(void))cancelHandler DEPRECATED_MSG_ATTRIBUTE("- Use -presentCheckoutForSubmittingTransactionCompletionHandler:paymentBrandSelectedHandler:cancelHandler: instead.");
+
+/**
+ Opens an in-App payment page for collecting user input and submitting a transaction.
+ Payment form for the choosen payment method will be opened. If no user input is required in app (e.g. PayPal), shopper will be redirected directly to the issuer web page.
+ @param paymentMethod The payment method for transaction.
+ @param loadingHandler A block executed whenever SDK sends request to the server or receives the response. You can start or stop loading animation based on inProgress parameter.
+ @param completionHandler A block executed when the transaction is completed. You need to send the request to your server to get the transaction status.
+ @param cancelHandler A block executed if the user closes the payment page prematurely.
+ @warning **Deprecated:** Use `-presentCheckoutWithPaymentBrand:loadingHandler:completionHandler:cancelHandler:` instead
+ */
+- (void)presentCheckoutWithPaymentMethod:(OPPCheckoutPaymentMethod)paymentMethod
+                          loadingHandler:(void (^ _Nullable )(BOOL inProgress))loadingHandler
+                       completionHandler:(void (^)(OPPTransaction * _Nullable transaction, NSError * _Nullable error))completionHandler
+                           cancelHandler:(void (^ _Nullable )(void))cancelHandler DEPRECATED_MSG_ATTRIBUTE("- Use -presentCheckoutWithPaymentBrand:loadingHandler:completionHandler:cancelHandler: instead.");
+@end
+NS_ASSUME_NONNULL_END

package/OPPWAMobile.framework/Versions/Current/Headers/OPPCheckoutSettings.h

@@ -0,0 +1,185 @@
+//
+// Copyright (c) 2019 by ACI Worldwide, Inc.
+// All rights reserved.
+//
+// This software is the confidential and proprietary information
+// of ACI Worldwide Inc ("Confidential Information"). You shall
+// not disclose such Confidential Information and shall use it
+// only in accordance with the terms of the license agreement
+// you entered with ACI Worldwide Inc.
+//
+
+#import <Foundation/Foundation.h>
+#import "OPPCheckoutPaymentMethod.h"
+#import <PassKit/PassKit.h>
+@class OPPCheckoutTheme;
+@class OPPSecurityPolicy;
+
+/// An enumeration for the possible store payment details modes.
+typedef NS_ENUM(NSInteger, OPPCheckoutStorePaymentDetailsMode) {
+    /// Always store payment details for future use.
+    OPPCheckoutStorePaymentDetailsModeAlways,
+    /// Display the option to prompt the user permissions to store payment details for future use.
+    OPPCheckoutStorePaymentDetailsModePrompt,
+    /// Never store payment details.
+    OPPCheckoutStorePaymentDetailsModeNever
+};
+
+/// An enumeration for the possible modes to skip CVV check.
+typedef NS_ENUM(NSInteger, OPPCheckoutSkipCVVMode) {
+    /// Always request CVV for card payments.
+    OPPCheckoutSkipCVVModeNever,
+    /// Skip CVV check only for payments by stored cards.
+    OPPCheckoutSkipCVVModeForStoredCards,
+    /// Always skip CVV check. CVV field won't be displayed in card payment forms.
+    OPPCheckoutSkipCVVModeAlways
+};
+
+/// An enumeration for the possible display modes of card brands on payment method selection screen.
+typedef NS_ENUM(NSInteger, OPPCheckoutCardBrandsDisplayMode) {
+    /// Display card brands in the list along with other payment methods.
+    OPPCheckoutCardBrandsDisplayModeSeparate,
+    /// Display all card brands grouped in one row. This mode allows shopper to skip choosing concrete card brand, the brand will be detected automatically based on card number.
+    OPPCheckoutCardBrandsDisplayModeGrouped
+};
+
+/// An enumeration for the possible ways of automatic card brand detection
+typedef NS_ENUM(NSInteger, OPPCheckoutBrandDetectionType) {
+    /// Uses regular expressions to analyze card number (supports a limited number of brands)
+    OPPCheckoutBrandDetectionTypeRegex,
+    /// Searches card bin in the bin list (more precise)
+    OPPCheckoutBrandDetectionTypeBinList
+};
+
+/**
+ 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.
+ */
+NS_ASSUME_NONNULL_BEGIN
+@interface OPPCheckoutSettings : NSObject
+
+/// @name Properties
+
+/**
+ The custom theme for the payment forms. Default is `OPPCheckoutThemeStyleLight`.
+ @see `OPPCheckoutThemeStyle`
+ */
+@property (nonatomic, readonly) OPPCheckoutTheme *theme;
+
+/**
+ This URL will receive the result of an asynchronous payment. Must be sent URL encoded.
+ */
+@property (nonatomic, copy, nullable) NSString *shopperResultURL;
+
+/**
+ The list of payment brands to be shown.
+ */
+@property (nonatomic, copy) NSArray<NSString *> *paymentBrands;
+
+/** 
+ A constant that specifies the store payment details mode. Default is `OPPCheckoutStorePaymentDetailsModeNever`.
+ */
+@property (nonatomic) OPPCheckoutStorePaymentDetailsMode storePaymentDetails;
+
+/**
+ A constant that specifies whether request CVV or not. Default is `OPPCheckoutSkipCVVModeNever`.
+ */
+@property (nonatomic) OPPCheckoutSkipCVVMode skipCVV;
+
+/**
+ A flag that specifies whether show card holder name in the card detail view or not. Default is `YES`.
+ */
+@property (nonatomic, getter=isCardHolderVisible) BOOL cardHolderVisible;
+
+/**
+ List of possible numbers of installments.
+ */
+@property (nonatomic, copy) NSArray<NSNumber *> *installmentOptions;
+
+/**
+ A flag that specifies whether payment should be split into installments.
+ */
+@property (nonatomic, getter=isInstallmentEnabled) BOOL installmentEnabled;
+
+/**
+ Set of security policies to confirm payment. 
+ Increase security for tokens or specific payment methods with Touch ID/Face ID or passcode.
+ */
+@property (nonatomic, copy, nullable) NSArray<OPPSecurityPolicy *> *securityPolicies;
+
+/**
+ 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.
+ */
+@property (nonatomic, copy, nullable) NSString *language;
+
+/** Encapsulates a request for payment, including information about payment processing capabilities and the payment amount. */
+@property (nonatomic, nullable) PKPaymentRequest *applePayPaymentRequest;
+
+/** 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`. */
+@property (nonatomic, copy, nullable) NSString *klarnaCountry;
+
+/** Sets the fee to be used for the "Billing agreement" link during a Klarna Invoice checkout. */
+@property (nonatomic, nullable) NSDecimalNumber *klarnaInvoiceFee;
+
+/** Sets the fee to be used for the "Read more" link during a Klarna Installments checkout. */
+@property (nonatomic, nullable) NSDecimalNumber *klarnaInstallmentsFee;
+
+/**
+ A flag that specifies whether show IBAN field on the Giropay payment form or not. Default is `NO`.
+ */
+@property (nonatomic, getter=isIBANRequired) BOOL IBANRequired;
+
+/**
+ A mode that specifies how to display card brands on payment method selection screen.
+ Default is `OPPCheckoutCardBrandsDisplayModeGrouped`.
+ */
+@property (nonatomic) OPPCheckoutCardBrandsDisplayMode cardBrandsDisplayMode;
+
+/**
+ 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`.
+ */
+@property (nonatomic) BOOL displayTotalAmount;
+
+/**
+ Type of automatic card brand detection to be used.
+ Default is `OPPCheckoutBrandDetectionTypeRegex`.
+ */
+@property (nonatomic) OPPCheckoutBrandDetectionType brandDetectionType;
+
+/**
+ 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.
+ */
+@property (nonatomic, copy) NSArray<NSString *> *brandDetectionPriority;
+
+/**
+ A flag that specifies whether show multiple detected brands under card number text field or keep them hidden by default.
+ Default is `YES`.
+ */
+@property (nonatomic) BOOL showDetectedBrands;
+
+/// @name Deprecated
+
+/**
+ The custom URL scheme for your app. This must be configured if your app integrates a payment option that may switch to either Mobile Safari or to another app to finish the payment authorization workflow.
+ @warning **Deprecated**. The property is no longer used.
+ */
+@property (nonatomic, copy) NSString *schemeURL DEPRECATED_ATTRIBUTE;
+
+/**
+ The description to show on the payment page above the total amount.
+ @warning **Deprecated**. The property is no longer used.
+ */
+@property (nonatomic, copy, nullable) NSString *paymentTitle DEPRECATED_ATTRIBUTE;
+
+/**
+ The payment methods to be shown. Expected an `NSArray` of `NSNumbers` representing different `OPPCheckoutPaymentMethod` enums.
+ @warning **Deprecated**. Use `paymentBrands` instead.
+ */
+@property (nonatomic, copy) NSArray<NSNumber *> *paymentMethods DEPRECATED_ATTRIBUTE;
+
+@end
+NS_ASSUME_NONNULL_END