react-native-hyperpay-sdk 0.15.0 → 0.17.0

package/ios/OPPWAMobile.xcframework/ios-arm64_armv7/OPPWAMobile.framework/Headers/OPPIkanoOiPaymentParams.h

@@ -0,0 +1,74 @@
+//
+// Copyright (c) $$year$$ 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 "OPPPaymentParams.h"
+
+/**
+ Class to encapsulate all necessary transaction parameters for performing an Ikano transaction.
+ */
+
+NS_ASSUME_NONNULL_BEGIN
+@interface OPPIkanoOiPaymentParams : OPPPaymentParams
+
+/// @name Initialization
+
+/// :nodoc:
+- (instancetype)initWithCheckoutID:(NSString *)checkoutID
+                      paymentBrand:(NSString *)paymentBrand
+                             error:(NSError * _Nullable __autoreleasing *)error NS_UNAVAILABLE;
+
+/**
+ Creates an object representing an Ikano transaction.
+ 
+ @param checkoutID The checkout ID of the transaction. Must be not `nil` or empty.
+ @param paymentBrand IKANOOI_SE, IKANOOI_NO or IKANOOI_FI is expected.
+ @param nationalIdentifier National identifier of the account.
+ @param error The error that occurred while validating payment parameters. See code attribute (`OPPErrorCode`) and `NSLocalizedDescription` to identify the reason of failure.
+ @return Returns an object representing an Ikano transaction.
+ */
++ (nullable instancetype)ikanoOiPaymentParamsWithCheckoutID:(NSString *)checkoutID
+                                               paymentBrand:(NSString *)paymentBrand
+                                         nationalIdentifier:(NSString *)nationalIdentifier
+                                                      error:(NSError **)error;
+
+/**
+ Creates an object representing an Ikano transaction.
+ 
+ @param checkoutID The checkout ID of the transaction. Must be not `nil` or empty.
+ @param paymentBrand IKANOOI_SE, IKANOOI_NO or IKANOOI_FI is expected.
+ @param nationalIdentifier National identifier of the account.
+ @param error The error that occurred while validating payment parameters. See code attribute (`OPPErrorCode`) and `NSLocalizedDescription` to identify the reason of failure.
+ @return Returns an object representing an Ikano transaction.
+ */
+- (nullable instancetype)initWithCheckoutID:(NSString *)checkoutID
+                               paymentBrand:(NSString *)paymentBrand
+                         nationalIdentifier:(NSString *)nationalIdentifier
+                                      error:(NSError **)error NS_DESIGNATED_INITIALIZER;
+
+/// @name Properties
+
+/** National identifier of the account. */
+@property (nonatomic, copy, readonly) NSString *nationalIdentifier;
+
+/// @name Parameter Checks
+
+/**
+ Checks if the national identifier is valid to perform a transaction.
+ 
+ @param nationalIdentifier National identifier of the account.
+ @param paymentBrand IKANOOI_SE, IKANOOI_NO or IKANOOI_FI is expected.
+ @return `YES` if the national identifier value is valid.
+ */
++ (BOOL)isNationalIdentifierValid:(NSString *)nationalIdentifier
+                  forPaymentBrand:(NSString *)paymentBrand;
+
+@end
+NS_ASSUME_NONNULL_END

package/ios/OPPWAMobile.xcframework/ios-arm64_armv7/OPPWAMobile.framework/Headers/OPPIkanoPrivateLabelVAPaymentParams.h

