react-native-hyperpay-sdk 0.39.0 → 1.0.1

package/OPPWAMobile.xcframework/ios-arm64_x86_64-simulator/OPPWAMobile.framework/Headers/OPPPaymentProvider.h

@@ -0,0 +1,239 @@
+//  © Copyright ACI Worldwide, Inc. 2018, 2026
+
+@import Foundation;
+@import PassKit;
+@class OPPTransaction;
+@class OPPPaymentParams;
+@class OPPCheckoutInfo;
+@class OPPThreeDSConfig;
+@class OPPBinInfo;
+@class Warning;
+@class OPPCheckoutData;
+@class OPPBrandInfo;
+@class OPPInstallmentPlanParams;
+@class OPPInstallmentPlanResponse;
+@class OPPPollingParams;
+@class OPPPollingStatus;
+
+/// An enumeration for the various provider modes.
+typedef NS_ENUM(NSInteger, OPPProviderMode) {
+    /// Sandbox environment for testing integration.
+    OPPProviderModeTest,
+    /// Live server for real transactions.
+    OPPProviderModeLive
+};
+
+NS_ASSUME_NONNULL_BEGIN
+
+/**
+ A protocol to handle 3D Secure workflow.
+ */
+@protocol OPPThreeDSEventListener <NSObject>
+@optional
+
+/**
+ Called before initialization of `OPPThreeDSService`.
+ Use this callback to provide `OPPThreeDSConfig` configurations applied during `OPPThreeDSService` initialization phase.
+ @param completion The completion block you should call to continue 3D Secure transaction.
+ */
+- (void)onThreeDSConfigRequiredWithCompletion:(void (^)(OPPThreeDSConfig *config))completion;
+
+/**
+ Called before starting the authentication process of 3D Secure transaction.
+ Use this callback to provide UINavigationController, which will be used for 3D Secure challenge process.
+ @param completion The completion block you should call to continue 3D Secure transaction.
+ */
+- (void)onThreeDSChallengeRequiredWithCompletion:(void (^)(UINavigationController *navController))completion;
+
+@end
+
+/**
+ Defines the methods and properties of the payment provider. Use the factory method `+paymentProviderWithMode:` to instantiate a new provider.
+*/
+@interface OPPPaymentProvider : NSObject
+
+/// @name Properties
+
+/**
+ Determines the type of Server to use. Transactions to the LIVE server come with fees attached.
+*/
+@property (nonatomic) OPPProviderMode mode;
+
+/**
+ Delegate for processing the 3-D Secure transaction.
+ */
+@property (nonatomic, weak, nullable) id<OPPThreeDSEventListener> threeDSEventListener;
+
+/// @name Factory methods
+
+/**
+ Factory method to obtain a new provider.
+ @param mode Determines the type of Server to use. Transactions to the LIVE server come with fees attached.
+ @return An `OPPPaymentProvider` which can be used to process transactions.
+*/
++ (instancetype)paymentProviderWithMode:(OPPProviderMode)mode;
+
+/// @name Process transaction
+
+/**
+ On sending a transaction, it is performed asynchronously using an `NSURLSession` to communicate with the Server. Depending on the endpoint the transaction will be submitted or registered only without making the payment.
+ 
+ @param transaction The transaction to be sent.
+ @param endpoint The endpoint which will be used for processing transaction. The endpoint must start with a `"/"`.
+ @param completionHandler A block executed when the transaction is sent.
+ */
+- (void)sendTransaction:(OPPTransaction *)transaction toEndpoint:(NSString *)endpoint completionHandler:(void (^)(OPPTransaction *transaction, NSError * _Nullable error))completionHandler;
+
+/**
+ On submitting a transaction, it is performed asynchronously using an `NSURLSession` to communicate with the Server. Depending on the concrete type of the transaction, various calls to the server are necessary to ensure proper processing. Submitting means that the transaction is sent to the server, where it will cause a debit of the given amount on the account specified in the `OPPTransaction`'s `OPPPaymentParams`.
+ 
+ @param transaction The transaction to be submitted.
+ @param completionHandler A block executed when the transaction is submitted.
+*/
+- (void)submitTransaction:(OPPTransaction *)transaction completionHandler:(void (^)(OPPTransaction *transaction, NSError * _Nullable error))completionHandler;
+
+/**
+ On storing a payment data, it is performed asynchronously using an `NSURLSession` to communicate with the Server. The method creates a just registration separate from any later payment.
+ 
+ @param transaction The transaction to be registered.
+ @param completionHandler A block executed when the transaction is registered.
+ */
+- (void)registerTransaction:(OPPTransaction *)transaction completionHandler:(void (^)(OPPTransaction *transaction, NSError * _Nullable error))completionHandler;
+
+/// @name Request checkout info
+/**
+ Requests checkout details such as amount, currency and tokens from the Server by checkout ID.
+ Request is performed asynchronously using an `NSURLSession`.
+ 
+ @param checkoutID The checkout ID of a transaction.
+ @param completionHandler The completion block will be invoked once the response in received. On success, you will receive an instance of `OPPCheckoutInfo`; on failure, an error.
+ */
+- (void)requestCheckoutInfoWithCheckoutID:(NSString *)checkoutID completionHandler:(void (^)(OPPCheckoutInfo * _Nullable checkoutInfo, NSError * _Nullable error))completionHandler;
+
+/// @name Request URLs for payment brand logos
+/**
+ Requests logo URLs for specified payment brands.
+ Request is performed asynchronously using an `NSURLSession`.
+ 
+ @param paymentBrands The list of payment brands to get logos from the Server.
+ @param completionHandler The completion block will be invoked once the response in received. On success, you will receive a dictionary with URLs in format `<paymentBrand: URL>`; on failure, an error.
+ */
+- (void)requestLogoURLsForPaymentBrands:(NSArray<NSString *> *)paymentBrands completionHandler:(void (^)(NSDictionary<NSString *, NSURL *> * _Nullable URLs, NSError * _Nullable error))completionHandler;
+
+/// @name Request `OPPBinInfo` for provided card bin
+/**
+@note If you are using core SDK, please request checkout info by calling `-[OPPPaymentProvider requestCheckoutInfoWithCheckoutID:completionHandler:]` before requestBinInfo call. Checkout info call is essential part of the flow, error will be thrown otherwise.
+ 
+@param checkoutID The checkout ID of a transaction.
+@param bin First 6 or more digits of the card number.
+@param completionHandler The completion block will be invoked once the response in received. On success, you will receive an instance of `OPPBinInfo`; on failure, an error.
+ */
+- (void)requestBinInfoWithCheckoutID:(NSString *)checkoutID
+                                 bin:(NSString *)bin
+                   completionHandler:(void (^)(OPPBinInfo * _Nullable binInfo,
+                                               NSError * _Nullable error))completionHandler;
+
+/**
+ Requests a list of iDeal banks.
+ 
+ This method is deprecated.
+ 
+ @param checkoutID The checkout ID of a transaction.
+ @param completionHandler The completion block which will be invoked once the response is received. On success, you will receive a list of banks in array, and on failure an error is received.
+ */
+- (void)requestIdealBanksWithCheckoutID:(nonnull NSString *)checkoutID
+                      completionHandler:(void (^)(NSArray <NSDictionary *> * _Nullable banks,
+                                                  NSError * _Nullable error))completionHandler __attribute__ ((deprecated));
+
+/// @name 3D Secure
+/**
+ The ipworks3ds SDK performs security checks in order to provide a  list of `Warning` objects. These can be checked by the app to determine whether or not to proceed with the checkout process.
+ 
+ @param completionHandler The completion block will be invoked once the performing of security checks is done . On success, you will receive an instance of `Warning`; on failure, an error.
+ */
+- (void)securityWarningsWithCompletionHandler:(void (^)(NSArray<Warning *> * _Nullable warnings,
+                                                        NSError * _Nullable error))completionHandler;
+
+/// @name Apple Pay methods
+/**
+ Determine whether this device can process Apple Pay payment requests using specific payment request. Your application should confirm that the user can make payments before attempting to authorize a payment. Your application may also want to alter its appearance or behavior when the user is not allowed to make payments.
+ 
+ @param request The return value of this method depends on the `supportedNetworks` property of this payment request.
+ 
+ @return `YES` if the user can authorize payments on this device using the payment request. `NO` if the user cannot authorize payments on these networks or if the user is restricted from authorizing payments.
+ */
++ (BOOL)canSubmitPaymentRequest:(PKPaymentRequest *)request;
+
+/**
+ Whether or not this device is capable of using Apple Pay. This checks both whether the user is running an iPhone 6/6+ or later, iPad Air 2 or later, or iPad mini 3 or later, as well as whether or not they have stored any cards in Apple Pay on their device.
+ 
+ @return Whether or not the user is currently able to pay with Apple Pay.
+ */
++ (BOOL)deviceSupportsApplePay;
+
+/**
+ A convenience method to return a `PKPaymentRequest` with sane default values. You will still need to configure the `paymentSummaryItems` property to indicate what the user is purchasing.
+ 
+ @param merchantIdentifier Your Apple Merchant ID, as obtained at https://developer.apple.com/account/ios/identifiers/merchant/merchantCreate.action
+ @param countryCode The merchant's ISO country code. We suggest using the country where your business is located.
+ @return A `PKPaymentRequest` with proper default values.
+ */
++ (PKPaymentRequest *)paymentRequestWithMerchantIdentifier:(NSString *)merchantIdentifier countryCode:(NSString *)countryCode;
+
+/// @name Device authentication
+
+/**
+ A convenience method to check if Touch ID, Face ID or passcode are set on user device.
+ @return `NO` if neither Touch ID/Face ID nor passcode are set, otherwise `YES`.
+ */
++ (BOOL)isDeviceAuthenticationAvailable;
+
+/**
+ * Returns the list of FPX banks as a dictionary.
+ * Key from the dictionary will be banks display name and bank name will be value for that key.
+ * @return A dictionary of FPX payment bank names where key will be banks display name and its value will be bank name.
+ */
++ (NSDictionary<NSString *, NSString *> * _Nonnull)getFPXBanks;
+
+/**
+ Requests a Apple's  recurring payments tokenId.
+ 
+ @param checkoutID The checkout ID of a transaction.
+ @param completionHandler The completion block which will be invoked once the response is received. On success, you will receive a tokenId, and on failure an error is received.
+ */
+- (void)requestApplesTokenIdWithCheckoutID:(nonnull NSString *)checkoutID
+                         completionHandler:(void (^)(NSString * _Nullable tokenId,
+                                                     NSError * _Nullable error))completionHandler;
+
+/**
+ Requests a Checkout payment data
+ 
+ @param checkoutID The checkout ID of a transaction.
+ @param completionHandler The completion block which will be invoked once the response is received. On success, you will receive an OPPCheckoutData ojbect with payment data, and on failure an error is received.
+ */
+- (void)requestCheckoutDataWithCheckoutID:(nonnull NSString *)checkoutID
+                        completionHandler:(void (^)(OPPCheckoutData * _Nullable checkoutData, NSError * _Nullable error))completionHandler;
+
+/// :nodoc:
+- (void)requestValidationsForPaymentBrands:(nonnull NSArray<NSString*> *)paymentBrands
+                                checkoutID:(nonnull NSString *)checkoutID
+                         completionHandler:(void (^)(NSArray<OPPBrandInfo *> * _Nullable brandRules,
+                                                     NSError * _Nullable error))completionHandler;
+
+/// :nodoc:
+- (void)sendThreeDS2AuthParams:(nonnull NSString *)authParams
+                   transaction:(nonnull OPPTransaction *)transaction
+             completionHandler:(void (^)(OPPTransaction * _Nonnull transaction,
+                                         NSError * _Nullable error))completionHandler;
+
+- (void)getVisaInstallmentPlans:(nonnull OPPInstallmentPlanParams *)planParams
+              completionHandler:(void (^)(OPPInstallmentPlanResponse * _Nullable response,
+                                          NSError * _Nullable error))completionHandler;
+
+/// :nodoc:
+- (void)getPollingData:(nonnull OPPPollingParams *)params
+     completionHandler:(void (^)(OPPPollingStatus * _Nullable response,
+                                 NSError * _Nullable error))completionHandler;
+@end
+NS_ASSUME_NONNULL_END
+

