Builder

public final class Builder

A helper class to build the HyperwalletBankAccount instance.

  • Creates a new instance of the HyperwalletBankAccount.Builder based on the required parameter to update Bank account.

    Declaration

    Swift

    public init(token: String)

    Parameters

    token

    The unique, auto-generated user identifier. Max 64 characters, prefixed with “usr-”.

  • Creates a new instance of the HyperwalletBankAccount.Builder based on the required parameters to create Bank account.

    Declaration

    Swift

    public init(transferMethodCountry: String,
            transferMethodCurrency: String,
            transferMethodProfileType: String,
            transferMethodType: String)

    Parameters

    transferMethodCountry

    The bank account country.
    transferMethodCurrency

    The bank account currency.
    transferMethodProfileType

    The bank account holder’s profile type, e.g. INDIVIDUAL or BUSINESS
    transferMethodType

    The bank account type, e.g. BANK_ACCOUNT or WIRE_ACCOUNT

  • Sets the bank account holder’s street address.

    Declaration

    Swift

    public func addressLine1(_ addressLine1: String) -> Builder

    Parameters

    addressLine1

    The bank account holder’s street address.

    Return Value

    a self HyperwalletBankAccount.Builder instance.

  • Sets the bank account holder’s address, second line.

    Declaration

    Swift

    public func addressLine2(_ addressLine2: String) -> Builder

    Parameters

    addressLine2

    The bank account holder’s address, second line.

    Return Value

    a self HyperwalletBankAccount.Builder instance.

  • Sets the bank account number, IBAN or equivalent. If you are providing an IBAN, the first two letters of the IBAN must match the transferMethodCountry

    Declaration

    Swift

    public func bankAccountId(_ bankAccountId: String) -> Builder

    Parameters

    bankAccountId

    The bank account number, IBAN or equivalent.

    Return Value

    a self HyperwalletBankAccount.Builder instance.

  • Sets the purpose of the bank account (e.g. checking, savings, etc).

    Declaration

    Swift

    public func bankAccountPurpose(_ purpose: String) -> Builder

    Parameters

    purpose

    The PurposeType

    Return Value

    a self HyperwalletBankAccount.Builder instance.

  • Sets the user’s relationship with the bank account holder.

    Declaration

    Swift

    public func bankAccountRelationship(_ relationship: String) -> Builder

    Parameters

    relationship

    The RelationshipType

    Return Value

    a self HyperwalletBankAccount.Builder instance.

  • Sets the bank code or equivalent (e.g. BIC/SWIFT code).

    Declaration

    Swift

    public func bankId(_ bankId: String) -> Builder

    Parameters

    bankId

    The bank code or equivalent (e.g. BIC/SWIFT code)

    Return Value

    a self HyperwalletBankAccount.Builder instance.

  • Sets the bank name.

    Declaration

    Swift

    public func bankName(_ bankName: String) -> Builder

    Parameters

    bankName

    The bank name

    Return Value

    a self HyperwalletBankAccount.Builder instance.

  • Sets the branch code, transit number, routing number or equivalent.

    Declaration

    Swift

    public func branchId(_ branchId: String) -> Builder

    Parameters

    branchId

    The branch code, transit number, routing number or equivalent.

    Return Value

    a self HyperwalletBankAccount.Builder instance.

  • Sets the branch name.

    Declaration

    Swift

    public func branchName(_ branchName: String) -> Builder

    Parameters

    branchName

    The branch name.

    Return Value

    a self HyperwalletBankAccount.Builder instance.

  • Sets the bank account holder’s role in the organization.

    Declaration

    Swift

    public func businessContactRole(_ businessContactRole: String) -> Builder

    Parameters

    businessContactRole

    The bank account holder’s role in the organization.

    Return Value

    a self HyperwalletBankAccount.Builder instance.

  • Sets the name of the bank account holder’s business.

    Declaration

    Swift

    public func businessName(_ businessName: String) -> Builder

    Parameters

    businessName

    The name of the bank account holder’s business.

    Return Value

    a self HyperwalletBankAccount.Builder instance.

  • Sets the country where the bank account holder’s business is registered.

    Declaration

    Swift

    public func businessRegistrationCountry(_ country: String) -> Builder

    Parameters

    businessRegistrationCountry

    The country where the bank account holder’s business is registered.

    Return Value

    a self HyperwalletBankAccount.Builder instance.

  • Sets the bank account holder’s business registration number or identifier, as assigned by the relevant government body.

    Declaration

    Swift

    public func businessRegistrationId(_ businessRegistrationId: String) -> Builder

    Parameters

    businessRegistrationId

    The bank account holder’s business registration number or identifier, as assigned by the relevant government body.

    Return Value

    a self HyperwalletBankAccount.Builder instance.

  • Sets the state, province or region where the bank account holder’s business is registered.

    Declaration

    Swift

    public func businessRegistrationStateProvince(_ stateProvince: String) -> Builder

    Parameters

    businessRegistrationStateProvince

    The state, province or region where the bank account holder’s business is registered.

    Return Value

    a self HyperwalletBankAccount.Builder instance.

  • Sets the bank account holder’s business type.

    Declaration

    Swift

    public func businessType(_ businessType: String) -> Builder

    Parameters

    businessType

    The bank account holder’s business type.

    Return Value

    a self HyperwalletBankAccount.Builder instance.

  • Sets the bank account holder’s city.

    Declaration

    Swift

    public func city(_ city: String) -> Builder

    Parameters

    city

    The bank account holder’s city.

    Return Value

    a self HyperwalletBankAccount.Builder instance.

  • Sets the bank account holder’s country.

    Declaration

    Swift

    public func country(_ country: String) -> Builder

    Parameters

    country

    The bank account holder’s country.

    Return Value

    a self HyperwalletBankAccount.Builder instance.

  • Sets the bank account holder’s birth country.

    Declaration

    Swift

    public func countryOfBirth(_ countryOfBirth: String) -> Builder

    Parameters

    countryOfBirth

    The bank account holder’s birth country.

    Return Value

    a self HyperwalletBankAccount.Builder instance.

  • Declaration

    Swift

    public func countryOfNationality(_ countryOfNationality: String) -> Builder

    Parameters

    countryOfNationality

    The bank account holder’s birth country.

    Return Value

    a self HyperwalletBankAccount.Builder instance.

  • Sets the bank account holder’s date of birth (All users must be at least 13 years old).

    Declaration

    Swift

    public func dateOfBirth(_ dateOfBirth: String) -> Builder

    Parameters

    dateOfBirth

    The bank account holder’s date of birth

    Return Value

    a self HyperwalletBankAccount.Builder instance.

  • Sets the bank account holder’s driver’s license number.

    Declaration

    Swift

    public func driversLicenseId(_ driversLicenseId: String) -> Builder

    Parameters

    driversLicenseId

    The bank account holder’s driver’s license number.

    Return Value

    a self HyperwalletBankAccount.Builder instance.

  • Sets the bank account holder’s employer identifier, generally used for tax purposes.

    Declaration

    Swift

    public func employerId(_ employerId: String) -> Builder

    Parameters

    employerId

    The bank account holder’s employer identifier, generally used for tax purposes.

    Return Value

    a self HyperwalletBankAccount.Builder instance.

  • Sets the bank account holder’s first name.

    Declaration

    Swift

    public func firstName(_ firstName: String) -> Builder

    Parameters

    firstName

    The bank account holder’s first name.

    Return Value

    a self HyperwalletBankAccount.Builder instance.

  • Sets the bank account holder’s gender.

    Declaration

    Swift

    public func gender(_ gender: String) -> Builder

    Parameters

    gender

    The bank account holder’s gender.

    Return Value

    a self HyperwalletBankAccount.Builder instance.

  • Sets the bank account holder’s government ID number, such as a Social Security Number.

    Declaration

    Swift

    public func governmentId(_ governmentId: String) -> Builder

    Parameters

    governmentId

    The bank account holder’s government ID number, such as a Social Security Number.

    Return Value

    a self HyperwalletBankAccount.Builder instance.

  • Sets the bank account holder’s government ID type.

    Declaration

    Swift

    public func governmentIdType(_ governmentIdType: String) -> Builder

    Parameters

    governmentIdType

    The bank account holder’s government ID type.

    Return Value

    a self HyperwalletBankAccount.Builder instance.

  • Sets the account number at the intermediary bank.

    Declaration

    Swift

    public func intermediaryBankAccountId(_ accountId: String) -> Builder

    Parameters

    intermediaryBankAccountId

    The account number at the intermediary bank.

    Return Value

    a self HyperwalletBankAccount.Builder instance.

  • Sets the intermediary bank street address.

    Declaration

    Swift

    public func intermediaryBankAddressLine1(_ addressLine1: String) -> Builder

    Parameters

    intermediaryBankAddressLine1

    The intermediary bank street address.

    Return Value

    a self HyperwalletBankAccount.Builder instance.

  • Sets the intermediary bank street address, second line.

    Declaration

    Swift

    public func intermediaryBankAddressLine2(_ addressLine2: String) -> Builder

    Parameters

    intermediaryBankAddressLine2

    The intermediary bank street address, second line.

    Return Value

    a self HyperwalletBankAccount.Builder instance.

  • Sets the intermediary bank city.

    Declaration

    Swift

    public func intermediaryBankCity(_ city: String) -> Builder

    Parameters

    intermediaryBankCity

    The intermediary bank city.

    Return Value

    a self HyperwalletBankAccount.Builder instance.

  • Sets the intermediary bank country.

    Declaration

    Swift

    public func intermediaryBankCountry(_ country: String) -> Builder

    Parameters

    intermediaryBankCountry

    The intermediary bank country.

    Return Value

    a self HyperwalletBankAccount.Builder instance.

  • Sets the intermediary bank’s 11-character SWIFT code.

    Declaration

    Swift

    public func intermediaryBankId(_ intermediaryBankId: String) -> Builder

    Parameters

    intermediaryBankId

    The intermediary bank’s 11-character SWIFT code.

    Return Value

    a self HyperwalletBankAccount.Builder instance.

  • Sets the intermediary bank name.

    Declaration

    Swift

    public func intermediaryBankName(_ name: String) -> Builder

    Parameters

    intermediaryBankName

    The intermediary bank name.

    Return Value

    a self HyperwalletBankAccount.Builder instance.

  • Sets the intermediary bank postal code.

    Declaration

    Swift

    public func intermediaryBankPostalCode(_ postalCode: String) -> Builder

    Parameters

    intermediaryBankPostalCode

    The intermediary bank postal code.

    Return Value

    a self HyperwalletBankAccount.Builder instance.

  • Sets the intermediary bank state, province or region.

    Declaration

    Swift

    public func intermediaryBankStateProvince(_ stateProvince: String) -> Builder

    Parameters

    intermediaryBankStateProvince

    The intermediary bank state, province or region.

    Return Value

    a self HyperwalletBankAccount.Builder instance.

  • Sets the bank account holder’s last name.

    Declaration

    Swift

    public func lastName(_ lastName: String) -> Builder

    Parameters

    lastName

    The bank account holder’s last name.

    Return Value

    a self HyperwalletBankAccount.Builder instance.

  • Sets the bank account holder’s middle name.

    Declaration

    Swift

    public func middleName(_ middleName: String) -> Builder

    Parameters

    middleName

    The bank account holder’s middle name.

    Return Value

    a self HyperwalletBankAccount.Builder instance.

  • Sets the bank account holder’s cell phone number.

    Declaration

    Swift

    public func mobileNumber(_ mobileNumber: String) -> Builder

    Parameters

    mobileNumber

    The bank account holder’s cell phone number.

    Return Value

    a self HyperwalletBankAccount.Builder instance.

  • Sets the bank account holder’s passport number.

    Declaration

    Swift

    public func passportId(_ passportId: String) -> Builder

    Parameters

    passportId

    The bank account holder’s passport number.

    Return Value

    a self HyperwalletBankAccount.Builder instance.

  • Sets the bank account holder’s phone number.

    Declaration

    Swift

    public func phoneNumber(_ phoneNumber: String) -> Builder

    Parameters

    phoneNumber

    The bank account holder’s phone number.

    Return Value

    a self HyperwalletBankAccount.Builder instance.

  • Sets the bank account holder’s postal code.

    Declaration

    Swift

    public func postalCode(_ postalCode: String) -> Builder

    Parameters

    postalCode

    The bank account holder’s postal code.

    Return Value

    a self HyperwalletBankAccount.Builder instance.

  • Sets the bank account holder’s profile type.

    Declaration

    Swift

    public func profileType(_ profileType: String) -> Builder

    Parameters

    profileType

    The bank account holder’s profile type, e.g. INDIVIDUAL or BUSINESS

    Return Value

    a self HyperwalletBankAccount.Builder instance.

  • Sets the bank account holder’s state, province or region.

    Declaration

    Swift

    public func stateProvince(_ stateProvince: String) -> Builder

    Parameters

    stateProvince

    The bank account holder’s state, province or region.

    Return Value

    a self HyperwalletBankAccount.Builder instance.

  • Sets the type of transfer method, e.g. BANK_ACCOUNT or WIRE_ACCOUNT.

    Declaration

    Swift

    public func type(_ type: String) -> Builder

    Parameters

    type

    The type of transfer method, e.g. BANK_ACCOUNT or WIRE_ACCOUNT.

    Return Value

    a self HyperwalletBankAccount.Builder instance.

  • Sets wire transfer instructions.

    Declaration

    Swift

    public func wireInstructions(_ wireInstructions: String) -> Builder

    Parameters

    wireInstructions

    Wire transfer instructions.

    Return Value

    a self HyperwalletBankAccount.Builder instance.

  • Builds a new instance of the HyperwalletBankAccount.

    Declaration

    Swift

    public func build() -> HyperwalletBankAccount

    Return Value

    a new instance of the HyperwalletBankAccount.