@@ -0,0 +1,124 @@
+//
+// Copyright (c) $$year$$ 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 "OPPPaymentParams.h"
+
+/**
+ Class to encapsulate all necessary transaction parameters for performing an Ikano private label transaction (as virtual account).
+ */
+
+NS_ASSUME_NONNULL_BEGIN
+
+@interface OPPIkanoPrivateLabelVAPaymentParams : OPPPaymentParams
+
+/// @name Initialization
+
+/// :nodoc:
+- (instancetype)initWithCheckoutID:(NSString *)checkoutID
+                      paymentBrand:(NSString *)paymentBrand
+                             error:(NSError * _Nullable __autoreleasing *)error NS_UNAVAILABLE;
+
+/**
+Creates an object representing an Ikano private label transaction (as virtual account).
+
+@param checkoutID The checkout ID of the transaction.
+@param accountNumber The account number.
+@param expiryMonth The expiration month of the account. It is expected in the format `MM`.
+@param expiryYear The expiration year of the account. It is expected in the format `YYYY`.
+@param accountVerification The verification code of the account.
+@param error The error that occurred while validating payment parameters. See code attribute (`OPPErrorCode`) and `NSLocalizedDescription` to identify the reason of failure.
+@return Returns an object representing an Ikano private label transaction (as virtual account).
+*/
++ (nullable instancetype)ikanoPrivateLabelVAPaymentParamsWithCheckoutID:(NSString *)checkoutID
+                                                          accountNumber:(NSString *)accountNumber
+                                                            expiryMonth:(NSString *)expiryMonth
+                                                             expiryYear:(NSString *)expiryYear
+                                                    accountVerification:(nullable NSString *)accountVerification
+                                                                  error:(NSError **)error;
+
+/**
+Creates an object representing an Ikano private label transaction (as virtual account).
+
+@param checkoutID The checkout ID of the transaction.
+@param accountNumber The account number.
+@param expiryMonth The expiration month of the account. It is expected in the format `MM`.
+@param expiryYear The expiration year of the account. It is expected in the format `YYYY`.
+@param accountVerification The verification code of the account.
+@param error The error that occurred while validating payment parameters. See code attribute (`OPPErrorCode`) and `NSLocalizedDescription` to identify the reason of failure.
+@return Returns an object representing an Ikano private label transaction (as virtual account).
+*/
+- (nullable instancetype)initWithCheckoutID:(NSString *)checkoutID
+                              accountNumber:(NSString *)accountNumber
+                                expiryMonth:(NSString *)expiryMonth
+                                 expiryYear:(NSString *)expiryYear
+                        accountVerification:(nullable NSString *)accountVerification
+                                      error:(NSError **)error NS_DESIGNATED_INITIALIZER;
+
+/// @name Properties
+
+/** The account number. */
+@property (nonatomic, copy, readonly) NSString *accountNumber;
+
+/** The expiration month of the account in the format `MM`. */
+@property (nonatomic, copy, readonly) NSString *expiryMonth;
+
+/** The expiration year of the account in the format `YYYY`. */
+@property (nonatomic, copy, readonly) NSString *expiryYear;
+
+/** The verification code of the account. */
+@property (nonatomic, copy, readonly) NSString *accountVerification;
+
+/// @name Parameter Checks
+
+/**
+ Checks if account number is valid (card number validation used).
+ 
+ @param accountNumber The account number.
+ @return `YES` if account number is valid, `NO` if it doesn't.
+ */
++ (BOOL)isAccountNumberValid:(NSString *)accountNumber;
+
+/**
+ Checks if expiration month is valid, `MM` format expected.
+ 
+ @param expiryMonth The expiration month of the account.
+ @return `YES` if expiration month is valid, `NO` if it doesn't.
+ */
++ (BOOL)isExpiryMonthValid:(NSString *)expiryMonth;
+
+/**
+ Checks if expiration year is valid, `YYYY` format expected.
+ 
+ @param expiryYear The expiration year of the account.
+ @return `YES` if expiration year is valid, `NO` if it doesn't.
+ */
++ (BOOL)isExpiryYearValid:(NSString *)expiryYear;
+
+/**
+ Checks if account is expired, expiration month and year should represent some date in the future.
+ 
+ @param expiryMonth The expiration month of the account.
+ @param expiryYear The expiration year of the account.
+ @return `YES` if the account is expired. `NO` if the account is not expired yet.
+ */
++ (BOOL)isAccountExpiredWithExpiryMonth:(NSString *)expiryMonth andYear:(NSString *)expiryYear;
+
+/**
+ Checks if verification code in valid, up to 5 digits expected.
+ 
+ @param accountVerification The verification code of the account.
+ @return `YES` if the verification code is valid, `NO` if it doesn't.
+ */
++ (BOOL)isAccountVerificationValid:(NSString *)accountVerification;
+
+@end
+
+NS_ASSUME_NONNULL_END

package/ios/OPPWAMobile.xcframework/ios-arm64_armv7/OPPWAMobile.framework/Headers/OPPInicisPaymentParams.h