package/OPPWAMobile.xcframework/ios-arm64_x86_64-simulator/OPPWAMobile.framework/Headers/OPPPaymentSchemes.h

@@ -0,0 +1,21 @@
+//  © Copyright ACI Worldwide, Inc. 2018, 2026
+
+#import <Foundation/Foundation.h>
+#import "OPPCheckoutProvider.h"
+
+@class OPPToken;
+@class OPPPaymentParams;
+
+NS_ASSUME_NONNULL_BEGIN
+
+/// :nodoc:
+
+@interface OPPPaymentSchemes : NSObject
+- (nullable instancetype)initWithCheckoutProvider:(nonnull OPPCheckoutProvider *)checkoutProvider;
+- (void)obtainCheckoutInfoCompletion:(void (^)(NSError * _Nullable error))completion;
+- (NSArray<NSString *> *)paymentSchemes;
+- (NSArray<OPPToken *> *)cardTokens;
+- (nullable OPPPaymentParams *)preparePaymentParamsWithPaymentBrand:(nonnull NSString *)paymentBrand token:(nullable OPPToken *)token;
+@end
+
+NS_ASSUME_NONNULL_END

package/OPPWAMobile.xcframework/ios-arm64_x86_64-simulator/OPPWAMobile.framework/Headers/OPPPaymentSelectionComponent.h

