HyperwalletUser

@objcMembers
public class HyperwalletUser : NSObject, Codable

Representation of the Hyperwallet’s user.

  • Representation of the user field type.

    See more

    Declaration

    Swift

    public enum UserField : String

  • The business type.

    See more

    Declaration

    Swift

    public enum BusinessType : String

  • The user’s role in the organization.

    See more

    Declaration

    Swift

    public enum BusinessContactRole : String

  • Representation of the gender.

    See more

    Declaration

    Swift

    public enum Gender : String

  • Representation of the user’s profile type.

    See more

    Declaration

    Swift

    public enum ProfileType : String

  • Representation of the user account status type.

    See more

    Declaration

    Swift

    public enum Status : String

  • Representation of the user’s verification status type.

    See more

    Declaration

    Swift

    public enum VerificationStatus : String, Codable

  • Declaration

    Swift

    public required init(from decoder: Decoder) throws

  • The user’s street address.

    Declaration

    Swift

    public var addressLine1: String? { get }

  • The user’s address, second line.

    Declaration

    Swift

    public var addressLine2: String? { get }

  • The business contact’s street address.

    Declaration

    Swift

    public var businessContactAddressLine1: String? { get }

  • The business contact’s address, second line.

    Declaration

    Swift

    public var businessContactAddressLine2: String? { get }

  • The business contact’s city.

    Declaration

    Swift

    public var businessContactCity: String? { get }

  • The business contact’s country,

    Declaration

    Swift

    public var businessContactCountry: String? { get }

  • The business contact’s postal code.

    Declaration

    Swift

    public var businessContactPostalCode: String? { get }

  • The user’s role in the organization

    Declaration

    Swift

    public var businessContactRole: BusinessContactRole? { get }

  • The business contact’s state, province or region.

    Declaration

    Swift

    public var businessContactStateProvince: String? { get }

  • The business name.

    Declaration

    Swift

    public var businessName: String? { get }

  • The business’ operating name.

    Declaration

    Swift

    public var businessOperatingName: String? { get }

  • The country where the business is registered.

    Declaration

    Swift

    public var businessRegistrationCountry: String? { get }

  • The business registration number or identifier assigned by a government body.

    Declaration

    Swift

    public var businessRegistrationId: String? { get }

  • The state, province or region where the business is registered.

    Declaration

    Swift

    public var businessRegistrationStateProvince: String? { get }

  • The business type

    Declaration

    Swift

    public var businessType: BusinessType? { get }

  • The user’s city.

    Declaration

    Swift

    public var city: String? { get }

  • A client-defined identifier for the user. This is the unique ID assigned to the user on your system.

    Declaration

    Swift

    public var clientUserId: String? { get }

  • The user’s country.

    Declaration

    Swift

    public var country: String? { get }

  • The user’s birth country.

    Declaration

    Swift

    public var countryOfBirth: String? { get }

  • The user’s country of citizenship or nationality.

    Declaration

    Swift

    public var countryOfNationality: String? { get }

  • The datetime the user account was created on in ISO 8601 format (YYYY-MM-DDThh:mm:ss). Note that the timezone used is UTC, therefore no time offset is returned.

    Declaration

    Swift

    public var createdOn: String? { get }

  • The user’s date of birth (All users must be at least 13 years old).

    Declaration

    Swift

    public var dateOfBirth: String? { get }

  • The user’s driver’s license number.

    Declaration

    Swift

    public var driversLicenseId: String? { get }

  • The contact email address for the user account. This must be unique for your program, so you cannot have two users belonging to the same program with the same email address.

    Declaration

    Swift

    public var email: String? { get }

  • The user’s employer identifier, generally used for tax purposes.

    Declaration

    Swift

    public var employerId: String? { get }

  • The user’s first name.

    Declaration

    Swift

    public var firstName: String? { get }

  • The user’s gender.

    Declaration

    Swift

    public var gender: Gender? { get }

  • The user’s government ID number, such as a Social Security Number.

    Declaration

    Swift

    public var governmentId: String? { get }

  • The user’s government ID type.

    Declaration

    Swift

    public var governmentIdType: String? { get }

  • The preferred language for the user’s account. Defaults to English if not provided.

    Declaration

    Swift

    public var language: String? { get }

  • The user’s last name.

    Declaration

    Swift

    public var lastName: String? { get }

  • The user’s middle name.

    Declaration

    Swift

    public var middleName: String? { get }

  • The user’s cell phone number.

    Declaration

    Swift

    public var mobileNumber: String? { get }

  • The user’s passport number.

    Declaration

    Swift

    public var passportId: String? { get }

  • The user’s phone number.

    Declaration

    Swift

    public var phoneNumber: String? { get }

  • The user’s postal code.

    Declaration

    Swift

    public var postalCode: String? { get }

  • The user’s profile type. See ProfileType

    Declaration

    Swift

    public var profileType: ProfileType? { get }

  • The unique identifier for the program to which the user will belong.

    Declaration

    Swift

    public var programToken: String? { get }

  • The user’s state, province or region.

    Declaration

    Swift

    public var stateProvince: String? { get }

  • The user account status.

    Declaration

    Swift

    public var status: Status? { get }

  • The local time of a region or a country. e.g. GMT, PST, …

    Declaration

    Swift

    public var timeZone: String? { get }

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

    Declaration

    Swift

    public var token: String? { get }

  • The user’s verification status. A user may be required to verify their identity after a certain threshold of payments is reached.

    Declaration

    Swift

    public var verificationStatus: VerificationStatus? { get }

  • Declaration

    Swift

    public func encode(to encoder: Encoder) throws

  • Gets the field value

    Declaration

    Swift

    public func getField(_ fieldName: String) -> String?

    Parameters

    fieldName

    The UserField type raw value

    Return Value

    Returns the field value, or nil if none exists.

  • A helper class to build the HyperwalletUser instance.

    See more

    Declaration

    Swift

    public final class Builder