react-native-hyperpay-sdk 0.2.0 → 0.5.0

package/OPPWAMobile.framework/Headers/OPPPaymentParamsBrand.h

@@ -0,0 +1,57 @@
+//
+// 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_ATTRIBUTE("The OPPPaymentParamsBrand class is formally deprecated. Use string values for the payment brands.")
+
+/**
+ An enumeration for the various payment brands.
+ 
+ @warning **Deprecated:** The `OPPPaymentParamsBrand` class is formally deprecated in 1.4.0. Use string values for the payment brands.
+ */
+typedef NS_ENUM(NSInteger, OPPPaymentParamsBrand) {
+    /// VISA card payment brand.
+    OPPPaymentParamsBrandVISA DEPRECATED_MSG_ATTRIBUTE("The attribute is no longer used. Please use string value \"VISA\" instead of."),
+    /// MasterCard payment brand.
+    OPPPaymentParamsBrandMasterCard DEPRECATED_MSG_ATTRIBUTE("The attribute is no longer used. Please use string value \"MASTER\" instead of."),
+    /// American Express card brand.
+    OPPPaymentParamsBrandAMEX DEPRECATED_MSG_ATTRIBUTE("The attribute is no longer used. Please use string value \"AMEX\" instead of."),
+    /// Diners Club card brand.
+    OPPPaymentParamsBrandDinersClub DEPRECATED_MSG_ATTRIBUTE("The attribute is no longer used. Please use string value \"DINERS\" instead of."),
+    /// Discover card brand.
+    OPPPaymentParamsBrandDiscover DEPRECATED_MSG_ATTRIBUTE("The attribute is no longer used. Please use string value \"DISCOVER\" instead of."),
+    /// UnionPay (ExpressPay) card brand.
+    OPPPaymentParamsBrandUnionPay DEPRECATED_MSG_ATTRIBUTE("The attribute is no longer used. Please use string value \"UNIONPAY\" instead of."),
+    /// JCB card brand.
+    OPPPaymentParamsBrandJCB DEPRECATED_MSG_ATTRIBUTE("The attribute is no longer used. Please use string value \"JCB\" instead of."),
+    
+    /// SEPA direct debit payment brand.
+    OPPPaymentParamsBrandDirectDebitSEPA DEPRECATED_MSG_ATTRIBUTE("The attribute is no longer used. Please use string value \"DIRECTDEBIT_SEPA\" instead of."),
+    /// SOFORT banking payment brand.
+    OPPPaymentParamsBrandSOFORTBanking DEPRECATED_MSG_ATTRIBUTE("The attribute is no longer used. Please use string value \"SOFORTUEBERWEISUNG\" instead of."),
+    /// BOLETO payment brand.
+    OPPPaymentParamsBrandBOLETO DEPRECATED_MSG_ATTRIBUTE("The attribute is no longer used. Please use string value \"BOLETO\" instead of."),
+    /// IDEAL payment brand.
+    OPPPaymentParamsBrandIDEAL DEPRECATED_MSG_ATTRIBUTE("The attribute is no longer used. Please use string value \"IDEAL\" instead of."),
+    
+    /// Apple pay payment brand.
+    OPPPaymentParamsBrandApplePay DEPRECATED_MSG_ATTRIBUTE("The attribute is no longer used. Please use string value \"APPLEPAY\" instead of."),
+    
+    /// PayPal payment brand.
+    OPPPaymentParamsBrandPayPal DEPRECATED_MSG_ATTRIBUTE("The attribute is no longer used. Please use string value \"PAYPAL\" instead of."),
+    /// China UnionPay brand.
+    OPPPaymentParamsBrandChinaUnionPay DEPRECATED_MSG_ATTRIBUTE("The attribute is no longer used. Please use string value \"CHINAUNIONPAY\" instead of."),
+    
+    /// Alipay payment brand.
+    OPPPaymentParamsBrandAlipay DEPRECATED_MSG_ATTRIBUTE("The attribute is no longer used. Please use string value \"ALIPAY\" instead of."),
+    
+    /// Unsupported payment brand.
+    OPPPaymentParamsBrandUnknown DEPRECATED_MSG_ATTRIBUTE("The attribute is no longer used.")
+};