@@ -0,0 +1,15 @@
+//  © Copyright ACI Worldwide, Inc. 2018, 2026
+
+#import <Foundation/Foundation.h>
+#import "OPPCheckoutProvider.h"
+
+/// :nodoc:
+
+NS_ASSUME_NONNULL_BEGIN
+
+@interface OPPPaymentSelectionComponent : NSObject
+- (instancetype)init NS_UNAVAILABLE;
+- (nullable instancetype)initWithCheckoutProvider:(nonnull OPPCheckoutProvider *)checkoutProvider viewController:(nonnull UIViewController *)controller;
+@end
+
+NS_ASSUME_NONNULL_END

package/OPPWAMobile.xcframework/ios-arm64_x86_64-simulator/OPPWAMobile.framework/Headers/OPPPaymentSelectionProtocol.h

@@ -0,0 +1,27 @@
+//  © Copyright ACI Worldwide, Inc. 2018, 2026
+
+#import <Foundation/Foundation.h>
+#import <UIkit/UIkit.h>
+
+@class OPPToken;
+
+NS_ASSUME_NONNULL_BEGIN
+
+/// :nodoc:
+@protocol OPPPaymentSchemeSelectionActionDelegate <NSObject>
+- (void)viewControllerDidLoaded;
+- (void)paymentSelectionControllerDidCancel;
+- (void)paymentSelectionControllerDidSelectPaymentBrand:(nonnull NSString *)paymentBrand
+                                      completionHandler:(nullable void (^)(BOOL success))completionHandler;
+- (void)paymentSelectionControllerDidSelectToken:(nonnull OPPToken *)token
+                               completionHandler:(nullable void (^)(BOOL success))completionHandler;
+@end
+
+/// :nodoc:
+@protocol OPPPaymentSelectionDataSource <NSObject>
+- (void)paymentSelectionControllerPaymentBrands:(nonnull NSArray<NSString *> *)paymentBrands;
+- (void)paymentSelectionControllerCardTokens:(nonnull NSArray<OPPToken *> *)cardTokens;
+@property (nonatomic, nullable) id<OPPPaymentSchemeSelectionActionDelegate> paymentSchemeActionDelegate;
+@end
+
+NS_ASSUME_NONNULL_END