@@ -0,0 +1,48 @@
+//
+// Copyright (c) $$year$$ 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 "OPPPaymentParams.h"
+
+/**
+ Class to encapsulate all necessary transaction parameters for performing KG Inicis transaction.
+ */
+NS_ASSUME_NONNULL_BEGIN
+@interface OPPInicisPaymentParams : OPPPaymentParams
+
+/// @name Initialization
+
+/// :nodoc:
+- (instancetype)initWithCheckoutID:(NSString *)checkoutID
+                      paymentBrand:(NSString *)paymentBrand
+                             error:(NSError * _Nullable __autoreleasing *)error NS_UNAVAILABLE;
+
+/**
+ Creates an object representing a KG Inicis transaction.
+ 
+ @param checkoutID The checkout ID of the transaction. Must be not `nil` or empty.
+ @param error The error that occurred while validating payment parameters. See code attribute (`OPPErrorCode`) and `NSLocalizedDescription` to identify the reason of failure.
+ @return Returns an object representing KG Inicis transaction.
+*/
+- (nullable instancetype)initWithCheckoutID:(NSString *)checkoutID
+                                      error:(NSError **)error NS_DESIGNATED_INITIALIZER;
+
+/**
+ Creates an object representing a KG Inicis transaction.
+ 
+ @param checkoutID The checkout ID of the transaction. Must be not `nil` or empty.
+ @param error The error that occurred while validating payment parameters. See code attribute (`OPPErrorCode`) and `NSLocalizedDescription` to identify the reason of failure.
+ @return Returns an object representing KG Inicis transaction.
+*/
++ (nullable instancetype)inicisPaymentParamsWithCheckoutID:(NSString *)checkoutID
+                                                     error:(NSError **)error;
+
+@end
+NS_ASSUME_NONNULL_END

package/ios/OPPWAMobile.xcframework/ios-arm64_armv7/OPPWAMobile.framework/Headers/OPPKlarnaInlinePaymentParams.h

@@ -0,0 +1,41 @@
+//
+// Copyright (c) $$year$$ 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 "OPPPaymentParams.h"
+
+/**
+ Class to encapsulate all necessary transaction parameters for performing Klarna Payments transaction.
+ */
+NS_ASSUME_NONNULL_BEGIN
+@interface OPPKlarnaInlinePaymentParams : OPPPaymentParams
+
+/// @name Initialization
+
+/**
+Creates an object representing a Klarna Payments transaction.
+
+@param checkoutID The checkout ID of the transaction. Must be not `nil` or empty.
+@param paymentBrand The payment brand of the transaction.
+@param error The error that occurred while validating payment parameters. See code attribute (`OPPErrorCode`) and `NSLocalizedDescription` to identify the reason of failure.
+@return Returns an object representing a Klarna Payments transaction.
+*/
++ (nullable instancetype)klarnaInlinePaymentParamsWithCheckoutID:(NSString *)checkoutID
+                                                    paymentBrand:(NSString *)paymentBrand
+                                                           error:(NSError **)error;
+
+/**
+ The id of the initial AD transaction (AD - account discovery). This parameter is required to submit PA transaction after shopper clicked Pay button.
+ */
+@property (nonatomic, copy, nullable) NSString *initialTransactionId;
+
+@end
+NS_ASSUME_NONNULL_END
+

package/ios/OPPWAMobile.xcframework/ios-arm64_armv7/OPPWAMobile.framework/Headers/OPPMBWayPaymentParams.h

