View on GitHub
-
Sets the user’s street address.
Declaration
Swift
public func addressLine1(_ addressLine1: String) -> BuilderParameters
addressLine1The user’s street address
Return Value
a self reference of
HyperwalletUser.Builderinstance. -
Sets the user’s address, second line.
Declaration
Swift
public func addressLine2(_ addressLine2: String) -> BuilderParameters
addressLine2The user’s address, second line.
Return Value
a self reference of
HyperwalletUser.Builderinstance. -
Builds a new instance of the
HyperwalletUser.Declaration
Swift
public func build() -> HyperwalletUserReturn Value
a new instance of the
HyperwalletUser. -
Sets the business contact’s street address.
Declaration
Swift
public func businessContactAddressLine1(_ businessContactAddressLine1: String) -> BuilderParameters
businessContactAddressLine1The business contact’s street address.
Return Value
a self reference of
HyperwalletUser.Builderinstance. -
Sets the business contact’s address, second line.
Declaration
Swift
public func businessContactAddressLine2(_ businessContactAddressLine2: String) -> BuilderParameters
businessContactAddressLine2The business contact’s address, second line.
Return Value
a self reference of
HyperwalletUser.Builderinstance. -
Sets the business contact’s city.
Declaration
Swift
public func businessContactCity(_ businessContactCity: String) -> BuilderParameters
businessContactCityThe business contact’s city.
Return Value
a self reference of
HyperwalletUser.Builderinstance. -
Sets the business contact’s country.
Declaration
Swift
public func businessContactCountry(_ businessContactCountry: String) -> BuilderParameters
businessContactCountryThe business contact’s city.
Return Value
a self reference of
HyperwalletUser.Builderinstance. -
Sets the business contact’s postal code.
Declaration
Swift
public func businessContactPostalCode(_ businessContactPostalCode: String) -> BuilderParameters
businessContactPostalCodeThe business contact’s postal code.
Return Value
a self reference of
HyperwalletUser.Builderinstance. -
Sets the user’s role in the organization.
Declaration
Swift
public func businessContactRole(_ businessContactRole: BusinessContactRole) -> BuilderParameters
businessContactPostalCodeThe
BusinessContactRole.Return Value
a self reference of
HyperwalletUser.Builderinstance. -
Sets the business contact’s state, province or region.
Declaration
Swift
public func businessContactStateProvince(_ businessContactStateProvince: String) -> BuilderParameters
businessContactStateProvinceThe business contact’s state, province or region.
Return Value
a self reference of
HyperwalletUser.Builderinstance. -
Sets the business name.
Declaration
Swift
public func businessName(_ businessName: String) -> BuilderParameters
businessNameThe business name.
Return Value
a self reference of
HyperwalletUser.Builderinstance. -
Sets the business’ operating name.
Declaration
Swift
public func businessOperatingName(_ businessOperatingName: String) -> BuilderParameters
businessNameThe business’ operating name.
Return Value
a self reference of
HyperwalletUser.Builderinstance. -
Sets the country where the business is registered.
Declaration
Swift
public func businessRegistrationCountry(_ businessRegistrationCountry: String) -> BuilderParameters
businessRegistrationCountryThe country where the business is registered.
Return Value
a self reference of
HyperwalletUser.Builderinstance. -
Sets the business registration number or identifier assigned by a government body.
Declaration
Swift
public func businessRegistrationId(_ businessRegistrationId: String) -> BuilderParameters
businessRegistrationIdThe business registration number or identifier assigned by a government body.
Return Value
a self reference of
HyperwalletUser.Builderinstance. -
Sets the state, province or region where the business is registered.
Declaration
Swift
public func businessRegistrationStateProvince(_ businessRegistrationStateProvince: String) -> BuilderParameters
businessRegistrationStateProvinceThe business registration number or identifier assigned by a government body.
Return Value
a self reference of
HyperwalletUser.Builderinstance. -
Sets the business type.
Declaration
Swift
public func businessType(_ businessType: BusinessType) -> BuilderParameters
businessRegistrationStateProvinceThe
BusinessType.Return Value
a self reference of
HyperwalletUser.Builderinstance. -
Sets the user’s city.
Declaration
Swift
public func city(_ city: String) -> BuilderParameters
cityThe user’s city.
Return Value
a self reference of
HyperwalletUser.Builderinstance. -
Sets the user’s country.
Declaration
Swift
public func country(_ country: String) -> BuilderParameters
countryThe user’s country.
Return Value
a self reference of
HyperwalletUser.Builderinstance. -
Sets the user’s birth country.
Declaration
Swift
public func countryOfBirth(_ countryOfBirth: String) -> BuilderParameters
countryThe user’s birth country.
Return Value
a self reference of
HyperwalletUser.Builderinstance. -
Sets the user’s country of citizenship or nationality.
Declaration
Swift
public func countryOfNationality(_ countryOfNationality: String) -> BuilderParameters
countryOfNationalityThe user’s country of citizenship or nationality.
Return Value
a self reference of
HyperwalletUser.Builderinstance. -
Sets 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 func createdOn(_ createdOn: String) -> BuilderParameters
createdOnThe 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.
Return Value
a self reference of
HyperwalletUser.Builderinstance. -
Sets the user’s date of birth (All users must be at least 13 years old).
Declaration
Swift
public func dateOfBirth(_ dateOfBirth: String) -> BuilderParameters
dateOfBirthThe user’s date of birth (All users must be at least 13 years old).
Return Value
a self reference of
HyperwalletUser.Builderinstance. -
Sets the user’s driver’s license number.
Declaration
Swift
public func driversLicenseId(_ driversLicenseId: String) -> BuilderParameters
driversLicenseIdThe user’s driver’s license number.
Return Value
a self reference of
HyperwalletUser.Builderinstance. -
Sets 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 func email(_ email: String) -> BuilderParameters
driversLicenseIdthe 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.
Return Value
a self reference of
HyperwalletUser.Builderinstance. -
Sets the user’s employer identifier, generally used for tax purposes.
Declaration
Swift
public func employerId(_ employerId: String) -> BuilderParameters
employerIdThe user’s employer identifier, generally used for tax purposes.
Return Value
a self reference of
HyperwalletUser.Builderinstance. -
Sets the user’s first name.
Declaration
Swift
public func firstName(_ firstName: String) -> BuilderParameters
firstNameThe user’s first name.
Return Value
a self reference of
HyperwalletUser.Builderinstance. -
Sets the user’s government ID number, such as a Social Security Number.
Declaration
Swift
public func governmentId(_ governmentId: String) -> BuilderParameters
governmentIdThe user’s government ID number, such as a Social Security Number.
Return Value
a self reference of
HyperwalletUser.Builderinstance. -
Sets the user’s government ID type.
Declaration
Swift
public func governmentIdType(_ governmentIdType: String) -> BuilderParameters
governmentIdTypeThe user’s government ID type.
Return Value
a self reference of
HyperwalletUser.Builderinstance. -
Sets the preferred language for the user’s account. Defaults to English if not provided.
Declaration
Swift
public func language(_ language: String) -> BuilderParameters
languageThe preferred language for the user’s account. Defaults to English if not provided.
Return Value
a self reference of
HyperwalletUser.Builderinstance. -
Sets the user’s last name.
Declaration
Swift
public func lastName(_ lastName: String) -> BuilderParameters
lastNameThe user’s last name.
Return Value
a self reference of
HyperwalletUser.Builderinstance. -
Sets the user’s middle name.
Declaration
Swift
public func middleName(_ middleName: String) -> BuilderParameters
middleNameThe user’s middle name.
Return Value
a self reference of
HyperwalletUser.Builderinstance. -
Sets the user’s cell phone number.
Declaration
Swift
public func mobileNumber(_ mobileNumber: String) -> BuilderParameters
middleNameThe user’s middle name.
Return Value
a self reference of
HyperwalletUser.Builderinstance. -
Sets the user’s passport number.
Declaration
Swift
public func passportId(_ passportId: String) -> BuilderParameters
passportIdThe user’s passport number.
Return Value
a self reference of
HyperwalletUser.Builderinstance. -
Sets the user’s phone number.
Declaration
Swift
public func phoneNumber(_ phoneNumber: String) -> BuilderParameters
passportIdThe user’s phone number.
Return Value
a self reference of
HyperwalletUser.Builderinstance. -
Sets the user’s postal code.
Declaration
Swift
public func postalCode(_ postalCode: String) -> BuilderParameters
postalCodeThe user’s postal code.
Return Value
a self reference of
HyperwalletUser.Builderinstance. -
Sets the user’s profile type.
Declaration
Swift
public func profileType(_ profileType: ProfileType) -> BuilderParameters
profileTypeThe
ProfileType.Return Value
a self reference of
HyperwalletUser.Builderinstance. -
Sets the unique identifier for the program to which the user will belong.
Declaration
Swift
public func programToken(_ programToken: String) -> BuilderParameters
programTokenThe unique identifier for the program to which the user will belong.
Return Value
a self reference of
HyperwalletUser.Builderinstance. -
Sets the field value based on the
UserField.RawValueDeclaration
Swift
public func setField(key: UserField.RawValue, value: String) -> BuilderParameters
keyThe
UserField.RawValuevaluevalueThe value
-
Sets the user’s state, province or region.
Declaration
Swift
public func stateProvince(_ stateProvince: String) -> BuilderParameters
stateProvinceThe user’s state, province or region.
Return Value
a self reference of
HyperwalletUser.Builderinstance. -
Sets the user account status.
Declaration
Swift
public func status(_ status: Status) -> BuilderParameters
statusThe user’s state, province or region.
Return Value
a self reference of
HyperwalletUser.Builderinstance. -
Sets the local time of a region or a country. e.g. GMT, PST, …
Declaration
Swift
public func timeZone(_ timeZone: String) -> BuilderParameters
timeZoneThe local time of a region or a country.
Return Value
a self reference of
HyperwalletUser.Builderinstance. -
Sets the unique, auto-generated user identifier. Max 64 characters, prefixed with “usr-”.
Declaration
Swift
public func token(_ token: String) -> BuilderParameters
tokenThe unique, auto-generated user identifier. Max 64 characters, prefixed with “usr-”.
Return Value
a self reference of
HyperwalletUser.Builderinstance. -
Sets the 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 func verificationStatus(_ verificationStatus: VerificationStatus) -> BuilderParameters
verificationStatusThe user’s verification status. A user may be required to verify their identity after a certainthreshold of payments is reached.
Return Value
a self reference of
HyperwalletUser.Builderinstance.
HyperwalletSDK (99% documented)