react-native-hyperpay-sdk 0.1.0

package/OPPWAMobile.framework/Headers/OPPChinaUnionPayPaymentParams.h

@@ -0,0 +1,62 @@
+//
+// 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 "OPPPaymentParams.h"
+
+/**
+ Class to encapsulate all necessary transaction parameters for performing a China UnionPay (UPOP) transaction.
+ */
+
+NS_ASSUME_NONNULL_BEGIN
+@interface OPPChinaUnionPayPaymentParams : OPPPaymentParams
+
+/// @name Initialization
+
+/// :nodoc:
+- (instancetype)initWithCheckoutID:(NSString *)checkoutID paymentBrand:(NSString *)paymentBrand error:(NSError * _Nullable __autoreleasing *)error NS_UNAVAILABLE;
+
+/**
+ Creates an object representing a China UnionPay transaction.
+ 
+ @param checkoutID The checkout ID of the transaction. Must be not `nil` or empty.
+ @param holder Holder of the card 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 a China UnionPay transaction.
+ */
++ (nullable instancetype)chinaUnionPayPaymentParamsWithCheckoutID:(NSString *)checkoutID holder:(nullable NSString *)holder error:(NSError **)error;
+
+/**
+ Creates an object representing a China UnionPay transaction.
+ 
+ @param checkoutID The checkout ID of the transaction. Must be not `nil` or empty.
+ @param holder Holder of the card 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 a China UnionPay transaction.
+ */
+- (nullable instancetype)initWithCheckoutID:(NSString *)checkoutID holder:(nullable NSString *)holder error:(NSError **)error NS_DESIGNATED_INITIALIZER;
+
+/// @name Properties
+
+/** Holder of the account. The length must be greater than 3 characters and less then 128 character. */
+@property (nonatomic, copy, readonly) NSString *holder;
+
+/// @name Parameter Checks
+
+/**
+ Checks if the holder name is filled with sufficient data to perform a transaction.
+ 
+ @param holder Holder of the card account.
+ @return `YES` if the holder name length greater than 3 characters and less than 128 character.
+ */
++ (BOOL)isHolderValid:(NSString *)holder;
+
+@end
+NS_ASSUME_NONNULL_END

package/OPPWAMobile.framework/Headers/OPPErrors.h