@@ -0,0 +1,66 @@
+//
+// Copyright (c) $$year$$ 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 "OPPPaymentParams.h"
+
+/**
+ Class to encapsulate all necessary transaction parameters for performing an MB WAY transaction.
+ */
+
+NS_ASSUME_NONNULL_BEGIN
+@interface OPPMBWayPaymentParams : OPPPaymentParams
+
+/// @name Initialization
+
+/// :nodoc:
+- (instancetype)initWithCheckoutID:(NSString *)checkoutID
+                      paymentBrand:(NSString *)paymentBrand
+                             error:(NSError * _Nullable __autoreleasing *)error NS_UNAVAILABLE;
+
+/**
+ Creates an object representing an MB WAY transaction.
+
+ @param checkoutID The checkout ID of the transaction. Must be not `nil` or empty.
+ @param email Email of the account.
+ @param error The error that occurred while validating payment parameters. See code attribute (`OPPErrorCode`) and `NSLocalizedDescription` to identify the reason of failure.
+ @return Returns an object representing an MB WAY transaction.
+ */
++ (nullable instancetype)mbWayPaymentParamsWithCheckoutID:(NSString *)checkoutID
+                                                    email:(NSString *)email
+                                                    error:(NSError **)error;
+
+/**
+ Creates an object representing an MB WAY transaction.
+ 
+ @param checkoutID The checkout ID of the transaction. Must be not `nil` or empty.
+ @param countryCode Country code of the mobile phone number.
+ @param phoneNumber Mobile phone number of the account.
+ @param error The error that occurred while validating payment parameters. See code attribute (`OPPErrorCode`) and `NSLocalizedDescription` to identify the reason of failure.
+ @return Returns an object representing an MB WAY transaction.
+ */
++ (nullable instancetype)mbWayPaymentParamsWithCheckoutID:(NSString *)checkoutID
+                                              countryCode:(NSString *)countryCode
+                                              phoneNumber:(NSString *)phoneNumber
+                                                    error:(NSError **)error;
+
+/// @name Properties
+
+/** Email of the account. */
+@property (nonatomic, copy, readonly) NSString *email;
+
+/** Country code of the mobile phone number. */
+@property (nonatomic, copy, readonly) NSString *countryCode;
+
+/** Mobile phone number of the account. */
+@property (nonatomic, copy, readonly) NSString *phoneNumber;
+
+@end
+NS_ASSUME_NONNULL_END

package/ios/OPPWAMobile.xcframework/ios-arm64_armv7/OPPWAMobile.framework/Headers/OPPPaymentBrandsConfig.h

@@ -0,0 +1,56 @@
+//
+// Copyright (c) $$year$$ 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 to encapsulate the payment brand configuration parameters from the Server. */
+
+NS_ASSUME_NONNULL_BEGIN
+@interface OPPPaymentBrandsConfig : NSObject
+
+/// @name Properties
+
+/** A flag that specifies whether payment brands from the Server are enabled or not. */
+@property (nonatomic, readonly, getter=isEnabled) BOOL enabled;
+
+/** Payment brand list from the Server. */
+@property (nonatomic, copy, readonly) NSArray<NSString *> *paymentBrands;
+
+/** A flag that specifies whether override checkout payment brands with brands from the Server or not. */
+@property (nonatomic, readonly) BOOL shouldOverride;
+
+/// @name Initialization
+
+/**
+ Creates `OPPPaymentBrandsConfig` 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 `OPPPaymentBrandsConfig` object, or `nil` if JSON contains invalid values.
+ */
++ (nullable instancetype)paymentBrandsConfigFromJSON:(NSDictionary *)JSON;
+
+/**
+ Creates an `OPPPaymentBrandsConfig` object with the provided values.
+ @param paymentBrands List of payment brands from the Server.
+ @param enabled A flag that specifies whether payment brands from the Server are enabled or not.
+ @param shouldOverride A flag that specifies whether override checkout payment brands with brands from the Server or not.
+ */
++ (instancetype)paymentBrandsConfigWithPaymentBrands:(NSArray<NSString *> *)paymentBrands enabled:(BOOL)enabled shouldOverride:(BOOL)shouldOverride;
+
+/**
+ Creates an `OPPPaymentBrandsConfig` object with the provided values.
+ @param paymentBrands List of payment brands from the Server.
+ @param enabled A flag that specifies whether payment brands from the Server are enabled or not.
+ @param shouldOverride A flag that specifies whether override checkout payment brands with brands from the Server or not.
+ */
+- (instancetype)initWithPaymentBrands:(NSArray<NSString *> *)paymentBrands enabled:(BOOL)enabled shouldOverride:(BOOL)shouldOverride;
+
+@end
+NS_ASSUME_NONNULL_END

package/ios/OPPWAMobile.xcframework/ios-arm64_armv7/OPPWAMobile.framework/Headers/OPPPaymentButton.h