package/OPPWAMobile.xcframework/ios-arm64_x86_64-simulator/OPPWAMobile.framework/Headers/OPPPaymentSelectionViewModel.h

@@ -0,0 +1,20 @@
+//  © Copyright ACI Worldwide, Inc. 2018, 2026
+
+#import <Foundation/Foundation.h>
+#import "OPPCheckoutProvider.h"
+
+@class OPPToken;
+
+NS_ASSUME_NONNULL_BEGIN
+
+/// :nodoc:
+
+@interface OPPPaymentSelectionViewModel : NSObject
+- (instancetype)init NS_UNAVAILABLE;
+- (nullable instancetype)initWithCheckoutProvider:(nonnull OPPCheckoutProvider *)checkoutProvider viewController:(nonnull UIViewController *)controller;
+- (void)loadPaymentSchemes;
+- (void)paymentSelectionControllerDidSelectPaymentBrand:(NSString *)paymentBrand completionHandler:(nullable void (^)(BOOL success))completionHandler;
+- (void)paymentSelectionControllerDidSelectToken:(nonnull OPPToken *)token completionHandler:(void (^)(BOOL success))completionHandler;
+@end
+
+NS_ASSUME_NONNULL_END

package/OPPWAMobile.xcframework/ios-arm64_x86_64-simulator/OPPWAMobile.framework/Headers/OPPTheme.h