@@ -0,0 +1,183 @@
+//
+// 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>
+
+/// An enumeration for the various types of error that resulted in an operation's failure.
+typedef NS_ENUM(NSInteger, OPPErrorCode) {
+    /// Unsupported transaction payment params.
+    OPPErrorCodePaymentParamsUnsupported = 1000,
+    /// Transaction checkoud ID is not valid.
+    OPPErrorCodePaymentParamsCheckoutIDInvalid = 1010,
+    /// Brand doesn't match payment params class.
+    OPPErrorCodePaymentParamsBrandInvalid = 1011,
+    /// The token identifier is invalid. Must be alpha-numeric string of length 32.
+    OPPErrorCodePaymentParamsTokenIDInvalid = 1090,
+    /// Tokenization is not supported for chosen payment brand.
+    OPPErrorCodePaymentParamsTokenizationUnsupported = 1091,
+
+    /// Holder must at least contain first and last name.
+    OPPErrorCodeCardHolderInvalid = 1110,
+    /// Invalid card number. Does not pass the Luhn check.
+    OPPErrorCodeCardNumberInvalid = 1111,
+    /// Unsupported card brand.
+    OPPErrorCodeCardBrandInvalid = 1112,
+    /// Month must be in the format MM.
+    OPPErrorCodeCardMonthInvalidFormat = 1113,
+    /// Year must be in the format YYYY.
+    OPPErrorCodeCardYearInvalidFormat = 1114,
+    /// Card is expired.
+    OPPErrorCodeCardExpired = 1115,
+    /// CVV invalid. Must be three or four digits.
+    OPPErrorCodeCardCVVInvalid = 1116,
+    
+    /// Holder of the bank account is not valid.
+    OPPErrorCodeBankAccountHolderInvalid = 1130,
+    /// IBAN is not valid.
+    OPPErrorCodeBankAccountIBANInvalid = 1131,
+    /// The country code of the bank is invalid. Should match ISO 3166-1 two-letter standard.
+    OPPErrorCodeBankAccountCountryInvalid = 1132,
+    /// The name of the bank which holds the account is invalid.
+    OPPErrorCodeBankAccountBankNameInvalid = 1133,
+    /// The BIC (Bank Identifier Code (SWIFT)) number of the bank account is invalid.
+    OPPErrorCodeBankAccountBICInvalid = 1134,
+    /// The code associated with the bank account is invalid.
+    OPPErrorCodeBankAccountBankCodeInvalid = 1135,
+    /// The account number of the bank account is invalid.
+    OPPErrorCodeBankAccountNumberInvalid = 1136,
+    
+    /// The Apple Pay payment token data is invalid. To perform this type of transaction a valid payment token data is needed.
+    OPPErrorCodeApplePayTokenDataInvalid = 1150,
+    
+    /// The phone number is not valid.
+    OPPErrorCodePhoneNumberInvalid = 1160,
+    /// The country code is not valid.
+    OPPErrorCodeCountryCodeInvalid = 1161,
+    /// The email is not valid.
+    OPPErrorCodeEmailInvalid = 1162,
+    /// The national identifier is not valid.
+    OPPErrorCodeNationalIdentifierInvalid = 1163,
+    
+    /// Checkout info cannot be loaded.
+    OPPErrorCodeCheckoutInfoCannotBeLoaded = 2000,
+    /// There are no available payment methods in checkout.
+    OPPErrorCodeNoAvailablePaymentMethods = 2001,
+    /// Payment method is not available.
+    OPPErrorCodePaymentMethodNotAvailable = 2002,
+    /// The transaction was aborted.
+    OPPErrorCodeTransactionAborted = 2003,
+    /// Brand validation rules cannot be loaded from.
+    OPPErrorCodeBrandValidationCannotBeLoaded = 2004,
+    
+    /// The transaction was declined. Please contact the system administrator of the merchant server to get the reason of failure.
+    OPPErrorCodeTransactionProcessingFailure = 2010,
+    /// The сheckout configuration is not valid.
+    OPPErrorCodeInvalidCheckoutConfiguration = 2020,
+    
+    /// Unexpected connection error. Please contact the system administrator of the server.
+    OPPErrorCodeConnectionFailure = 3000,
+    
+    /// Invalid input parameters for the request.
+    OPPErrorCodeRequestParametersInvalid = 3001,
+    
+    /// Invalid response from the Server.
+    OPPErrorCodeServerResponseInvalid = 3002,
+    
+    /// File loaded from resources does not have valid checksum. Make sure you installed the framework correctly and no one has been tampering with the application.
+    OPPErrorCodeSecurityXMLManipulation = 4000,
+    
+    /// Invalid framework version. Versions of base and extension frameworks are not matching.
+    OPPErrorCodeFrameworkVersionInvalid = 5000
+};
+
+/**
+ Contains all error messages and codes that returned by SDK methods.
+ 
+ To retrieve the return code ([OPPErrorCode](../Constants/OPPErrorCode.html )) use the code attribute of the `NSError` object:
+ 
+     error.code;
+ 
+ To retrieve the error description look to localized description:
+ 
+     (NSString *)error.localizedDescription;
+ 
+ ## User info dictionary keys
+ 
+ This key may exist in the user info dictionary, in addition to those defined for `NSError`.
+ 
+     NSString *const OPPErrorTransactionFailureDetailsKey
+ 
+ ### Constants
+ 
+ `OPPErrorTransactionFailureDetailsKey`
+ The corresponding value is an `NSDictionary` containing the detail transaction failure information.
+ 
+ ##Error codes
+ Below you can find all currently supported error codes. See also separate page with `OPPErrorCode` enum definition.
+ ###Payment params errors:
+ - 1000: Unsupported transaction payment params.
+ - 1010: Transaction checkoud ID is not valid.
+ - 1011: Brand doesn't match payment params class.
+ - 1090: The token identifier is invalid. Must be alpha-numeric string of length 32.
+ - 1091: Tokenization is not supported for chosen payment brand.
+
+ ###Card errors:
+ - 1110: Holder must at least contain first and last name.
+ - 1111: Invalid card number. Does not pass the Luhn check.
+ - 1112: Unsupported card brand.
+ - 1113: Month must be in the format MM.
+ - 1114: Year must be in the format YYYY.
+ - 1115: Card is expired.
+ - 1116: CVV invalid. Must be three or four digits.
+
+ ###Bank account errors:
+ - 1130: Holder of the bank account is not valid.
+ - 1131: IBAN is not valid.
+ - 1132: The country code of the bank is invalid. Should match ISO 3166-1 two-letter standard.
+ - 1133: The name of the bank which holds the account is invalid.
+ - 1134: The BIC (Bank Identifier Code (SWIFT)) number of the bank account is invalid.
+ - 1135: The code associated with the bank account is invalid.
+ - 1136: The account number of the bank account is invalid.
+ 
+ ###Apple Pay errors:
+ - 1150: The Apple Pay payment token data is invalid. To perform this type of transaction a valid payment token data is needed.
+ 
+ ###Transaction errors:
+ - 2000: Checkout info cannot be loaded.
+ - 2001: There are no available payment methods in checkout.
+ - 2002: Payment method is not available.
+ - 2003: The transaction was aborted.
+ - 2004: Brand validation rules cannot be loaded from.
+ 
+ - 2010: The transaction was declined. Please contact the system administrator of the merchant server to get the reason of failure.
+ - 2020: The сheckout configuration is not valid.
+ 
+ ###Request errors:
+ - 3000: Unexpected connection error. Please contact the system administrator of the server.
+ - 3001: Invalid input parameters for the request.
+ - 3002: Invalid response from the Server.
+ 
+ ###Security errors:
+ - 4000: File loaded from resources does not have valid checksum. Make sure you installed the framework correctly and no one has been tampering with the application.
+ 
+ ###Linking errors:
+ - 5000: Invalid framework version. Versions of base and extension frameworks are not matching.
+ */
+
+@interface OPPErrors : NSObject
+
+/** The error domain for specific errors associated with the ready-to-use UI or SDK API. */
+FOUNDATION_EXPORT NSString *const OPPErrorDomain;
+
+/** The corresponding value is the `error.userInfo` dictionary containing the detail transaction failure information. */
+FOUNDATION_EXPORT NSString *const OPPErrorTransactionFailureDetailsKey;
+
+@end

