OPPBankAccountPaymentParams

@objc
public class OPPBankAccountPaymentParams : OPPPaymentParams, NSCopying

Class to encapsulate all necessary transaction parameters for performing an Blik transaction.

Properties

  • The name of the bank account holder.

    Declaration

    Swift

    @objc
public private(set) var holder: String? { get }

  • The iban (International Bank Account Number) associated with the bank account.

    Declaration

    Swift

    @objc
public private(set) var iban: String? { get }

  • The account number of the bank account. Either the account number or the IBAN are required.

    Declaration

    Swift

    @objc
public private(set) var accountNumber: String? { get }

  • The country code of the bank account (ISO 3166-1).

    Declaration

    Swift

    @objc
public private(set) var country: String? { get }

  • The name of the bank which holds the account.

    Declaration

    Swift

    @objc
public private(set) var bankName: String? { get }
  • bic

    The BIC (Bank Identifier Code (SWIFT)) number of the bank account. Either the bankCode or the BIC are required.

    Declaration

    Swift

    @objc
public private(set) var bic: String? { get }

  • The code associated with the bank account. Either the bankCode or the BIC are required.

    Declaration

    Swift

    @objc
public private(set) var bankCode: String? { get }

  • Default is false. If true, the payment information will be stored for future use.

    Declaration

    Swift

    @objc
public private(set) var isTokenizationEnabled: Bool { get }

Initialization

  • Creates an object representing a SEPA direct debit transaction.

    Throws

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

    Declaration

    Swift

    @objc
public class func directDebitSEPAPaymentParams(withCheckoutID checkoutID: String,
                                               holder: String,
                                               iban: String,
                                               tokenizationEnabled: Bool) throws -> OPPDirectDebitSEPAPaymentParams

    Parameters

    checkoutID

    The checkout ID of the transaction. Must be not nil or empty.
    holder

    The name of the bank account holder.
    iban

    The IBAN (International Bank Account Number) associated with the bank account.
    tokenizationEnabled

    If true, the payment information will be stored for future use.

    Return Value

    Returns an object representing a SEPA direct debit transaction, and nil if parameters are invalid.

  • Creates an object representing a SOFORT banking transaction.

    Throws

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

    Declaration

    Swift

    @objc
public class func sofortBankingPaymentParams(withCheckoutID checkoutID: String, country: String) throws -> OPPSofortBankingPaymentParams

    Parameters

    checkoutID

    The checkout ID of the transaction. Must be not nil or empty.
    country

    The country code of the bank account (ISO 3166-1).

    Return Value

    Returns an object representing a SOFORT banking transaction, and nil if parameters are invalid.

  • Creates an object representing an IDEAL 1.0 transaction. This method is deprecated. Use `idealPaymentParamsWithCheckoutID:country:error:‘ instead.

    Throws

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

    Declaration

    Swift

    @available(*, deprecated, message: "Use `idealPaymentParamsWithCheckoutID:country:error:` instead.")
@objc
public class func idealPaymentParams(withCheckoutID checkoutID: String, bankName: String) throws -> OPPIdealPaymentParams

    Parameters

    checkoutID

    The checkout ID of the transaction. Must be not nil or empty.
    bankName

    The name of the bank which holds the account.

    Return Value

    Returns an object representing an IDEAL transaction, and nil if parameters are invalid.

  • Creates an object representing an IDEAL 2.0 transaction.

    Throws

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

    Declaration

    Swift

    @objc
public class func idealPaymentParams(withCheckoutID checkoutID: String, country: String) throws -> OPPIdealPaymentParams

    Parameters

    checkoutID

    The checkout ID of the transaction. Must be not nil or empty.
    country

    The country code of the bank account in the following format [a-zA-Z]{2} (ISO 3166-1).

    Return Value

    Returns an object representing an IDEAL transaction, and nil if parameters are invalid.

  • Creates an object representing a Giropay transaction.

    Throws

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

    Declaration

    Swift

    @objc
public class func giropayPaymentParams(withCheckoutID checkoutID: String,
                                       bic: String?,
                                       bankCode: String?,
                                       iban: String?,
                                       accountNumber: String?) throws -> OPPGiropayPaymentParams

    Parameters

    checkoutID

    The checkout ID of the transaction. Must be not nil or empty.
    bic

    The BIC (Bank Identifier Code (SWIFT)) number of the bank account. Either the bankCode or the BIC are required.
    bankCode

    The code associated with the bank account. Either the bankCode or the BIC are required.
    iban

    The IBAN (International Bank Account Number) associated with the bank account.
    accountNumber

    The account number of the bank account.

    Return Value

    Returns an object representing a Giropay transaction, and nil if parameters are invalid.

  • Creates an object representing a Paytrail transaction.

    Throws

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

    Declaration

    Swift

    @objc
public class func paytrailPaymentParams(withCheckoutID checkoutID: String) throws -> OPPPaytrailPaymentParams

    Parameters

    checkoutID

    The checkout ID of the transaction. Must be not nil or empty.

    Return Value

    Returns an object representing a Paytrail transaction, and nil if parameters are invalid.

Validations

  • Checks if the bank account holder name is filled with sufficient data to perform a transaction.

    Declaration

    Swift

    @objc
public static func isHolderValid(_ holder: String) -> Bool

    Parameters

    holder

    The name of the bank account holder.

    Return Value

    Returns true if the holder name contains more than 4 characters, up to 128 characters.

  • Checks if the IBAN is valid. The first two 2 characters specify the country code as of ISO 3166-1 alpha-2. Only letters. The next 2 characters specify the check digits for a sanity check. Only digits. The remaining characters up to 27 characters specify the Basic Bank Account Number (“BBAN”). Both letters & digits allowed.

    Declaration

    Swift

    @objc
public static func isIBANValid(_ iban: String) -> Bool

    Parameters

    iban

    International Bank Account Number.

    Return Value

    Returns true if the IBAN meets the criteria described above.

  • Checks if the account number is valid.

    Declaration

    Swift

    @objc
public static func isAccountNumberValid(_ accountNumber: String) -> Bool

    Parameters

    accountNumber

    The account number of the bank account.

    Return Value

    Returns true if the account number is valid.

  • Checks if the country code matches ISO 3166-1 two-letter standard.

    Declaration

    Swift

    @objc
public static func isCountryValid(_ country: String) -> Bool

    Parameters

    country

    The country of the bank account.

    Return Value

    Returns true if the country code matches ISO 3166-1 two-letter standard.

  • Checks if the name of the bank is valid.

    Declaration

    Swift

    @objc
public static func isBankNameValid(_ bankName: String) -> Bool

    Parameters

    bankName

    The name of the bank which holds the account.

    Return Value

    Returns true if the name of the bank is valid.

  • Checks if the BIC is valid.

    Declaration

    Swift

    @objc
public static func isBICValid(_ bic: String) -> Bool

    Parameters

    bic

    The BIC (Bank Identifier Code (SWIFT)) number of the bank account.

    Return Value

    Returns true if the BIC is valid.

  • Checks if the bank code is valid.

    Declaration

    Swift

    @objc
public static func isBankCodeValid(_ bankCode: String) -> Bool

    Parameters

    bankCode

    The code associated with the bank account.

    Return Value

    Returns true if the bank code is valid.