react-native-hyperpay-sdk 0.15.0 → 0.17.0

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

@@ -0,0 +1,89 @@
+//
+// 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 "OPPBaseCardPaymentParams.h"
+
+/**
+ Class to encapsulate all necessary transaction parameters for performing a token transaction.
+ */
+
+NS_ASSUME_NONNULL_BEGIN
+@interface OPPTokenPaymentParams : OPPBaseCardPaymentParams
+
+/// @name Initialization
+
+/// :nodoc:
+- (instancetype)initWithCheckoutID:(NSString *)checkoutID paymentBrand:(NSString *)paymentBrand error:(NSError * _Nullable __autoreleasing *)error NS_UNAVAILABLE;
+
+/**
+ Creates an object representing a token transaction.
+ 
+ @param checkoutID The checkout ID of the transaction. Must be not `nil` or empty.
+ @param tokenID The identifier of the token that can be used to reference the token later.
+ @param paymentBrand Payment brand of the tokenized 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 token transaction, and `nil` if parameters are invalid.
+ */
++ (nullable instancetype)tokenPaymentParamsWithCheckoutID:(NSString *)checkoutID tokenID:(NSString *)tokenID paymentBrand:(NSString *)paymentBrand error:(NSError **)error;
+
+/**
+ Creates an object representing a token transaction.
+ 
+ @param checkoutID The checkout ID of the transaction. Must be not `nil` or empty.
+ @param tokenID The identifier of the token that can be used to reference the token later.
+ @param cardPaymentBrand The payment brand of the tokenized card.
+ @param CVV The CVV code found on the card.
+ @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 token transaction, and `nil` if parameters are invalid.
+ */
++ (nullable instancetype)tokenPaymentParamsWithCheckoutID:(NSString *)checkoutID tokenID:(NSString *)tokenID cardPaymentBrand:(NSString *)cardPaymentBrand CVV:(nullable NSString *)CVV error:(NSError **)error;
+
+/**
+ Creates an object representing a token transaction.
+ 
+ @param checkoutID The checkout ID of the transaction. Must be not `nil` or empty.
+ @param tokenID The identifier of the token that can be used to reference the token later.
+ @param paymentBrand Payment method brand.
+ @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 token transaction, and `nil` if parameters are invalid.
+ */
+ - (nullable instancetype)initWithCheckoutID:(NSString *)checkoutID tokenID:(NSString *)tokenID paymentBrand:(NSString *)paymentBrand error:(NSError **)error NS_DESIGNATED_INITIALIZER;
+
+/**
+ Creates an object representing a token transaction.
+ 
+ @param checkoutID The checkout ID of the transaction. Must be not `nil` or empty.
+ @param tokenID The identifier of the token that can be used to reference the token later.
+ @param cardPaymentBrand The payment brand of the tokenized card.
+ @param CVV The CVV code found on the card.
+ @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 token transaction, and `nil` if parameters are invalid.
+ */
+- (nullable instancetype)initWithCheckoutID:(NSString *)checkoutID tokenID:(NSString *)tokenID cardPaymentBrand:(NSString *)cardPaymentBrand CVV:(nullable NSString *)CVV error:(NSError **)error NS_DESIGNATED_INITIALIZER;
+
+/// @name Properties
+
+/**
+ The identifier of the token that can be used to reference the token later.
+ */
+@property (nonatomic, copy, readonly) NSString *tokenID;
+
+/// @name Validation methods
+/**
+ Checks if the token identifier is valid to perform a transaction.
+ 
+ @param tokenID The identifier of the token that can be used to reference the token later.
+ @return `YES` if token identifier is alpha-numeric string of length 32.
+ */
++ (BOOL)isTokenIDValid:(NSString *)tokenID;
+
+@end
+NS_ASSUME_NONNULL_END

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