@@ -0,0 +1,24 @@
+//  © Copyright ACI Worldwide, Inc. 2018, 2026
+
+@import Foundation;
+@import UIKit;
+
+/**
+ Base class of OPPCheckoutTheme
+ */
+
+NS_ASSUME_NONNULL_BEGIN
+@interface OPPTheme : NSObject
+
+/**
+ Indicator view processing style that is shown over primary background color.
+ */
+@property (nonatomic) UIActivityIndicatorViewStyle activityIndicatorPrimaryStyle;
+
+/**
+ Indicator view processing style that is shown over secondary background color.
+ */
+@property (nonatomic) UIActivityIndicatorViewStyle activityIndicatorSecondaryStyle;
+
+@end
+NS_ASSUME_NONNULL_END

package/OPPWAMobile.xcframework/ios-arm64_x86_64-simulator/OPPWAMobile.framework/Headers/OPPThreeDSChallengeUiType.h

@@ -0,0 +1,22 @@
+//  © Copyright ACI Worldwide, Inc. 2018, 2026
+
+#import <Foundation/Foundation.h>
+
+/// An enumeration for the various types of UI for displaying challenge screens.
+/// @note An enumeration is represented by bitmask values that may be combined together. For example, it's valid to specify several options in an option set: `[.text, .html]`.
+typedef NS_OPTIONS(NSUInteger, OPPThreeDSChallengeUiType) {
+    /// Format for a one-time passcode (OTP) or text during a non-payment authentication transaction.
+    OPPThreeDSChallengeUiTypeText = 1,
+    /// Format that allows multiple options to be presented to the cardholder to obtain single response.
+    OPPThreeDSChallengeUiTypeSingleSelect = 2,
+    /// Format that allows multiple options to be presented to the Cardholder to obtain multiple response on single screen.
+    OPPThreeDSChallengeUiTypeMultiSelect = 4,
+    /// Format that allows to complete authentication outside of the merchant app, e.g. in issuer’s mobile app.
+    OPPThreeDSChallengeUiTypeOob = 8,
+    /// Format that allows to present issuer-specific designed html in a web view.
+    OPPThreeDSChallengeUiTypeHtml = 16,
+    /// Format that allows to present issuer-specific designed html oob in a web view.
+    OPPThreeDSChallengeUiTypeHtmlOob = 32,
+    /// Format that allows to present information to be presented.
+    OPPThreeDSChallengeUiTypeInformation = 64
+};

package/OPPWAMobile.xcframework/ios-arm64_x86_64-simulator/OPPWAMobile.framework/Headers/OPPViewController.h

@@ -0,0 +1,17 @@
+//  © Copyright ACI Worldwide, Inc. 2018, 2026
+
+#import <Foundation/Foundation.h>
+
+#ifndef OPPViewController_h
+#define OPPViewController_h
+
+/// An enumeration of possible custom UI controllers.
+typedef NSString * OPPViewController NS_STRING_ENUM;
+
+/// Constant for a key to custom Card Details View Controller.
+extern OPPViewController const OPPViewControllerCardDetails;
+
+/// Constant for a key to custom Payment Selection View Controller.
+extern OPPViewController const OPPViewControllerPaymentSelection;
+
+#endif /* OPPViewController_h */