package/OPPWAMobile.framework/Headers/OPPPaymentProvider.h

@@ -0,0 +1,132 @@
+//
+// 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 OPPTransaction;
+@class OPPPaymentParams;
+@class OPPCheckoutInfo;
+
+/// 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
+/**
+ 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;
+
+/// @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 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;
+
+@end
+NS_ASSUME_NONNULL_END

package/OPPWAMobile.framework/Headers/OPPSecurityPolicy.h

@@ -0,0 +1,87 @@
+//
+// 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 possible modes of security policy.
+typedef NS_ENUM(NSInteger, OPPSecurityPolicyMode) {
+    /// Device authentication is required to complete payment. Payment method won't be displayed in the list if neither Touch ID/FACE ID nor passcode are set.
+    OPPSecurityPolicyModeDeviceAuthRequired,
+    /// Require device authentication only if Touch ID, Face ID or passcode are set.
+    OPPSecurityPolicyModeDeviceAuthRequiredIfAvailable,
+    /// Shopper don't have to provide Touch ID, Face ID or passcode to complete payment.
+    OPPSecurityPolicyModeDeviceAuthNotRequired
+};
+
+/**
+ Class which is used to apply security policy mode for the set of payment methods.
+ */
+NS_ASSUME_NONNULL_BEGIN
+@interface OPPSecurityPolicy : NSObject
+
+/// @name Initialization
+
+/**
+ Creates security policy for the list of payment methods with specified mode.
+ @param paymentBrands List of payment brands. Note that Apple Pay will be ignored, because device authentication is mandatory for this payment method.
+ @param mode Mode of security policy which will be applied to the `paymentBrands`.
+ */
++ (instancetype)securityPolicyWithPaymentBrands:(NSArray<NSString *> *)paymentBrands mode:(OPPSecurityPolicyMode)mode;
+
+/**
+ Creates security policy for tokens with specified mode.
+ @param mode Mode of security policy which will be applied for all tokens.
+ */
++ (instancetype)securityPolicyForTokensWithMode:(OPPSecurityPolicyMode)mode;
+
+/// :nodoc:
+- (instancetype)init NS_UNAVAILABLE;
+
+
+/// @name Properties
+
+/**
+ The mode of security policy.
+ */
+@property (nonatomic, readonly) OPPSecurityPolicyMode mode;
+
+/**
+ The list of payment brands.
+ */
+@property (nonatomic, copy, readonly, nullable) NSArray<NSString *> *paymentBrands;
+
+/**
+ The flag that defines whether mode is applied to `paymentBrands` or to all tokens.
+ */
+@property (nonatomic, readonly, getter=isTokenPolicy) BOOL tokenPolicy;
+
+/// @name Deprecated Properties
+
+/**
+ The list of payment methods.
+ @warning **Deprecated:** Use `paymentBrands` instead
+ */
+@property (nonatomic, copy, readonly, nullable) NSArray<NSNumber *> *paymentMethods DEPRECATED_ATTRIBUTE;
+
+@end
+
+/// Deprecated methods
+@interface OPPSecurityPolicy (Deprecated)
+/**
+ Creates security policy for the list of payment methods with specified mode.
+ @param paymentMethods List of payment methods. Note that Apple Pay will be ignored, because device authentication is mandatory for this payment method.
+ @param mode Mode of security policy which will be applied to the `paymentMethods`.
+ @warning **Deprecated:** Use `+securityPolicyWithPaymentBrands:mode:` instead
+ */
++ (instancetype)securityPolicyWithPaymentMethods:(NSArray<NSNumber *> *)paymentMethods mode:(OPPSecurityPolicyMode)mode DEPRECATED_MSG_ATTRIBUTE("- Use +securityPolicyWithPaymentBrands:mode: instead.");
+@end
+NS_ASSUME_NONNULL_END

package/OPPWAMobile.framework/Headers/OPPToken.h