package/OPPWAMobile.framework/Headers/OPPIkanoOiPaymentParams.h

@@ -0,0 +1,74 @@
+//
+// 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 "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/OPPWAMobile.framework/Headers/OPPMBWayPaymentParams.h

@@ -0,0 +1,66 @@
+//
+// 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 "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/OPPWAMobile.framework/Headers/OPPPayPalPaymentParams.h

@@ -0,0 +1,48 @@
+//
+// 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 "OPPPaymentParams.h"
+
+__deprecated_msg("The OPPPayPalPaymentParams class is formally deprecated. To make PayPal transaction, instead use OPPPaymentParams class with payment brand 'PAYPAL'.")
+/**
+ Class to encapsulate all necessary transaction parameters for performing a PayPal transaction.
+ 
+ @warning **Deprecated:** The `OPPPayPalPaymentParams` class is formally deprecated in 1.4.0. To make PayPal transaction, instead use `OPPPaymentParams` class with payment brand 'PAYPAL'.
+ */
+
+NS_ASSUME_NONNULL_BEGIN
+@interface OPPPayPalPaymentParams : OPPPaymentParams
+
+/// @name Initialization
+
+/// :nodoc:
+- (instancetype)initWithCheckoutID:(NSString *)checkoutID paymentBrand:(NSString *)paymentBrand error:(NSError * _Nullable __autoreleasing *)error NS_UNAVAILABLE;
+
+/**
+ Creates an object representing a PayPal 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 a PayPal transaction.
+ */
++ (nullable instancetype)payPalPaymentParamsWithCheckoutID:(NSString *)checkoutID error:(NSError **)error;
+
+/**
+ Creates an object representing a PayPal 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 a PayPal transaction.
+ */
+- (nullable instancetype)initWithCheckoutID:(NSString *)checkoutID error:(NSError **)error NS_DESIGNATED_INITIALIZER;
+@end
+NS_ASSUME_NONNULL_END
+

package/OPPWAMobile.framework/Headers/OPPPaymentBrandsConfig.h

@@ -0,0 +1,56 @@
+//
+// 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 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/OPPWAMobile.framework/Headers/OPPPaymentButton.h

@@ -0,0 +1,79 @@
+//
+// 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 UIKit;
+#import "OPPCheckoutPaymentMethod.h"
+
+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;
+
+/// @name Deprecated properties
+
+/**
+ Payment method for the transaction that is used to display an appropriate logo.
+ @warning **Deprecated:** Use `paymentBrand` instead
+ */
+@property (nonatomic) OPPCheckoutPaymentMethod paymentMethod DEPRECATED_ATTRIBUTE;
+
+@end
+
+/// Deprecated methods
+@interface OPPPaymentButton (Deprecated)
+/**
+ Creates and returns payment button initialized with the payment brand.
+ @param paymentMethod Payment method for the transaction.
+ @warning **Deprecated:** Use `+paymentButtonWithPaymentBrand:` instead
+ */
++ (instancetype)paymentButtonWithPaymentMethod:(OPPCheckoutPaymentMethod)paymentMethod DEPRECATED_MSG_ATTRIBUTE("- Use +paymentButtonWithPaymentBrand: instead.");
+
+/**
+ Creates and returns payment button initialized with the payment method.
+ @param paymentMethod Payment method for the transaction.
+ @warning **Deprecated:** Use `-initWithPaymentBrand:` instead
+ */
+- (instancetype)initWithPaymentMethod:(OPPCheckoutPaymentMethod)paymentMethod DEPRECATED_MSG_ATTRIBUTE("- Use -initWithPaymentBrand: instead.");
+@end
+NS_ASSUME_NONNULL_END

package/OPPWAMobile.framework/Headers/OPPPaymentParams.h

@@ -0,0 +1,100 @@
+//
+// 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 "OPPPaymentParamsBrand.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 Deprecated Properties
+
+/**
+ Method of payment for the request.
+ @warning **Deprecated:** Use `paymentBrand` instead
+ */
+@property (nonatomic, readonly) OPPPaymentParamsBrand brand DEPRECATED_ATTRIBUTE;
+
+
+/// @name Custom parameters methods 
+
+/**
+ Method to add custom parameter that will be sent to the server.
+ @param name Name should be prepended with SHOPPER_*, e.g. SHOPPER_customerId. Expected string that matches regex SHOPPER_[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)addCustomParamWithName:(NSString *)name value:(NSString *)value;
+
+/**
+ Method to remove record from the dictionary of custom parameters.
+ @param name Parameter name.
+ */
+- (void)removeCustomParamWithName:(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