OPPIkanoPrivateLabelVAPaymentParams

@interface OPPIkanoPrivateLabelVAPaymentParams : OPPPaymentParams

Class to encapsulate all necessary transaction parameters for performing an Ikano private label transaction (as virtual account).

Initialization

  • Creates an object representing an Ikano private label transaction (as virtual account).

    Declaration

    Objective-C

    + (nullable instancetype)
    ikanoPrivateLabelVAPaymentParamsWithCheckoutID:
        (nonnull NSString *)checkoutID
                                     accountNumber:
                                         (nonnull NSString *)accountNumber
                                       expiryMonth:
                                           (nonnull NSString *)expiryMonth
                                        expiryYear:
                                            (nonnull NSString *)expiryYear
                               accountVerification:
                                   (nullable NSString *)accountVerification
                                             error:
                                                 (NSError *_Nullable *_Nullable)
                                                     error;

    Parameters

    checkoutID

    The checkout ID of the transaction.
    accountNumber

    The account number.
    expiryMonth

    The expiration month of the account. It is expected in the format MM.
    expiryYear

    The expiration year of the account. It is expected in the format YYYY.
    accountVerification

    The verification code of the account.
    error

    The error that occurred while validating payment parameters. See code attribute (OPPErrorCode) and NSLocalizedDescription to identify the reason of failure.

    Return Value

    Returns an object representing an Ikano private label transaction (as virtual account).

  • Creates an object representing an Ikano private label transaction (as virtual account).

    Declaration

    Objective-C

    - (nullable instancetype)
     initWithCheckoutID:(nonnull NSString *)checkoutID
          accountNumber:(nonnull NSString *)accountNumber
            expiryMonth:(nonnull NSString *)expiryMonth
             expiryYear:(nonnull NSString *)expiryYear
    accountVerification:(nullable NSString *)accountVerification
                  error:(NSError *_Nullable *_Nullable)error;

    Swift

    init(checkoutID: String, accountNumber: String, expiryMonth: String, expiryYear: String, accountVerification: String?) throws

    Parameters

    checkoutID

    The checkout ID of the transaction.
    accountNumber

    The account number.
    expiryMonth

    The expiration month of the account. It is expected in the format MM.
    expiryYear

    The expiration year of the account. It is expected in the format YYYY.
    accountVerification

    The verification code of the account.
    error

    The error that occurred while validating payment parameters. See code attribute (OPPErrorCode) and NSLocalizedDescription to identify the reason of failure.

    Return Value

    Returns an object representing an Ikano private label transaction (as virtual account).

Properties

  • The account number.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly) NSString *_Nonnull accountNumber;

    Swift

    var accountNumber: String { get }

  • The expiration month of the account in the format MM.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly) NSString *_Nonnull expiryMonth;

    Swift

    var expiryMonth: String { get }

  • The expiration year of the account in the format YYYY.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly) NSString *_Nonnull expiryYear;

    Swift

    var expiryYear: String { get }

  • The verification code of the account.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly) NSString *_Nonnull accountVerification;

    Swift

    var accountVerification: String { get }

Parameter Checks

  • Checks if account number is valid (card number validation used).

    Declaration

    Objective-C

    + (BOOL)isAccountNumberValid:(nonnull NSString *)accountNumber;

    Swift

    class func isAccountNumberValid(_ accountNumber: String) -> Bool

    Parameters

    accountNumber

    The account number.

    Return Value

    YES if account number is valid, NO if it doesn’t.

  • Checks if expiration month is valid, MM format expected.

    Declaration

    Objective-C

    + (BOOL)isExpiryMonthValid:(nonnull NSString *)expiryMonth;

    Swift

    class func isExpiryMonthValid(_ expiryMonth: String) -> Bool

    Parameters

    expiryMonth

    The expiration month of the account.

    Return Value

    YES if expiration month is valid, NO if it doesn’t.

  • Checks if expiration year is valid, YYYY format expected.

    Declaration

    Objective-C

    + (BOOL)isExpiryYearValid:(nonnull NSString *)expiryYear;

    Swift

    class func isExpiryYearValid(_ expiryYear: String) -> Bool

    Parameters

    expiryYear

    The expiration year of the account.

    Return Value

    YES if expiration year is valid, NO if it doesn’t.

  • Checks if account is expired, expiration month and year should represent some date in the future.

    Declaration

    Objective-C

    + (BOOL)isAccountExpiredWithExpiryMonth:(nonnull NSString *)expiryMonth
                                andYear:(nonnull NSString *)expiryYear;

    Swift

    class func isAccountExpired(withExpiryMonth expiryMonth: String, andYear expiryYear: String) -> Bool

    Parameters

    expiryMonth

    The expiration month of the account.
    expiryYear

    The expiration year of the account.

    Return Value

    YES if the account is expired. NO if the account is not expired yet.

  • Checks if verification code in valid, up to 5 digits expected.

    Declaration

    Objective-C

    + (BOOL)isAccountVerificationValid:(nonnull NSString *)accountVerification;

    Swift

    class func isAccountVerificationValid(_ accountVerification: String) -> Bool

    Parameters

    accountVerification

    The verification code of the account.

    Return Value

    YES if the verification code is valid, NO if it doesn’t.