@@ -0,0 +1,95 @@
+//
+// 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 "OPPCard.h"
+#import "OPPBankAccount.h"
+#import "OPPPaymentParams.h"
+
+/**
+ Class to encapsulate shopper’s payment details that have been tokenized.
+ */
+
+NS_ASSUME_NONNULL_BEGIN
+@interface OPPToken : NSObject
+
+/// @name Properties
+
+/** The identifier of the token that can be used to reference the token later. */
+@property (nonatomic, copy, readonly) NSString *tokenID;
+
+/**
+ The payment brand of the transaction.
+ */
+@property (nonatomic, copy, readonly) NSString *paymentBrand;
+
+/** 
+ Shopper’s card details.
+ */
+@property (nonatomic, readonly) OPPCard *card;
+
+/** 
+ Shopper’s bank account details.
+ */
+@property (nonatomic, readonly) OPPBankAccount *bankAccount;
+
+
+/// @name Initialization
+
+/// :nodoc:
+- (instancetype)init NS_UNAVAILABLE;
+
+/**
+ Creates an `OPPToken` object from JSON.
+ @param JSON A dictionary with parameters received from the Server.
+ @return Returns an `OPPToken` object, or `nil` if JSON contains invalid values.
+ */
++ (nullable instancetype)tokenFromJSON:(NSDictionary *)JSON;
+
+/**
+ Creates an `OPPToken` object with provided card parameters.
+ @param tokenID The identifier of the token that can be used to reference the token later.
+ @param paymentBrand The payment brand.
+ @param card Shopper’s card details.
+ @return Returns an `OPPToken` object, or `nil` if parameters are empty.
+ */
++ (nullable instancetype)tokenWithTokenID:(NSString *)tokenID paymentBrand:(NSString *)paymentBrand card:(OPPCard *)card;
+
+
+/**
+ Creates an `OPPToken` object with provided bank account parameters.
+ @param tokenID The identifier of the token that can be used to reference the token later.
+ @param paymentBrand The payment brand.
+ @param bankAccount Shopper’s bank account details.
+ @return Returns an `OPPToken` object, or `nil` if parameters are empty.
+ */
++ (nullable instancetype)tokenWithTokenID:(NSString *)tokenID paymentBrand:(NSString *)paymentBrand bankAccount:(OPPBankAccount *)bankAccount;
+
+/**
+ Creates an `OPPToken` object with provided card parameters.
+ @param tokenID The identifier of the token that can be used to reference the token later.
+ @param paymentBrand The payment brand.
+ @param card Shopper’s card details.
+ @return Returns an `OPPToken` object, or `nil` if parameters are empty.
+ */
+- (nullable instancetype)initWithTokenID:(NSString *)tokenID paymentBrand:(NSString *)paymentBrand card:(OPPCard *)card;
+
+/**
+ Creates an `OPPToken` object with provided bank account parameters.
+ @param tokenID The identifier of the token that can be used to reference the token later.
+ @param paymentBrand The payment brand.
+ @param bankAccount Shopper’s bank account details.
+ @return Returns an `OPPToken` object, or `nil` if parameters are empty.
+ */
+- (nullable instancetype)initWithTokenID:(NSString *)tokenID paymentBrand:(NSString *)paymentBrand bankAccount:(OPPBankAccount *)bankAccount;
+
+@end
+NS_ASSUME_NONNULL_END

package/OPPWAMobile.framework/Headers/OPPTokenPaymentParams.h

