OPPInstantPayPaymentParams

@objc
public final class OPPInstantPayPaymentParams : OPPBankAccountPaymentParams

Class to encapsulate all necessary transaction parameters for performing a InstantPay transaction.

Properties

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

    Declaration

    Swift

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

Initialization

  • Creates an object representing a Instant Pay 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 static func instantPayPaymentParams(checkoutID: String,
                                           accountHolder: String,
                                           accountNumber: String,
                                           routingNumber: String,
                                           countryCode: String) throws -> Self

    Parameters

    checkoutID

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

    The account holder of the bank account.
    accountNumber

    The account number of the bank account.
    routingNumber

    The routing number associated with the bank account.
    countryCode

    The country code associated with the bank account.

    Return Value

    Returns an object representing an Instant Pay transaction.

  • Creates an object representing a Instant Pay 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 init(checkoutID: String,
            accountHolder: String,
            accountNumber: String,
            routingNumber: String,
            countryCode: String) throws

    Parameters

    checkoutID

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

    The account holder of the bank account.
    accountNumber

    The account number of the bank account.
    routingNumber

    The routing number associated with the bank account.
    countryCode

    The country code associated with the bank account.

    Return Value

    Returns an object representing an Instant Pay transaction.

Validations

  • Checks if the routing number is valid.

    Declaration

    Swift

    @objc
public static func isRoutingNumberValid(_ routingNumber: String) -> Bool

    Parameters

    routingNumber

    The routing number for validation.

    Return Value

    Returns true if the routing number is valid.