@@ -0,0 +1,53 @@
+//
+// Copyright (c) $$year$$ 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 UIKit;
+
+NS_ASSUME_NONNULL_BEGIN
+/**
+ A constant to be used instead of specific card brand. The brand will be detected automatically based on card number.
+ */
+extern NSString *const OPPPaymentBrandCard;
+
+/**
+ Class that extends UIButton in order to esily integrate separate payment methods in the app.
+ 
+ By default button contains appropriate logo if a valid payment method is set. Button can be fully customized as common UIButton.
+ 
+ To create and submit a transaction, use `-[OPPCheckoutProvider presentCheckoutWithPaymentBrand:loadingHandler:completionHandler:cancelHandler:]` in button action method.
+ */
+@interface OPPPaymentButton : UIButton
+
+/// @name Initialization
+
+/**
+ Creates and returns payment button initialized with the payment brand.
+ @param paymentBrand Payment brand for the transaction.
+ */
++ (instancetype)paymentButtonWithPaymentBrand:(NSString *)paymentBrand;
+
+/**
+ Creates and returns payment button initialized with the payment method.
+ @param paymentBrand Payment brand for the transaction.
+ */
+- (instancetype)initWithPaymentBrand:(NSString *)paymentBrand;
+
+/// @name Properties
+
+/**
+ Payment brand for the transaction that is used to display an appropriate logo.
+ Logo will be loaded automatically from the Server.
+ To use your own image for a button, set it before initializing the payment brand.
+ */
+@property (nonatomic, copy) NSString *paymentBrand;
+
+@end
+NS_ASSUME_NONNULL_END

package/ios/OPPWAMobile.xcframework/ios-arm64_armv7/OPPWAMobile.framework/Headers/OPPPaymentParams.h

@@ -0,0 +1,91 @@
+//
+// Copyright (c) $$year$$ 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 to represent a set of parameters needed for performing an e-commerce transaction.
+ */
+
+NS_ASSUME_NONNULL_BEGIN
+@interface OPPPaymentParams : NSObject
+
+/// @name Initialization
+
+/// :nodoc:
+- (instancetype)init NS_UNAVAILABLE;
+
+/**
+ Creates an object representing a payment transaction.
+ 
+ @param checkoutID The checkout ID of the transaction. Must be not `nil` or empty.
+ @param paymentBrand The payment brand of the transaction.
+ @param error The error that occurred while validating payment parameters. See code attribute (`OPPErrorCode`) and `NSLocalizedDescription` to identify the reason of failure.
+ @return Returns an object representing a payment transaction, and `nil` if parameters are invalid.
+ */
++ (nullable instancetype)paymentParamsWithCheckoutID:(NSString *)checkoutID paymentBrand:(NSString *)paymentBrand error:(NSError **)error;
+
+/**
+ Creates an object representing a payment transaction.
+ 
+ @param checkoutID The checkout ID of the transaction. Must be not `nil` or empty.
+ @param paymentBrand The payment brand of the transaction.
+ @param error The error that occurred while validating payment parameters. See code attribute (`OPPErrorCode`) and `NSLocalizedDescription` to identify the reason of failure.
+ @return Returns an object representing a payment transaction, and `nil` if parameters are invalid.
+ */
+- (nullable instancetype)initWithCheckoutID:(NSString *)checkoutID paymentBrand:(NSString *)paymentBrand error:(NSError **)error NS_DESIGNATED_INITIALIZER;
+
+/// @name Properties
+
+/** A property that can be set with a value from initial checkout request (mandatory). This value is required in the next steps. */
+@property (nonatomic, copy, readonly) NSString *checkoutID;
+
+/**
+ The payment brand of the transaction.
+ */
+@property (nonatomic, copy, readonly) NSString *paymentBrand;
+
+/**
+ This URL will receive the result of an asynchronous payment. Must be sent URL encoded.
+ */
+@property (nonatomic, copy, nullable) NSString *shopperResultURL;
+
+/**
+ Dictionary of custom parameters that will be sent to the server.
+ */
+@property (nonatomic, copy, readonly) NSDictionary<NSString *, NSString *> *customParams;
+
+
+/// @name Custom parameters methods 
+
+/**
+Method to add parameter that will be sent to the server.
+@param name Parameter name, expected string that matches regex [0-9a-zA-Z._\\[\\]]{3,64}.
+@param value Any string no longer than 2048 characters.
+@return Returns `YES` if name and value are valid and parameter is successfully saved, otherwise `NO`.
+*/
+- (BOOL)addParamWithName:(NSString *)name value:(NSString *)value;
+
+/**
+ Method to remove record from the dictionary of parameters.
+ @param name Parameter name.
+ */
+- (void)removeParamWithName:(NSString *)name;
+
+/// @name Helper methods
+
+/**
+ Helper method to mask sensitive payment details such as card number, CVV and etc.
+ */
+- (void)mask;
+
+@end
+NS_ASSUME_NONNULL_END