@@ -0,0 +1,180 @@
+//
+// 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 token transaction.
+ */
+
+NS_ASSUME_NONNULL_BEGIN
+@interface OPPTokenPaymentParams : OPPPaymentParams
+
+/// @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;
+
+/**
+ The CVV code found on the card. Property should be set, if CVV check is required for transaction processing.
+ */
+@property (nonatomic, copy, readonly, nullable) NSString *CVV;
+
+/** The number of installments the payment should be split into. */
+@property (nonatomic, copy) NSNumber *numberOfInstallments;
+
+/// @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;
+
+/**
+ Checks if the card CVV is filled with sufficient data to perform a transaction.
+ 
+ @param CVV The card security code or CVV.
+ @return `YES` if 3,4-digit number is provided.
+ */
++ (BOOL)isCvvValid:(NSString *)CVV;
+
+@end
+
+/// Deprecated methods
+@interface OPPTokenPaymentParams (Deprecated)
+/**
+ 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 brand 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.
+ @warning **Deprecated:** Use `+tokenPaymentParamsWithCheckoutID:tokenID:paymentBrand:error:` instead
+ */
++ (nullable instancetype)tokenPaymentParamsWithCheckoutID:(NSString *)checkoutID tokenID:(NSString *)tokenID brand:(OPPPaymentParamsBrand)brand error:(NSError **)error DEPRECATED_MSG_ATTRIBUTE("- Use +tokenPaymentParamsWithCheckoutID:tokenID:paymentBrand:error: instead.");
+
+/**
+ 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 cardBrand The 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.
+ @warning **Deprecated:** Use `+tokenPaymentParamsWithCheckoutID:tokenID:cardPaymentBrand:CVV:error:` instead
+ */
++ (nullable instancetype)tokenPaymentParamsWithCheckoutID:(NSString *)checkoutID tokenID:(NSString *)tokenID cardBrand:(OPPPaymentParamsBrand)cardBrand CVV:(nullable NSString *)CVV error:(NSError **)error DEPRECATED_MSG_ATTRIBUTE("- Use +tokenPaymentParamsWithCheckoutID:tokenID:cardPaymentBrand:CVV:error: instead.");
+
+/**
+ 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 brand 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.
+ @warning **Deprecated:** Use `-initWithCheckoutID:tokenID:paymentBrand:error:` instead
+ */
+- (nullable instancetype)initWithCheckoutID:(NSString *)checkoutID tokenID:(NSString *)tokenID brand:(OPPPaymentParamsBrand)brand error:(NSError **)error DEPRECATED_MSG_ATTRIBUTE("- Use -initWithCheckoutID:tokenID:paymentBrand:error: instead.");
+
+/**
+ 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 cardBrand The 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.
+ @warning **Deprecated:** Use `-initWithCheckoutID:tokenID:cardPaymentBrand:CVV:error:` instead
+ */
+- (nullable instancetype)initWithCheckoutID:(NSString *)checkoutID tokenID:(NSString *)tokenID cardBrand:(OPPPaymentParamsBrand)cardBrand CVV:(nullable NSString *)CVV error:(NSError **)error DEPRECATED_MSG_ATTRIBUTE("- Use -initWithCheckoutID:tokenID:cardPaymentBrand:CVV:error: instead.");
+
+/**
+ Checks if the card CVV is filled with sufficient data to perform a transaction.
+ 
+ @param CVV The card security code or CVV.
+ @param brand The brand of the tokenized card.
+ @return YES if the card CVV length greater than 3 characters and less than 4 characters, it's also valid for `nil` value, because it's optional parameter.
+ @warning **Deprecated:** Use `+isCvvValid:forPaymentBrand:` instead
+ */
++ (BOOL)isCvvValid:(NSString *)CVV forBrand:(OPPPaymentParamsBrand)brand DEPRECATED_MSG_ATTRIBUTE("- Use +isCvvValid:forPaymentBrand: instead.");
+
+/**
+ Checks if the card CVV is filled with sufficient data to perform a transaction.
+ 
+ @param CVV The card security code or CVV.
+ @param paymentBrand The payment brand of the tokenized card.
+ @return YES if the card CVV length greater than 3 characters and less than 4 characters, it's also valid for `nil` value, because it's optional parameter.
+ @warning **Deprecated:** Use `+isCvvValid:` instead
+ */
++ (BOOL)isCvvValid:(NSString *)CVV forPaymentBrand:(NSString *)paymentBrand DEPRECATED_MSG_ATTRIBUTE("- Use +isCvvValid: instead.");
+
+
+@end
+NS_ASSUME_NONNULL_END

package/OPPWAMobile.framework/Headers/OPPTransaction.h

@@ -0,0 +1,77 @@
+//
+// 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 OPPTransactionProcessor;
+@class OPPPaymentParams;
+
+/// 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;
+
+/// App payment signed request parameters contain seller’s order information which should be forwarded to Alipay native SDK.
+@property (nonatomic, copy, readonly, nullable) NSString *alipaySignedOrderInfo;
+
+@end
+NS_ASSUME_NONNULL_END