@@ -0,0 +1,121 @@
+//
+// 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 OPPTransactionProcessor;
+@class OPPPaymentParams;
+@class OPPThreeDS2Info;
+@class OPPYooKassaInfo;
+
+/// An enumeration for the various types of transaction.
+typedef NS_ENUM(NSInteger, OPPTransactionType) {
+    /// The synchronous transaction.
+    OPPTransactionTypeSynchronous,
+    /// The asynchronous transaction.
+    OPPTransactionTypeAsynchronous,
+    /// The transaction is undefined.
+    OPPTransactionTypeUndefined
+};
+
+/**
+ Class to encapsulate the parameters needed for performing transaction.
+ */
+
+NS_ASSUME_NONNULL_BEGIN
+@interface OPPTransaction : NSObject
+
+/// @name Initialization
+
+/// :nodoc:
+- (instancetype)init NS_UNAVAILABLE;
+
+/**
+ Creates and returns transaction initialized with payment params.
+ 
+ @param paymentParams The payment parameters for transaction. Must not be `nil`.
+ */
++ (instancetype)transactionWithPaymentParams:(OPPPaymentParams *)paymentParams;
+
+/**
+ Creates and returns transaction initialized with payment params.
+ 
+ @param paymentParams The payment parameters for transaction. Must not be `nil`.
+ */
+- (instancetype)initWithPaymentParams:(OPPPaymentParams *)paymentParams NS_DESIGNATED_INITIALIZER;
+
+/// @name Properties
+
+/** 
+ The parameters representing a specific payment method that are kept as an `OPPPaymentParams` object.
+ */
+@property (nonatomic, readonly) OPPPaymentParams *paymentParams;
+
+/**
+ The type of the transaction.
+ */
+@property (nonatomic, readonly) OPPTransactionType type;
+
+/// The URL to the receiver system (e.g. 3-D Secure, PayPal) that the shopper should be forwarded to. The property has `nil` value on synchronous transaction.
+@property (nonatomic, nullable) NSURL *redirectURL;
+
+/**
+ Relative path to get status of transaction.
+ @note The property is returned ONLY from `OPPCheckoutProvider` methods. If you are using core SDK, please request checkout info to get `checkoutInfo.resourcePath` by calling `-[OPPPaymentProvider requestCheckoutInfoWithCheckoutID:completionHandler:]`.
+ */
+@property (nonatomic, copy, nullable) NSString *resourcePath;
+
+/// 3-D Secure 2 response parameters.
+@property (nonatomic, readonly, nullable) OPPThreeDS2Info *threeDS2Info;
+
+/// YooKassa response parameters.
+@property (nonatomic, readonly, nullable) OPPYooKassaInfo *yooKassaInfo;
+
+/// The URL which posts threeDSMethodData to the ACS. It should be opened in a hidden iframe.
+ @property (nonatomic, nullable) NSURL *threeDS2MethodRedirectURL;
+
+/**
+ Dictionary for holding brand-specific parameters like:
+ @see `OPPTransactionKlarnaInlineClientTokenKey`, `OPPTransactionKlarnaInlineClientCallbackUrlKey`, `OPPTransactionKlarnaInlineClientFailureCallbackUrlKey`, `OPPTransactionKlarnaInlineInitialTransactionIdKey`, `OPPTransactionAlipaySignedOrderInfoKey`.
+ */
+@property (nonatomic, readonly, nullable) NSDictionary<NSString *, NSString *> *brandSpecificInfo;
+
+/**
+Constant for a key to get Klarna Payments client token value from the transaction response.
+*/
+FOUNDATION_EXPORT NSString *const OPPTransactionKlarnaInlineClientTokenKey;
+
+/**
+Constant for a key to get Klarna Payments callback URL value from the transaction response.
+*/
+FOUNDATION_EXPORT NSString *const OPPTransactionKlarnaInlineClientCallbackUrlKey;
+
+/**
+Constant for a key to get Klarna Payments failure callback URL from the transaction response.
+*/
+FOUNDATION_EXPORT NSString *const OPPTransactionKlarnaInlineClientFailureCallbackUrlKey;
+
+/**
+Constant for a key to get Klarna Payments initial transaction id from the transaction response.
+*/
+FOUNDATION_EXPORT NSString *const OPPTransactionKlarnaInlineInitialTransactionIdKey;
+
+/**
+Constant for a key to get Alipay seller's order information which should be forwarded to Alipay native SDK.
+*/
+FOUNDATION_EXPORT NSString *const OPPTransactionAlipaySignedOrderInfoKey;
+
+/**
+Constant for a key to get Bancontact app scheme URL to redirect to the Bancontact app.
+*/
+FOUNDATION_EXPORT NSString *const OPPTransactionBancontactLinkAppSchemeUrlKey;
+
+@end
+NS_ASSUME_NONNULL_END

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

@@ -0,0 +1,60 @@
+//
+// 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 shopper’s virtual account details that have been tokenized.
+ */
+
+NS_ASSUME_NONNULL_BEGIN
+@interface OPPVirtualAccount : NSObject
+
+/// @name Properties
+
+/** The name of virtual account holder. */
+@property (nonatomic, copy, nullable) NSString *holder;
+
+/** The identifier of the virtual account. */
+@property (nonatomic, copy) NSString *accountId;
+
+/// @name Initialization
+
+/// :nodoc:
+- (instancetype)init NS_UNAVAILABLE;
+
+/**
+ Creates an `OPPVirtualAccount` object from the JSON.
+ @param JSON A dictionary with parameters received from the Server.
+ @return Returns an `OPPVirtualAccount` object, or `nil` if JSON contains invalid values.
+ */
++ (nullable instancetype)virtualAccountFromJSON:(NSDictionary *)JSON;
+
+/**
+ Creates an `OPPVirtualAccount` object with the provided values.
+ @param holder The name of virtual account holder.
+ @param accountId The identifier of the virtual account.
+ @return Returns an `OPPVirtualAccount` object, or `nil` if parameters are empty.
+ */
++ (nullable instancetype)virtualAccountWithHolder:(nullable NSString *)holder
+                                        accountId:(NSString *)accountId;
+
+/**
+ Creates an `OPPVirtualAccount` object with the provided values.
+ @param holder The name of virtual account holder.
+ @param accountId The identifier of the virtual account.
+ @return Returns an `OPPVirtualAccount` object, or `nil` if parameters are empty.
+ */
+- (nullable instancetype)initWithHolder:(nullable NSString *)holder
+                              accountId:(NSString *)accountId NS_DESIGNATED_INITIALIZER;
+
+@end
+NS_ASSUME_NONNULL_END