OPPBankAccountPaymentParams

@interface OPPBankAccountPaymentParams : OPPPaymentParams

Class to encapsulate all necessary transaction parameters for performing a bank transfer transaction.

Initialization

  • Creates an object representing a SEPA direct debit transaction.

    Declaration

    Objective-C

    + (nullable instancetype)
    directDebitSEPAPaymentParamsWithCheckoutID:(nonnull NSString *)checkoutID
                                        holder:(nonnull NSString *)holder
                                          IBAN:(nonnull NSString *)IBAN
                           tokenizationEnabled:(BOOL)tokenizationEnabled
                                         error:(NSError *_Nullable *_Nullable)
                                                   error;

    Swift

    class func directDebitSEPAPaymentParams(withCheckoutID checkoutID: String, holder: String, iban IBAN: String, tokenizationEnabled: Bool) throws -> Self

    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 YES, the payment information will be stored for future use.
    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 a SEPA direct debit transaction, and nil if parameters are invalid.

  • Creates an object representing a SOFORT banking transaction.

    Declaration

    Objective-C

    + (nullable instancetype)
    sofortBankingPaymentParamsWithCheckoutID:(nonnull NSString *)checkoutID
                                     country:(nonnull NSString *)country
                                       error:
                                           (NSError *_Nullable *_Nullable)error;

    Swift

    class func sofortBankingPaymentParams(withCheckoutID checkoutID: String, country: String) throws -> Self

    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).
    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 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.

    Declaration

    Objective-C

    + (nullable instancetype)
    idealPaymentParamsWithCheckoutID:(nonnull NSString *)checkoutID
                            bankName:(nonnull NSString *)bankName
                               error:(NSError *_Nullable *_Nullable)error;

    Swift

    class func idealPaymentParams(withCheckoutID checkoutID: String, bankName: String) throws -> Self

    Parameters

    checkoutID

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

    The name of the bank which holds 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 IDEAL transaction, and nil if parameters are invalid.

  • Creates an object representing an IDEAL 2.0 transaction.

    Declaration

    Objective-C

    + (nullable instancetype)
    idealPaymentParamsWithCheckoutID:(nonnull NSString *)checkoutID
                             country:(nonnull NSString *)country
                               error:(NSError *_Nullable *_Nullable)error;

    Swift

    class func idealPaymentParams(withCheckoutID checkoutID: String, country: String) throws -> Self

    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).
    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 IDEAL transaction, and nil if parameters are invalid.

  • Creates an object representing a Giropay transaction.

    Declaration

    Objective-C

    + (nullable instancetype)
    giropayPaymentParamsWithCheckoutID:(nonnull NSString *)checkoutID
                                   BIC:(nullable NSString *)BIC
                              bankCode:(nullable NSString *)bankCode
                                  IBAN:(nullable NSString *)IBAN
                         accountNumber:(nullable NSString *)accountNumber
                                 error:(NSError *_Nullable *_Nullable)error;

    Swift

    class func giropayPaymentParams(withCheckoutID checkoutID: String, bic BIC: String?, bankCode: String?, iban IBAN: String?, accountNumber: String?) throws -> Self

    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.
    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 a Giropay transaction, and nil if parameters are invalid.

  • Creates an object representing a Paytrail transaction.

    Declaration

    Objective-C

    + (nullable instancetype)
    paytrailPaymentParamsWithCheckoutID:(nonnull NSString *)checkoutID
                                  error:(NSError *_Nullable *_Nullable)error;

    Swift

    class func paytrailPaymentParams(withCheckoutID checkoutID: String) throws -> Self

    Parameters

    checkoutID

    The checkout ID of the transaction. Must be not nil or empty.
    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 a Paytrail transaction, and nil if parameters are invalid.

Properties

  • The name of the bank account holder.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly, nullable) NSString *holder;

    Swift

    var holder: String? { get }

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

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly, nullable) NSString *IBAN;

    Swift

    var iban: String? { get }

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

    Declaration

    Objective-C

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

    Swift

    var accountNumber: String? { get }

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

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly, nullable) NSString *country;

    Swift

    var country: String? { get }

  • The name of the bank which holds the account.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly, nullable) NSString *bankName;

    Swift

    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

    Objective-C

    @property (nonatomic, copy, readonly, nullable) NSString *BIC;

    Swift

    var bic: String? { get }

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

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly, nullable) NSString *bankCode;

    Swift

    var bankCode: String? { get }

  • Default is NO. If YES, the payment information will be stored for future use.

    Declaration

    Objective-C

    @property (nonatomic, readonly, getter=isTokenizationEnabled) BOOL tokenizationEnabled;

    Swift

    var isTokenizationEnabled: Bool { get }

Validation methods

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

    Declaration

    Objective-C

    + (BOOL)isHolderValid:(nonnull NSString *)holder;

    Swift

    class func isHolderValid(_ holder: String) -> Bool

    Parameters

    holder

    The name of the bank account holder.

    Return Value

    YES 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

    Objective-C

    + (BOOL)isIBANValid:(nonnull NSString *)IBAN;

    Swift

    class func isIBANValid(_ IBAN: String) -> Bool

    Parameters

    IBAN

    International Bank Account Number.

    Return Value

    YES if the IBAN meets the criteria described above.

  • Checks if the account number is valid.

    Declaration

    Objective-C

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

    Swift

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

    Parameters

    accountNumber

    The account number of the bank account.

    Return Value

    YES if the account number is valid.

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

    Declaration

    Objective-C

    + (BOOL)isCountryValid:(nonnull NSString *)country;

    Swift

    class func isCountryValid(_ country: String) -> Bool

    Parameters

    country

    The country of the bank account.

    Return Value

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

  • Checks if the name of the bank is valid.

    Declaration

    Objective-C

    + (BOOL)isBankNameValid:(nonnull NSString *)bankName;

    Swift

    class func isBankNameValid(_ bankName: String) -> Bool

    Parameters

    bankName

    The name of the bank which holds the account.

    Return Value

    YES if the name of the bank is valid.

  • Checks if the BIC is valid.

    Declaration

    Objective-C

    + (BOOL)isBICValid:(nonnull NSString *)BIC;

    Swift

    class func isBICValid(_ BIC: String) -> Bool

    Parameters

    BIC

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

    Return Value

    YES if the BIC is valid.

  • Checks if the bank code is valid.

    Declaration

    Objective-C

    + (BOOL)isBankCodeValid:(nonnull NSString *)bankCode;

    Swift

    class func isBankCodeValid(_ bankCode: String) -> Bool

    Parameters

    bankCode

    The code associated with the bank account.

    Return Value

    YES if the bank code is valid.