diff --git a/Classes.html b/Classes.html new file mode 100644 index 00000000..21cf57c5 --- /dev/null +++ b/Classes.html @@ -0,0 +1,987 @@ + + + + Classes Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + Classes Reference +

+ +
+ +
+ +
+
+

Classes

+

The following classes are available globally.

+ +
+
+ +
+
+
+ +
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/Classes/Hyperwallet.html b/Classes/Hyperwallet.html new file mode 100644 index 00000000..533ce2d9 --- /dev/null +++ b/Classes/Hyperwallet.html @@ -0,0 +1,3532 @@ + + + + Hyperwallet Class Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + Hyperwallet Class Reference +

+ +
+ +
+ +
+
+

Hyperwallet

+
+
+ + 
@objcMembers
+public final class Hyperwallet : NSObject
+ +
+
+

The Hyperwallet class is an iOS specific implementation of the +Hyperwallet platform User APIs.

+ +

A single instance of the Hyperwallet class is maintained. Resetting the current instance by calling +setup(_: HyperwalletAuthenticationTokenProvider) is critical when switching between authenticated Users. +Failure to do so will result in incorrect access and incorrect modifications to User data.

+ +

Authentication with the Hyperwallet platform is accomplished through the usage of JSON Web Tokens. At +instantiation an HyperwalletAuthenticationTokenProvider is set as a member variable to provide +the Hyperwallet class with an authentication token upon request.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + shared + +
    +
    +
    +
    +
    +
    +

    Returns the previously initialized instance of the Hyperwallet Core SDK interface object

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public static var shared: Hyperwallet { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + clearInstance() + +
    +
    +
    +
    +
    +
    +

    Clears Hyperwallet instance.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public static func clearInstance()
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + setup(_:) + +
    +
    +
    +
    +
    +
    +

    Creates a new instance of the Hyperwallet Core SDK interface object. If a previously created instance exists, +it will be replaced.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public static func setup(_ provider: HyperwalletAuthenticationTokenProvider)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + provider + + +
    +

    a provider of Hyperwallet authentication tokens.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Retrieves a configuration if one exists - else using the authentication token from the provider, +it tries to fetch the configuration object again and returns it else error

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func getConfiguration(completion: @escaping (Configuration?, HyperwalletErrorType?) -> Void)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + completion + + +
    +

    the callback handler of responses from the Hyperwallet platform

    +
    +
    +
    +
    +
    +
    • +
  • +
    + + + + getUser(completion:) + +
    +
    +
    +
    +
    +
    +

    Returns the HyperwalletUser for the User associated with the authentication token returned from +HyperwalletAuthenticationTokenProvider.retrieveAuthenticationToken(_ : @escaping CompletionHandler) or nil +if none exists.

    + +

    The completion: @escaping (HyperwalletUser?, HyperwalletErrorType?) -> Void that is passed in to +this method invocation will receive the successful response(HyperwalletUser) or error(HyperwalletErrorType) +from processing the request.

    + +

    This function will request a new authentication token via HyperwalletAuthenticationTokenProvider +if the current one is expired or is about to expire.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func getUser(completion: @escaping (HyperwalletUser?, HyperwalletErrorType?) -> Void)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + completion + + +
    +

    the callback handler of responses from the Hyperwallet platform

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Creates a HyperwalletBankAccount for the User associated with the authentication token returned from +HyperwalletAuthenticationTokenProvider.retrieveAuthenticationToken(_ : @escaping CompletionHandler).

    + +

    The completion: @escaping (HyperwalletBankAccount?, HyperwalletErrorType?) -> Void that is passed in to this +method invocation will receive the successful response(HyperwalletBankAccount) or error(HyperwalletErrorType) +from processing the request.

    + +

    This function will request a new authentication token via HyperwalletAuthenticationTokenProvider +if the current one is expired or is about to expire.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func createBankAccount(account: HyperwalletBankAccount,
+                              completion: @escaping (HyperwalletBankAccount?, HyperwalletErrorType?) -> Void)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + account + + +
    +

    the HyperwalletBankAccount to be created

    +
    +
    + + completion + + +
    +

    the callback handler of responses from the Hyperwallet platform

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Creates a HyperwalletPaperCheck for the User associated with the authentication token returned from +HyperwalletAuthenticationTokenProvider.retrieveAuthenticationToken(_ : @escaping CompletionHandler).

    + +

    The completion: @escaping (HyperwalletPaperCheck?, HyperwalletErrorType?) -> Void +that is passed in to this method invocation will receive the successful response(HyperwalletPaperCheck) +or error(HyperwalletErrorType) from processing the request.

    + +

    This function will request a new authentication token via HyperwalletAuthenticationTokenProvider +if the current one is expired or is about to expire.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func createPaperCheck(
+    account: HyperwalletPaperCheck,
+    completion: @escaping (HyperwalletPaperCheck?, HyperwalletErrorType?) -> Void)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + account + + +
    +

    the HyperwalletPaperCheck to be created

    +
    +
    + + completion + + +
    +

    the callback handler of responses from the Hyperwallet platform

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Creates a HyperwalletBankCard for the User associated with the authentication token returned from +HyperwalletAuthenticationTokenProvider.retrieveAuthenticationToken(_ : @escaping CompletionHandler).

    + +

    The completion: @escaping (HyperwalletBankCard?, HyperwalletErrorType?) -> Void that is passed in to this +method invocation will receive the successful response(HyperwalletBankCard) or error(HyperwalletErrorType) +from processing the request.

    + +

    This function will request a new authentication token via HyperwalletAuthenticationTokenProvider +if the current one is expired or is about to expire.

    + +

    @param bankCard +@param listener

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func createBankCard(account: HyperwalletBankCard,
+                           completion: @escaping (HyperwalletBankCard?, HyperwalletErrorType?) -> Void)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + account + + +
    +

    the HyperwalletBankCard to be created

    +
    +
    + + completion + + +
    +

    the callback handler of responses from the Hyperwallet platform

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Creates a HyperwalletPayPalAccount for the User associated with the authentication token returned from +HyperwalletAuthenticationTokenProvider.retrieveAuthenticationToken(_ : @escaping CompletionHandler).

    + +

    The completion: @escaping (HyperwalletPayPalAccount?, HyperwalletErrorType?) -> Void that is passed in to this +method invocation will receive the successful response(HyperwalletPayPalAccount) or error(HyperwalletErrorType) +from processing the request.

    + +

    This function will request a new authentication token via HyperwalletAuthenticationTokenProvider +if the current one is expired or is about to expire.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func createPayPalAccount(account: HyperwalletPayPalAccount,
+                                completion: @escaping (HyperwalletPayPalAccount?, HyperwalletErrorType?) -> Void)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + account + + +
    +

    the HyperwalletPayPalAccount to be created

    +
    +
    + + completion + + +
    +

    the callback handler of responses from the Hyperwallet platform

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Creates a HyperwalletTransfer for the User associated with the authentication token returned from +HyperwalletAuthenticationTokenProvider.retrieveAuthenticationToken(_ : @escaping CompletionHandler).

    + +

    The completion: @escaping (HyperwalletTransfer?, HyperwalletErrorType?) -> Void that is passed in to this +method invocation will receive the successful response(HyperwalletTransfer) or error(HyperwalletErrorType) +from processing the request.

    + +

    This function will request a new authentication token via HyperwalletAuthenticationTokenProvider +if the current one is expired or is about to expire.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func createTransfer(transfer: HyperwalletTransfer,
+                           completion: @escaping (HyperwalletTransfer?, HyperwalletErrorType?) -> Void)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + transfer + + +
    +

    the HyperwalletTransfer to be created

    +
    +
    + + completion + + +
    +

    the callback handler of responses from the Hyperwallet platform

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Creates a HyperwalletVenmoAccount for the User associated with the authentication token returned from +HyperwalletAuthenticationTokenProvider.retrieveAuthenticationToken(_ : @escaping CompletionHandler).

    + +

    The completion: @escaping (HyperwalletVenmoAccount?, HyperwalletErrorType?) -> Void that is passed in to this +method invocation will receive the successful response(HyperwalletVenmoAccount) or error(HyperwalletErrorType) +from processing the request.

    + +

    This function will request a new authentication token via HyperwalletAuthenticationTokenProvider +if the current one is expired or is about to expire.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func createVenmoAccount(account: HyperwalletVenmoAccount,
+                               completion: @escaping (HyperwalletVenmoAccount?, HyperwalletErrorType?) -> Void)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + account + + +
    +

    the HyperwalletVenmoAccount to be created

    +
    +
    + + completion + + +
    +

    the callback handler of responses from the Hyperwallet platform

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Deactivates the HyperwalletBankAccount linked to the transfer method token specified. The +HyperwalletBankAccount being deactivated must belong to the User that is associated with the +authentication token returned from +HyperwalletAuthenticationTokenProvider.retrieveAuthenticationToken(_ : @escaping CompletionHandler).

    + +

    The completion: @escaping (HyperwalletStatusTransition?, HyperwalletErrorType?) -> Void that is passed in to +this method invocation will receive the successful response(HyperwalletStatusTransition) or +error(HyperwalletErrorType) from processing the request.

    + +

    This function will request a new authentication token via HyperwalletAuthenticationTokenProvider` +if the current one is expired or is about to expire.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func deactivateBankAccount(transferMethodToken: String,
+                                  notes: String? = nil,
+                                  completion: @escaping (HyperwalletStatusTransition?,
+                                                         HyperwalletErrorType?) -> Void)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + transferMethodToken + + +
    +

    the Hyperwallet specific unique identifier for the HyperwalletBankAccount + being deactivated

    +
    +
    + + notes + + +
    +

    a note regarding the status change

    +
    +
    + + completion + + +
    +

    the callback handler of responses from the Hyperwallet platform

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Deactivates the HyperwalletPaperCheck linked to the transfer method token specified. The +HyperwalletPaperCheck being deactivated must belong to the User that is associated with the +authentication token returned from +HyperwalletAuthenticationTokenProvider.retrieveAuthenticationToken(_ : @escaping CompletionHandler).

    + +

    The completion: @escaping (HyperwalletStatusTransition?, HyperwalletErrorType?) -> Void that is passed in to +this method invocation will receive the successful response(HyperwalletStatusTransition) or +error(HyperwalletErrorType) from processing the request.

    + +

    This function will request a new authentication token via HyperwalletAuthenticationTokenProvider` +if the current one is expired or is about to expire.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func deactivatePaperCheck(transferMethodToken: String,
+                                 notes: String? = nil,
+                                 completion: @escaping (HyperwalletStatusTransition?,
+                                                         HyperwalletErrorType?) -> Void)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + transferMethodToken + + +
    +

    the Hyperwallet specific unique identifier for the HyperwalletPaperCheck + being deactivated

    +
    +
    + + notes + + +
    +

    a note regarding the status change

    +
    +
    + + completion + + +
    +

    the callback handler of responses from the Hyperwallet platform

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Deactivates the HyperwalletBankCard linked to the transfer method token specified. The +HyperwalletBankCard being deactivated must belong to the User that is associated with the +authentication token returned from +HyperwalletAuthenticationTokenProvider.retrieveAuthenticationToken(_ : @escaping CompletionHandler).

    + +

    The completion: @escaping (HyperwalletStatusTransition?, HyperwalletErrorType?) -> Void that is passed in to +this method invocation will receive the successful response(HyperwalletStatusTransition) or +error(HyperwalletErrorType) from processing the request.

    + +

    This function will request a new authentication token via HyperwalletAuthenticationTokenProvider +if the current one is expired or is about to expire.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func deactivateBankCard(transferMethodToken: String,
+                               notes: String? = nil,
+                               completion: @escaping (HyperwalletStatusTransition?,
+                                                      HyperwalletErrorType?) -> Void)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + transferMethodToken + + +
    +

    the Hyperwallet specific unique identifier for the HyperwalletBankCard + being deactivated

    +
    +
    + + notes + + +
    +

    a note regarding the status change

    +
    +
    + + completion + + +
    +

    the callback handler of responses from the Hyperwallet platform

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Deactivates the HyperwalletPayPalAccount linked to the transfer method token specified. The +HyperwalletPayPalAccount being deactivated must belong to the User that is associated with the +authentication token returned from +HyperwalletAuthenticationTokenProvider.retrieveAuthenticationToken(_ : @escaping CompletionHandler).

    + +

    The completion: @escaping (HyperwalletStatusTransition?, HyperwalletErrorType?) -> Void that is passed in to +this method invocation will receive the successful response(HyperwalletStatusTransition) or +error(HyperwalletErrorType) from processing the request.

    + +

    This function will request a new authentication token via HyperwalletAuthenticationTokenProvider +if the current one is expired or is about to expire.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func deactivatePayPalAccount(transferMethodToken: String,
+                                    notes: String? = nil,
+                                    completion: @escaping (HyperwalletStatusTransition?,
+                                                           HyperwalletErrorType?) -> Void)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + transferMethodToken + + +
    +

    the Hyperwallet specific unique identifier for the HyperwalletPayPalAccount + being deactivated

    +
    +
    + + notes + + +
    +

    a note regarding the status change

    +
    +
    + + completion + + +
    +

    the callback handler of responses from the Hyperwallet platform

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Deactivates the HyperwalletVenmoAccount linked to the transfer method token specified. The +HyperwalletVenmoAccount being deactivated must belong to the User that is associated with the +authentication token returned from +HyperwalletAuthenticationTokenProvider.retrieveAuthenticationToken(_ : @escaping CompletionHandler).

    + +

    The completion: @escaping (HyperwalletStatusTransition?, HyperwalletErrorType?) -> Void that is passed in to +this method invocation will receive the successful response(HyperwalletStatusTransition) or +error(HyperwalletErrorType) from processing the request.

    + +

    This function will request a new authentication token via HyperwalletAuthenticationTokenProvider +if the current one is expired or is about to expire.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func deactivateVenmoAccount(transferMethodToken: String,
+                                   notes: String? = nil,
+                                   completion: @escaping (HyperwalletStatusTransition?,
+                                                          HyperwalletErrorType?) -> Void)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + transferMethodToken + + +
    +

    the Hyperwallet specific unique identifier for the HyperwalletVenmoAccount + being deactivated

    +
    +
    + + notes + + +
    +

    a note regarding the status change

    +
    +
    + + completion + + +
    +

    the callback handler of responses from the Hyperwallet platform

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Schedules the HyperwalletTransfer linked to the transfer method token specified.

    + +

    The completion: @escaping (HyperwalletStatusTransition?, HyperwalletErrorType?) -> Void that is passed in to +this method invocation will receive the successful response(HyperwalletStatusTransition) or +error(HyperwalletErrorType) from processing the request.

    + +

    This function will request a new authentication token via HyperwalletAuthenticationTokenProvider +if the current one is expired or is about to expire.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func scheduleTransfer(transferToken: String,
+                             notes: String? = nil,
+                             completion: @escaping (HyperwalletStatusTransition?, HyperwalletErrorType?) -> Void)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + transferToken + + +
    +

    the Hyperwallet specific unique identifier for the HyperwalletTransfer + being commited

    +
    +
    + + notes + + +
    +

    a note regarding the status change

    +
    +
    + + completion + + +
    +

    the callback handler of responses from the Hyperwallet platform

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Returns the HyperwalletBankAccount linked to the transfer method token specified, or nil if none exists.

    + +

    The completion: @escaping (HyperwalletBankAccount?, HyperwalletErrorType?) -> Void that is passed in to this +method invocation will receive the successful response(HyperwalletBankAccount) or error(HyperwalletErrorType) +from processing the request.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func getBankAccount(transferMethodToken: String,
+                           completion: @escaping (HyperwalletBankAccount?, HyperwalletErrorType?) -> Void)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + transferMethodToken + + +
    +

    the Hyperwallet specific unique identifier for the HyperwalletBankAccount + being requested

    +
    +
    + + completion + + +
    +

    the callback handler of responses from the Hyperwallet platform

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Returns the HyperwalletPaperCheck linked to the transfer method token specified, or nil if none exists.

    + +

    The completion: @escaping (HyperwalletPaperCheck?, HyperwalletErrorType?) -> Void +that is passed in to this method invocation will receive the successful response(HyperwalletPaperCheck) +or error(HyperwalletErrorType) from processing the request.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func getPaperCheck(
+    transferMethodToken: String,
+    completion: @escaping (HyperwalletPaperCheck?, HyperwalletErrorType?) -> Void)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + transferMethodToken + + +
    +

    the Hyperwallet specific unique identifier for the HyperwalletPaperCheck + being requested

    +
    +
    + + completion + + +
    +

    the callback handler of responses from the Hyperwallet platform

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Returns the HyperwalletBankCard linked to the transfer method token specified, or nil if none exists.

    + +

    The completion: @escaping (HyperwalletBankCard?, HyperwalletErrorType?) -> Void that is passed in to +this method invocation will receive the successful response(HyperwalletBankCard) or error(HyperwalletErrorType) +from processing the request.

    + +

    This function will request a new authentication token via HyperwalletAuthenticationTokenProvider +if the current one is expired or is about to expire.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func getBankCard(transferMethodToken: String,
+                        completion: @escaping (HyperwalletBankCard?, HyperwalletErrorType?) -> Void)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + transferMethodToken + + +
    +

    the Hyperwallet specific unique identifier for the HyperwalletBankCard + being requested

    +
    +
    + + completion + + +
    +

    the callback handler of responses from the Hyperwallet platform

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Returns the HyperwalletPayPalAccount linked to the transfer method token specified, or nil if none exists.

    + +

    The completion: @escaping (HyperwalletPayPalAccount?, HyperwalletErrorType?) -> Void that is passed in to this +method invocation will receive the successful response(HyperwalletPayPalAccount) or error(HyperwalletErrorType) +from processing the request.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func getPayPalAccount(transferMethodToken: String,
+                             completion: @escaping (HyperwalletPayPalAccount?, HyperwalletErrorType?) -> Void)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + transferMethodToken + + +
    +

    the Hyperwallet specific unique identifier for the HyperwalletPayPalAccount + being requested

    +
    +
    + + completion + + +
    +

    the callback handler of responses from the Hyperwallet platform

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Returns the HyperwalletPrepaidCard linked to the transfer method token specified, or nil if none exists.

    + +

    The completion: @escaping (HyperwalletPrepaidCard?, HyperwalletErrorType?) -> Void that is passed in to +this method invocation will receive the successful response(HyperwalletPrepaidCard) or +error(HyperwalletErrorType) from processing the request.

    + +

    This function will request a new authentication token via HyperwalletAuthenticationTokenProvider +if the current one is expired or is about to expire.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func getPrepaidCard(transferMethodToken: String,
+                           completion: @escaping (HyperwalletPrepaidCard?, HyperwalletErrorType?) -> Void)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + transferMethodToken + + +
    +

    the Hyperwallet specific unique identifier for the HyperwalletPrepaidCard + being requested

    +
    +
    + + completion + + +
    +

    the callback handler of responses from the Hyperwallet platform

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Returns the HyperwalletTransfer linked to the transfer method token specified, or nil if none exists.

    + +

    The completion: @escaping (HyperwalletTransfer?, HyperwalletErrorType?) -> Void that is passed in to this +method invocation will receive the successful response(HyperwalletTransfer) or error(HyperwalletErrorType) +from processing the request.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func getTransfer(transferToken: String,
+                        completion: @escaping (HyperwalletTransfer?, HyperwalletErrorType?) -> Void)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + transferToken + + +
    +

    the Hyperwallet specific unique identifier for the HyperwalletTransfer + being requested

    +
    +
    + + completion + + +
    +

    the callback handler of responses from the Hyperwallet platform

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Returns the HyperwalletVenmoAccount linked to the transfer method token specified, or nil if none exists.

    + +

    The completion: @escaping (HyperwalletVenmoAccount?, HyperwalletErrorType?) -> Void that is passed in to this +method invocation will receive the successful response(HyperwalletVenmoAccount) or error(HyperwalletErrorType) +from processing the request.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func getVenmoAccount(transferMethodToken: String,
+                            completion: @escaping (HyperwalletVenmoAccount?, HyperwalletErrorType?) -> Void)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + transferMethodToken + + +
    +

    the Hyperwallet specific unique identifier for the HyperwalletVenmoAccount + being requested

    +
    +
    + + completion + + +
    +

    the callback handler of responses from the Hyperwallet platform

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Returns the list of HyperwalletBankAccounts for the User associated with the authentication token +returned from +HyperwalletAuthenticationTokenProvider.retrieveAuthenticationToken(_ : @escaping CompletionHandler), +or nil if non exist.

    + +

    The ordering and filtering of HyperwalletBankAccounts will be based on the criteria specified within +the HyperwalletBankAccountQueryParam object, if it is not nil. Otherwise the default ordering and +filtering will be applied:

    + +
      +
    • Offset: 0
      • +
    • Limit: 10
      • +
    • Created Before: N/A
      • +
    • Created After: N/A
      • +
    • Type: Bank Account
      • +
    • Status: All
      • +
    • Sort By: Created On
      • +
    + +

    The completion: @escaping (HyperwalletPageList<HyperwalletBankAccount>?, HyperwalletErrorType?) -> Void that +is passed in to this method invocation will receive the successful +response(HyperwalletPageList?) or error(HyperwalletErrorType) from processing the +request.

    + +

    This function will request a new authentication token via HyperwalletAuthenticationTokenProvider +if the current one is expired or is about to expire.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func listBankAccounts(queryParam: HyperwalletBankAccountQueryParam? = nil,
+                             completion: @escaping (HyperwalletPageList<HyperwalletBankAccount>?,
+    HyperwalletErrorType?) -> Void)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + queryParam + + +
    +

    the ordering and filtering criteria

    +
    +
    + + completion + + +
    +

    the callback handler of responses from the Hyperwallet platform

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Returns the list of HyperwalletPaperChecks for the User associated with the authentication token +returned from +HyperwalletAuthenticationTokenProvider.retrieveAuthenticationToken(_ : @escaping CompletionHandler), +or nil if non exist.

    + +

    The ordering and filtering of HyperwalletPaperChecks will be based on the criteria specified within +the HyperwalletPaperCheckQueryParam object, if it is not nil. Otherwise the default ordering and +filtering will be applied:

    + +
      +
    • Offset: 0
      • +
    • Limit: 10
      • +
    • Created Before: N/A
      • +
    • Created After: N/A
      • +
    • Type: Paper Check
      • +
    • Status: All
      • +
    • Sort By: Created On
      • +
    + +

    The completion: @escaping (HyperwalletPageList<HyperwalletPaperCheck>?, HyperwalletErrorType?) -> Void +that is passed in to this method invocation will receive the successful +response(HyperwalletPageList?) or error(HyperwalletErrorType) from processing the +request.

    + +

    This function will request a new authentication token via HyperwalletAuthenticationTokenProvider +if the current one is expired or is about to expire.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func listPaperChecks(queryParam: HyperwalletPaperCheckQueryParam? = nil,
+                            completion: @escaping (HyperwalletPageList<HyperwalletPaperCheck>?,
+    HyperwalletErrorType?) -> Void)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + queryParam + + +
    +

    the ordering and filtering criteria

    +
    +
    + + completion + + +
    +

    the callback handler of responses from the Hyperwallet platform

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Returns the HyperwalletBankCard for the User associated with the authentication token returned from +HyperwalletAuthenticationTokenProvider.retrieveAuthenticationToken(_ : @escaping CompletionHandler), +or nil if non exist.

    + +

    The ordering and filtering of HyperwalletBankCard will be based on the criteria specified within the +HyperwalletBankAccountQueryParam object, if it is not nil. Otherwise the default ordering and +filtering will be applied.

    + +
      +
    • Offset: 0
      • +
    • Limit: 10
      • +
    • Created Before: N/A
      • +
    • Created After: N/A
      • +
    • Type: Bank Card
      • +
    • Status: All
      • +
    • Sort By: Created On
      • +
    + +

    The completion: @escaping (HyperwalletPageList<HyperwalletBankCard>?, HyperwalletErrorType?) -> Void that is +passed in to this method invocation will receive the successful +response(HyperwalletPageList?) or error(HyperwalletErrorType) from processing the request.

    + +

    This function will request a new authentication token via HyperwalletAuthenticationTokenProvider +if the current one is expired or is about to expire.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func listBankCards(queryParam: HyperwalletBankCardQueryParam? = nil,
+                          completion: @escaping (HyperwalletPageList<HyperwalletBankCard>?,
+                                                 HyperwalletErrorType?) -> Void)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + queryParam + + +
    +

    the ordering and filtering criteria

    +
    +
    + + completion + + +
    +

    the callback handler of responses from the Hyperwallet platform

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Returns the HyperwalletPayPalAccount for the User associated with the authentication token returned from +HyperwalletAuthenticationTokenProvider.retrieveAuthenticationToken(_ : @escaping CompletionHandler), +or nil if non exist.

    + +

    The ordering and filtering of HyperwalletPayPalAccount will be based on the criteria specified within the +HyperwalletPayPalAccountQueryParam object, if it is not nil. Otherwise the default ordering and +filtering will be applied.

    + +
      +
    • Offset: 0
      • +
    • Limit: 10
      • +
    • Created Before: N/A
      • +
    • Created After: N/A
      • +
    • Status: All
      • +
    • Sort By: Created On
      • +
    + +

    The completion: @escaping (HyperwalletPageList<HyperwalletPayPalAccount>?, HyperwalletErrorType?) -> Void +that is passed in to this method invocation will receive the successful +response(HyperwalletPageList?) or error(HyperwalletErrorType) from processing the +request.

    + +

    This function will request a new authentication token via HyperwalletAuthenticationTokenProvider +if the current one is expired or is about to expire.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func listPayPalAccounts(queryParam: HyperwalletPayPalAccountQueryParam? = nil,
+                               completion: @escaping (HyperwalletPageList<HyperwalletPayPalAccount>?,
+                                                      HyperwalletErrorType?) -> Void)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + queryParam + + +
    +

    the ordering and filtering criteria

    +
    +
    + + completion + + +
    +

    the callback handler of responses from the Hyperwallet platform

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Returns the HyperwalletTransferMethod (Bank Account, Bank Card, PayPay Account, Prepaid Card, Paper Checks) +for the User associated with the authentication token returned from +HyperwalletAuthenticationTokenProvider.retrieveAuthenticationToken(_ : @escaping CompletionHandler), +or nil if non exist.

    + +

    The ordering and filtering of HyperwalletBankCard will be based on the criteria specified within the +HyperwalletBankAccountQueryParam object, if it is not nil. Otherwise the default ordering and +filtering will be applied.

    + +
      +
    • Offset: 0
      • +
    • Limit: 10
      • +
    • Created Before: N/A
      • +
    • Created After: N/A
      • +
    • Type: All
      • +
    • Status: All
      • +
    • Sort By: Created On
      • +
    + +

    The completion: @escaping (HyperwalletPageList<HyperwalletTransferMethod>?, HyperwalletErrorType?) -> Void +that is passed in to this method invocation will receive the successful +response(HyperwalletPageList?) or error(HyperwalletErrorType) from processing +the request.

    + +

    This function will request a new authentication token via HyperwalletAuthenticationTokenProvider +if the current one is expired or is about to expire.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func listTransferMethods(queryParam: HyperwalletTransferMethodQueryParam? = nil,
+                                completion: @escaping (HyperwalletPageList<HyperwalletTransferMethod>?,
+    HyperwalletErrorType?) -> Void)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + queryParam + + +
    +

    the ordering and filtering criteria

    +
    +
    + + completion + + +
    +

    the callback handler of responses from the Hyperwallet platform

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Returns the HyperwalletPrepaidCard +for the User associated with the authentication token returned from +HyperwalletAuthenticationTokenProvider.retrieveAuthenticationToken(_ : @escaping CompletionHandler), +or nil if non exist.

    + +

    The ordering and filtering of HyperwalletPrepaidCard will be based on the criteria specified within the +HyperwalletPrepaidCardQueryParam object, if it is not nil. Otherwise the default ordering and +filtering will be applied.

    + +
      +
    • Offset: 0
      • +
    • Limit: 10
      • +
    • Created Before: N/A
      • +
    • Created After: N/A
      • +
    • Status: All
      • +
    • Sort By: Created On
      • +
    + +

    The completion: @escaping (HyperwalletPageList<HyperwalletPrepaidCard>?, HyperwalletErrorType?) -> Void +that is passed in to this method invocation will receive the successful +response(HyperwalletPageList?) or error(HyperwalletErrorType) from processing +the request.

    + +

    This function will request a new authentication token via HyperwalletAuthenticationTokenProvider +if the current one is expired or is about to expire.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func listPrepaidCards(queryParam: HyperwalletPrepaidCardQueryParam? = nil,
+                             completion: @escaping (HyperwalletPageList<HyperwalletPrepaidCard>?,
+    HyperwalletErrorType?) -> Void)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + queryParam + + +
    +

    the ordering and filtering criteria

    +
    +
    + + completion + + +
    +

    the callback handler of responses from the Hyperwallet platform

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Returns the HyperwalletVenmoAccount for the User associated with the authentication token returned from +HyperwalletAuthenticationTokenProvider.retrieveAuthenticationToken(_ : @escaping CompletionHandler), +or nil if non exist.

    + +

    The ordering and filtering of HyperwalletVenmoAccount will be based on the criteria specified within the +HyperwalletVenmoQueryParam object, if it is not nil. Otherwise the default ordering and +filtering will be applied.

    + +
      +
    • Offset: 0
      • +
    • Limit: 10
      • +
    • Created Before: N/A
      • +
    • Created After: N/A
      • +
    • Status: All
      • +
    • Sort By: Created On
      • +
    + +

    The completion: @escaping (HyperwalletPageList<HyperwalletVenmoAccount>?, HyperwalletErrorType?) -> Void +that is passed in to this method invocation will receive the successful +response(HyperwalletPageList?) or error(HyperwalletErrorType) from processing the +request.

    + +

    This function will request a new authentication token via HyperwalletAuthenticationTokenProvider +if the current one is expired or is about to expire.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func listVenmoAccounts(queryParam: HyperwalletVenmoQueryParam? = nil,
+                              completion: @escaping (HyperwalletPageList<HyperwalletVenmoAccount>?,
+                                                     HyperwalletErrorType?) -> Void)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + queryParam + + +
    +

    the ordering and filtering criteria

    +
    +
    + + completion + + +
    +

    the callback handler of responses from the Hyperwallet platform

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Returns the list of receipts for the User associated with the authentication token.

    + +

    The ordering and filtering of HyperwalletReceipt will be based on the criteria specified within the +HyperwalletReceiptQueryParam object, if it is not nil. Otherwise the default ordering and +filtering will be applied.

    + +
      +
    • Offset: 0
      • +
    • Limit: 10
      • +
    • Created Before: N/A
      • +
    • Created After: N/A
      • +
    • Currency: All
      • +
    • Sort By: Created On
      • +
    + +

    The completion: @escaping (HyperwalletPageList<HyperwalletReceipt>?, HyperwalletErrorType?) -> Void +that is passed in to this method invocation will receive the successful +response(HyperwalletPageList?) or error(HyperwalletErrorType) from processing +the request.

    + +

    This function will request a new authentication token via HyperwalletAuthenticationTokenProvider +if the current one is expired or is about to expire.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func listUserReceipts(queryParam: HyperwalletReceiptQueryParam? = nil,
+                             completion: @escaping (HyperwalletPageList<HyperwalletReceipt>?,
+    HyperwalletErrorType?) -> Void)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + queryParam + + +
    +

    the ordering and filtering criteria

    +
    +
    + + completion + + +
    +

    the callback handler of responses from the Hyperwallet platform

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The filtering of HyperwalletReceipt will be based on the criteria specified within the +HyperwalletReceiptQueryParam object. CreatedAfter needs to be provided to get the receipts. +Receipts are returned sorted in ascending order of creation date

    + +
      +
    • Created Before: N/A
      • +
    • Created After: “Some Date”
      • +
    • Currency: All
      • +
    + +

    The completion: @escaping (HyperwalletPageList<HyperwalletReceipt>?, HyperwalletErrorType?) -> Void +that is passed in to this method invocation will receive the successful +response(HyperwalletPageList?) or error(HyperwalletErrorType) from processing +the request.

    + +

    This function will request a new authentication token via HyperwalletAuthenticationTokenProvider +if the current one is expired or is about to expire.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func listPrepaidCardReceipts(prepaidCardToken: String,
+                                    queryParam: HyperwalletReceiptQueryParam? = nil,
+                                    completion: @escaping (HyperwalletPageList<HyperwalletReceipt>?,
+    HyperwalletErrorType?) -> Void)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + queryParam + + +
    +

    the ordering and filtering criteria

    +
    +
    + + completion + + +
    +

    the callback handler of responses from the Hyperwallet platform

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Returns the list of transfers for the User associated with the authentication token.

    + +

    The ordering and filtering of HyperwalletTransfer will be based on the criteria specified within the +HyperwalletTransferQueryParam object, if it is not nil. Otherwise the default ordering and +filtering will be applied.

    + +
      +
    • Offset: 0
      • +
    • Limit: 10
      • +
    • Created Before: N/A
      • +
    • Created After: N/A
      • +
    • clientTransferId: N/A
      • +
    • destinationToken: N/A
      • +
    • sourceToken: N/A
      • +
    + +

    The completion: @escaping (HyperwalletPageList<HyperwalletTransfer>?, HyperwalletErrorType?) -> Void +that is passed in to this method invocation will receive the successful +response(HyperwalletPageList?) or error(HyperwalletErrorType) from processing +the request.

    + +

    This function will request a new authentication token via HyperwalletAuthenticationTokenProvider +if the current one is expired or is about to expire.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func listTransfers(queryParam: HyperwalletTransferQueryParam? = nil,
+                          completion: @escaping (HyperwalletPageList<HyperwalletTransfer>?,
+    HyperwalletErrorType?) -> Void)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + queryParam + + +
    +

    the ordering and filtering criteria

    +
    +
    + + completion + + +
    +

    the callback handler of responses from the Hyperwallet platform

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Returns the transfer method configuration field set for the User that is associated with the authentication +token returned from +HyperwalletAuthenticationTokenProvider.retrieveAuthenticationToken(_ : @escaping CompletionHandler).

    + +

    The completion: @escaping (HyperwalletTransferMethodConfigurationField?, HyperwalletErrorType?) -> Void +that is passed in to this method invocation will receive the successful +response(HyperwalletTransferMethodConfigurationField) or error(HyperwalletErrorType) from processing the +request.

    + +

    This function will request a new authentication token via HyperwalletAuthenticationTokenProvider +if the current one is expired or is about to expire.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func retrieveTransferMethodConfigurationFields(
+    request: HyperwalletTransferMethodConfigurationFieldQuery,
+    completion: @escaping (HyperwalletTransferMethodConfigurationField?, HyperwalletErrorType?) -> Void)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + request + + +
    +

    containing a transfer method configuration key tuple of country, currency, + transfer method type and profile

    +
    +
    + + completion + + +
    +

    the callback handler of responses from the Hyperwallet platform

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Returns the transfer method update configuration fields set for the User that is associated with +the authentication token returned from +HyperwalletAuthenticationTokenProvider.retrieveAuthenticationToken(_ : @escaping CompletionHandler).

    + +

    The completion: @escaping (HyperwalletTransferMethodUpdateConfigurationField?, HyperwalletErrorType?) -> Void +that is passed in to this method invocation will receive the successful +response(HyperwalletTransferMethodUpdateConfigurationField) or error(HyperwalletErrorType) from processing the +request.

    + +

    This function will request a new authentication token via HyperwalletAuthenticationTokenProvider +if the current one is expired or is about to expire.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func retrieveTransferMethodUpdateConfigurationFields(
+    request: HyperwalletTransferMethodUpdateConfigurationFieldQuery,
+    completion: @escaping (HyperwalletTransferMethodUpdateConfigurationField?, HyperwalletErrorType?) -> Void)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + request + + +
    +

    GraphQL query containing transfer method token and required configuration fields

    +
    +
    + + completion + + +
    +

    the callback handler of responses from the Hyperwallet platform

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Returns the transfer method configuration key set for the User that is associated +with the authentication token returned from +HyperwalletAuthenticationTokenProvider.retrieveAuthenticationToken(_ : @escaping CompletionHandler).

    + +

    The completion: @escaping (HyperwalletTransferMethodConfigurationKey?, HyperwalletErrorType?) -> Void +that is passed in to this method invocation will receive the successful +response(HyperwalletTransferMethodConfigurationKey) or error(HyperwalletErrorType) from processing the +request.

    + +

    This function will request a new authentication token via HyperwalletAuthenticationTokenProvider +if the current one is expired or is about to expire.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func retrieveTransferMethodConfigurationKeys(
+    request: HyperwalletTransferMethodConfigurationKeysQuery,
+    completion: @escaping (HyperwalletTransferMethodConfigurationKey?, HyperwalletErrorType?) -> Void)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + request + + +
    +

    containing the transfer method configuration key query

    +
    +
    + + completion + + +
    +

    the callback handler of responses from the Hyperwallet platform

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Returns the transfer method types, processing times, and fees for the User that is associated +with the authentication token returned from +HyperwalletAuthenticationTokenProvider.retrieveAuthenticationToken(_ : @escaping CompletionHandler).

    + +

    The completion: @escaping (HyperwalletTransferMethodConfigurationKey?, HyperwalletErrorType?) -> Void +that is passed in to this method invocation will receive the successful +response(HyperwalletTransferMethodConfigurationKey) or +error(HyperwalletErrorType) from processing the +request.

    + +

    This function will request a new authentication token via HyperwalletAuthenticationTokenProvider +if the current one is expired or is about to expire.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func retrieveTransferMethodTypesFeesAndProcessingTimes(
+    request: HyperwalletTransferMethodTypesFeesAndProcessingTimesQuery,
+    completion: @escaping (HyperwalletTransferMethodConfigurationKey?,
+                           HyperwalletErrorType?) -> Void)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + request + + +
    +

    containing the transfer method configuration key query

    +
    +
    + + completion + + +
    +

    the callback handler of responses from the Hyperwallet platform

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Updates the HyperwalletBankAccount for the User associated with the authentication token returned from +HyperwalletAuthenticationTokenProvider.retrieveAuthenticationToken(_ : @escaping CompletionHandler).

    + +

    To identify the HyperwalletBankAccount that is going to be updated, the transfer method token must be +set as part of the HyperwalletBankAccount object passed in.

    + +

    The completion: @escaping (HyperwalletBankAccount?, HyperwalletErrorType?) -> Void that is passed in to this +method invocation will receive the successful response(HyperwalletBankAccount) or error(HyperwalletErrorType) +from processing the request.

    + +

    This function will request a new authentication token via HyperwalletAuthenticationTokenProvider +if the current one is expired or is about to expire.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func updateBankAccount(account: HyperwalletBankAccount,
+                              completion: @escaping (HyperwalletBankAccount?, HyperwalletErrorType?) -> Void)
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Updates the HyperwalletPaperCheck for the User associated with the authentication token returned from +HyperwalletAuthenticationTokenProvider.retrieveAuthenticationToken(_ : @escaping CompletionHandler).

    + +

    To identify the HyperwalletPaperCheck that is going to be updated, the transfer method token must be +set as part of the HyperwalletPaperCheck object passed in.

    + +

    The completion: @escaping (HyperwalletPaperCheck?, HyperwalletErrorType?) -> Void +that is passed in to this method invocation will receive the successful response(HyperwalletPaperCheck) +or error(HyperwalletErrorType) from processing the request.

    + +

    This function will request a new authentication token via HyperwalletAuthenticationTokenProvider +if the current one is expired or is about to expire.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func updatePaperCheck(
+    account: HyperwalletPaperCheck,
+    completion: @escaping (HyperwalletPaperCheck?, HyperwalletErrorType?) -> Void)
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Updates the HyperwalletBankCard for the User associated with the authentication token returned from +HyperwalletAuthenticationTokenProvider.retrieveAuthenticationToken(_ : @escaping CompletionHandler).

    + +

    To identify the HyperwalletBankCard that is going to be updated, the transfer method token must be +set as part of the HyperwalletBankCard object passed in.

    + +

    The completion: @escaping (HyperwalletBankCard?, HyperwalletErrorType?) -> Void that is passed in to this +method invocation will receive the successful response(HyperwalletBankCard) or error(HyperwalletErrorType) from +processing the request.

    + +

    This function will request a new authentication token via HyperwalletAuthenticationTokenProvider +if the current one is expired or is about to expire.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func updateBankCard(account: HyperwalletBankCard,
+                           completion: @escaping (HyperwalletBankCard?, HyperwalletErrorType?) -> Void)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + account + + +
    +

    the HyperwalletBankCard to be updated

    +
    +
    + + completion + + +
    +

    the callback handler of responses from the Hyperwallet platform

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Updates the HyperwalletPayPalAccount for the User associated with the authentication token returned from +HyperwalletAuthenticationTokenProvider.retrieveAuthenticationToken(_ : @escaping CompletionHandler).

    + +

    To identify the HyperwalletPayPalAccount that is going to be updated, the transfer method token must be +set as part of the HyperwalletPayPalAccount object passed in.

    + +

    The completion: @escaping (HyperwalletPayPalAccount?, HyperwalletErrorType?) -> Void that is passed in to this +method invocation will receive the successful response(HyperwalletPayPalAccount) or error(HyperwalletErrorType) +from processing the request.

    + +

    This function will request a new authentication token via HyperwalletAuthenticationTokenProvider +if the current one is expired or is about to expire.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func updatePayPalAccount(account: HyperwalletPayPalAccount,
+                                completion: @escaping (HyperwalletPayPalAccount?, HyperwalletErrorType?) -> Void)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + account + + +
    +

    the HyperwalletPayPalAccount to be updated

    +
    +
    + + completion + + +
    +

    the callback handler of responses from the Hyperwallet platform

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Updates the HyperwalletVenmoAccount for the User associated with the authentication token returned from +HyperwalletAuthenticationTokenProvider.retrieveAuthenticationToken(_ : @escaping CompletionHandler).

    + +

    To identify the HyperwalletVenmoAccount that is going to be updated, the transfer method token must be +set as part of the HyperwalletVenmoAccount object passed in.

    + +

    The completion: @escaping (HyperwalletVenmoAccount?, HyperwalletErrorType?) -> Void that is passed in to this +method invocation will receive the successful response(HyperwalletVenmoAccount) or error(HyperwalletErrorType) +from processing the request.

    + +

    This function will request a new authentication token via HyperwalletAuthenticationTokenProvider +if the current one is expired or is about to expire.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func updateVenmoAccount(account: HyperwalletVenmoAccount,
+                               completion: @escaping (HyperwalletVenmoAccount?, HyperwalletErrorType?) -> Void)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + account + + +
    +

    the HyperwalletVenmoAccount to be updated

    +
    +
    + + completion + + +
    +

    the callback handler of responses from the Hyperwallet platform

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Returns the list of balances for the User associated with the authentication token.

    + +

    The ordering and filtering of HyperwalletBalance will be based on the criteria specified within the +HyperwalletBalanceQueryParam object, if it is not nil. Otherwise the default ordering and +filtering will be applied.

    + +
      +
    • Offset: 0
      • +
    • Limit: 10
      • +
    • Currency: All
      • +
    • Sort By: currency
      • +
    + +

    The completion: @escaping (HyperwalletPageList<HyperwalletBalance>?, HyperwalletErrorType?) -> Void +that is passed in to this method invocation will receive the successful +response(HyperwalletPageList?) or error(HyperwalletErrorType) from processing +the request.

    + +

    This function will request a new authentication token via HyperwalletAuthenticationTokenProvider +if the current one is expired or is about to expire.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func listUserBalances(queryParam: HyperwalletBalanceQueryParam? = nil,
+                             completion: @escaping (HyperwalletPageList<HyperwalletBalance>?,
+    HyperwalletErrorType?) -> Void)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + queryParam + + +
    +

    the ordering and filtering criteria

    +
    +
    + + completion + + +
    +

    the callback handler of responses from the Hyperwallet platform

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Returns the list of prepaid card balances for the User associated with the authentication token.

    + +

    The ordering and filtering of HyperwalletBalance will be based on the criteria specified within the +HyperwalletPrepaidCardBalanceQueryParam object, if it is not nil. Otherwise the default ordering and +filtering will be applied.

    + +
      +
    • Offset: 0
      • +
    • Limit: 10
      • +
    • Sort By: currency
      • +
    + +

    The completion: @escaping (HyperwalletPageList<HyperwalletBalance>?, HyperwalletErrorType?) -> Void +that is passed in to this method invocation will receive the successful +response(HyperwalletPageList?) or error(HyperwalletErrorType) from processing +the request.

    + +

    This function will request a new authentication token via HyperwalletAuthenticationTokenProvider +if the current one is expired or is about to expire.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func listPrepaidCardBalances(prepaidCardToken: String,
+                                    queryParam: HyperwalletPrepaidCardBalanceQueryParam? = nil,
+                                    completion: @escaping (HyperwalletPageList<HyperwalletBalance>?,
+                                                           HyperwalletErrorType?) -> Void)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + prepaidCardToken + + +
    +

    the prepaid card token

    +
    +
    + + queryParam + + +
    +

    the ordering and filtering criteria

    +
    +
    + + completion + + +
    +

    the callback handler of responses from the Hyperwallet platform

    +
    +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/Classes/HyperwalletBalanceQueryParam.html b/Classes/HyperwalletBalanceQueryParam.html new file mode 100644 index 00000000..8e3d847e --- /dev/null +++ b/Classes/HyperwalletBalanceQueryParam.html @@ -0,0 +1,443 @@ + + + + HyperwalletBalanceQueryParam Class Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + HyperwalletBalanceQueryParam Class Reference +

+ +
+ +
+ +
+
+

HyperwalletBalanceQueryParam

+
+
+ + 
public class HyperwalletBalanceQueryParam : QueryParam
+ +
+
+

Representation of the balance QueryParam fields.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + currency + +
    +
    +
    +
    +
    +
    +

    A value that identifies the currency of balance

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var currency: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + QuerySortable + +
    +
    +
    +
    +
    +
    +

    Representation of the sortable fields

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public enum QuerySortable : String
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/Classes/HyperwalletBalanceQueryParam/QuerySortable.html b/Classes/HyperwalletBalanceQueryParam/QuerySortable.html new file mode 100644 index 00000000..9df76aa1 --- /dev/null +++ b/Classes/HyperwalletBalanceQueryParam/QuerySortable.html @@ -0,0 +1,496 @@ + + + + QuerySortable Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + QuerySortable Enumeration Reference +

+ +
+ +
+ +
+
+

QuerySortable

+
+
+ + 
public enum QuerySortable : String
+ +
+
+

Representation of the sortable fields

+ +
+
+ +
+
+
+
    +
  • +
    + + + + ascendantAmount + +
    +
    +
    +
    +
    +
    +

    Sort the result by ascendant amount

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case ascendantAmount = "+amount"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + ascendantCurrency + +
    +
    +
    +
    +
    +
    +

    Sort the result by ascendant currency

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case ascendantCurrency = "+currency"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + descendantAmount + +
    +
    +
    +
    +
    +
    +

    Sort the result by descendant amount

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case descendantAmount = "-amount"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + descendantCurrency + +
    +
    +
    +
    +
    +
    +

    Sort the result by descendant currency

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case descendantCurrency = "-currency"
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/Classes/HyperwalletBankAccount.html b/Classes/HyperwalletBankAccount.html new file mode 100644 index 00000000..f2db6385 --- /dev/null +++ b/Classes/HyperwalletBankAccount.html @@ -0,0 +1,1607 @@ + + + + HyperwalletBankAccount Class Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + HyperwalletBankAccount Class Reference +

+ +
+ +
+ +
+
+

HyperwalletBankAccount

+
+
+ + 
@objcMembers
+public final class HyperwalletBankAccount : HyperwalletTransferMethod
+ +
+
+

Representation of the user’s bank account

+ +
+
+ +
+
+
+
    +
  • +
    + + + + init(from:) + +
    +
    +
    +
    +
    +
    +

    The required initializer

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public required init(from decoder: Decoder) throws
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + addressLine1 + +
    +
    +
    +
    +
    +
    +

    The bank account holder’s street address.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var addressLine1: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + addressLine2 + +
    +
    +
    +
    +
    +
    +

    The bank account holder’s address, second line.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var addressLine2: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + bankAccountId + +
    +
    +
    +
    +
    +
    +

    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 var bankAccountId: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + bankAccountPurpose + +
    +
    +
    +
    +
    +
    +

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

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var bankAccountPurpose: String? { get }
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The user’s relationship with the bank account holder.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var bankAccountRelationship: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + bankId + +
    +
    +
    +
    +
    +
    +

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

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var bankId: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + bankName + +
    +
    +
    +
    +
    +
    +

    The bank name.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var bankName: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + branchId + +
    +
    +
    +
    +
    +
    +

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

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var branchId: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + branchName + +
    +
    +
    +
    +
    +
    +

    The branch name.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var branchName: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + businessContactRole + +
    +
    +
    +
    +
    +
    +

    The bank account holder’s role in the organization.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var businessContactRole: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + businessName + +
    +
    +
    +
    +
    +
    +

    The name of the bank account holder’s business.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var businessName: String? { get }
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

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

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var businessRegistrationCountry: String? { get }
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

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

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var businessRegistrationId: String? { get }
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

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

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var businessRegistrationStateProvince: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + businessType + +
    +
    +
    +
    +
    +
    +

    The bank account holder’s business type.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var businessType: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + city + +
    +
    +
    +
    +
    +
    +

    The bank account holder’s city.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var city: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + country + +
    +
    +
    +
    +
    +
    +

    The bank account holder’s country.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var country: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + countryOfBirth + +
    +
    +
    +
    +
    +
    +

    The bank account holder’s birth country.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var countryOfBirth: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + countryOfNationality + +
    +
    +
    +
    +
    +
    +

    The bank account holder’s nationality country.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var countryOfNationality: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + dateOfBirth + +
    +
    +
    +
    +
    +
    +

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

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var dateOfBirth: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + driversLicenseId + +
    +
    +
    +
    +
    +
    +

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

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var driversLicenseId: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + employerId + +
    +
    +
    +
    +
    +
    +

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

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var employerId: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + firstName + +
    +
    +
    +
    +
    +
    +

    The bank account holder’s first name.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var firstName: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + gender + +
    +
    +
    +
    +
    +
    +

    The bank account holder’s gender.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var gender: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + governmentId + +
    +
    +
    +
    +
    +
    +

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

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var governmentId: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + governmentIdType + +
    +
    +
    +
    +
    +
    +

    The bank account holder’s government ID type.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var governmentIdType: String? { get }
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The account number at the intermediary bank.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var intermediaryBankAccountId: String? { get }
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The intermediary bank street address.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var intermediaryBankAddressLine1: String? { get }
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The intermediary bank street address, second line.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var intermediaryBankAddressLine2: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + intermediaryBankCity + +
    +
    +
    +
    +
    +
    +

    The intermediary bank city.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var intermediaryBankCity: String? { get }
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The intermediary bank country.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var intermediaryBankCountry: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + intermediaryBankId + +
    +
    +
    +
    +
    +
    +

    The intermediary bank’s 11-character SWIFT code.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var intermediaryBankId: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + intermediaryBankName + +
    +
    +
    +
    +
    +
    +

    The intermediary bank name.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var intermediaryBankName: String? { get }
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The intermediary bank postal code.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var intermediaryBankPostalCode: String? { get }
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The intermediary bank state, province or region.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var intermediaryBankStateProvince: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + lastName + +
    +
    +
    +
    +
    +
    +

    The bank account holder’s last name.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var lastName: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + middleName + +
    +
    +
    +
    +
    +
    +

    The bank account holder’s middle name.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var middleName: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + mobileNumber + +
    +
    +
    +
    +
    +
    +

    The bank account holder’s cell phone number.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var mobileNumber: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + passportId + +
    +
    +
    +
    +
    +
    +

    The bank account holder’s passport number.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var passportId: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + phoneNumber + +
    +
    +
    +
    +
    +
    +

    The bank account holder’s phone number.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var phoneNumber: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + postalCode + +
    +
    +
    +
    +
    +
    +

    The bank account holder’s postal code.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var postalCode: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + stateProvince + +
    +
    +
    +
    +
    +
    +

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

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var stateProvince: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + wireInstructions + +
    +
    +
    +
    +
    +
    +

    The wire transfer instructions

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var wireInstructions: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + Builder + +
    +
    +
    +
    +
    +
    +

    A helper class to build the HyperwalletBankAccount instance.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public final class Builder
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/Classes/HyperwalletBankAccount/Builder.html b/Classes/HyperwalletBankAccount/Builder.html new file mode 100644 index 00000000..5736577b --- /dev/null +++ b/Classes/HyperwalletBankAccount/Builder.html @@ -0,0 +1,2805 @@ + + + + Builder Class Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + Builder Class Reference +

+ +
+ +
+ +
+
+

Builder

+
+
+ + 
public final class Builder
+ +
+
+

A helper class to build the HyperwalletBankAccount instance.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + init(token:) + +
    +
    +
    +
    +
    +
    +

    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

    +
    +
    +
    +
    +
    +
    • +
  • +
    + + + + addressLine1(_:) + +
    +
    +
    +
    +
    +
    +

    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.

    +
    +
    +
    +
    • +
  • +
    + + + + addressLine2(_:) + +
    +
    +
    +
    +
    +
    +

    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.

    +
    +
    +
    +
    • +
  • +
    + + + + bankAccountId(_:) + +
    +
    +
    +
    +
    +
    +

    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.

    +
    +
    +
    +
    • +
  • +
    + + + + bankId(_:) + +
    +
    +
    +
    +
    +
    +

    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.

    +
    +
    +
    +
    • +
  • +
    + + + + bankName(_:) + +
    +
    +
    +
    +
    +
    +

    Sets the bank name.

    + +
    +
    +

    Declaration

    +
    +

    Swift

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

    Parameters

    + + + + + + + +
    + + bankName + + +
    +

    The bank name

    +
    +
    +
    +
    +

    Return Value

    +

    a self HyperwalletBankAccount.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + branchId(_:) + +
    +
    +
    +
    +
    +
    +

    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.

    +
    +
    +
    +
    • +
  • +
    + + + + branchName(_:) + +
    +
    +
    +
    +
    +
    +

    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.

    +
    +
    +
    +
    • +
  • +
    + + + + businessName(_:) + +
    +
    +
    +
    +
    +
    +

    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.

    +
    +
    +
    +
    • +
  • +
    + + + + businessType(_:) + +
    +
    +
    +
    +
    +
    +

    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.

    +
    +
    +
    +
    • +
  • +
    + + + + city(_:) + +
    +
    +
    +
    +
    +
    +

    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.

    +
    +
    +
    +
    • +
  • +
    + + + + country(_:) + +
    +
    +
    +
    +
    +
    +

    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.

    +
    +
    +
    +
    • +
  • +
    + + + + countryOfBirth(_:) + +
    +
    +
    +
    +
    +
    +

    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.

    +
    +
    +
    +
    • +
  • +
    + + + + dateOfBirth(_:) + +
    +
    +
    +
    +
    +
    +

    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.

    +
    +
    +
    +
    • +
  • +
    + + + + driversLicenseId(_:) + +
    +
    +
    +
    +
    +
    +

    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.

    +
    +
    +
    +
    • +
  • +
    + + + + employerId(_:) + +
    +
    +
    +
    +
    +
    +

    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.

    +
    +
    +
    +
    • +
  • +
    + + + + firstName(_:) + +
    +
    +
    +
    +
    +
    +

    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.

    +
    +
    +
    +
    • +
  • +
    + + + + gender(_:) + +
    +
    +
    +
    +
    +
    +

    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.

    +
    +
    +
    +
    • +
  • +
    + + + + governmentId(_:) + +
    +
    +
    +
    +
    +
    +

    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.

    +
    +
    +
    +
    • +
  • +
    + + + + governmentIdType(_:) + +
    +
    +
    +
    +
    +
    +

    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.

    +
    +
    +
    +
    • +
  • +
    + + + + lastName(_:) + +
    +
    +
    +
    +
    +
    +

    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.

    +
    +
    +
    +
    • +
  • +
    + + + + middleName(_:) + +
    +
    +
    +
    +
    +
    +

    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.

    +
    +
    +
    +
    • +
  • +
    + + + + mobileNumber(_:) + +
    +
    +
    +
    +
    +
    +

    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.

    +
    +
    +
    +
    • +
  • +
    + + + + passportId(_:) + +
    +
    +
    +
    +
    +
    +

    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.

    +
    +
    +
    +
    • +
  • +
    + + + + phoneNumber(_:) + +
    +
    +
    +
    +
    +
    +

    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.

    +
    +
    +
    +
    • +
  • +
    + + + + postalCode(_:) + +
    +
    +
    +
    +
    +
    +

    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.

    +
    +
    +
    +
    • +
  • +
    + + + + profileType(_:) + +
    +
    +
    +
    +
    +
    +

    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.

    +
    +
    +
    +
    • +
  • +
    + + + + stateProvince(_:) + +
    +
    +
    +
    +
    +
    +

    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.

    +
    +
    +
    +
    • +
  • +
    + + + + type(_:) + +
    +
    +
    +
    +
    +
    +

    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.

    +
    +
    +
    +
    • +
  • +
    + + + + wireInstructions(_:) + +
    +
    +
    +
    +
    +
    +

    Sets wire transfer instructions.

    + +
    +
    +

    Declaration

    +
    +

    Swift

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

    Parameters

    + + + + + + + +
    + + wireInstructions + + +
    +

    Wire transfer instructions.

    +
    +
    +
    +
    +

    Return Value

    +

    a self HyperwalletBankAccount.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + build() + +
    +
    +
    +
    +
    +
    +

    Builds a new instance of the HyperwalletBankAccount.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func build() -> HyperwalletBankAccount
    + +
    +
    +
    +

    Return Value

    +

    a new instance of the HyperwalletBankAccount.

    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/Classes/HyperwalletBankAccountQueryParam.html b/Classes/HyperwalletBankAccountQueryParam.html new file mode 100644 index 00000000..204990ae --- /dev/null +++ b/Classes/HyperwalletBankAccountQueryParam.html @@ -0,0 +1,414 @@ + + + + HyperwalletBankAccountQueryParam Class Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + HyperwalletBankAccountQueryParam Class Reference +

+ +
+ +
+ +
+
+

HyperwalletBankAccountQueryParam

+
+
+ + 
public class HyperwalletBankAccountQueryParam : HyperwalletTransferMethodQueryParam
+ +
+
+

Representation of the bank account query parameters.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + toQuery() + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    override public func toQuery() -> [String : String]
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/Classes/HyperwalletBankCard.html b/Classes/HyperwalletBankCard.html new file mode 100644 index 00000000..ae6bb6f8 --- /dev/null +++ b/Classes/HyperwalletBankCard.html @@ -0,0 +1,552 @@ + + + + HyperwalletBankCard Class Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + HyperwalletBankCard Class Reference +

+ +
+ +
+ +
+
+

HyperwalletBankCard

+
+
+ + 
@objcMembers
+public class HyperwalletBankCard : HyperwalletTransferMethod
+ +
+
+

Representation of the user’s bank card

+ +
+
+ +
+
+
+
    +
  • +
    + + + + init(from:) + +
    +
    +
    +
    +
    +
    +

    The required initializer

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public required init(from decoder: Decoder) throws
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + cardBrand + +
    +
    +
    +
    +
    +
    +

    The card brand

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var cardBrand: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + cardNumber + +
    +
    +
    +
    +
    +
    +

    The card number

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var cardNumber: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + cardType + +
    +
    +
    +
    +
    +
    +

    The card type

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var cardType: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + dateOfExpiry + +
    +
    +
    +
    +
    +
    +

    The expiration date.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var dateOfExpiry: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + Builder + +
    +
    +
    +
    +
    +
    +

    A helper class to build the HyperwalletBankCard instance.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public final class Builder
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/Classes/HyperwalletBankCard/Builder.html b/Classes/HyperwalletBankCard/Builder.html new file mode 100644 index 00000000..ca269cb5 --- /dev/null +++ b/Classes/HyperwalletBankCard/Builder.html @@ -0,0 +1,687 @@ + + + + Builder Class Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + Builder Class Reference +

+ +
+ +
+ +
+
+

Builder

+
+
+ + 
public final class Builder
+ +
+
+

A helper class to build the HyperwalletBankCard instance.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + init(token:) + +
    +
    +
    +
    +
    +
    +

    Creates a new instance of the HyperwalletBankCard.Builder based on the required parameter to update +Bank card.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public init(token: String)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + token + + +
    +

    The bank card token.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Creates a new instance of the HyperwalletBankCard.Builder based on the required parameters to create +Bank card.

    + +
    +
    +

    Declaration

    +
    +

    Swift

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

    Parameters

    + + + + + + + + + + + + + + + +
    + + transferMethodCountry + + +
    +

    The bank card country.

    +
    +
    + + transferMethodCurrency + + +
    +

    The bank card currency.

    +
    +
    + + transferMethodProfileType + + +
    +

    The method profile type

    +
    +
    +
    +
    +
    +
    • +
  • +
    + + + + build() + +
    +
    +
    +
    +
    +
    +

    Builds a new instance of the HyperwalletBankCard.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func build() -> HyperwalletBankCard
    + +
    +
    +
    +

    Return Value

    +

    a new instance of the HyperwalletBankCard.

    +
    +
    +
    +
    • +
  • +
    + + + + cardNumber(_:) + +
    +
    +
    +
    +
    +
    +

    Sets the card number

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func cardNumber(_ cardNumber: String) -> Builder
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + cardNumber + + +
    +

    The 16-digit card number

    +
    +
    +
    +
    +

    Return Value

    +

    a self reference of HyperwalletBankCard.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + cvv(_:) + +
    +
    +
    +
    +
    +
    +

    Sets the card security code which is embossed or printed on the card.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func cvv(_ cvv: String) -> Builder
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + cvv + + +
    +

    the card security code which is embossed or printed on the card

    +
    +
    +
    +
    +

    Return Value

    +

    a self reference of HyperwalletBankCard.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + dateOfExpiry(_:) + +
    +
    +
    +
    +
    +
    +

    Sets the expiration date.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func dateOfExpiry(_ dateOfExpiry: String) -> Builder
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + dateOfExpiry + + +
    +

    the expiration date for the card (YYYY-MM).

    +
    +
    +
    +
    +

    Return Value

    +

    a self reference of HyperwalletBankCard.Builder instance.

    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/Classes/HyperwalletBankCardQueryParam.html b/Classes/HyperwalletBankCardQueryParam.html new file mode 100644 index 00000000..80307340 --- /dev/null +++ b/Classes/HyperwalletBankCardQueryParam.html @@ -0,0 +1,414 @@ + + + + HyperwalletBankCardQueryParam Class Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + HyperwalletBankCardQueryParam Class Reference +

+ +
+ +
+ +
+
+

HyperwalletBankCardQueryParam

+
+
+ + 
public class HyperwalletBankCardQueryParam : HyperwalletTransferMethodQueryParam
+ +
+
+

Representation of the bank card query parameters.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + toQuery() + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    override public func toQuery() -> [String : String]
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/Classes/HyperwalletPaperCheck.html b/Classes/HyperwalletPaperCheck.html new file mode 100644 index 00000000..c0b16b4f --- /dev/null +++ b/Classes/HyperwalletPaperCheck.html @@ -0,0 +1,1174 @@ + + + + HyperwalletPaperCheck Class Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + HyperwalletPaperCheck Class Reference +

+ +
+ +
+ +
+
+

HyperwalletPaperCheck

+
+
+ + 
@objcMembers
+public class HyperwalletPaperCheck : HyperwalletTransferMethod
+ +
+
+

Representation of the user’s paper check

+ +
+
+ +
+
+
+
    +
  • +
    + + + + init(from:) + +
    +
    +
    +
    +
    +
    +

    The required initializer

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public required init(from decoder: Decoder) throws
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The user’s relationship with the bank account holder.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var bankAccountRelationship: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + addressLine1 + +
    +
    +
    +
    +
    +
    +

    The bank account holder’s street address.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var addressLine1: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + addressLine2 + +
    +
    +
    +
    +
    +
    +

    The bank account holder’s address, second line.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var addressLine2: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + city + +
    +
    +
    +
    +
    +
    +

    The bank account holder’s city.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var city: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + country + +
    +
    +
    +
    +
    +
    +

    The bank account holder’s country.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var country: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + postalCode + +
    +
    +
    +
    +
    +
    +

    The bank account holder’s postal code.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var postalCode: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + stateProvince + +
    +
    +
    +
    +
    +
    +

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

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var stateProvince: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + shippingMethod + +
    +
    +
    +
    +
    +
    +

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

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var shippingMethod: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + businessName + +
    +
    +
    +
    +
    +
    +

    The name of the bank account holder’s business.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var businessName: String? { get }
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

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

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var businessRegistrationCountry: String? { get }
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

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

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var businessRegistrationId: String? { get }
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

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

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var businessRegistrationStateProvince: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + businessType + +
    +
    +
    +
    +
    +
    +

    The bank account holder’s business type.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var businessType: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + countryOfBirth + +
    +
    +
    +
    +
    +
    +

    The bank account holder’s birth country.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var countryOfBirth: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + countryOfNationality + +
    +
    +
    +
    +
    +
    +

    The bank account holder’s nationality country.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var countryOfNationality: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + dateOfBirth + +
    +
    +
    +
    +
    +
    +

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

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var dateOfBirth: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + driversLicenseId + +
    +
    +
    +
    +
    +
    +

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

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var driversLicenseId: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + employerId + +
    +
    +
    +
    +
    +
    +

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

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var employerId: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + firstName + +
    +
    +
    +
    +
    +
    +

    The bank account holder’s first name.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var firstName: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + gender + +
    +
    +
    +
    +
    +
    +

    The bank account holder’s gender.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var gender: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + governmentId + +
    +
    +
    +
    +
    +
    +

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

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var governmentId: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + governmentIdType + +
    +
    +
    +
    +
    +
    +

    The bank account holder’s government ID type.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var governmentIdType: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + phoneNumber + +
    +
    +
    +
    +
    +
    +

    The bank account holder’s phone number.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var phoneNumber: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + mobileNumber + +
    +
    +
    +
    +
    +
    +

    The bank account holder’s cell phone number.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var mobileNumber: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + lastName + +
    +
    +
    +
    +
    +
    +

    The bank account holder’s last name.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var lastName: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + middleName + +
    +
    +
    +
    +
    +
    +

    The bank account holder’s middle name.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var middleName: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + passportId + +
    +
    +
    +
    +
    +
    +

    The bank account holder’s passport number.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var passportId: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + Builder + +
    +
    +
    +
    +
    +
    +

    A helper class to build the HyperwalletPaperCheck instance.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public final class Builder
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/Classes/HyperwalletPaperCheck/Builder.html b/Classes/HyperwalletPaperCheck/Builder.html new file mode 100644 index 00000000..cf393d04 --- /dev/null +++ b/Classes/HyperwalletPaperCheck/Builder.html @@ -0,0 +1,2003 @@ + + + + Builder Class Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + Builder Class Reference +

+ +
+ +
+ +
+
+

Builder

+
+
+ + 
public final class Builder
+ +
+
+

A helper class to build the HyperwalletPaperCheck instance.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + init(token:) + +
    +
    +
    +
    +
    +
    +

    Creates a new instance of the HyperwalletPaperCheck.Builder +based on the required parameter to updaate Bank card.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public init(token: String)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + token + + +
    +

    The bank card token.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Creates a new instance of the HyperwalletPaperCheck.Builder +based on the required parameters to create paper check.

    + +
    +
    +

    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, i.e, PAPER_CHECK

    +
    +
    +
    +
    +
    +
    • +
  • +
    + + + + addressLine1(_:) + +
    +
    +
    +
    +
    +
    +

    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 HyperwalletPaperCheck.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + addressLine2(_:) + +
    +
    +
    +
    +
    +
    +

    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 HyperwalletPaperCheck.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 HyperwalletPaperCheck.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + city(_:) + +
    +
    +
    +
    +
    +
    +

    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 HyperwalletPaperCheck.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + country(_:) + +
    +
    +
    +
    +
    +
    +

    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 HyperwalletPaperCheck.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + postalCode(_:) + +
    +
    +
    +
    +
    +
    +

    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 HyperwalletPaperCheck.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + shippingMethod(_:) + +
    +
    +
    +
    +
    +
    +

    Sets the shipping method for paper check.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func shippingMethod(_ shippingMethod: String) -> Builder
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + shippingMethod + + +
    +

    The bank account holder’s postal code.

    +
    +
    +
    +
    +

    Return Value

    +

    a self HyperwalletPaperCheck.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + stateProvince(_:) + +
    +
    +
    +
    +
    +
    +

    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 HyperwalletPaperCheck.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + profileType(_:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    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 HyperwalletPaperCheck.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + lastName(_:) + +
    +
    +
    +
    +
    +
    +

    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 HyperwalletPaperCheck.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + middleName(_:) + +
    +
    +
    +
    +
    +
    +

    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 HyperwalletPaperCheck.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + mobileNumber(_:) + +
    +
    +
    +
    +
    +
    +

    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 HyperwalletPaperCheck.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + passportId(_:) + +
    +
    +
    +
    +
    +
    +

    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 HyperwalletPaperCheck.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + phoneNumber(_:) + +
    +
    +
    +
    +
    +
    +

    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 HyperwalletPaperCheck.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + countryOfBirth(_:) + +
    +
    +
    +
    +
    +
    +

    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 HyperwalletPaperCheck.Builder instance.

    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

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

    Parameters

    + + + + + + + +
    + + countryOfNationality + + +
    +

    The bank account holder’s birth country.

    +
    +
    +
    +
    +

    Return Value

    +

    a self HyperwalletPaperCheck.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + dateOfBirth(_:) + +
    +
    +
    +
    +
    +
    +

    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 HyperwalletPaperCheck.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + driversLicenseId(_:) + +
    +
    +
    +
    +
    +
    +

    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 HyperwalletPaperCheck.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + employerId(_:) + +
    +
    +
    +
    +
    +
    +

    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 HyperwalletPaperCheck.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + firstName(_:) + +
    +
    +
    +
    +
    +
    +

    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 HyperwalletPaperCheck.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + gender(_:) + +
    +
    +
    +
    +
    +
    +

    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 HyperwalletPaperCheck.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + governmentId(_:) + +
    +
    +
    +
    +
    +
    +

    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 HyperwalletPaperCheck.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + governmentIdType(_:) + +
    +
    +
    +
    +
    +
    +

    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 HyperwalletPaperCheck.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 HyperwalletPaperCheck.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + businessName(_:) + +
    +
    +
    +
    +
    +
    +

    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 HyperwalletPaperCheck.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 HyperwalletPaperCheck.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 HyperwalletPaperCheck.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 HyperwalletPaperCheck.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + businessType(_:) + +
    +
    +
    +
    +
    +
    +

    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 HyperwalletPaperCheck.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + build() + +
    +
    +
    +
    +
    +
    +

    Builds a new instance of the HyperwalletPaperCheck.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func build() -> HyperwalletPaperCheck
    + +
    +
    +
    +

    Return Value

    +

    a new instance of the HyperwalletPaperCheck.

    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/Classes/HyperwalletPaperCheckQueryParam.html b/Classes/HyperwalletPaperCheckQueryParam.html new file mode 100644 index 00000000..bfee60cd --- /dev/null +++ b/Classes/HyperwalletPaperCheckQueryParam.html @@ -0,0 +1,414 @@ + + + + HyperwalletPaperCheckQueryParam Class Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + HyperwalletPaperCheckQueryParam Class Reference +

+ +
+ +
+ +
+
+

HyperwalletPaperCheckQueryParam

+
+
+ + 
public class HyperwalletPaperCheckQueryParam : HyperwalletTransferMethodQueryParam
+ +
+
+

Representation of the paper check query parameters.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + toQuery() + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    override public func toQuery() -> [String : String]
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/Classes/HyperwalletPayPalAccount.html b/Classes/HyperwalletPayPalAccount.html new file mode 100644 index 00000000..7c0bac50 --- /dev/null +++ b/Classes/HyperwalletPayPalAccount.html @@ -0,0 +1,471 @@ + + + + HyperwalletPayPalAccount Class Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + HyperwalletPayPalAccount Class Reference +

+ +
+ +
+ +
+
+

HyperwalletPayPalAccount

+
+
+ + 
@objcMembers
+public final class HyperwalletPayPalAccount : HyperwalletTransferMethod
+ +
+
+

Representation of the user’s PayPal account

+ +
+
+ +
+
+
+
    +
  • +
    + + + + init(from:) + +
    +
    +
    +
    +
    +
    +

    The required initializer

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public required init(from decoder: Decoder) throws
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + email + +
    +
    +
    +
    +
    +
    +

    The email address.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var email: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + Builder + +
    +
    +
    +
    +
    +
    +

    A helper class to build the HyperwalletPayPalAccount instance.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public final class Builder
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/Classes/HyperwalletPayPalAccount/Builder.html b/Classes/HyperwalletPayPalAccount/Builder.html new file mode 100644 index 00000000..bf0c2320 --- /dev/null +++ b/Classes/HyperwalletPayPalAccount/Builder.html @@ -0,0 +1,637 @@ + + + + Builder Class Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + Builder Class Reference +

+ +
+ +
+ +
+
+

Builder

+
+
+ + 
public final class Builder
+ +
+
+

A helper class to build the HyperwalletPayPalAccount instance.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + init(token:) + +
    +
    +
    +
    +
    +
    +

    Creates a new instance of the HyperwalletPayPalAccount based on the required parameter to update +PayPal account.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public init(token: String)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + token + + +
    +

    The PayPal account token.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Creates a new instance of the HyperwalletPayPalAccount based on the required parameters to create +PayPal account.

    + +
    +
    +

    Declaration

    +
    +

    Swift

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

    Parameters

    + + + + + + + + + + + + + + + +
    + + transferMethodCountry + + +
    +

    The PayPal account country.

    +
    +
    + + transferMethodCurrency + + +
    +

    The PayPal account currency.

    +
    +
    + + transferMethodProfileType + + +
    +

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

    +
    +
    +
    +
    +
    +
    • +
  • +
    + + + + email(_:) + +
    +
    +
    +
    +
    +
    +

    Sets the email address

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func email(_ email: String) -> Builder
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + email + + +
    +

    The email address user want to create a PayPal account

    +
    +
    +
    +
    +

    Return Value

    +

    a self HyperwalletPayPalAccount.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + profileType(_:) + +
    +
    +
    +
    +
    +
    +

    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.

    +
    +
    +
    +
    • +
  • +
    + + + + build() + +
    +
    +
    +
    +
    +
    +

    Builds a new instance of the HyperwalletPayPalAccount.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func build() -> HyperwalletPayPalAccount
    + +
    +
    +
    +

    Return Value

    +

    a new instance of the HyperwalletPayPalAccount.

    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/Classes/HyperwalletPayPalAccountQueryParam.html b/Classes/HyperwalletPayPalAccountQueryParam.html new file mode 100644 index 00000000..f64ecb3c --- /dev/null +++ b/Classes/HyperwalletPayPalAccountQueryParam.html @@ -0,0 +1,414 @@ + + + + HyperwalletPayPalAccountQueryParam Class Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + HyperwalletPayPalAccountQueryParam Class Reference +

+ +
+ +
+ +
+
+

HyperwalletPayPalAccountQueryParam

+
+
+ + 
public class HyperwalletPayPalAccountQueryParam : HyperwalletTransferMethodQueryParam
+ +
+
+

Representation of the PayPal account query parameters.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + toQuery() + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    override public func toQuery() -> [String : String]
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/Classes/HyperwalletPrepaidCard.html b/Classes/HyperwalletPrepaidCard.html new file mode 100644 index 00000000..e1c40411 --- /dev/null +++ b/Classes/HyperwalletPrepaidCard.html @@ -0,0 +1,633 @@ + + + + HyperwalletPrepaidCard Class Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + HyperwalletPrepaidCard Class Reference +

+ +
+ +
+ +
+
+

HyperwalletPrepaidCard

+
+
+ + 
@objcMembers
+public final class HyperwalletPrepaidCard : HyperwalletTransferMethod
+ +
+
+

Representation of the user’s Prepaid card account

+ +
+
+ +
+
+
+
    +
  • +
    + + + + init(from:) + +
    +
    +
    +
    +
    +
    +

    The required initializer

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public required init(from decoder: Decoder) throws
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + cardType + +
    +
    +
    +
    +
    +
    +

    The prepaid card’s type

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var cardType: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + cardPackage + +
    +
    +
    +
    +
    +
    +

    The prepaid card’s package

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var cardPackage: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + cardNumber + +
    +
    +
    +
    +
    +
    +

    The prepaid card’s number

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var cardNumber: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + cardBrand + +
    +
    +
    +
    +
    +
    +

    The prepaid card’s brand

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var cardBrand: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + dateOfExpiry + +
    +
    +
    +
    +
    +
    +

    The prepaid card’s expiry date

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var dateOfExpiry: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + primaryCardToken + +
    +
    +
    +
    +
    +
    +

    The primary prepaid card’s token

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var primaryCardToken: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + userToken + +
    +
    +
    +
    +
    +
    +

    The prepaid card’s user token (instant issue cards only)

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var userToken: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + Builder + +
    +
    +
    +
    +
    +
    +

    A helper class to build the HyperwalletPrepaidCard instance.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public final class Builder
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/Classes/HyperwalletPrepaidCard/Builder.html b/Classes/HyperwalletPrepaidCard/Builder.html new file mode 100644 index 00000000..2837f1c0 --- /dev/null +++ b/Classes/HyperwalletPrepaidCard/Builder.html @@ -0,0 +1,615 @@ + + + + Builder Class Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + Builder Class Reference +

+ +
+ +
+ +
+
+

Builder

+
+
+ + 
public final class Builder
+ +
+
+

A helper class to build the HyperwalletPrepaidCard instance.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + init(token:) + +
    +
    +
    +
    +
    +
    +

    Creates a new instance of the HyperwalletPayPalAccount based on the required parameter to update +PayPal account.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public init(token: String)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + token + + +
    +

    The PayPal account token.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Creates a new instance of the HyperwalletPrepaidCard based on the required parameters to create +prepaid card account.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public init(transferMethodProfileType: String)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + transferMethodProfileType + + +
    +

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

    +
    +
    +
    +
    +
    +
    • +
  • +
    + + + + cardPackage(_:) + +
    +
    +
    +
    +
    +
    +

    Sets the card package

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func cardPackage(_ cardPackage: String) -> Builder
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + cardPackage + + +
    +

    The card package name or identifier. You must provide an exact cardPackage value + that has been been configured for the program or leave it blank. + If left blank, the default card package will be automatically selected.

    +
    +
    +
    +
    +

    Return Value

    +

    a self HyperwalletPrepaidCard.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + userToken(_:) + +
    +
    +
    +
    +
    +
    +

    Sets userToken for an instant issue card

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func userToken(_ userToken: String) -> Builder
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + userToken + + +
    +

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

    +
    +
    +
    +
    +

    Return Value

    +

    a self HyperwalletPrepaidCard.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + build() + +
    +
    +
    +
    +
    +
    +

    Builds a new instance of the HyperwalletPrepaidCard.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func build() -> HyperwalletPrepaidCard
    + +
    +
    +
    +

    Return Value

    +

    a new instance of the HyperwalletPrepaidCard.

    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/Classes/HyperwalletPrepaidCardBalanceQueryParam.html b/Classes/HyperwalletPrepaidCardBalanceQueryParam.html new file mode 100644 index 00000000..d303dd83 --- /dev/null +++ b/Classes/HyperwalletPrepaidCardBalanceQueryParam.html @@ -0,0 +1,416 @@ + + + + HyperwalletPrepaidCardBalanceQueryParam Class Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + HyperwalletPrepaidCardBalanceQueryParam Class Reference +

+ +
+ +
+ +
+
+

HyperwalletPrepaidCardBalanceQueryParam

+
+
+ + 
public class HyperwalletPrepaidCardBalanceQueryParam : QueryParam
+ +
+
+

Representation of the prepaid card balance QueryParam fields.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + QuerySortable + +
    +
    +
    +
    +
    +
    +

    Representation of the sortable fields

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public enum QuerySortable : String
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/Classes/HyperwalletPrepaidCardBalanceQueryParam/QuerySortable.html b/Classes/HyperwalletPrepaidCardBalanceQueryParam/QuerySortable.html new file mode 100644 index 00000000..d8cd2c83 --- /dev/null +++ b/Classes/HyperwalletPrepaidCardBalanceQueryParam/QuerySortable.html @@ -0,0 +1,496 @@ + + + + QuerySortable Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + QuerySortable Enumeration Reference +

+ +
+ +
+ +
+
+

QuerySortable

+
+
+ + 
public enum QuerySortable : String
+ +
+
+

Representation of the sortable fields

+ +
+
+ +
+
+
+
    +
  • +
    + + + + ascendantAmount + +
    +
    +
    +
    +
    +
    +

    Sort the result by ascendant amount

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case ascendantAmount = "+amount"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + ascendantCurrency + +
    +
    +
    +
    +
    +
    +

    Sort the result by ascendant currency

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case ascendantCurrency = "+currency"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + descendantAmount + +
    +
    +
    +
    +
    +
    +

    Sort the result by descendant amount

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case descendantAmount = "-amount"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + descendantCurrency + +
    +
    +
    +
    +
    +
    +

    Sort the result by descendant currency

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case descendantCurrency = "-currency"
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/Classes/HyperwalletPrepaidCardQueryParam.html b/Classes/HyperwalletPrepaidCardQueryParam.html new file mode 100644 index 00000000..cb97a392 --- /dev/null +++ b/Classes/HyperwalletPrepaidCardQueryParam.html @@ -0,0 +1,414 @@ + + + + HyperwalletPrepaidCardQueryParam Class Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + HyperwalletPrepaidCardQueryParam Class Reference +

+ +
+ +
+ +
+
+

HyperwalletPrepaidCardQueryParam

+
+
+ + 
public class HyperwalletPrepaidCardQueryParam : HyperwalletTransferMethodQueryParam
+ +
+
+

Representation of the prepaid card query parameters.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + toQuery() + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    override public func toQuery() -> [String : String]
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/Classes/HyperwalletReceiptQueryParam.html b/Classes/HyperwalletReceiptQueryParam.html new file mode 100644 index 00000000..97924761 --- /dev/null +++ b/Classes/HyperwalletReceiptQueryParam.html @@ -0,0 +1,443 @@ + + + + HyperwalletReceiptQueryParam Class Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + HyperwalletReceiptQueryParam Class Reference +

+ +
+ +
+ +
+
+

HyperwalletReceiptQueryParam

+
+
+ + 
public class HyperwalletReceiptQueryParam : QueryParam
+ +
+
+

Representation of the user receipts QueryParam fields.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + currency + +
    +
    +
    +
    +
    +
    +

    A value that identifies the user receipts currency.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var currency: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + QuerySortable + +
    +
    +
    +
    +
    +
    +

    Representation of the field’s sortable

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public enum QuerySortable : String
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/Classes/HyperwalletReceiptQueryParam/QuerySortable.html b/Classes/HyperwalletReceiptQueryParam/QuerySortable.html new file mode 100644 index 00000000..1629787c --- /dev/null +++ b/Classes/HyperwalletReceiptQueryParam/QuerySortable.html @@ -0,0 +1,604 @@ + + + + QuerySortable Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + QuerySortable Enumeration Reference +

+ +
+ +
+ +
+
+

QuerySortable

+
+
+ + 
public enum QuerySortable : String
+ +
+
+

Representation of the field’s sortable

+ +
+
+ +
+
+
+
    +
  • +
    + + + + ascendantAmount + +
    +
    +
    +
    +
    +
    +

    Sort the result by ascendant amount

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case ascendantAmount = "+amount"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + ascendantCreatedOn + +
    +
    +
    +
    +
    +
    +

    Sort the result by ascendant created on

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case ascendantCreatedOn = "+createdOn"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + ascendantCurrency + +
    +
    +
    +
    +
    +
    +

    Sort the result by ascendant currency

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case ascendantCurrency = "+currency"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + ascendantType + +
    +
    +
    +
    +
    +
    +

    Sort the result by ascendant type

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case ascendantType = "+type"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + descendantAmount + +
    +
    +
    +
    +
    +
    +

    Sort the result by descendant amount

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case descendantAmount = "-amount"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + descendantCreatedOn + +
    +
    +
    +
    +
    +
    +

    Sort the result by descendant created on

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case descendantCreatedOn = "-createdOn"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + descendantCurrency + +
    +
    +
    +
    +
    +
    +

    Sort the result by descendant currency

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case descendantCurrency = "-currency"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + descendantType + +
    +
    +
    +
    +
    +
    +

    Sort the result by descendant type

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case descendantType = "-type"
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/Classes/HyperwalletTransferMethod.html b/Classes/HyperwalletTransferMethod.html new file mode 100644 index 00000000..e99a14c4 --- /dev/null +++ b/Classes/HyperwalletTransferMethod.html @@ -0,0 +1,821 @@ + + + + HyperwalletTransferMethod Class Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + HyperwalletTransferMethod Class Reference +

+ +
+ +
+ +
+
+

HyperwalletTransferMethod

+
+
+ + 
@objcMembers
+public class HyperwalletTransferMethod : NSObject, Codable
+ +
+
+

Representation of the transfer method (bank account, bank card, PayPal account, prepaid card, paper check).

+ +
+
+ +
+
+
+
    +
  • +
    + + + + TransferMethodField + +
    +
    +
    +
    +
    +
    +

    Representation of the transfer method’s field type

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public enum TransferMethodField : String
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + TransferMethodType + +
    +
    +
    +
    +
    +
    +

    Representation of the transfer method’s type

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public enum TransferMethodType : String
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + init() + +
    +
    +
    +
    +
    +
    +

    Creates a new instance of the HyperwalletTransferMethod

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    override public init()
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + init(from:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public required init(from decoder: Decoder) throws
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + encode(to:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func encode(to encoder: Encoder) throws
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + getField(_:) + +
    +
    +
    +
    +
    +
    +

    Gets the field value

    + +
    +
    +

    Declaration

    +
    +

    Swift

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

    Parameters

    + + + + + + + +
    + + fieldName + + +
    +

    The TransferMethodField type raw value

    +
    +
    +
    +
    +

    Return Value

    +

    Returns the field value, or nil if none exists.

    +
    +
    +
    +
    • +
  • +
    + + + + setField(key:value:) + +
    +
    +
    +
    +
    +
    +

    Sets the field value based on the key

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func setField(key: TransferMethodField.RawValue, value: String)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + key + + +
    +

    The TransferMethodField.RawValue value

    +
    +
    + + value + + +
    +

    The value

    +
    +
    +
    +
    +
    +
    • +
  • +
    + + + + createdOn + +
    +
    +
    +
    +
    +
    +

    The transfer method’s created time

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var createdOn: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + profileType + +
    +
    +
    +
    +
    +
    +

    The transfer method holder’s profile type, e.g. INDIVIDUAL or BUSINESS.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var profileType: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + status + +
    +
    +
    +
    +
    +
    +

    The transfer method’s status

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var status: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + token + +
    +
    +
    +
    +
    +
    +

    The transfer method’s token

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var token: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + transferMethodCountry + +
    +
    +
    +
    +
    +
    +

    The transfer method’s country

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var transferMethodCountry: String? { get }
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The transfer method’s currency

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var transferMethodCurrency: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + type + +
    +
    +
    +
    +
    +
    +

    The transfer method’s type

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var type: String? { get }
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/Classes/HyperwalletTransferMethod/TransferMethodField.html b/Classes/HyperwalletTransferMethod/TransferMethodField.html new file mode 100644 index 00000000..3937fd3d --- /dev/null +++ b/Classes/HyperwalletTransferMethod/TransferMethodField.html @@ -0,0 +1,2038 @@ + + + + TransferMethodField Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + TransferMethodField Enumeration Reference +

+ +
+ +
+ +
+
+

TransferMethodField

+
+
+ + 
public enum TransferMethodField : String
+ +
+
+

Representation of the transfer method’s field type

+ +
+
+ +
+
+
+
    +
  • +
    + + + + createdOn + +
    +
    +
    +
    +
    +
    +

    The datetime when the transfer method was created on.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case createdOn
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + status + +
    +
    +
    +
    +
    +
    +

    The transfer method status transition.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case status
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + token + +
    +
    +
    +
    +
    +
    +

    The transfer method identifier.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case token
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + transferMethodCountry + +
    +
    +
    +
    +
    +
    +

    The transfer method country.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case transferMethodCountry
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The transfer method currency.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case transferMethodCurrency
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + type + +
    +
    +
    +
    +
    +
    +

    The transfer method type.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case type
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + addressLine1 + +
    +
    +
    +
    +
    +
    +

    The bank account holder’s street address.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case addressLine1
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + addressLine2 + +
    +
    +
    +
    +
    +
    +

    The bank account holder’s address, second line.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case addressLine2
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + bankAccountId + +
    +
    +
    +
    +
    +
    +

    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

    + 
    case bankAccountId
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + bankAccountPurpose + +
    +
    +
    +
    +
    +
    +

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

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case bankAccountPurpose
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The user’s relationship with the bank account holder.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case bankAccountRelationship
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + bankId + +
    +
    +
    +
    +
    +
    +

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

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case bankId
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + bankName + +
    +
    +
    +
    +
    +
    +

    The bank name.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case bankName
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + branchId + +
    +
    +
    +
    +
    +
    +

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

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case branchId
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + branchName + +
    +
    +
    +
    +
    +
    +

    The branch name

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case branchName
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + businessContactRole + +
    +
    +
    +
    +
    +
    +

    The bank account holder’s role in the organization.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case businessContactRole
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + businessName + +
    +
    +
    +
    +
    +
    +

    The name of the transfer method holder’s business

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case businessName
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The country where the transfer method holder’s business is registered

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case businessRegistrationCountry
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

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

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case businessRegistrationId
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

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

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case businessRegistrationStateProvince
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + businessType + +
    +
    +
    +
    +
    +
    +

    The bank account holder’s business type.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case businessType
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + city + +
    +
    +
    +
    +
    +
    +

    The bank account holder’s city.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case city
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + country + +
    +
    +
    +
    +
    +
    +

    The bank account holder’s country.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case country
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + countryOfBirth + +
    +
    +
    +
    +
    +
    +

    The country where bank account holder born

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case countryOfBirth
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + countryOfNationality + +
    +
    +
    +
    +
    +
    +

    The Nationality of the bank account holder

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case countryOfNationality
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + dateOfBirth + +
    +
    +
    +
    +
    +
    +

    The bank account holder’s date of birth.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case dateOfBirth
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + driversLicenseId + +
    +
    +
    +
    +
    +
    +

    The LicenseId of the bank account holder

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case driversLicenseId
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + employerId + +
    +
    +
    +
    +
    +
    +

    The employer Id of the bank account holder

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case employerId
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + firstName + +
    +
    +
    +
    +
    +
    +

    The bank account holder’s first name.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case firstName
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + gender + +
    +
    +
    +
    +
    +
    +

    The bank account holder’s gender

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case gender
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + governmentId + +
    +
    +
    +
    +
    +
    +

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

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case governmentId
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + governmentIdType + +
    +
    +
    +
    +
    +
    +

    The bank account holder’s government IdType

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case governmentIdType
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The bank account holder’s Intermediary Bank AccountId

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case intermediaryBankAccountId
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The bank account holder’s Intermediary Bank AddressLine1

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case intermediaryBankAddressLine1
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The bank account holder’s Intermediary Bank AddressLine2

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case intermediaryBankAddressLine2
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + intermediaryBankCity + +
    +
    +
    +
    +
    +
    +

    The bank account holder’s Intermediary Bank’s City

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case intermediaryBankCity
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The bank account holder’s Intermediary Bank’s Country

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case intermediaryBankCountry
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + intermediaryBankId + +
    +
    +
    +
    +
    +
    +

    The bank account holder’s Intermediary Bank Id

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case intermediaryBankId
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + intermediaryBankName + +
    +
    +
    +
    +
    +
    +

    The bank account holder’s Intermediary Bank Name

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case intermediaryBankName
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The bank account holder’s Intermediary PostalCode:

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case intermediaryBankPostalCode
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The bank account holder’s Intermediary Bank’s State and Province

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case intermediaryBankStateProvince
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + lastName + +
    +
    +
    +
    +
    +
    +

    The bank account holder’s last name.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case lastName
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + middleName + +
    +
    +
    +
    +
    +
    +

    The bank account holder’s middle name.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case middleName
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + mobileNumber + +
    +
    +
    +
    +
    +
    +

    The bank account holder’s mobile number

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case mobileNumber
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + passportId + +
    +
    +
    +
    +
    +
    +

    The bank account holder’s passport Id

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case passportId
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + phoneNumber + +
    +
    +
    +
    +
    +
    +

    The bank account holder’s phone number.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case phoneNumber
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + postalCode + +
    +
    +
    +
    +
    +
    +

    The bank account holder’s postal code.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case postalCode
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + profileType + +
    +
    +
    +
    +
    +
    +

    The bank account holder’s profile type.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case profileType
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + stateProvince + +
    +
    +
    +
    +
    +
    +

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

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case stateProvince
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + wireInstructions + +
    +
    +
    +
    +
    +
    +

    The wire transfer instructions

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case wireInstructions
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + cardBrand + +
    +
    +
    +
    +
    +
    +

    The card brand.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case cardBrand
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + cardNumber + +
    +
    +
    +
    +
    +
    +

    The 16-digit card number.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case cardNumber
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + cardType + +
    +
    +
    +
    +
    +
    +

    The bank card type.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case cardType
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + cvv + +
    +
    +
    +
    +
    +
    +

    The card security code which is embossed or printed on the card.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case cvv
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + dateOfExpiry + +
    +
    +
    +
    +
    +
    +

    The expiration date for the card (YYYY-MM).

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case dateOfExpiry
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + primaryCardToken + +
    +
    +
    +
    +
    +
    +

    The primary card token

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case primaryCardToken
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + email + +
    +
    +
    +
    +
    +
    +

    The email address associated with the PayPal account.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case email
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + accountId + +
    +
    +
    +
    +
    +
    +

    The mobile number associated with the Venmo account.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case accountId
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + cardPackage + +
    +
    +
    +
    +
    +
    +

    The card’s package

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case cardPackage
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + userToken + +
    +
    +
    +
    +
    +
    +

    The user token

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case userToken
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + shippingMethod + +
    +
    +
    +
    +
    +
    +

    The shipping method

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case shippingMethod
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/Classes/HyperwalletTransferMethod/TransferMethodType.html b/Classes/HyperwalletTransferMethod/TransferMethodType.html new file mode 100644 index 00000000..6b258ab7 --- /dev/null +++ b/Classes/HyperwalletTransferMethod/TransferMethodType.html @@ -0,0 +1,577 @@ + + + + TransferMethodType Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + TransferMethodType Enumeration Reference +

+ +
+ +
+ +
+
+

TransferMethodType

+
+
+ + 
public enum TransferMethodType : String
+ +
+
+

Representation of the transfer method’s type

+ +
+
+ +
+
+
+
    +
  • +
    + + + + bankAccount + +
    +
    +
    +
    +
    +
    +

    When the transfer method is Bank Account

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case bankAccount = "BANK_ACCOUNT"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + bankCard + +
    +
    +
    +
    +
    +
    +

    When the transfer method is Bank Card

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case bankCard = "BANK_CARD"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + payPalAccount + +
    +
    +
    +
    +
    +
    +

    When the transfer method is PayPal Account

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case payPalAccount = "PAYPAL_ACCOUNT"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + wireAccount + +
    +
    +
    +
    +
    +
    +

    When the transfer method is Wire Account

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case wireAccount = "WIRE_ACCOUNT"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + prepaidCard + +
    +
    +
    +
    +
    +
    +

    When the transfer method is Prepaid Card

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case prepaidCard = "PREPAID_CARD"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + venmoAccount + +
    +
    +
    +
    +
    +
    +

    When the transfer method is Venmo Account

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case venmoAccount = "VENMO_ACCOUNT"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + paperCheck + +
    +
    +
    +
    +
    +
    +

    when transfer method is paper check

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case paperCheck = "PAPER_CHECK"
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/Classes/HyperwalletTransferMethodQueryParam.html b/Classes/HyperwalletTransferMethodQueryParam.html new file mode 100644 index 00000000..ccf6b0f4 --- /dev/null +++ b/Classes/HyperwalletTransferMethodQueryParam.html @@ -0,0 +1,552 @@ + + + + HyperwalletTransferMethodQueryParam Class Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + HyperwalletTransferMethodQueryParam Class Reference +

+ +
+ +
+ +
+
+

HyperwalletTransferMethodQueryParam

+
+
+ + 
public class HyperwalletTransferMethodQueryParam : QueryParam
+ +
+
+

Representation of the common transfer method’s query parameters.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + status + +
    +
    +
    +
    +
    +
    +

    Returns transfer method with this status.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var status: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + type + +
    +
    +
    +
    +
    +
    +

    Returns transfer method of that type

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var type: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + QueryStatus + +
    +
    +
    +
    +
    +
    +

    Representation of the transfer method status

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public enum QueryStatus : String
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + QuerySortable + +
    +
    +
    +
    +
    +
    +

    Representation of the field’s sortable

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public enum QuerySortable : String
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + QueryType + +
    +
    +
    +
    +
    +
    +

    Representation of the transfer method’s type

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public enum QueryType : String
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + toQuery() + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    override public func toQuery() -> [String : String]
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/Classes/HyperwalletTransferMethodQueryParam/QuerySortable.html b/Classes/HyperwalletTransferMethodQueryParam/QuerySortable.html new file mode 100644 index 00000000..9610f5fc --- /dev/null +++ b/Classes/HyperwalletTransferMethodQueryParam/QuerySortable.html @@ -0,0 +1,496 @@ + + + + QuerySortable Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + QuerySortable Enumeration Reference +

+ +
+ +
+ +
+
+

QuerySortable

+
+
+ + 
public enum QuerySortable : String
+ +
+
+

Representation of the field’s sortable

+ +
+
+ +
+
+
+
    +
  • +
    + + + + ascendantCreatedOn + +
    +
    +
    +
    +
    +
    +

    Sort the result by ascendant created on

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case ascendantCreatedOn = "+createdOn"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + ascendantStatus + +
    +
    +
    +
    +
    +
    +

    Sort the result by ascendant status

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case ascendantStatus = "+status"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + descendantCreatedOn + +
    +
    +
    +
    +
    +
    +

    Sort the result by descendant created on

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case descendantCreatedOn = "-createdOn"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + descendantStatus + +
    +
    +
    +
    +
    +
    +

    Sort the result by descendant status

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case descendantStatus = "-status"
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/Classes/HyperwalletTransferMethodQueryParam/QueryStatus.html b/Classes/HyperwalletTransferMethodQueryParam/QueryStatus.html new file mode 100644 index 00000000..87122bbe --- /dev/null +++ b/Classes/HyperwalletTransferMethodQueryParam/QueryStatus.html @@ -0,0 +1,577 @@ + + + + QueryStatus Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + QueryStatus Enumeration Reference +

+ +
+ +
+ +
+
+

QueryStatus

+
+
+ + 
public enum QueryStatus : String
+ +
+
+

Representation of the transfer method status

+ +
+
+ +
+
+
+
    +
  • +
    + + + + activated + +
    +
    +
    +
    +
    +
    +

    Filter by activated transfer methods

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case activated = "ACTIVATED"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + deActivated + +
    +
    +
    +
    +
    +
    +

    Filter by deActivated transfer methods

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case deActivated = "DE_ACTIVATED"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + invalid + +
    +
    +
    +
    +
    +
    +

    Filter only invalid transfer methods

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case invalid = "INVALID"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + lostOrStolen + +
    +
    +
    +
    +
    +
    +

    Filter only lost or stolen prepaid cards

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case lostOrStolen = "LOST_OR_STOLEN"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + preActivated + +
    +
    +
    +
    +
    +
    +

    Filter by preActivated prepaid cards

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case preActivated = "PRE_ACTIVATED"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + suspended + +
    +
    +
    +
    +
    +
    +

    Filter only suspended prepaid cards

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case suspended = "SUSPENDED"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + verified + +
    +
    +
    +
    +
    +
    +

    Filter only verified transfer methods

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case verified = "VERIFIED"
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/Classes/HyperwalletTransferMethodQueryParam/QueryType.html b/Classes/HyperwalletTransferMethodQueryParam/QueryType.html new file mode 100644 index 00000000..e5c1eac4 --- /dev/null +++ b/Classes/HyperwalletTransferMethodQueryParam/QueryType.html @@ -0,0 +1,577 @@ + + + + QueryType Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + QueryType Enumeration Reference +

+ +
+ +
+ +
+
+

QueryType

+
+
+ + 
public enum QueryType : String
+ +
+
+

Representation of the transfer method’s type

+ +
+
+ +
+
+
+
    +
  • +
    + + + + bankAccount + +
    +
    +
    +
    +
    +
    +

    When the transfer method is Bank Account

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case bankAccount = "BANK_ACCOUNT"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + bankCard + +
    +
    +
    +
    +
    +
    +

    When the transfer method is Bank Card

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case bankCard = "BANK_CARD"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + payPalAccount + +
    +
    +
    +
    +
    +
    +

    When the transfer method is PayPal Account

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case payPalAccount = "PAYPAL_ACCOUNT"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + wireAccount + +
    +
    +
    +
    +
    +
    +

    When the transfer method is Wire Account

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case wireAccount = "WIRE_ACCOUNT"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + prepaidCard + +
    +
    +
    +
    +
    +
    +

    When the transfer method is Prepaid Card

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case prepaidCard = "PREPAID_CARD"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + venmoAccount + +
    +
    +
    +
    +
    +
    +

    When the transfer method is Venmo Account

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case venmoAccount = "VENMO_ACCOUNT"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + paperCheck + +
    +
    +
    +
    +
    +
    +

    When the transfer method is Paper Check

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case paperCheck = "PAPER_CHECK"
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/Classes/HyperwalletTransferQueryParam.html b/Classes/HyperwalletTransferQueryParam.html new file mode 100644 index 00000000..741fc448 --- /dev/null +++ b/Classes/HyperwalletTransferQueryParam.html @@ -0,0 +1,469 @@ + + + + HyperwalletTransferQueryParam Class Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + HyperwalletTransferQueryParam Class Reference +

+ +
+ +
+ +
+
+

HyperwalletTransferQueryParam

+
+
+ + 
public class HyperwalletTransferQueryParam : QueryParam
+ +
+
+

Representation of the user transfers QueryParams fields.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + clientTransferId + +
    +
    +
    +
    +
    +
    +

    A value that identifies the client transfer id.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var clientTransferId: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + destinationToken + +
    +
    +
    +
    +
    +
    +

    A value that identifies the destination token.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var destinationToken: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + sourceToken + +
    +
    +
    +
    +
    +
    +

    A value that identifies the source token.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var sourceToken: String?
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/Classes/HyperwalletUser.html b/Classes/HyperwalletUser.html new file mode 100644 index 00000000..0f07e832 --- /dev/null +++ b/Classes/HyperwalletUser.html @@ -0,0 +1,1879 @@ + + + + HyperwalletUser Class Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + HyperwalletUser Class Reference +

+ +
+ +
+ +
+
+

HyperwalletUser

+
+
+ + 
@objcMembers
+public class HyperwalletUser : NSObject, Codable
+ +
+
+

Representation of the Hyperwallet’s user.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + UserField + +
    +
    +
    +
    +
    +
    +

    Representation of the user field type.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public enum UserField : String
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + BusinessType + +
    +
    +
    +
    +
    +
    +

    The business type.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public enum BusinessType : String
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + BusinessContactRole + +
    +
    +
    +
    +
    +
    +

    The user’s role in the organization.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public enum BusinessContactRole : String
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + Gender + +
    +
    +
    +
    +
    +
    +

    Representation of the gender.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public enum Gender : String
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + ProfileType + +
    +
    +
    +
    +
    +
    +

    Representation of the user’s profile type.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public enum ProfileType : String
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + Status + +
    +
    +
    +
    +
    +
    +

    Representation of the user account status type.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public enum Status : String
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + VerificationStatus + +
    +
    +
    +
    +
    +
    +

    Representation of the user’s verification status type.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public enum VerificationStatus : String, Codable
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + init(from:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public required init(from decoder: Decoder) throws
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + addressLine1 + +
    +
    +
    +
    +
    +
    +

    The user’s street address.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var addressLine1: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + addressLine2 + +
    +
    +
    +
    +
    +
    +

    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 }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + businessContactCity + +
    +
    +
    +
    +
    +
    +

    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 }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + businessContactRole + +
    +
    +
    +
    +
    +
    +

    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 }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + businessName + +
    +
    +
    +
    +
    +
    +

    The business name.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var businessName: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + businessOperatingName + +
    +
    +
    +
    +
    +
    +

    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 }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + businessType + +
    +
    +
    +
    +
    +
    +

    The business type

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var businessType: BusinessType? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + city + +
    +
    +
    +
    +
    +
    +

    The user’s city.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var city: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + clientUserId + +
    +
    +
    +
    +
    +
    +

    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 }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + country + +
    +
    +
    +
    +
    +
    +

    The user’s country.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var country: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + countryOfBirth + +
    +
    +
    +
    +
    +
    +

    The user’s birth country.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var countryOfBirth: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + countryOfNationality + +
    +
    +
    +
    +
    +
    +

    The user’s country of citizenship or nationality.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var countryOfNationality: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + createdOn + +
    +
    +
    +
    +
    +
    +

    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 }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + dateOfBirth + +
    +
    +
    +
    +
    +
    +

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

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var dateOfBirth: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + driversLicenseId + +
    +
    +
    +
    +
    +
    +

    The user’s driver’s license number.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var driversLicenseId: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + email + +
    +
    +
    +
    +
    +
    +

    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 }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + employerId + +
    +
    +
    +
    +
    +
    +

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

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var employerId: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + firstName + +
    +
    +
    +
    +
    +
    +

    The user’s first name.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var firstName: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + gender + +
    +
    +
    +
    +
    +
    +

    The user’s gender.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var gender: Gender? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + governmentId + +
    +
    +
    +
    +
    +
    +

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

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var governmentId: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + governmentIdType + +
    +
    +
    +
    +
    +
    +

    The user’s government ID type.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var governmentIdType: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + language + +
    +
    +
    +
    +
    +
    +

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

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var language: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + lastName + +
    +
    +
    +
    +
    +
    +

    The user’s last name.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var lastName: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + middleName + +
    +
    +
    +
    +
    +
    +

    The user’s middle name.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var middleName: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + mobileNumber + +
    +
    +
    +
    +
    +
    +

    The user’s cell phone number.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var mobileNumber: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + passportId + +
    +
    +
    +
    +
    +
    +

    The user’s passport number.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var passportId: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + phoneNumber + +
    +
    +
    +
    +
    +
    +

    The user’s phone number.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var phoneNumber: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + postalCode + +
    +
    +
    +
    +
    +
    +

    The user’s postal code.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var postalCode: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + profileType + +
    +
    +
    +
    +
    +
    +

    The user’s profile type. See ProfileType

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var profileType: ProfileType? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + programToken + +
    +
    +
    +
    +
    +
    +

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

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var programToken: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + stateProvince + +
    +
    +
    +
    +
    +
    +

    The user’s state, province or region.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var stateProvince: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + status + +
    +
    +
    +
    +
    +
    +

    The user account status.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var status: Status? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + timeZone + +
    +
    +
    +
    +
    +
    +

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

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var timeZone: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + token + +
    +
    +
    +
    +
    +
    +

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

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var token: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + verificationStatus + +
    +
    +
    +
    +
    +
    +

    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 }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + encode(to:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func encode(to encoder: Encoder) throws
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + getField(_:) + +
    +
    +
    +
    +
    +
    +

    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.

    +
    +
    +
    +
    • +
  • +
    + + + + Builder + +
    +
    +
    +
    +
    +
    +

    A helper class to build the HyperwalletUser instance.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public final class Builder
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/Classes/HyperwalletUser/Builder.html b/Classes/HyperwalletUser/Builder.html new file mode 100644 index 00000000..c0e5d993 --- /dev/null +++ b/Classes/HyperwalletUser/Builder.html @@ -0,0 +1,2645 @@ + + + + Builder Class Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + Builder Class Reference +

+ +
+ +
+ +
+
+

Builder

+
+
+ + 
public final class Builder
+ +
+
+

A helper class to build the HyperwalletUser instance.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + addressLine1(_:) + +
    +
    +
    +
    +
    +
    +

    Sets the user’s street address.

    + +
    +
    +

    Declaration

    +
    +

    Swift

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

    Parameters

    + + + + + + + +
    + + addressLine1 + + +
    +

    The user’s street address

    +
    +
    +
    +
    +

    Return Value

    +

    a self reference of HyperwalletUser.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + addressLine2(_:) + +
    +
    +
    +
    +
    +
    +

    Sets the user’s address, second line.

    + +
    +
    +

    Declaration

    +
    +

    Swift

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

    Parameters

    + + + + + + + +
    + + addressLine2 + + +
    +

    The user’s address, second line.

    +
    +
    +
    +
    +

    Return Value

    +

    a self reference of HyperwalletUser.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + build() + +
    +
    +
    +
    +
    +
    +

    Builds a new instance of the HyperwalletUser.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func build() -> HyperwalletUser
    + +
    +
    +
    +

    Return Value

    +

    a new instance of the HyperwalletUser.

    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Sets the business contact’s street address.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func businessContactAddressLine1(_ businessContactAddressLine1: String) -> Builder
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + businessContactAddressLine1 + + +
    +

    The business contact’s street address.

    +
    +
    +
    +
    +

    Return Value

    +

    a self reference of HyperwalletUser.Builder instance.

    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Sets the business contact’s address, second line.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func businessContactAddressLine2(_ businessContactAddressLine2: String) -> Builder
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + businessContactAddressLine2 + + +
    +

    The business contact’s address, second line.

    +
    +
    +
    +
    +

    Return Value

    +

    a self reference of HyperwalletUser.Builder instance.

    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Sets the business contact’s city.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func businessContactCity(_ businessContactCity: String) -> Builder
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + businessContactCity + + +
    +

    The business contact’s city.

    +
    +
    +
    +
    +

    Return Value

    +

    a self reference of HyperwalletUser.Builder instance.

    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Sets the business contact’s country.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func businessContactCountry(_ businessContactCountry: String) -> Builder
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + businessContactCountry + + +
    +

    The business contact’s city.

    +
    +
    +
    +
    +

    Return Value

    +

    a self reference of HyperwalletUser.Builder instance.

    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Sets the business contact’s postal code.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func businessContactPostalCode(_ businessContactPostalCode: String) -> Builder
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + businessContactPostalCode + + +
    +

    The business contact’s postal code.

    +
    +
    +
    +
    +

    Return Value

    +

    a self reference of HyperwalletUser.Builder instance.

    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Sets the user’s role in the organization.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func businessContactRole(_ businessContactRole: BusinessContactRole) -> Builder
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + businessContactPostalCode + + + +
    +
    +
    +

    Return Value

    +

    a self reference of HyperwalletUser.Builder instance.

    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Sets the business contact’s state, province or region.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func businessContactStateProvince(_ businessContactStateProvince: String) -> Builder
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + businessContactStateProvince + + +
    +

    The business contact’s state, province or region.

    +
    +
    +
    +
    +

    Return Value

    +

    a self reference of HyperwalletUser.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + businessName(_:) + +
    +
    +
    +
    +
    +
    +

    Sets the business name.

    + +
    +
    +

    Declaration

    +
    +

    Swift

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

    Parameters

    + + + + + + + +
    + + businessName + + +
    +

    The business name.

    +
    +
    +
    +
    +

    Return Value

    +

    a self reference of HyperwalletUser.Builder instance.

    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Sets the business’ operating name.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func businessOperatingName(_ businessOperatingName: String) -> Builder
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + businessName + + +
    +

    The business’ operating name.

    +
    +
    +
    +
    +

    Return Value

    +

    a self reference of HyperwalletUser.Builder instance.

    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Sets the country where the business is registered.

    + +
    +
    +

    Declaration

    +
    +

    Swift

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

    Parameters

    + + + + + + + +
    + + businessRegistrationCountry + + +
    +

    The country where the business is registered.

    +
    +
    +
    +
    +

    Return Value

    +

    a self reference of HyperwalletUser.Builder instance.

    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Sets the business registration number or identifier assigned by a government body.

    + +
    +
    +

    Declaration

    +
    +

    Swift

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

    Parameters

    + + + + + + + +
    + + businessRegistrationId + + +
    +

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

    +
    +
    +
    +
    +

    Return Value

    +

    a self reference of HyperwalletUser.Builder instance.

    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Sets the state, province or region where the business is registered.

    + +
    +
    +

    Declaration

    +
    +

    Swift

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

    Parameters

    + + + + + + + +
    + + businessRegistrationStateProvince + + +
    +

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

    +
    +
    +
    +
    +

    Return Value

    +

    a self reference of HyperwalletUser.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + businessType(_:) + +
    +
    +
    +
    +
    +
    +

    Sets the business type.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func businessType(_ businessType: BusinessType) -> Builder
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + businessRegistrationStateProvince + + +
    +

    The BusinessType.

    +
    +
    +
    +
    +

    Return Value

    +

    a self reference of HyperwalletUser.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + city(_:) + +
    +
    +
    +
    +
    +
    +

    Sets the user’s city.

    + +
    +
    +

    Declaration

    +
    +

    Swift

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

    Parameters

    + + + + + + + +
    + + city + + +
    +

    The user’s city.

    +
    +
    +
    +
    +

    Return Value

    +

    a self reference of HyperwalletUser.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + country(_:) + +
    +
    +
    +
    +
    +
    +

    Sets the user’s country.

    + +
    +
    +

    Declaration

    +
    +

    Swift

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

    Parameters

    + + + + + + + +
    + + country + + +
    +

    The user’s country.

    +
    +
    +
    +
    +

    Return Value

    +

    a self reference of HyperwalletUser.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + countryOfBirth(_:) + +
    +
    +
    +
    +
    +
    +

    Sets the user’s birth country.

    + +
    +
    +

    Declaration

    +
    +

    Swift

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

    Parameters

    + + + + + + + +
    + + country + + +
    +

    The user’s birth country.

    +
    +
    +
    +
    +

    Return Value

    +

    a self reference of HyperwalletUser.Builder instance.

    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Sets the user’s country of citizenship or nationality.

    + +
    +
    +

    Declaration

    +
    +

    Swift

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

    Parameters

    + + + + + + + +
    + + countryOfNationality + + +
    +

    The user’s country of citizenship or nationality.

    +
    +
    +
    +
    +

    Return Value

    +

    a self reference of HyperwalletUser.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + createdOn(_:) + +
    +
    +
    +
    +
    +
    +

    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) -> Builder
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + createdOn + + +
    +

    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.

    +
    +
    +
    +
    +

    Return Value

    +

    a self reference of HyperwalletUser.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + dateOfBirth(_:) + +
    +
    +
    +
    +
    +
    +

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

    + +
    +
    +

    Declaration

    +
    +

    Swift

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

    Parameters

    + + + + + + + +
    + + dateOfBirth + + +
    +

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

    +
    +
    +
    +
    +

    Return Value

    +

    a self reference of HyperwalletUser.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + driversLicenseId(_:) + +
    +
    +
    +
    +
    +
    +

    Sets the user’s driver’s license number.

    + +
    +
    +

    Declaration

    +
    +

    Swift

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

    Parameters

    + + + + + + + +
    + + driversLicenseId + + +
    +

    The user’s driver’s license number.

    +
    +
    +
    +
    +

    Return Value

    +

    a self reference of HyperwalletUser.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + email(_:) + +
    +
    +
    +
    +
    +
    +

    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) -> Builder
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + driversLicenseId + + +
    +

    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.

    +
    +
    +
    +
    +

    Return Value

    +

    a self reference of HyperwalletUser.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + employerId(_:) + +
    +
    +
    +
    +
    +
    +

    Sets the user’s employer identifier, generally used for tax purposes.

    + +
    +
    +

    Declaration

    +
    +

    Swift

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

    Parameters

    + + + + + + + +
    + + employerId + + +
    +

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

    +
    +
    +
    +
    +

    Return Value

    +

    a self reference of HyperwalletUser.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + firstName(_:) + +
    +
    +
    +
    +
    +
    +

    Sets the user’s first name.

    + +
    +
    +

    Declaration

    +
    +

    Swift

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

    Parameters

    + + + + + + + +
    + + firstName + + +
    +

    The user’s first name.

    +
    +
    +
    +
    +

    Return Value

    +

    a self reference of HyperwalletUser.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + gender(_:) + +
    +
    +
    +
    +
    +
    +

    Sets the user’s gender.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func gender(_ gender: Gender) -> Builder
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + gender + + +
    +

    The Gender.

    +
    +
    +
    +
    +

    Return Value

    +

    a self reference of HyperwalletUser.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + governmentId(_:) + +
    +
    +
    +
    +
    +
    +

    Sets the user’s government ID number, such as a Social Security Number.

    + +
    +
    +

    Declaration

    +
    +

    Swift

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

    Parameters

    + + + + + + + +
    + + governmentId + + +
    +

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

    +
    +
    +
    +
    +

    Return Value

    +

    a self reference of HyperwalletUser.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + governmentIdType(_:) + +
    +
    +
    +
    +
    +
    +

    Sets the user’s government ID type.

    + +
    +
    +

    Declaration

    +
    +

    Swift

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

    Parameters

    + + + + + + + +
    + + governmentIdType + + +
    +

    The user’s government ID type.

    +
    +
    +
    +
    +

    Return Value

    +

    a self reference of HyperwalletUser.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + language(_:) + +
    +
    +
    +
    +
    +
    +

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

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func language(_ language: String) -> Builder
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + language + + +
    +

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

    +
    +
    +
    +
    +

    Return Value

    +

    a self reference of HyperwalletUser.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + lastName(_:) + +
    +
    +
    +
    +
    +
    +

    Sets the user’s last name.

    + +
    +
    +

    Declaration

    +
    +

    Swift

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

    Parameters

    + + + + + + + +
    + + lastName + + +
    +

    The user’s last name.

    +
    +
    +
    +
    +

    Return Value

    +

    a self reference of HyperwalletUser.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + middleName(_:) + +
    +
    +
    +
    +
    +
    +

    Sets the user’s middle name.

    + +
    +
    +

    Declaration

    +
    +

    Swift

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

    Parameters

    + + + + + + + +
    + + middleName + + +
    +

    The user’s middle name.

    +
    +
    +
    +
    +

    Return Value

    +

    a self reference of HyperwalletUser.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + mobileNumber(_:) + +
    +
    +
    +
    +
    +
    +

    Sets the user’s cell phone number.

    + +
    +
    +

    Declaration

    +
    +

    Swift

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

    Parameters

    + + + + + + + +
    + + middleName + + +
    +

    The user’s middle name.

    +
    +
    +
    +
    +

    Return Value

    +

    a self reference of HyperwalletUser.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + passportId(_:) + +
    +
    +
    +
    +
    +
    +

    Sets the user’s passport number.

    + +
    +
    +

    Declaration

    +
    +

    Swift

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

    Parameters

    + + + + + + + +
    + + passportId + + +
    +

    The user’s passport number.

    +
    +
    +
    +
    +

    Return Value

    +

    a self reference of HyperwalletUser.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + phoneNumber(_:) + +
    +
    +
    +
    +
    +
    +

    Sets the user’s phone number.

    + +
    +
    +

    Declaration

    +
    +

    Swift

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

    Parameters

    + + + + + + + +
    + + passportId + + +
    +

    The user’s phone number.

    +
    +
    +
    +
    +

    Return Value

    +

    a self reference of HyperwalletUser.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + postalCode(_:) + +
    +
    +
    +
    +
    +
    +

    Sets the user’s postal code.

    + +
    +
    +

    Declaration

    +
    +

    Swift

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

    Parameters

    + + + + + + + +
    + + postalCode + + +
    +

    The user’s postal code.

    +
    +
    +
    +
    +

    Return Value

    +

    a self reference of HyperwalletUser.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + profileType(_:) + +
    +
    +
    +
    +
    +
    +

    Sets the user’s profile type.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func profileType(_ profileType: ProfileType) -> Builder
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + profileType + + +
    +

    The ProfileType.

    +
    +
    +
    +
    +

    Return Value

    +

    a self reference of HyperwalletUser.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + programToken(_:) + +
    +
    +
    +
    +
    +
    +

    Sets the unique identifier for the program to which the user will belong.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func programToken(_ programToken: String) -> Builder
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + programToken + + +
    +

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

    +
    +
    +
    +
    +

    Return Value

    +

    a self reference of HyperwalletUser.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + setField(key:value:) + +
    +
    +
    +
    +
    +
    +

    Sets the field value based on the UserField

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func setField(key: UserField, value: String) -> Builder
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + key + + +
    +

    The UserField value

    +
    +
    + + value + + +
    +

    The value

    +
    +
    +
    +
    +
    +
    • +
  • +
    + + + + setField(key:value:) + +
    +
    +
    +
    +
    +
    +

    Sets the field value based on the UserField.RawValue

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func setField(key: UserField.RawValue, value: String) -> Builder
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + key + + +
    +

    The UserField.RawValue value

    +
    +
    + + value + + +
    +

    The value

    +
    +
    +
    +
    +
    +
    • +
  • +
    + + + + stateProvince(_:) + +
    +
    +
    +
    +
    +
    +

    Sets the user’s state, province or region.

    + +
    +
    +

    Declaration

    +
    +

    Swift

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

    Parameters

    + + + + + + + +
    + + stateProvince + + +
    +

    The user’s state, province or region.

    +
    +
    +
    +
    +

    Return Value

    +

    a self reference of HyperwalletUser.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + status(_:) + +
    +
    +
    +
    +
    +
    +

    Sets the user account status.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func status(_ status: Status) -> Builder
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + status + + +
    +

    The user’s state, province or region.

    +
    +
    +
    +
    +

    Return Value

    +

    a self reference of HyperwalletUser.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + timeZone(_:) + +
    +
    +
    +
    +
    +
    +

    Sets the local time of a region or a country. e.g. GMT, PST, …

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func timeZone(_ timeZone: String) -> Builder
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + timeZone + + +
    +

    The local time of a region or a country.

    +
    +
    +
    +
    +

    Return Value

    +

    a self reference of HyperwalletUser.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + token(_:) + +
    +
    +
    +
    +
    +
    +

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

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func token(_ token: String) -> Builder
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + token + + +
    +

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

    +
    +
    +
    +
    +

    Return Value

    +

    a self reference of HyperwalletUser.Builder instance.

    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    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) -> Builder
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + verificationStatus + + +
    +

    The 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.Builder instance.

    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/Classes/HyperwalletUser/BusinessContactRole.html b/Classes/HyperwalletUser/BusinessContactRole.html new file mode 100644 index 00000000..291d303b --- /dev/null +++ b/Classes/HyperwalletUser/BusinessContactRole.html @@ -0,0 +1,469 @@ + + + + BusinessContactRole Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + BusinessContactRole Enumeration Reference +

+ +
+ +
+ +
+
+

BusinessContactRole

+
+
+ + 
public enum BusinessContactRole : String
+ +
+
+

The user’s role in the organization.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + director + +
    +
    +
    +
    +
    +
    +

    The director role

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case director = "DIRECTOR"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + other + +
    +
    +
    +
    +
    +
    +

    The other role

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case other = "OTHER"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + owner + +
    +
    +
    +
    +
    +
    +

    The owner role

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case owner = "OWNER"
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/Classes/HyperwalletUser/BusinessType.html b/Classes/HyperwalletUser/BusinessType.html new file mode 100644 index 00000000..0c8b2837 --- /dev/null +++ b/Classes/HyperwalletUser/BusinessType.html @@ -0,0 +1,442 @@ + + + + BusinessType Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + BusinessType Enumeration Reference +

+ +
+ +
+ +
+
+

BusinessType

+
+
+ + 
public enum BusinessType : String
+ +
+
+

The business type.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + corporation + +
    +
    +
    +
    +
    +
    +

    The corporation business type

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case corporation = "CORPORATION"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + partnership + +
    +
    +
    +
    +
    +
    +

    The partnership business type

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case partnership = "PARTNERSHIP"
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/Classes/HyperwalletUser/Gender.html b/Classes/HyperwalletUser/Gender.html new file mode 100644 index 00000000..3beaebde --- /dev/null +++ b/Classes/HyperwalletUser/Gender.html @@ -0,0 +1,442 @@ + + + + Gender Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + Gender Enumeration Reference +

+ +
+ +
+ +
+
+

Gender

+
+
+ + 
public enum Gender : String
+ +
+
+

Representation of the gender.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + female + +
    +
    +
    +
    +
    +
    +

    The female gender

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case female = "FEMALE"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + male + +
    +
    +
    +
    +
    +
    +

    The male gender

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case male = "MALE"
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/Classes/HyperwalletUser/ProfileType.html b/Classes/HyperwalletUser/ProfileType.html new file mode 100644 index 00000000..1fe02214 --- /dev/null +++ b/Classes/HyperwalletUser/ProfileType.html @@ -0,0 +1,442 @@ + + + + ProfileType Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + ProfileType Enumeration Reference +

+ +
+ +
+ +
+
+

ProfileType

+
+
+ + 
public enum ProfileType : String
+ +
+
+

Representation of the user’s profile type.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + business + +
    +
    +
    +
    +
    +
    +

    The business profile type.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case business = "BUSINESS"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + individual + +
    +
    +
    +
    +
    +
    +

    The individual profile type.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case individual = "INDIVIDUAL"
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/Classes/HyperwalletUser/Status.html b/Classes/HyperwalletUser/Status.html new file mode 100644 index 00000000..dc45ef55 --- /dev/null +++ b/Classes/HyperwalletUser/Status.html @@ -0,0 +1,523 @@ + + + + Status Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + Status Enumeration Reference +

+ +
+ +
+ +
+
+

Status

+
+
+ + 
public enum Status : String
+ +
+
+

Representation of the user account status type.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + activated + +
    +
    +
    +
    +
    +
    +

    The user account is activated.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case activated = "ACTIVATED"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + deactivated + +
    +
    +
    +
    +
    +
    +

    The user account is deactivated.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case deactivated = "DE_ACTIVATED"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + frozen + +
    +
    +
    +
    +
    +
    +

    The user account is frozen.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case frozen = "FROZEN"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + locked + +
    +
    +
    +
    +
    +
    +

    The user account is locked.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case locked = "LOCKED"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + preActivated + +
    +
    +
    +
    +
    +
    +

    The user account is pre activated.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case preActivated = "PRE_ACTIVATED"
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/Classes/HyperwalletUser/UserField.html b/Classes/HyperwalletUser/UserField.html new file mode 100644 index 00000000..89a96a38 --- /dev/null +++ b/Classes/HyperwalletUser/UserField.html @@ -0,0 +1,1553 @@ + + + + UserField Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + UserField Enumeration Reference +

+ +
+ +
+ +
+
+

UserField

+
+
+ + 
public enum UserField : String
+ +
+
+

Representation of the user field type.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + addressLine1 + +
    +
    +
    +
    +
    +
    +

    The user’s street address.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case addressLine1
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + addressLine2 + +
    +
    +
    +
    +
    +
    +

    The user’s address, second line.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case addressLine2
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The business contact’s street address.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case businessContactAddressLine1
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The business contact’s address, second line.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case businessContactAddressLine2
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + businessContactCity + +
    +
    +
    +
    +
    +
    +

    The business contact’s city.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case businessContactCity
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The business contact’s country.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case businessContactCountry
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The business contact’s postal code.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case businessContactPostalCode
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + businessContactRole + +
    +
    +
    +
    +
    +
    +

    The user’s role in the organization.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case businessContactRole
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The business contact’s state, province or region.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case businessContactStateProvince
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + businessName + +
    +
    +
    +
    +
    +
    +

    The business name.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case businessName
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + businessOperatingName + +
    +
    +
    +
    +
    +
    +

    The business’ operating name.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case businessOperatingName
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The country where the business is registered.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case businessRegistrationCountry
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

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

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case businessRegistrationId
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

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

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case businessRegistrationStateProvince
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + businessType + +
    +
    +
    +
    +
    +
    +

    The business type.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case businessType
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + city + +
    +
    +
    +
    +
    +
    +

    The user’s city.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case city
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + clientUserId + +
    +
    +
    +
    +
    +
    +

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

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case clientUserId
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + country + +
    +
    +
    +
    +
    +
    +

    The user’s country.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case country
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + countryOfBirth + +
    +
    +
    +
    +
    +
    +

    The user’s birth country.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case countryOfBirth
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + countryOfNationality + +
    +
    +
    +
    +
    +
    +

    The user’s country of citizenship or nationality.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case countryOfNationality
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + createdOn + +
    +
    +
    +
    +
    +
    +

    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

    + 
    case createdOn
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + dateOfBirth + +
    +
    +
    +
    +
    +
    +

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

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case dateOfBirth
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + driversLicenseId + +
    +
    +
    +
    +
    +
    +

    The user’s driver’s license number.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case driversLicenseId
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + email + +
    +
    +
    +
    +
    +
    +

    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

    + 
    case email
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + employerId + +
    +
    +
    +
    +
    +
    +

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

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case employerId
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + firstName + +
    +
    +
    +
    +
    +
    +

    The user’s first name.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case firstName
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + gender + +
    +
    +
    +
    +
    +
    +

    The user’s gender.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case gender
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + governmentId + +
    +
    +
    +
    +
    +
    +

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

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case governmentId
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + governmentIdType + +
    +
    +
    +
    +
    +
    +

    The user’s government ID type.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case governmentIdType
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + language + +
    +
    +
    +
    +
    +
    +

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

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case language
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + lastName + +
    +
    +
    +
    +
    +
    +

    The user’s last name.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case lastName
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + middleName + +
    +
    +
    +
    +
    +
    +

    The user’s middle name.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case middleName
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + mobileNumber + +
    +
    +
    +
    +
    +
    +

    The user’s cell phone number.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case mobileNumber
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + passportId + +
    +
    +
    +
    +
    +
    +

    The user’s passport number.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case passportId
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + phoneNumber + +
    +
    +
    +
    +
    +
    +

    The user’s phone number.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case phoneNumber
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + postalCode + +
    +
    +
    +
    +
    +
    +

    The user’s postal code.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case postalCode
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + profileType + +
    +
    +
    +
    +
    +
    +

    The user’s postal code.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case profileType
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + programToken + +
    +
    +
    +
    +
    +
    +

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

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case programToken
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + stateProvince + +
    +
    +
    +
    +
    +
    +

    The user’s state, province or region.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case stateProvince
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + status + +
    +
    +
    +
    +
    +
    +

    The user account status.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case status
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + timeZone + +
    +
    +
    +
    +
    +
    +

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

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case timeZone
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + token + +
    +
    +
    +
    +
    +
    +

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

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case token
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + verificationStatus + +
    +
    +
    +
    +
    +
    +

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

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case verificationStatus
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/Classes/HyperwalletUser/VerificationStatus.html b/Classes/HyperwalletUser/VerificationStatus.html new file mode 100644 index 00000000..55ca2481 --- /dev/null +++ b/Classes/HyperwalletUser/VerificationStatus.html @@ -0,0 +1,523 @@ + + + + VerificationStatus Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + VerificationStatus Enumeration Reference +

+ +
+ +
+ +
+
+

VerificationStatus

+
+
+ + 
public enum VerificationStatus : String, Codable
+ +
+
+

Representation of the user’s verification status type.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + failed + +
    +
    +
    +
    +
    +
    +

    The user’s verification status is fail. Temporary status before changing to REQUIRED.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case failed = "FAILED"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + notRequired + +
    +
    +
    +
    +
    +
    +

    The user’s verification status is not require.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case notRequired = "NOT_REQUIRED"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + required + +
    +
    +
    +
    +
    +
    +

    The user’s verification status is require.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case required = "REQUIRED"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + underReview + +
    +
    +
    +
    +
    +
    +

    The user’s verification status is under review.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case underReview = "UNDER_REVIEW"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + verified + +
    +
    +
    +
    +
    +
    +

    The user’s verification status is verified.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case verified = "VERIFIED"
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/Classes/HyperwalletVenmoAccount.html b/Classes/HyperwalletVenmoAccount.html new file mode 100644 index 00000000..8d5065a1 --- /dev/null +++ b/Classes/HyperwalletVenmoAccount.html @@ -0,0 +1,471 @@ + + + + HyperwalletVenmoAccount Class Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + HyperwalletVenmoAccount Class Reference +

+ +
+ +
+ +
+
+

HyperwalletVenmoAccount

+
+
+ + 
@objcMembers
+public final class HyperwalletVenmoAccount : HyperwalletTransferMethod
+ +
+
+

Representation of the user’s Venmo account

+ +
+
+ +
+
+
+
    +
  • +
    + + + + init(from:) + +
    +
    +
    +
    +
    +
    +

    The required initializer

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public required init(from decoder: Decoder) throws
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + accountId + +
    +
    +
    +
    +
    +
    +

    The accountId as phone number.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var accountId: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + Builder + +
    +
    +
    +
    +
    +
    +

    A helper class to build the HyperwalletVenmoAccount instance.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public final class Builder
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/Classes/HyperwalletVenmoAccount/Builder.html b/Classes/HyperwalletVenmoAccount/Builder.html new file mode 100644 index 00000000..2c03ba5c --- /dev/null +++ b/Classes/HyperwalletVenmoAccount/Builder.html @@ -0,0 +1,637 @@ + + + + Builder Class Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + Builder Class Reference +

+ +
+ +
+ +
+
+

Builder

+
+
+ + 
public final class Builder
+ +
+
+

A helper class to build the HyperwalletVenmoAccount instance.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + init(token:) + +
    +
    +
    +
    +
    +
    +

    Creates a new instance of the HyperwalletVenmoAccount based on the required parameter to update +Venmo account.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public init(token: String)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + token + + +
    +

    The Venmo account token.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Creates a new instance of the HyperwalletVenmoAccount based on the required parameters to create +Venmo account.

    + +
    +
    +

    Declaration

    +
    +

    Swift

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

    Parameters

    + + + + + + + + + + + + + + + +
    + + transferMethodCountry + + +
    +

    The Venmo account country.

    +
    +
    + + transferMethodCurrency + + +
    +

    The Venmo account currency.

    +
    +
    + + transferMethodProfileType + + +
    +

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

    +
    +
    +
    +
    +
    +
    • +
  • +
    + + + + accountId(_:) + +
    +
    +
    +
    +
    +
    +

    Sets the accountId address

    + +
    +
    +

    Declaration

    +
    +

    Swift

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

    Parameters

    + + + + + + + +
    + + accountId + + +
    +

    The accountId as phone number user want to create a Venmo account

    +
    +
    +
    +
    +

    Return Value

    +

    a self HyperwalletVenmoAccount.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + profileType(_:) + +
    +
    +
    +
    +
    +
    +

    Sets the bank account holder’s profile type.

    + +
    +
    +

    Declaration

    +
    +

    Swift

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

    Parameters

    + + + + + + + +
    + + profileType + + +
    +

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

    +
    +
    +
    +
    +

    Return Value

    +

    a self HyperwalletVenmoAccount.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + build() + +
    +
    +
    +
    +
    +
    +

    Builds a new instance of the HyperwalletVenmoAccount.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func build() -> HyperwalletVenmoAccount
    + +
    +
    +
    +

    Return Value

    +

    a new instance of the HyperwalletVenmoAccount.

    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/Classes/HyperwalletVenmoQueryParam.html b/Classes/HyperwalletVenmoQueryParam.html new file mode 100644 index 00000000..0fa7a27b --- /dev/null +++ b/Classes/HyperwalletVenmoQueryParam.html @@ -0,0 +1,414 @@ + + + + HyperwalletVenmoQueryParam Class Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + HyperwalletVenmoQueryParam Class Reference +

+ +
+ +
+ +
+
+

HyperwalletVenmoQueryParam

+
+
+ + 
public class HyperwalletVenmoQueryParam : HyperwalletTransferMethodQueryParam
+ +
+
+

Representation of the common Venmo’s query parameters.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + toQuery() + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    override public func toQuery() -> [String : String]
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/Classes/QueryParam.html b/Classes/QueryParam.html new file mode 100644 index 00000000..dda9fa54 --- /dev/null +++ b/Classes/QueryParam.html @@ -0,0 +1,552 @@ + + + + QueryParam Class Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + QueryParam Class Reference +

+ +
+ +
+ +
+
+

QueryParam

+
+
+ + 
public class QueryParam
+ +
+
+

Representation of the common query parameters.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + createdAfter + +
    +
    +
    +
    +
    +
    +

    Returns user receipts created after this datetime.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var createdAfter: Date?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + createdBefore + +
    +
    +
    +
    +
    +
    +

    Returns user receipts created before this datetime.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var createdBefore: Date?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + limit + +
    +
    +
    +
    +
    +
    +

    The maximum number of records that will be returned per page

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var limit: Int?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + offset + +
    +
    +
    +
    +
    +
    +

    The number of records to skip. If no filters are applied, records will be skipped from the beginning +(based on default sort criteria). Default value is 0. Range is from 0 to {n-1} where n = number of +matching records for the query.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var offset: Int?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + sortBy + +
    +
    +
    +
    +
    +
    +

    The user receipts attribute to sort the result set by.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var sortBy: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + init() + +
    +
    +
    +
    +
    +
    +

    Creates a new instance of QueryParam]

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public init()
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/Enums.html b/Enums.html new file mode 100644 index 00000000..05ccd59a --- /dev/null +++ b/Enums.html @@ -0,0 +1,493 @@ + + + + Enumerations Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + Enumerations Reference +

+ +
+ +
+ +
+
+

Enumerations

+

The following enumerations are available globally.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + HyperwalletErrorType + +
    +
    +
    +
    +
    +
    +

    The HyperwalletErrorType is the error type returned By Hyperwallet SDK.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public enum HyperwalletErrorType : Error, LocalizedError
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The HyperwalletAuthenticationErrorType is the authentication error type returned By Hyperwallet SDK.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public enum HyperwalletAuthenticationErrorType : LocalizedError
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + HyperwalletErrorGroup + +
    +
    +
    +
    +
    +
    +

    Representation of the error type group

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public enum HyperwalletErrorGroup : String
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + HyperwalletDataType + +
    +
    +
    +
    +
    +
    +

    Representation of the transfer method configuration field data type

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public enum HyperwalletDataType : String, Codable
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/Enums/HyperwalletAuthenticationErrorType.html b/Enums/HyperwalletAuthenticationErrorType.html new file mode 100644 index 00000000..c0e0eebe --- /dev/null +++ b/Enums/HyperwalletAuthenticationErrorType.html @@ -0,0 +1,479 @@ + + + + HyperwalletAuthenticationErrorType Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + HyperwalletAuthenticationErrorType Enumeration Reference +

+ +
+ +
+ +
+
+

HyperwalletAuthenticationErrorType

+
+
+ + 
public enum HyperwalletAuthenticationErrorType : LocalizedError
+ +
+
+

The HyperwalletAuthenticationErrorType is the authentication error type returned By Hyperwallet SDK.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + expired(_:) + +
    +
    +
    +
    +
    +
    + +
      +
    • expired: Returned when the authenticated session is expired
      • +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case expired(_: String)
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + unexpected(_:) + +
    +
    +
    +
    +
    +
    + +
      +
    • unexpected: Returned when an unexpected behavior happened.
      • +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case unexpected(_: String)
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + message() + +
    +
    +
    +
    +
    +
    +

    Gets the AuthenticationErrorType error message

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func message() -> String
    + +
    +
    +
    +

    Return Value

    +

    An error message detail

    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/Enums/HyperwalletDataType.html b/Enums/HyperwalletDataType.html new file mode 100644 index 00000000..026b6b8d --- /dev/null +++ b/Enums/HyperwalletDataType.html @@ -0,0 +1,685 @@ + + + + HyperwalletDataType Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + HyperwalletDataType Enumeration Reference +

+ +
+ +
+ +
+
+

HyperwalletDataType

+
+
+ + 
public enum HyperwalletDataType : String, Codable
+ +
+
+

Representation of the transfer method configuration field data type

+ +
+
+ +
+
+
+
    +
  • +
    + + + + text + +
    +
    +
    +
    +
    +
    +

    The text field type

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case text = "TEXT"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + selection + +
    +
    +
    +
    +
    +
    +

    The selecion option field type

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case selection = "SELECTION"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + boolean + +
    +
    +
    +
    +
    +
    +

    The boolean field type

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case boolean = "BOOLEAN"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + number + +
    +
    +
    +
    +
    +
    +

    The numeric field type

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case number = "NUMBER"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + range + +
    +
    +
    +
    +
    +
    +

    The range field type

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case range = "RANGE"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + date + +
    +
    +
    +
    +
    +
    +

    The date field type

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case date = "DATE"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + datetime + +
    +
    +
    +
    +
    +
    +

    The datetime field type

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case datetime = "DATETIME"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + expiryDate + +
    +
    +
    +
    +
    +
    +

    The expiry date field type

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case expiryDate = "EXPIRY_DATE"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + phone + +
    +
    +
    +
    +
    +
    +

    The phone field type

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case phone = "PHONE"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + email + +
    +
    +
    +
    +
    +
    +

    The email field type

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case email = "EMAIL"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + file + +
    +
    +
    +
    +
    +
    +

    The file field type

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case file = "FILE"
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/Enums/HyperwalletErrorGroup.html b/Enums/HyperwalletErrorGroup.html new file mode 100644 index 00000000..86ffd4c0 --- /dev/null +++ b/Enums/HyperwalletErrorGroup.html @@ -0,0 +1,496 @@ + + + + HyperwalletErrorGroup Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + HyperwalletErrorGroup Enumeration Reference +

+ +
+ +
+ +
+
+

HyperwalletErrorGroup

+
+
+ + 
public enum HyperwalletErrorGroup : String
+ +
+
+

Representation of the error type group

+ +
+
+ +
+
+
+
    +
  • +
    + + + + business + +
    +
    +
    +
    +
    +
    +

    Returned when a business error is thrown

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case business = "BUSINESS_ERROR"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + unexpected + +
    +
    +
    +
    +
    +
    +

    Returned when an unexpected error is thrown

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case unexpected = "UNEXPECTED_ERROR"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + connection + +
    +
    +
    +
    +
    +
    +

    Returned when a connection error is thrown

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case connection = "CONNECTION_ERROR"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + authentication + +
    +
    +
    +
    +
    +
    +

    Returned when a authentication error is thrown

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case authentication = "AUTHENTICATION_ERROR"
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/Enums/HyperwalletErrorType.html b/Enums/HyperwalletErrorType.html new file mode 100644 index 00000000..b647041c --- /dev/null +++ b/Enums/HyperwalletErrorType.html @@ -0,0 +1,778 @@ + + + + HyperwalletErrorType Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + HyperwalletErrorType Enumeration Reference +

+ +
+ +
+ +
+
+

HyperwalletErrorType

+
+
+ + 
public enum HyperwalletErrorType : Error, LocalizedError
+ +
+
+

The HyperwalletErrorType is the error type returned By Hyperwallet SDK.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + http(_:_:) + +
    +
    +
    +
    +
    +
    +

    Returned when an HTTP code is not in the range 2xx.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case http(_: HyperwalletErrors, _: Int)
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + parseError(_:) + +
    +
    +
    +
    +
    +
    +

    Returned when a response parser process throws error.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case parseError(_: HyperwalletErrors)
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + notInitialized(_:) + +
    +
    +
    +
    +
    +
    +

    Returned when the SDK was not initialized properly.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case notInitialized(_: HyperwalletErrors)
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + invalidUrl(_:) + +
    +
    +
    +
    +
    +
    +

    Returned when a provided URL is not valid

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case invalidUrl(_: HyperwalletErrors)
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Returned when a transaction is explicitly aborted.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case transactionAborted(_: HyperwalletErrors)
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Returned on authentication failure

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case authenticationError(_: HyperwalletAuthenticationErrorType)
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + unexpected(_:) + +
    +
    +
    +
    +
    +
    +

    Returned when an unexpected behavior happened.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case unexpected(_: HyperwalletErrors)
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + graphQlErrors(_:) + +
    +
    +
    +
    +
    +
    +

    Returned when a GraphQL parser process throws error.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case graphQlErrors(_: HyperwalletErrors)
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + invalidRequest(_:) + +
    +
    +
    +
    +
    +
    +

    Returned when some step-in builds the request throws error.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case invalidRequest(_: HyperwalletErrors)
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + connectionError(_:) + +
    +
    +
    +
    +
    +
    +

    Returned when during the connection process throws error.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case connectionError(_: HyperwalletErrors)
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + group + +
    +
    +
    +
    +
    +
    +

    The error type group

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var group: HyperwalletErrorGroup { get }
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Gets the HyperwalletErrors based on the ErrorType

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func getHyperwalletErrors() -> HyperwalletErrors?
    + +
    +
    +
    +

    Return Value

    +

    An instance of HyperwalletErrors or nil

    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Gets the AuthenticationErrorType on the ErrorType

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func getAuthenticationError() -> HyperwalletAuthenticationErrorType?
    + +
    +
    +
    +

    Return Value

    +

    An instance of AuthenticationErrorType or nil

    +
    +
    +
    +
    • +
  • +
    + + + + getHttpCode() + +
    +
    +
    +
    +
    +
    +

    Gets the HTTP Code based on the ErrorType.http

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func getHttpCode() -> Int?
    + +
    +
    +
    +

    Return Value

    +

    The HTTP Code or return nil

    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/Extensions.html b/Extensions.html new file mode 100644 index 00000000..20b5b17c --- /dev/null +++ b/Extensions.html @@ -0,0 +1,409 @@ + + + + Extensions Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + Extensions Reference +

+ +
+ +
+ +
+
+

Extensions

+

The following extensions are available globally.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + ISO8601DateFormatter + +
    +
    +
    +
    +
    +
    +

    Date extension.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public extension ISO8601DateFormatter
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/Extensions/ISO8601DateFormatter.html b/Extensions/ISO8601DateFormatter.html new file mode 100644 index 00000000..042704dd --- /dev/null +++ b/Extensions/ISO8601DateFormatter.html @@ -0,0 +1,416 @@ + + + + ISO8601DateFormatter Extension Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + ISO8601DateFormatter Extension Reference +

+ +
+ +
+ +
+
+

ISO8601DateFormatter

+
+
+ + 
public extension ISO8601DateFormatter
+ +
+
+

Date extension.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + ignoreTimeZone + +
    +
    +
    +
    +
    +
    +

    The thread-safe date formatter to work with ISO8601 date representations. + The time zone is ignored.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    static let ignoreTimeZone: ISO8601DateFormatter
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/Guides.html b/Guides.html new file mode 100644 index 00000000..e2ee1cb8 --- /dev/null +++ b/Guides.html @@ -0,0 +1,399 @@ + + + + Guides Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + Guides Reference +

+ +
+ +
+ +
+
+

Guides

+

The following guides are available globally.

+ +
+
+ +
+
+
+ +
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/Protocols.html b/Protocols.html new file mode 100644 index 00000000..f8e5d133 --- /dev/null +++ b/Protocols.html @@ -0,0 +1,501 @@ + + + + Protocols Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + Protocols Reference +

+ +
+ +
+ +
+
+

Protocols

+

The following protocols are available globally.

+ +
+
+ +
+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    The HyperwalletAuthenticationTokenProvider protocol provides the Hyperwallet iOS Core SDK with an +abstraction to retrieve an authentication token. An authentication token is a JSON Web Token that will be used +to authenticate the User to the Hyperwallet platform.

    + +

    Implementations of HyperwalletAuthenticationTokenProvider are expected to be non-blocking and thread safe.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public protocol HyperwalletAuthenticationTokenProvider
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The HyperwalletTransferMethodConfigurationField protocol for processing the transfer method +configuration field result from the Hyperwallet platform.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public protocol HyperwalletTransferMethodConfigurationField
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The HyperwalletTransferMethodConfigurationKey protocol for processing the transfer method configuration +key result from the Hyperwallet platform.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public protocol HyperwalletTransferMethodConfigurationKey
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The HyperwalletTransferMethodUpdateConfigurationField protocol for processing the update transfer method +configuration field result from the Hyperwallet platform.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public protocol HyperwalletTransferMethodUpdateConfigurationField
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/Protocols/HyperwalletAuthenticationTokenProvider.html b/Protocols/HyperwalletAuthenticationTokenProvider.html new file mode 100644 index 00000000..59790d43 --- /dev/null +++ b/Protocols/HyperwalletAuthenticationTokenProvider.html @@ -0,0 +1,511 @@ + + + + HyperwalletAuthenticationTokenProvider Protocol Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + HyperwalletAuthenticationTokenProvider Protocol Reference +

+ +
+ +
+ +
+
+

HyperwalletAuthenticationTokenProvider

+
+
+ + 
@objc
+public protocol HyperwalletAuthenticationTokenProvider
+ +
+
+

The HyperwalletAuthenticationTokenProvider protocol provides the Hyperwallet iOS Core SDK with an +abstraction to retrieve an authentication token. An authentication token is a JSON Web Token that will be used +to authenticate the User to the Hyperwallet platform.

+ +

Implementations of HyperwalletAuthenticationTokenProvider are expected to be non-blocking and thread safe.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + CompletionHandler + +
    +
    +
    +
    +
    +
    +

    A callback interface to handle the submission of an authentication token or an error message in case of failure.

    + +

    The authentication token is a JSON web token that contains as part of its claim set the principal that will +be interacting with the Hyperwallet platform.

    + +

    Authentication token will be used until it expires.

    + +

    The HyperwalletAuthenticationErrorType will contain error in case authentication token +is not retrieved successfully.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    typealias CompletionHandler = (_ authenticationToken: String?, _ error: Error?) -> Void
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + authenticationToken + + +
    +

    a JWT token identifying a Hyperwallet User principal

    +
    +
    + + error + + +
    +

    an HyperwalletAuthenticationErrorType indicating the cause of the authentication + token retrieval error

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Invoked when the Hyperwallet iOS Core SDK requires an authentication token.

    + +

    Implementations of this function are expected to call the +HyperwalletAuthenticationTokenProvider.CompletionHandler(String, nil) method when an authentication token is +retrieved and the HyperwalletAuthenticationTokenProvider.CompletionHandler(nil, AuthenticationErrorType) +when an authentication token is not retrieved.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    func retrieveAuthenticationToken(completionHandler: @escaping CompletionHandler)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + completionHandler + + +
    +

    A completion handler for authentication tokens

    +
    +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/Protocols/HyperwalletTransferMethodConfigurationField.html b/Protocols/HyperwalletTransferMethodConfigurationField.html new file mode 100644 index 00000000..7614e9f2 --- /dev/null +++ b/Protocols/HyperwalletTransferMethodConfigurationField.html @@ -0,0 +1,451 @@ + + + + HyperwalletTransferMethodConfigurationField Protocol Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + HyperwalletTransferMethodConfigurationField Protocol Reference +

+ +
+ +
+ +
+
+

HyperwalletTransferMethodConfigurationField

+
+
+ + 
public protocol HyperwalletTransferMethodConfigurationField
+ +
+
+

The HyperwalletTransferMethodConfigurationField protocol for processing the transfer method +configuration field result from the Hyperwallet platform.

+ +
+
+ +
+
+
+ +
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/Protocols/HyperwalletTransferMethodConfigurationKey.html b/Protocols/HyperwalletTransferMethodConfigurationKey.html new file mode 100644 index 00000000..70ab07ae --- /dev/null +++ b/Protocols/HyperwalletTransferMethodConfigurationKey.html @@ -0,0 +1,532 @@ + + + + HyperwalletTransferMethodConfigurationKey Protocol Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + HyperwalletTransferMethodConfigurationKey Protocol Reference +

+ +
+ +
+ +
+
+

HyperwalletTransferMethodConfigurationKey

+
+
+ + 
public protocol HyperwalletTransferMethodConfigurationKey
+ +
+
+

The HyperwalletTransferMethodConfigurationKey protocol for processing the transfer method configuration +key result from the Hyperwallet platform.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + countries() + +
    +
    +
    +
    +
    +
    +

    Returns the list of countries

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    func countries() -> [HyperwalletCountry]?
    + +
    +
    +
    +

    Return Value

    +

    a list of HyperwalletCountry object

    +
    +
    +
    +
    • +
  • +
    + + + + currencies(from:) + +
    +
    +
    +
    +
    +
    +

    Returns the list of currencies based on the country

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    func currencies(from countryCode: String) -> [HyperwalletCurrency]?
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + countryCode + + +
    +

    the 2 letter ISO 3166-1 country code

    +
    +
    +
    +
    +

    Return Value

    +

    a list of HyperwalletCurrency object

    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Returns the list of transfer method types based on the parameters

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    func transferMethodTypes(countryCode: String, currencyCode: String) -> [HyperwalletTransferMethodType]?
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + countryCode + + +
    +

    the 2 letter ISO 3166-1 country code

    +
    +
    + + currencyCode + + +
    +

    the 3 letter ISO 4217-1 currency code

    +
    +
    +
    +
    +

    Return Value

    +

    a list of HyperwalletTransferMethodTypes

    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/Protocols/HyperwalletTransferMethodUpdateConfigurationField.html b/Protocols/HyperwalletTransferMethodUpdateConfigurationField.html new file mode 100644 index 00000000..0a52147c --- /dev/null +++ b/Protocols/HyperwalletTransferMethodUpdateConfigurationField.html @@ -0,0 +1,420 @@ + + + + HyperwalletTransferMethodUpdateConfigurationField Protocol Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + HyperwalletTransferMethodUpdateConfigurationField Protocol Reference +

+ +
+ +
+ +
+
+

HyperwalletTransferMethodUpdateConfigurationField

+
+
+ + 
public protocol HyperwalletTransferMethodUpdateConfigurationField
+ +
+
+

The HyperwalletTransferMethodUpdateConfigurationField protocol for processing the update transfer method +configuration field result from the Hyperwallet platform.

+ +
+
+ +
+
+
+ +
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/Structs.html b/Structs.html new file mode 100644 index 00000000..173da0d9 --- /dev/null +++ b/Structs.html @@ -0,0 +1,1208 @@ + + + + Structures Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + Structures Reference +

+ +
+ +
+ +
+
+

Structures

+

The following structures are available globally.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + Configuration + +
    +
    +
    +
    +
    +
    +

    Configuration object retrieved on successful authentication

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public struct Configuration : Codable
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + HyperwalletErrors + +
    +
    +
    +
    +
    +
    +

    Representation of the Hyperwallet error list

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public struct HyperwalletErrors : Decodable
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + HyperwalletError + +
    +
    +
    +
    +
    +
    +

    Representation of the Hyperwallet error entity.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public struct HyperwalletError : Decodable
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + HyperwalletBalance + +
    +
    +
    +
    +
    +
    +

    Details of the balance.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public struct HyperwalletBalance : Decodable
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + Connection + +
    +
    +
    +
    +
    +
    +

    Representation of the GraphQL’s Connection type

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public struct Connection<T> : Codable where T : Decodable, T : Encodable
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + HyperwalletCountry + +
    +
    +
    +
    +
    +
    +

    Representation of a HyperwalletCountry node

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public struct HyperwalletCountry : Codable
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + HyperwalletCurrency + +
    +
    +
    +
    +
    +
    +

    Representation of a HyperwalletCurrency node

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public struct HyperwalletCurrency : Codable
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + HyperwalletFee + +
    +
    +
    +
    +
    +
    +

    Representation of the fee

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public struct HyperwalletFee : Codable, Hashable
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + HyperwalletField + +
    +
    +
    +
    +
    +
    +

    Representation of the transfer method configuration field

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public struct HyperwalletField : Codable
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + HyperwalletFieldGroup + +
    +
    +
    +
    +
    +
    +

    Representation of list of HyperwalletField and the group to which it belongs

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public struct HyperwalletFieldGroup : Codable
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Representation of the transfer method configuration field selection option

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public struct HyperwalletFieldSelectionOption : Codable
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Representation of the transfer method configuration field processing times

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public struct HyperwalletProcessingTime : Codable
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Representation of transfer method type

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public struct HyperwalletTransferMethodType : Codable
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Representation of the transfer method configuration field validation message

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public struct HyperwalletValidationMessage : Codable
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Representation of the transfer method configuration

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public struct HyperwalletTransferMethodConfiguration : Codable
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + HyperwalletMask + +
    +
    +
    +
    +
    +
    +

    Representation of the transfer method configuration field mask

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public struct HyperwalletMask : Codable
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Representation of the transfer method configuration field conditionalPatterns

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public struct HyperwalletConditionalPattern : Codable
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The HyperwalletTransferMethodConfigurationFieldQuery struct defines and builds a query to retrieve the fields +required to create a transfer method (Bank Account, Bank Card, PayPal Account, Prepaid Card, Paper Check) +with the Hyperwallet platform.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public struct HyperwalletTransferMethodConfigurationFieldQuery : GraphQlQuery, Hashable
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The ‘HyperwalletTransferMethodConfigurationKeysQuery’ struct defines and builds a query to retrieve the key set +that is required to construct a HyperwalletTransferMethodConfigurationFieldQuery.

    + +

    In addition to the key set, the query will also retrieve the processing time and fees associated with each +country, currency and transfer method type tuple.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public struct HyperwalletTransferMethodConfigurationKeysQuery : GraphQlQuery
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The ‘HyperwalletTransferMethodTypesFeesAndProcessingTimesQuery’ struct defines +and builds a query to retrieve the processing time and fees associated with each country, currency +and transfer method type tuple. +that is required to construct a HyperwalletTransferMethodConfigurationFieldQuery.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public struct HyperwalletTransferMethodTypesFeesAndProcessingTimesQuery : GraphQlQuery, Hashable
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The HyperwalletTransferMethodUpdateConfigurationFieldQuery +struct defines and builds a query to retrieve the fields +required to update a transfer method (Bank Account, Bank Card, PayPal Account, Prepaid Card, Paper Check and Venmo) +with the Hyperwallet platform.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public struct HyperwalletTransferMethodUpdateConfigurationFieldQuery : GraphQlQuery, Hashable
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + HyperwalletPageList + +
    +
    +
    +
    +
    +
    +

    Representation of subset content from a dataset

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public struct HyperwalletPageList<ListType> : Decodable where ListType : Decodable
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + HyperwalletPageLink + +
    +
    +
    +
    +
    +
    +

    Representation of the page link

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public struct HyperwalletPageLink : Decodable
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Representation of the relationship between the current document and the linked document

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public struct HyperwalletPageParameter : Decodable
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Details of the transaction.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public struct HyperwalletReceiptDetails : Decodable
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + HyperwalletReceipt + +
    +
    +
    +
    +
    +
    +

    Representation of the Hyperwallet’s receipt.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public struct HyperwalletReceipt : Decodable, Equatable
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Representation of the status transition.

    + +

    The status transition describes a status change for an existing bank account, bank card, PayPal account, +prepaid card, paper check or payment.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public struct HyperwalletStatusTransition : Codable
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Representation of a HyperwalletForeignExchange

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public struct HyperwalletForeignExchange : Codable
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + HyperwalletTransfer + +
    +
    +
    +
    +
    +
    +

    Representation of a HyperwalletTransfer

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public struct HyperwalletTransfer : Codable
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/Structs/Configuration.html b/Structs/Configuration.html new file mode 100644 index 00000000..3d84c083 --- /dev/null +++ b/Structs/Configuration.html @@ -0,0 +1,523 @@ + + + + Configuration Structure Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + Configuration Structure Reference +

+ +
+ +
+ +
+
+

Configuration

+
+
+ + 
public struct Configuration : Codable
+ +
+
+

Configuration object retrieved on successful authentication

+ +
+
+ +
+
+
+
    +
  • +
    + + + + environment + +
    +
    +
    +
    +
    +
    +

    The environment type

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let environment: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + insightsUrl + +
    +
    +
    +
    +
    +
    +

    The insights Url

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let insightsUrl: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + issuer + +
    +
    +
    +
    +
    +
    +

    The issuer

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let issuer: String
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + userToken + +
    +
    +
    +
    +
    +
    +

    The user token

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let userToken: String
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + programModel + +
    +
    +
    +
    +
    +
    +

    The program model

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let programModel: String?
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/Structs/Connection.html b/Structs/Connection.html new file mode 100644 index 00000000..fc8555e8 --- /dev/null +++ b/Structs/Connection.html @@ -0,0 +1,415 @@ + + + + Connection Structure Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + Connection Structure Reference +

+ +
+ +
+ +
+
+

Connection

+
+
+ + 
public struct Connection<T> : Codable where T : Decodable, T : Encodable
+ +
+
+

Representation of the GraphQL’s Connection type

+ +
+
+ +
+
+
+
    +
  • +
    + + + + nodes + +
    +
    +
    +
    +
    +
    +

    Array of Connection type

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let nodes: [T]?
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/Structs/HyperwalletBalance.html b/Structs/HyperwalletBalance.html new file mode 100644 index 00000000..227221b3 --- /dev/null +++ b/Structs/HyperwalletBalance.html @@ -0,0 +1,442 @@ + + + + HyperwalletBalance Structure Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + HyperwalletBalance Structure Reference +

+ +
+ +
+ +
+
+

HyperwalletBalance

+
+
+ + 
public struct HyperwalletBalance : Decodable
+ +
+
+

Details of the balance.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + currency + +
    +
    +
    +
    +
    +
    +

    The currency of balance

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let currency: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + amount + +
    +
    +
    +
    +
    +
    +

    The amount of balance

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let amount: String?
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/Structs/HyperwalletConditionalPattern.html b/Structs/HyperwalletConditionalPattern.html new file mode 100644 index 00000000..932b9394 --- /dev/null +++ b/Structs/HyperwalletConditionalPattern.html @@ -0,0 +1,442 @@ + + + + HyperwalletConditionalPattern Structure Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + HyperwalletConditionalPattern Structure Reference +

+ +
+ +
+ +
+
+

HyperwalletConditionalPattern

+
+
+ + 
public struct HyperwalletConditionalPattern : Codable
+ +
+
+

Representation of the transfer method configuration field conditionalPatterns

+ +
+
+ +
+
+
+
    +
  • +
    + + + + pattern + +
    +
    +
    +
    +
    +
    +

    The pattern

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let pattern: String
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + regex + +
    +
    +
    +
    +
    +
    +

    The regex

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let regex: String
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/Structs/HyperwalletCountry.html b/Structs/HyperwalletCountry.html new file mode 100644 index 00000000..a8f0db3a --- /dev/null +++ b/Structs/HyperwalletCountry.html @@ -0,0 +1,469 @@ + + + + HyperwalletCountry Structure Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + HyperwalletCountry Structure Reference +

+ +
+ +
+ +
+
+

HyperwalletCountry

+
+
+ + 
public struct HyperwalletCountry : Codable
+ +
+
+

Representation of a HyperwalletCountry node

+ +
+
+ +
+
+
+
    +
  • +
    + + + + code + +
    +
    +
    +
    +
    +
    +

    The 2 letter ISO 3166-1 country code

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let code: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + name + +
    +
    +
    +
    +
    +
    +

    The country name

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let name: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + currencies + +
    +
    +
    +
    +
    +
    +

    The HyperwalletCurrency nodes that connect to this country node

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let currencies: Connection<HyperwalletCurrency>?
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/Structs/HyperwalletCurrency.html b/Structs/HyperwalletCurrency.html new file mode 100644 index 00000000..a87f6787 --- /dev/null +++ b/Structs/HyperwalletCurrency.html @@ -0,0 +1,469 @@ + + + + HyperwalletCurrency Structure Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + HyperwalletCurrency Structure Reference +

+ +
+ +
+ +
+
+

HyperwalletCurrency

+
+
+ + 
public struct HyperwalletCurrency : Codable
+ +
+
+

Representation of a HyperwalletCurrency node

+ +
+
+ +
+
+
+
    +
  • +
    + + + + code + +
    +
    +
    +
    +
    +
    +

    The 3 letter ISO 4217-1 currency code

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let code: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + name + +
    +
    +
    +
    +
    +
    +

    The currency name

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let name: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + transferMethodTypes + +
    +
    +
    +
    +
    +
    +

    The HyperwalletTransferMethodType nodes that connect to this currency node

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let transferMethodTypes: Connection<HyperwalletTransferMethodType>?
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/Structs/HyperwalletError.html b/Structs/HyperwalletError.html new file mode 100644 index 00000000..31fb4730 --- /dev/null +++ b/Structs/HyperwalletError.html @@ -0,0 +1,578 @@ + + + + HyperwalletError Structure Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + HyperwalletError Structure Reference +

+ +
+ +
+ +
+
+

HyperwalletError

+
+
+ + 
public struct HyperwalletError : Decodable
+ +
+
+

Representation of the Hyperwallet error entity.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + message + +
    +
    +
    +
    +
    +
    +

    The error message

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public private(set) var message: String { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + code + +
    +
    +
    +
    +
    +
    +

    The error code

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public private(set) var code: String { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + fieldName + +
    +
    +
    +
    +
    +
    +

    The field name

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public private(set) var fieldName: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + relatedResources + +
    +
    +
    +
    +
    +
    +

    The list of related resources

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public private(set) var relatedResources: [String]? { get }
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Creates an instance of HyperwalletError

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public init(message: String, code: String, fieldName: String? = nil, relatedResources: [String]? = nil)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + +
    + + message + + +
    +

    The error message

    +
    +
    + + code + + +
    +

    The error code

    +
    +
    + + fieldName + + +
    +

    The field name. By the default is nil

    +
    +
    + + relatedResources + + +
    +

    The list of related resources. By the default is nil

    +
    +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/Structs/HyperwalletErrors.html b/Structs/HyperwalletErrors.html new file mode 100644 index 00000000..ad42a97a --- /dev/null +++ b/Structs/HyperwalletErrors.html @@ -0,0 +1,574 @@ + + + + HyperwalletErrors Structure Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + HyperwalletErrors Structure Reference +

+ +
+ +
+ +
+
+

HyperwalletErrors

+
+
+ + 
public struct HyperwalletErrors : Decodable
+ +
+
+

Representation of the Hyperwallet error list

+ +
+
+ +
+
+
+
    +
  • +
    + + + + errorList + +
    +
    +
    +
    +
    +
    +

    The error list

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public private(set) var errorList: [HyperwalletError]? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + originalError + +
    +
    +
    +
    +
    +
    +

    The original error

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public private(set) var originalError: Error? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + CodingKeys + +
    +
    +
    +
    +
    +
    +

    The CodingKeys for Hyperwallet errors

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public enum CodingKeys : String, CodingKey
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + init(errorList:) + +
    +
    +
    +
    +
    +
    +

    Creates an instance of HyperwalletErrors

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public init(errorList: [HyperwalletError])
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + errorList + + +
    +

    The HyperwalletError list.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Creates an instance of HyperwalletErrors

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public init(errorList: [HyperwalletError], originalError: Error?)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + errorList + + +
    +

    The HyperwalletError list.

    +
    +
    + + originalError + + +
    +

    The original error.

    +
    +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/Structs/HyperwalletErrors/CodingKeys.html b/Structs/HyperwalletErrors/CodingKeys.html new file mode 100644 index 00000000..e00cf2eb --- /dev/null +++ b/Structs/HyperwalletErrors/CodingKeys.html @@ -0,0 +1,418 @@ + + + + CodingKeys Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + CodingKeys Enumeration Reference +

+ +
+ +
+ +
+
+

CodingKeys

+
+
+ + 
public enum CodingKeys : String, CodingKey
+ +
+
+

The CodingKeys for Hyperwallet errors

+ +
+
+ +
+
+
+
    +
  • +
    + + + + errorList + +
    +
    +
    +
    +
    +
    + +
      +
    • errorList: The list of errors
      • +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case errorList = "errors"
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/Structs/HyperwalletFee.html b/Structs/HyperwalletFee.html new file mode 100644 index 00000000..1705ad48 --- /dev/null +++ b/Structs/HyperwalletFee.html @@ -0,0 +1,523 @@ + + + + HyperwalletFee Structure Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + HyperwalletFee Structure Reference +

+ +
+ +
+ +
+
+

HyperwalletFee

+
+
+ + 
public struct HyperwalletFee : Codable, Hashable
+ +
+
+

Representation of the fee

+ +
+
+ +
+
+
+
    +
  • +
    + + + + feeRateType + +
    +
    +
    +
    +
    +
    +

    The fee rate type (FLAT or PERCENT)

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let feeRateType: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + value + +
    +
    +
    +
    +
    +
    +

    The fee value

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var value: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + currency + +
    +
    +
    +
    +
    +
    +

    The fee currency

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var currency: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + minimum + +
    +
    +
    +
    +
    +
    +

    The minimum fee, or nil if none exists

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let minimum: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + maximum + +
    +
    +
    +
    +
    +
    +

    The maximum fee, or nil if none exists

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let maximum: String?
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/Structs/HyperwalletField.html b/Structs/HyperwalletField.html new file mode 100644 index 00000000..f8227f43 --- /dev/null +++ b/Structs/HyperwalletField.html @@ -0,0 +1,766 @@ + + + + HyperwalletField Structure Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + HyperwalletField Structure Reference +

+ +
+ +
+ +
+
+

HyperwalletField

+
+
+ + 
public struct HyperwalletField : Codable
+ +
+
+

Representation of the transfer method configuration field

+ +
+
+ +
+
+
+
    +
  • +
    + + + + dataType + +
    +
    +
    +
    +
    +
    +

    The field data type, or nil if none exists

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let dataType: HyperwalletDataType.RawValue?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + fieldSelectionOptions + +
    +
    +
    +
    +
    +
    +

    The list of selection option, or nil if none exists

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let fieldSelectionOptions: [HyperwalletFieldSelectionOption]?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + isRequired + +
    +
    +
    +
    +
    +
    +

    Indicate if the field is mandatory, or nil if none exists

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let isRequired: Bool?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + isEditable + +
    +
    +
    +
    +
    +
    +

    Indicate if the field is editable, or nil if none exists

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let isEditable: Bool?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + label + +
    +
    +
    +
    +
    +
    +

    The field label

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let label: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + maxLength + +
    +
    +
    +
    +
    +
    +

    The field maximum length, or nil if none exists

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let maxLength: Int?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + minLength + +
    +
    +
    +
    +
    +
    +

    The field minimum length, or nil if none exists

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let minLength: Int?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + name + +
    +
    +
    +
    +
    +
    +

    The field name, or nil if none exists

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let name: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + placeholder + +
    +
    +
    +
    +
    +
    +

    The field placeholder, or nil if none exists

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let placeholder: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + regularExpression + +
    +
    +
    +
    +
    +
    +

    The regular expression to validate the field value, or nil if none exists

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let regularExpression: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + validationMessage + +
    +
    +
    +
    +
    +
    +

    The validation message

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let validationMessage: HyperwalletValidationMessage?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + value + +
    +
    +
    +
    +
    +
    +

    The field value

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let value: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + mask + +
    +
    +
    +
    +
    +
    +

    The mask, or nil if none exists

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let mask: HyperwalletMask?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + fieldValueMasked + +
    +
    +
    +
    +
    +
    +

    Indicate if the field is masked, or nil if none exists

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let fieldValueMasked: Bool?
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/Structs/HyperwalletFieldGroup.html b/Structs/HyperwalletFieldGroup.html new file mode 100644 index 00000000..32fc413c --- /dev/null +++ b/Structs/HyperwalletFieldGroup.html @@ -0,0 +1,442 @@ + + + + HyperwalletFieldGroup Structure Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + HyperwalletFieldGroup Structure Reference +

+ +
+ +
+ +
+
+

HyperwalletFieldGroup

+
+
+ + 
public struct HyperwalletFieldGroup : Codable
+ +
+
+

Representation of list of HyperwalletField and the group to which it belongs

+ +
+
+ +
+
+
+
    +
  • +
    + + + + group + +
    +
    +
    +
    +
    +
    +

    The group

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let group: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + fields + +
    +
    +
    +
    +
    +
    +

    The list of HyperwalletField

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let fields: [HyperwalletField]?
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/Structs/HyperwalletFieldSelectionOption.html b/Structs/HyperwalletFieldSelectionOption.html new file mode 100644 index 00000000..57d8d1c3 --- /dev/null +++ b/Structs/HyperwalletFieldSelectionOption.html @@ -0,0 +1,442 @@ + + + + HyperwalletFieldSelectionOption Structure Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + HyperwalletFieldSelectionOption Structure Reference +

+ +
+ +
+ +
+
+

HyperwalletFieldSelectionOption

+
+
+ + 
public struct HyperwalletFieldSelectionOption : Codable
+ +
+
+

Representation of the transfer method configuration field selection option

+ +
+
+ +
+
+
+
    +
  • +
    + + + + label + +
    +
    +
    +
    +
    +
    +

    The label

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let label: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + value + +
    +
    +
    +
    +
    +
    +

    The value

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let value: String?
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/Structs/HyperwalletForeignExchange.html b/Structs/HyperwalletForeignExchange.html new file mode 100644 index 00000000..392e11fd --- /dev/null +++ b/Structs/HyperwalletForeignExchange.html @@ -0,0 +1,523 @@ + + + + HyperwalletForeignExchange Structure Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + HyperwalletForeignExchange Structure Reference +

+ +
+ +
+ +
+
+

HyperwalletForeignExchange

+
+
+ + 
public struct HyperwalletForeignExchange : Codable
+ +
+
+

Representation of a HyperwalletForeignExchange

+ +
+
+ +
+
+
+
    +
  • +
    + + + + destinationAmount + +
    +
    +
    +
    +
    +
    +

    The destination amount

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let destinationAmount: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + destinationCurrency + +
    +
    +
    +
    +
    +
    +

    The destination currency

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let destinationCurrency: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + rate + +
    +
    +
    +
    +
    +
    +

    The rate

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let rate: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + sourceAmount + +
    +
    +
    +
    +
    +
    +

    The source amount

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let sourceAmount: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + sourceCurrency + +
    +
    +
    +
    +
    +
    +

    The source currency

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let sourceCurrency: String?
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/Structs/HyperwalletMask.html b/Structs/HyperwalletMask.html new file mode 100644 index 00000000..f883a900 --- /dev/null +++ b/Structs/HyperwalletMask.html @@ -0,0 +1,469 @@ + + + + HyperwalletMask Structure Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + HyperwalletMask Structure Reference +

+ +
+ +
+ +
+
+

HyperwalletMask

+
+
+ + 
public struct HyperwalletMask : Codable
+ +
+
+

Representation of the transfer method configuration field mask

+ +
+
+ +
+
+
+
    +
  • +
    + + + + conditionalPatterns + +
    +
    +
    +
    +
    +
    +

    The conditional pattern, or nil if none exists

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let conditionalPatterns: [HyperwalletConditionalPattern]?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + defaultPattern + +
    +
    +
    +
    +
    +
    +

    The default pattern

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let defaultPattern: String
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + scrubRegex + +
    +
    +
    +
    +
    +
    +

    The scrub regex, or nil if none exists

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let scrubRegex: String?
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/Structs/HyperwalletPageLink.html b/Structs/HyperwalletPageLink.html new file mode 100644 index 00000000..91b3af47 --- /dev/null +++ b/Structs/HyperwalletPageLink.html @@ -0,0 +1,442 @@ + + + + HyperwalletPageLink Structure Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + HyperwalletPageLink Structure Reference +

+ +
+ +
+ +
+
+

HyperwalletPageLink

+
+
+ + 
public struct HyperwalletPageLink : Decodable
+ +
+
+

Representation of the page link

+ +
+
+ +
+
+
+ +
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/Structs/HyperwalletPageList.html b/Structs/HyperwalletPageList.html new file mode 100644 index 00000000..e6700a47 --- /dev/null +++ b/Structs/HyperwalletPageList.html @@ -0,0 +1,523 @@ + + + + HyperwalletPageList Structure Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + HyperwalletPageList Structure Reference +

+ +
+ +
+ +
+
+

HyperwalletPageList

+
+
+ + 
public struct HyperwalletPageList<ListType> : Decodable where ListType : Decodable
+ +
+
+

Representation of subset content from a dataset

+ +
+
+ +
+
+
+
    +
  • +
    + + + + count + +
    +
    +
    +
    +
    +
    +

    The amount of the dataset

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let count: Int?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + data + +
    +
    +
    +
    +
    +
    +

    The ListType items

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let data: [ListType]?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + limit + +
    +
    +
    +
    +
    +
    +

    The maximum number of records that will be returned per page

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let limit: Int?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + links + +
    +
    +
    +
    +
    +
    +

    The links

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let links: [HyperwalletPageLink]?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + offset + +
    +
    +
    +
    +
    +
    +

    The number of records to skip.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let offset: Int?
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/Structs/HyperwalletPageParameter.html b/Structs/HyperwalletPageParameter.html new file mode 100644 index 00000000..00cf8d52 --- /dev/null +++ b/Structs/HyperwalletPageParameter.html @@ -0,0 +1,415 @@ + + + + HyperwalletPageParameter Structure Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + HyperwalletPageParameter Structure Reference +

+ +
+ +
+ +
+
+

HyperwalletPageParameter

+
+
+ + 
public struct HyperwalletPageParameter : Decodable
+ +
+
+

Representation of the relationship between the current document and the linked document

+ +
+
+ +
+
+
+
    +
  • +
    + + + + rel + +
    +
    +
    +
    +
    +
    +

    The relationship

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let rel: String?
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/Structs/HyperwalletProcessingTime.html b/Structs/HyperwalletProcessingTime.html new file mode 100644 index 00000000..f5799105 --- /dev/null +++ b/Structs/HyperwalletProcessingTime.html @@ -0,0 +1,496 @@ + + + + HyperwalletProcessingTime Structure Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + HyperwalletProcessingTime Structure Reference +

+ +
+ +
+ +
+
+

HyperwalletProcessingTime

+
+
+ + 
public struct HyperwalletProcessingTime : Codable
+ +
+
+

Representation of the transfer method configuration field processing times

+ +
+
+ +
+
+
+
    +
  • +
    + + + + country + +
    +
    +
    +
    +
    +
    +

    The country to process

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let country: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + currency + +
    +
    +
    +
    +
    +
    +

    The currency to process

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let currency: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + transferMethodType + +
    +
    +
    +
    +
    +
    +

    The transfer method type

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let transferMethodType: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + value + +
    +
    +
    +
    +
    +
    +

    The value to process

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let value: String?
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/Structs/HyperwalletReceipt.html b/Structs/HyperwalletReceipt.html new file mode 100644 index 00000000..1a36b57f --- /dev/null +++ b/Structs/HyperwalletReceipt.html @@ -0,0 +1,794 @@ + + + + HyperwalletReceipt Structure Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + HyperwalletReceipt Structure Reference +

+ +
+ +
+ +
+
+

HyperwalletReceipt

+
+
+ + 
public struct HyperwalletReceipt : Decodable, Equatable
+ +
+
+

Representation of the Hyperwallet’s receipt.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + amount + +
    +
    +
    +
    +
    +
    +

    The gross amount of the transaction.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let amount: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + createdOn + +
    +
    +
    +
    +
    +
    +

    The datetime the transaction was created on in ISO 8601 format ‘YYYY-MM-DDThh:mm:ss’ (UTC timezone)

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let createdOn: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + currency + +
    +
    +
    +
    +
    +
    +

    The 3-letter currency code for the transaction.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let currency: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + destinationToken + +
    +
    +
    +
    +
    +
    +

    A token identifying where the funds were sent.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let destinationToken: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + details + +
    +
    +
    +
    +
    +
    +

    Details of the transaction.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let details: HyperwalletReceiptDetails?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + entry + +
    +
    +
    +
    +
    +
    +

    The type of transaction.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let entry: HyperwalletEntryType?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + fee + +
    +
    +
    +
    +
    +
    +

    The fee amount.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let fee: String?
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The 3-letter currency code for the foreign exchange.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let foreignExchangeCurrency: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + foreignExchangeRate + +
    +
    +
    +
    +
    +
    +

    The foreign exchange rate.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let foreignExchangeRate: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + journalId + +
    +
    +
    +
    +
    +
    +

    The journal entry number for the transaction.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let journalId: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + sourceToken + +
    +
    +
    +
    +
    +
    +

    A token identifying the source of funds.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let sourceToken: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + type + +
    +
    +
    +
    +
    +
    +

    The transaction type.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let type: HyperwalletReceiptType?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + ==(_:_:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public static func == (lhs: HyperwalletReceipt, rhs: HyperwalletReceipt) -> Bool
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The transaction type.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public enum HyperwalletReceiptType : String, Decodable
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + HyperwalletEntryType + +
    +
    +
    +
    +
    +
    +

    The entry type.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public enum HyperwalletEntryType : String, Decodable
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/Structs/HyperwalletReceipt/HyperwalletEntryType.html b/Structs/HyperwalletReceipt/HyperwalletEntryType.html new file mode 100644 index 00000000..176aa76b --- /dev/null +++ b/Structs/HyperwalletReceipt/HyperwalletEntryType.html @@ -0,0 +1,442 @@ + + + + HyperwalletEntryType Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + HyperwalletEntryType Enumeration Reference +

+ +
+ +
+ +
+
+

HyperwalletEntryType

+
+
+ + 
public enum HyperwalletEntryType : String, Decodable
+ +
+
+

The entry type.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + credit + +
    +
    +
    +
    +
    +
    +

    The credit entry type

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case credit = "CREDIT"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + debit + +
    +
    +
    +
    +
    +
    +

    The debit entry type

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case debit = "DEBIT"
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/Structs/HyperwalletReceipt/HyperwalletReceiptType.html b/Structs/HyperwalletReceipt/HyperwalletReceiptType.html new file mode 100644 index 00000000..a3390654 --- /dev/null +++ b/Structs/HyperwalletReceipt/HyperwalletReceiptType.html @@ -0,0 +1,3727 @@ + + + + HyperwalletReceiptType Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + HyperwalletReceiptType Enumeration Reference +

+ +
+ +
+ +
+
+

HyperwalletReceiptType

+
+
+ + 
public enum HyperwalletReceiptType : String, Decodable
+ +
+
+

The transaction type.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + annualFee + +
    +
    +
    +
    +
    +
    +

    The annual fee

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case annualFee = "ANNUAL_FEE"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + annualFeeRefund + +
    +
    +
    +
    +
    +
    +

    The annual fee refund

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case annualFeeRefund = "ANNUAL_FEE_REFUND"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + customerServiceFee + +
    +
    +
    +
    +
    +
    +

    The customer service fee

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case customerServiceFee = "CUSTOMER_SERVICE_FEE"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The customer service fee refund

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case customerServiceFeeRefund = "CUSTOMER_SERVICE_FEE_REFUND"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + expeditedShippingFee + +
    +
    +
    +
    +
    +
    +

    The expedited shipping fee

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case expeditedShippingFee = "EXPEDITED_SHIPPING_FEE"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + genericFeeRefund + +
    +
    +
    +
    +
    +
    +

    The generic fee refund

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case genericFeeRefund = "GENERIC_FEE_REFUND"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + monthlyFee + +
    +
    +
    +
    +
    +
    +

    The monthly fee

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case monthlyFee = "MONTHLY_FEE"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + monthlyFeeRefund + +
    +
    +
    +
    +
    +
    +

    The monthly fee refund

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case monthlyFeeRefund = "MONTHLY_FEE_REFUND"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + paymentExpiryFee + +
    +
    +
    +
    +
    +
    +

    The payment expiry fee

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case paymentExpiryFee = "PAYMENT_EXPIRY_FEE"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + paymentFee + +
    +
    +
    +
    +
    +
    +

    The payment fee

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case paymentFee = "PAYMENT_FEE"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + processingFee + +
    +
    +
    +
    +
    +
    +

    The processing fee

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case processingFee = "PROCESSING_FEE"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + standardShippingFee + +
    +
    +
    +
    +
    +
    +

    The standard shipping fee

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case standardShippingFee = "STANDARD_SHIPPING_FEE"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + transferFee + +
    +
    +
    +
    +
    +
    +

    The transfer fee

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case transferFee = "TRANSFER_FEE"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + adjustment + +
    +
    +
    +
    +
    +
    +

    The adjustment

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case adjustment = "ADJUSTMENT"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + deposit + +
    +
    +
    +
    +
    +
    +

    The deposit

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case deposit = "DEPOSIT"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + foreignExchange + +
    +
    +
    +
    +
    +
    +

    The foreign exchange

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case foreignExchange = "FOREIGN_EXCHANGE"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + manualAdjustment + +
    +
    +
    +
    +
    +
    +

    The manual adjustment

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case manualAdjustment = "MANUAL_ADJUSTMENT"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + paymentExpiration + +
    +
    +
    +
    +
    +
    +

    The payment expiration

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case paymentExpiration = "PAYMENT_EXPIRATION"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The bank account transfer fee

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case bankAccountTransferFee = "BANK_ACCOUNT_TRANSFER_FEE"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The bank account transfer return

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case bankAccountTransferReturn = "BANK_ACCOUNT_TRANSFER_RETURN"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The bank account transfer return fee

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case bankAccountTransferReturnFee = "BANK_ACCOUNT_TRANSFER_RETURN_FEE"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + transferToBankAccount + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case transferToBankAccount = "TRANSFER_TO_BANK_ACCOUNT"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + cardActivationFee + +
    +
    +
    +
    +
    +
    +

    The card activation fee

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case cardActivationFee = "CARD_ACTIVATION_FEE"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The card activation fee waiver

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case cardActivationFeeWaiver = "CARD_ACTIVATION_FEE_WAIVER"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + cardFee + +
    +
    +
    +
    +
    +
    +

    The card fee

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case cardFee = "CARD_FEE"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The manual transfer to prepaid card

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case manualTransferToPrepaidCard = "MANUAL_TRANSFER_TO_PREPAID_CARD"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The prepaid card balance inquiry fee

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case prepaidCardBalanceInquiryFee = "PREPAID_CARD_BALANCE_INQUIRY_FEE"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The prepaid card cash advance

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case prepaidCardCashAdvance = "PREPAID_CARD_CASH_ADVANCE"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The prepaid card disputed charge refund

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case prepaidCardDisputedChargeRefund = "PREPAID_CARD_DISPUTED_CHARGE_REFUND"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The prepaid card dispute deposit

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case prepaidCardDisputeDeposit = "PREPAID_CARD_DISPUTE_DEPOSIT"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The prepaid card domestic cash withdrawal fee

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case prepaidCardDomesticCashWithdrawalFee = "PREPAID_CARD_DOMESTIC_CASH_WITHDRAWAL_FEE"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The prepaid card exchange rate difference

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case prepaidCardExchangeRateDifference = "PREPAID_CARD_EXCHANGE_RATE_DIFFERENCE"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The prepaid card manual unload

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case prepaidCardManualUnload = "PREPAID_CARD_MANUAL_UNLOAD"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The prepaid card overseas cash withdrawal fee

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case prepaidCardOverseasCashWithdrawalFee = "PREPAID_CARD_OVERSEAS_CASH_WITHDRAWAL_FEE"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The prepaid card pin change fee

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case prepaidCardPinChangeFee = "PREPAID_CARD_PIN_CHANGE_FEE"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + prepaidCardRefund + +
    +
    +
    +
    +
    +
    +

    The prepaid card refund

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case prepaidCardRefund = "PREPAID_CARD_REFUND"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The prepaid card replacement fee

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case prepaidCardReplacementFee = "PREPAID_CARD_REPLACEMENT_FEE"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The prepaid card sale reversal

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case prepaidCardSaleReversal = "PREPAID_CARD_SALE_REVERSAL"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + prepaidCardUnload + +
    +
    +
    +
    +
    +
    +

    The prepaid card unload

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case prepaidCardUnload = "PREPAID_CARD_UNLOAD"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + transferToDebitCard + +
    +
    +
    +
    +
    +
    +

    The transfer to debit card

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case transferToDebitCard = "TRANSFER_TO_DEBIT_CARD"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + transferToPrepaidCard + +
    +
    +
    +
    +
    +
    +

    The transfer to prepaid card

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case transferToPrepaidCard = "TRANSFER_TO_PREPAID_CARD"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The prepaid card account deposit

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case prepaidCardAccountDeposit = "PREPAID_CARD_ACCOUNT_DEPOSIT"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + prepaidCardAccountFee + +
    +
    +
    +
    +
    +
    +

    The prepaid card account fee

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case prepaidCardAccountFee = "PREPAID_CARD_ACCOUNT_FEE"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The prepaid card annual fee discount

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case prepaidCardAnnualFeeDiscount = "PREPAID_CARD_ANNUAL_FEE_DISCOUNT"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The prepaid card bill reprint fee

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case prepaidCardBillReprintFee = "PREPAID_CARD_BILL_REPRINT_FEE"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The prepaid card atm or cash advance fee

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case prepaidCardAtmOrCashAdvanceFee = "PREPAID_CARD_ATM_OR_CASH_ADVANCE_FEE"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The prepaid card cash advance chargeback

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case prepaidCardCashAdvanceChargeback = "PREPAID_CARD_CASH_ADVANCE_CHARGEBACK"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The prepaid card cash advance chargeback reversal

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case prepaidCardCashAdvanceChargebackReversal = "PREPAID_CARD_CASH_ADVANCE_CHARGEBACK_REVERSAL"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The prepaid card cash advance repress

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case prepaidCardCashAdvanceRepress = "PREPAID_CARD_CASH_ADVANCE_REPRESS"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The prepaid card cash advance repress reversal

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case prepaidCardCashAdvanceRepressReversal = "PREPAID_CARD_CASH_ADVANCE_REPRESS_REVERSAL"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + prepaidCardChargeback + +
    +
    +
    +
    +
    +
    +

    The prepaid card chargeback

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case prepaidCardChargeback = "PREPAID_CARD_CHARGEBACK"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The prepaid card chargeback refund

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case prepaidCardChargebackRefund = "PREPAID_CARD_CHARGEBACK_REFUND"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The prepaid card chargeback refund reversal

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case prepaidCardChargebackRefundReversal = "PREPAID_CARD_CHARGEBACK_REFUND_REVERSAL"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The prepaid card chargeback reversal

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case prepaidCardChargebackReversal = "PREPAID_CARD_CHARGEBACK_REVERSAL"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The prepaid card commission or fee

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case prepaidCardCommissionOrFee = "PREPAID_CARD_COMMISSION_OR_FEE"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The prepaid card debit transfer

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case prepaidCardDebitTransfer = "PREPAID_CARD_DEBIT_TRANSFER"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The prepaid card document request fee

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case prepaidCardDocumentRequestFee = "PREPAID_CARD_DOCUMENT_REQUEST_FEE"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The prepaid card emergency cash

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case prepaidCardEmergencyCash = "PREPAID_CARD_EMERGENCY_CASH"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The prepaid card emergency card

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case prepaidCardEmergencyCard = "PREPAID_CARD_EMERGENCY_CARD"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + prepaidCardIncome + +
    +
    +
    +
    +
    +
    +

    The prepaid card income

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case prepaidCardIncome = "PREPAID_CARD_INCOME"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + prepaidCardLoadFee + +
    +
    +
    +
    +
    +
    +

    The prepaid card load fee

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case prepaidCardLoadFee = "PREPAID_CARD_LOAD_FEE"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The prepaid card overdue payment interest

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case prepaidCardOverduePaymentInterest = "PREPAID_CARD_OVERDUE_PAYMENT_INTEREST"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + prepaidCardPayment + +
    +
    +
    +
    +
    +
    +

    The prepaid card payment

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case prepaidCardPayment = "PREPAID_CARD_PAYMENT"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The prepaid card pin reprint fee

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case prepaidCardPinReprintFee = "PREPAID_CARD_PIN_REPRINT_FEE"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The prepaid card priority pass fee

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case prepaidCardPriorityPassFee = "PREPAID_CARD_PRIORITY_PASS_FEE"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The prepaid card priority pass renewal

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case prepaidCardPriorityPassRenewal = "PREPAID_CARD_PRIORITY_PASS_RENEWAL"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The prepaid card recurring interest

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case prepaidCardRecurringInterest = "PREPAID_CARD_RECURRING_INTEREST"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The prepaid card refund repress

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case prepaidCardRefundRepress = "PREPAID_CARD_REFUND_REPRESS"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The prepaid card refund repress reversal

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case prepaidCardRefundRepressReversal = "PREPAID_CARD_REFUND_REPRESS_REVERSAL"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The prepaid card statement fee

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case prepaidCardStatementFee = "PREPAID_CARD_STATEMENT_FEE"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The prepaid card telephone support fee

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case prepaidCardTelephoneSupportFee = "PREPAID_CARD_TELEPHONE_SUPPORT_FEE"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The prepaid card transfer fee

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case prepaidCardTransferFee = "PREPAID_CARD_TRANSFER_FEE"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The prepaid card transfer return

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case prepaidCardTransferReturn = "PREPAID_CARD_TRANSFER_RETURN"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The prepaid card bank withdrawal chargeback

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case prepaidCardBankWithdrawalChargeback = "PREPAID_CARD_BANK_WITHDRAWAL_CHARGEBACK"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + prepaidCardRefundfee + +
    +
    +
    +
    +
    +
    +

    The prepaid card refund fee

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case prepaidCardRefundfee = "PREPAID_CARD_REFUND_FEE"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The prepaid card monthly maintenance fee

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case prepaidCardMonthlyMaintenanceFee = "PREPAID_CARD_MONTHLY_MAINTENANCE_FEE"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The prepaid card transaction fee

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case prepaidCardTransactionFee = "PREPAID_CARD_TRANSACTION_FEE"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + prepaidCardSmsFee + +
    +
    +
    +
    +
    +
    +

    The prepaid card sms fee

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case prepaidCardSmsFee = "PREPAID_CARD_SMS_FEE"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The prepaid card declined authorization fee

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case prepaidCardDeclinedAuthorizationFee = "PREPAID_CARD_DECLINED_AUTHORIZATION_FEE"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + fispc + +
    +
    +
    +
    +
    +
    +

    The prepaid card purchases

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case fispc = "FISPC"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + donation + +
    +
    +
    +
    +
    +
    +

    The donation

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case donation = "DONATION"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + donationFee + +
    +
    +
    +
    +
    +
    +

    The donation fee

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case donationFee = "DONATION_FEE"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + donationReturn + +
    +
    +
    +
    +
    +
    +

    The donation return

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case donationReturn = "DONATION_RETURN"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + merchantPayment + +
    +
    +
    +
    +
    +
    +

    The merchant payment

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case merchantPayment = "MERCHANT_PAYMENT"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + merchantPaymentFee + +
    +
    +
    +
    +
    +
    +

    The merchant payment fee

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case merchantPaymentFee = "MERCHANT_PAYMENT_FEE"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + merchantPaymentRefund + +
    +
    +
    +
    +
    +
    +

    The merchant payment refund

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case merchantPaymentRefund = "MERCHANT_PAYMENT_REFUND"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + merchantPaymentReturn + +
    +
    +
    +
    +
    +
    +

    The merchant payment return

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case merchantPaymentReturn = "MERCHANT_PAYMENT_RETURN"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The money gram transfer return

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case moneygramTransferReturn = "MONEYGRAM_TRANSFER_RETURN"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + transferToMoneygram + +
    +
    +
    +
    +
    +
    +

    The transfer to money gram

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case transferToMoneygram = "TRANSFER_TO_MONEYGRAM"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + paperCheckFee + +
    +
    +
    +
    +
    +
    +

    The paper check fee

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case paperCheckFee = "PAPER_CHECK_FEE"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + paperCheckRefund + +
    +
    +
    +
    +
    +
    +

    The paper check refund

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case paperCheckRefund = "PAPER_CHECK_REFUND"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + transferToPaperCheck + +
    +
    +
    +
    +
    +
    +

    The transfer to paper check

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case transferToPaperCheck = "TRANSFER_TO_PAPER_CHECK"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + accountClosure + +
    +
    +
    +
    +
    +
    +

    The account to be closed

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case accountClosure = "ACCOUNT_CLOSURE"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + accountClosureFee + +
    +
    +
    +
    +
    +
    +

    The account closure fee

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case accountClosureFee = "ACCOUNT_CLOSURE_FEE"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + accountUnload + +
    +
    +
    +
    +
    +
    +

    The account unload

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case accountUnload = "ACCOUNT_UNLOAD"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + dormantUserFee + +
    +
    +
    +
    +
    +
    +

    The dormant user fee

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case dormantUserFee = "DORMANT_USER_FEE"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + dormantUserFeeRefund + +
    +
    +
    +
    +
    +
    +

    The dormant user fee refund

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case dormantUserFeeRefund = "DORMANT_USER_FEE_REFUND"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + payment + +
    +
    +
    +
    +
    +
    +

    The payment

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case payment = "PAYMENT"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + paymentCancellation + +
    +
    +
    +
    +
    +
    +

    The payment cancellation

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case paymentCancellation = "PAYMENT_CANCELLATION"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + paymentReversal + +
    +
    +
    +
    +
    +
    +

    The payment reversal

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case paymentReversal = "PAYMENT_REVERSAL"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + paymentReversalFee + +
    +
    +
    +
    +
    +
    +

    The payment reversal fee

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case paymentReversalFee = "PAYMENT_REVERSAL_FEE"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + paymentReturn + +
    +
    +
    +
    +
    +
    +

    The payment return

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case paymentReturn = "PAYMENT_RETURN"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The transfer to program account

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case transferToProgramAccount = "TRANSFER_TO_PROGRAM_ACCOUNT"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + transferToUser + +
    +
    +
    +
    +
    +
    +

    The transfer to user

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case transferToUser = "TRANSFER_TO_USER"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The virtual incentive cancellation

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case virtualIncentiveCancellation = "VIRTUAL_INCENTIVE_CANCELLATION"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The virtual incentive issuance

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case virtualIncentiveIssuance = "VIRTUAL_INCENTIVE_ISSUANCE"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The virtual incentive purchase

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case virtualIncentivePurchase = "VIRTUAL_INCENTIVE_PURCHASE"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The virtual incentive refund

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case virtualIncentiveRefund = "VIRTUAL_INCENTIVE_REFUND"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The transfer to western union

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case transferToWesternUnion = "TRANSFER_TO_WESTERN_UNION"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + transferToWubsWire + +
    +
    +
    +
    +
    +
    +

    The transfer to wubs wire

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case transferToWubsWire = "TRANSFER_TO_WUBS_WIRE"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The western union transfer return

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case westernUnionTransferReturn = "WESTERN_UNION_TRANSFER_RETURN"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The wubs wire transfer return

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case wubsWireTransferReturn = "WUBS_WIRE_TRANSFER_RETURN"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + transferToWire + +
    +
    +
    +
    +
    +
    +

    The transfer to Wire

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case transferToWire = "TRANSFER_TO_WIRE"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + wireTransferFee + +
    +
    +
    +
    +
    +
    +

    The wire transfer fee

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case wireTransferFee = "WIRE_TRANSFER_FEE"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + wireTransferReturn + +
    +
    +
    +
    +
    +
    +

    The wire transfer return

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case wireTransferReturn = "WIRE_TRANSFER_RETURN"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + prepaidCardSale + +
    +
    +
    +
    +
    +
    +

    The prepaid card sale

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case prepaidCardSale = "PREPAID_CARD_SALE"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Transfer to PayPal account

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case transferToPayPalAccount = "TRANSFER_TO_PAYPAL_ACCOUNT"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Return to Paypal Account

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case paypalAccountTransferReturn = "PAYPAL_ACCOUNT_TRANSFER_RETURN"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Transfer to Venmo account

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case transferToVenmoAccount = "TRANSFER_TO_VENMO_ACCOUNT"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Return to Venmo account

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case venmoAccountTransferReturn = "VENMO_ACCOUNT_TRANSFER_RETURN"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + transferToBankCard + +
    +
    +
    +
    +
    +
    +

    Transfer To Bank Card

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case transferToBankCard = "TRANSFER_TO_BANK_CARD"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + unknown + +
    +
    +
    +
    +
    +
    +

    Default - unknown transfer type

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case unknown = "UNKNOWN_RECEIPT_TYPE"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + init(from:) + +
    +
    +
    +
    +
    +
    +

    A safe initializer for creating a HyperwalletReceiptType object

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public init(from decoder: Decoder) throws
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + decoder + + +
    +

    The decoder to read data from.

    +
    +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/Structs/HyperwalletReceiptDetails.html b/Structs/HyperwalletReceiptDetails.html new file mode 100644 index 00000000..39d7bfda --- /dev/null +++ b/Structs/HyperwalletReceiptDetails.html @@ -0,0 +1,1306 @@ + + + + HyperwalletReceiptDetails Structure Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + HyperwalletReceiptDetails Structure Reference +

+ +
+ +
+ +
+
+

HyperwalletReceiptDetails

+
+
+ + 
public struct HyperwalletReceiptDetails : Decodable
+ +
+
+

Details of the transaction.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + bankAccountId + +
    +
    +
    +
    +
    +
    +

    The bank account number, IBAN or equivalent

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let bankAccountId: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + bankAccountPurpose + +
    +
    +
    +
    +
    +
    +

    The bank account type, e.g. CHECKING or SAVINGS

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let bankAccountPurpose: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + bankId + +
    +
    +
    +
    +
    +
    +

    The bank code, BIC/SWIFT or equivalent

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let bankId: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + bankName + +
    +
    +
    +
    +
    +
    +

    The bank name

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let bankName: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + branchAddressLine1 + +
    +
    +
    +
    +
    +
    +

    The branch address, first line

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let branchAddressLine1: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + branchAddressLine2 + +
    +
    +
    +
    +
    +
    +

    The branch address, second line

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let branchAddressLine2: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + branchCity + +
    +
    +
    +
    +
    +
    +

    The branch city

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let branchCity: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + branchCountry + +
    +
    +
    +
    +
    +
    +

    The 2-letter country code of the branch

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let branchCountry: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + branchId + +
    +
    +
    +
    +
    +
    +

    The branch code or equivalent

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let branchId: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + branchName + +
    +
    +
    +
    +
    +
    +

    The branch name

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let branchName: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + branchPostalCode + +
    +
    +
    +
    +
    +
    +

    The branch postal code

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let branchPostalCode: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + branchStateProvince + +
    +
    +
    +
    +
    +
    +

    The branch state or province

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let branchStateProvince: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + cardExpiryDate + +
    +
    +
    +
    +
    +
    +

    The card expiry date in YYYY-MM format

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let cardExpiryDate: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + cardHolderName + +
    +
    +
    +
    +
    +
    +

    The card holder’s full name

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let cardHolderName: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + cardNumber + +
    +
    +
    +
    +
    +
    +

    The card number

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let cardNumber: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + charityName + +
    +
    +
    +
    +
    +
    +

    The name of the charity that is receiving the donation

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let charityName: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + checkNumber + +
    +
    +
    +
    +
    +
    +

    The paper check number

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let checkNumber: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + clientPaymentId + +
    +
    +
    +
    +
    +
    +

    The client-assigned transaction identifier

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let clientPaymentId: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + memo + +
    +
    +
    +
    +
    +
    +

    An internal note added by a client operator

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let memo: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + notes + +
    +
    +
    +
    +
    +
    +

    A description for the receipt

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let notes: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + payeeAddressLine1 + +
    +
    +
    +
    +
    +
    +

    The payee’s address first line

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let payeeAddressLine1: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + payeeAddressLine2 + +
    +
    +
    +
    +
    +
    +

    The payee’s address, second line

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let payeeAddressLine2: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + payeeCity + +
    +
    +
    +
    +
    +
    +

    The payee’s city

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let payeeCity: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + payeeCountry + +
    +
    +
    +
    +
    +
    +

    The payee’s 2-letter country code

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let payeeCountry: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + payeeEmail + +
    +
    +
    +
    +
    +
    +

    The payee’s email address on record

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let payeeEmail: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + payeeName + +
    +
    +
    +
    +
    +
    +

    The payee’s full name

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let payeeName: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + payeePostalCode + +
    +
    +
    +
    +
    +
    +

    The payee’s postal code, ZIP code or equivalent

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let payeePostalCode: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + payeeStateProvince + +
    +
    +
    +
    +
    +
    +

    The payee’s state or province

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let payeeStateProvince: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + payerName + +
    +
    +
    +
    +
    +
    +

    The payer’s full name

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let payerName: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + paymentExpiryDate + +
    +
    +
    +
    +
    +
    +

    The payment expiry date in YYYY-MM-DD format

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let paymentExpiryDate: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + returnOrRecallReason + +
    +
    +
    +
    +
    +
    +

    The reason for returning or recalling the payment

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let returnOrRecallReason: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + securityAnswer + +
    +
    +
    +
    +
    +
    +

    The answer to the securityQuestion

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let securityAnswer: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + securityQuestion + +
    +
    +
    +
    +
    +
    +

    A security question

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let securityQuestion: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + website + +
    +
    +
    +
    +
    +
    +

    The URL of the client website where the virtual incentive was accrued

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let website: String?
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/Structs/HyperwalletStatusTransition.html b/Structs/HyperwalletStatusTransition.html new file mode 100644 index 00000000..0f49064c --- /dev/null +++ b/Structs/HyperwalletStatusTransition.html @@ -0,0 +1,610 @@ + + + + HyperwalletStatusTransition Structure Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + HyperwalletStatusTransition Structure Reference +

+ +
+ +
+ +
+
+

HyperwalletStatusTransition

+
+
+ + 
public struct HyperwalletStatusTransition : Codable
+ +
+
+

Representation of the status transition.

+ +

The status transition describes a status change for an existing bank account, bank card, PayPal account, +prepaid card, paper check or payment.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + createdOn + +
    +
    +
    +
    +
    +
    +

    The datetime the status changed in ISO 8601 format (YYYY-MM-DDThh:mm:ss). Note that the timezone used is UTC, +therefore there is no time offset.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let createdOn: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + fromStatus + +
    +
    +
    +
    +
    +
    +

    The status before the transition.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let fromStatus: Status?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + notes + +
    +
    +
    +
    +
    +
    +

    Comments regarding the status change.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let notes: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + token + +
    +
    +
    +
    +
    +
    +

    The unique, auto-generated status transition identifier.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let token: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + toStatus + +
    +
    +
    +
    +
    +
    +

    The status after the transition.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let toStatus: Status?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + transition + +
    +
    +
    +
    +
    +
    +

    The new status of the resource.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let transition: Status?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + Status + +
    +
    +
    +
    +
    +
    +

    Representation of the status.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public enum Status : String, Codable
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + Builder + +
    +
    +
    +
    +
    +
    +

    A helper class to build the HyperwalletStatusTransition instance.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public class Builder
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/Structs/HyperwalletStatusTransition/Builder.html b/Structs/HyperwalletStatusTransition/Builder.html new file mode 100644 index 00000000..77e4e4eb --- /dev/null +++ b/Structs/HyperwalletStatusTransition/Builder.html @@ -0,0 +1,476 @@ + + + + Builder Class Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + Builder Class Reference +

+ +
+ +
+ +
+
+

Builder

+
+
+ + 
public class Builder
+ +
+
+

A helper class to build the HyperwalletStatusTransition instance.

+ +
+
+ +
+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Initialization of Builder

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public init(notes: String? = nil, transition: Status)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + notes + + +
    +

    Comments regarding the status change

    +
    +
    + + transition + + +
    +

    The new status of the resource

    +
    +
    +
    +
    +
    +
    • +
  • +
    + + + + build() + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func build() -> HyperwalletStatusTransition
    + +
    +
    +
    +

    Return Value

    +

    a new instance of the HyperwalletTransfer.

    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/Structs/HyperwalletStatusTransition/Status.html b/Structs/HyperwalletStatusTransition/Status.html new file mode 100644 index 00000000..d6d85d27 --- /dev/null +++ b/Structs/HyperwalletStatusTransition/Status.html @@ -0,0 +1,982 @@ + + + + Status Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + Status Enumeration Reference +

+ +
+ +
+ +
+
+

Status

+
+
+ + 
public enum Status : String, Codable
+ +
+
+

Representation of the status.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + activated + +
    +
    +
    +
    +
    +
    +

    The status is activate.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case activated = "ACTIVATED"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + cancelled + +
    +
    +
    +
    +
    +
    +

    The status is cancel.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case cancelled = "CANCELLED"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + completed + +
    +
    +
    +
    +
    +
    +

    The status is complete.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case completed = "COMPLETED"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + deactivated + +
    +
    +
    +
    +
    +
    +

    The status is deactivate.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case deactivated = "DE_ACTIVATED"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + expired + +
    +
    +
    +
    +
    +
    +

    The status is expire.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case expired = "EXPIRED"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + failed + +
    +
    +
    +
    +
    +
    +

    The status is fail.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case failed = "FAILED"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + inProgress + +
    +
    +
    +
    +
    +
    +

    The status is in progress.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case inProgress = "IN_PROGRESS"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + invalid + +
    +
    +
    +
    +
    +
    +

    The status is invalid.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case invalid = "INVALID"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + lostOrStolen + +
    +
    +
    +
    +
    +
    +

    The status is lost or stolen.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case lostOrStolen = "LOST_OR_STOLEN"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The status is pending account activation.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case pendingAccountActivation = "PENDING_ACCOUNT_ACTIVATION"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + pendingIdVerification + +
    +
    +
    +
    +
    +
    +

    The status is pending identity verification.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case pendingIdVerification = "PENDING_ID_VERIFICATION"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The status is pending tax verification.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case pendingTaxVerification = "PENDING_TAX_VERIFICATION"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The status is pending transaction verification.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case pendingTransactionVerification = "PENDING_TRANSACTION_VERIFICATION"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The status is pending transfer method action.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case pendingTransferMethodAction = "PENDING_TRANSACTION_METHOD_ACTION"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + quoted + +
    +
    +
    +
    +
    +
    +

    The status is quoted

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case quoted = "QUOTED"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + recalled + +
    +
    +
    +
    +
    +
    +

    The status is recall.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case recalled = "RECALLED"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + returned + +
    +
    +
    +
    +
    +
    +

    The status is return.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case returned = "RETURNED"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + scheduled + +
    +
    +
    +
    +
    +
    +

    The status is schedule.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case scheduled = "SCHEDULED"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + suspended + +
    +
    +
    +
    +
    +
    +

    The status is suspend.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case suspended = "SUSPENDED"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + unsuspended + +
    +
    +
    +
    +
    +
    +

    The status is not suspended.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case unsuspended = "UNSUSPENDED"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + verificationRequired + +
    +
    +
    +
    +
    +
    +

    The status is verification required

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case verificationRequired = "VERIFICATION_REQUIRED"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + verified + +
    +
    +
    +
    +
    +
    +

    The status is verified.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case verified = "VERIFIED"
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/Structs/HyperwalletTransfer.html b/Structs/HyperwalletTransfer.html new file mode 100644 index 00000000..735255ab --- /dev/null +++ b/Structs/HyperwalletTransfer.html @@ -0,0 +1,876 @@ + + + + HyperwalletTransfer Structure Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + HyperwalletTransfer Structure Reference +

+ +
+ +
+ +
+
+

HyperwalletTransfer

+
+
+ + 
public struct HyperwalletTransfer : Codable
+ +
+
+

Representation of a HyperwalletTransfer

+ +
+
+ +
+
+
+
    +
  • +
    + + + + clientTransferId + +
    +
    +
    +
    +
    +
    +

    A value that identifies the client transfer id.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let clientTransferId: String
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + createdOn + +
    +
    +
    +
    +
    +
    +

    The created date

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let createdOn: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + destinationAmount + +
    +
    +
    +
    +
    +
    +

    The destination amount

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let destinationAmount: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + destinationCurrency + +
    +
    +
    +
    +
    +
    +

    The destination currency

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let destinationCurrency: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + destinationFeeAmount + +
    +
    +
    +
    +
    +
    +

    The destination amount

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let destinationFeeAmount: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + destinationToken + +
    +
    +
    +
    +
    +
    +

    The destination token

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let destinationToken: String
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + expiresOn + +
    +
    +
    +
    +
    +
    +

    The expiresOn

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let expiresOn: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + foreignExchanges + +
    +
    +
    +
    +
    +
    +

    The list of foreignExchanges

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let foreignExchanges: [HyperwalletForeignExchange]?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + memo + +
    +
    +
    +
    +
    +
    +

    The memo

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let memo: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + notes + +
    +
    +
    +
    +
    +
    +

    The notes to add

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let notes: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + sourceAmount + +
    +
    +
    +
    +
    +
    +

    The source amount

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let sourceAmount: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + sourceCurrency + +
    +
    +
    +
    +
    +
    +

    The source currency

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let sourceCurrency: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + sourceFeeAmount + +
    +
    +
    +
    +
    +
    +

    The source fee

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let sourceFeeAmount: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + sourceToken + +
    +
    +
    +
    +
    +
    +

    The source token

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let sourceToken: String
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + status + +
    +
    +
    +
    +
    +
    +

    The transfer status

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let status: HyperwalletTransferStatus?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + token + +
    +
    +
    +
    +
    +
    +

    The token

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let token: String?
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Representation of a HyperwalletTransferStatus

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public enum HyperwalletTransferStatus : String, Codable
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + Builder + +
    +
    +
    +
    +
    +
    +

    A helper class to build the HyperwalletTransfer instance.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public class Builder
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/Structs/HyperwalletTransfer/Builder.html b/Structs/HyperwalletTransfer/Builder.html new file mode 100644 index 00000000..78fac57b --- /dev/null +++ b/Structs/HyperwalletTransfer/Builder.html @@ -0,0 +1,798 @@ + + + + Builder Class Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + Builder Class Reference +

+ +
+ +
+ +
+
+

Builder

+
+
+ + 
public class Builder
+ +
+
+

A helper class to build the HyperwalletTransfer instance.

+ +
+
+ +
+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Creates a new instance of the HyperwalletTransfer.Builder based on the required parameters to create +a transfer.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public init(clientTransferId: String, sourceToken: String, destinationToken: String)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + clientTransferId + + +
    +

    A client defined transfer identifier. + This is the unique ID assigned to the transfer on your system. + Max 50 characters.

    +
    +
    + + sourceToken + + +
    +

    A token identifying the source of funds. + It can be a prepaid card token prefixed with trm- or user token prefixed with usr-.

    +
    +
    + + destinationToken + + +
    +

    A token identifying where the funds have been sent. + It is your merchant account token prefixed with act-.

    +
    +
    +
    +
    +
    +
    • +
  • +
    + + + + destinationAmount(_:) + +
    +
    +
    +
    +
    +
    +

    Sets the transfer destination amount.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func destinationAmount(_ destinationAmount: String?) -> Builder
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + destinationAmount + + +
    +

    The payment amount in the specified currency loaded into + your merchant account.

    +
    +
    +
    +
    +

    Return Value

    +

    a self HyperwalletTransfer.Builder instance.

    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Sets the transfer destination currency.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func destinationCurrency(_ destinationCurrency: String?) -> Builder
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + destinationCurrency + + +
    +

    The currency of the payment amount loaded into your merchant + account in ISO 4217 format.

    +
    +
    +
    +
    +

    Return Value

    +

    a self HyperwalletTransfer.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + memo(_:) + +
    +
    +
    +
    +
    +
    +

    Sets the transfer memo.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func memo(_ memo: String?) -> Builder
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + memo + + +
    +

    An internal memo for the SpendBack transfer (will not be visible to + the user making the payment).

    +
    +
    +
    +
    +

    Return Value

    +

    a self HyperwalletTransfer.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + notes(_:) + +
    +
    +
    +
    +
    +
    +

    Sets the transfer notes.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func notes(_ notes: String?) -> Builder
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + notes + + +
    +

    A description for the SpendBack transfer.

    +
    +
    +
    +
    +

    Return Value

    +

    a self HyperwalletTransfer.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + sourceAmount(_:) + +
    +
    +
    +
    +
    +
    +

    Sets the transfer source amount.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func sourceAmount(_ sourceAmount: String?) -> Builder
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + sourceAmount + + +
    +

    The payment amount in the specified currency that is debited + from the sourceToken.

    +
    +
    +
    +
    +

    Return Value

    +

    a self HyperwalletTransfer.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + sourceCurrency(_:) + +
    +
    +
    +
    +
    +
    +

    Sets the transfer source currency.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func sourceCurrency(_ sourceCurrency: String?) -> Builder
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + sourceCurrency + + +
    +

    The currency of the payment amount debited from the sourceToken + in ISO 4217 format.

    +
    +
    +
    +
    +

    Return Value

    +

    a self HyperwalletTransfer.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + build() + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func build() -> HyperwalletTransfer
    + +
    +
    +
    +

    Return Value

    +

    a new instance of the HyperwalletTransfer.

    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/Structs/HyperwalletTransfer/HyperwalletTransferStatus.html b/Structs/HyperwalletTransfer/HyperwalletTransferStatus.html new file mode 100644 index 00000000..078b5a2a --- /dev/null +++ b/Structs/HyperwalletTransfer/HyperwalletTransferStatus.html @@ -0,0 +1,631 @@ + + + + HyperwalletTransferStatus Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + HyperwalletTransferStatus Enumeration Reference +

+ +
+ +
+ +
+
+

HyperwalletTransferStatus

+
+
+ + 
public enum HyperwalletTransferStatus : String, Codable
+ +
+
+

Representation of a HyperwalletTransferStatus

+ +
+
+ +
+
+
+
    +
  • +
    + + + + cancelled + +
    +
    +
    +
    +
    +
    +

    The transfer status is cancelled

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case cancelled = "CANCELLED"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + completed + +
    +
    +
    +
    +
    +
    +

    The transfer status is completed

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case completed = "COMPLETED"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + expired + +
    +
    +
    +
    +
    +
    +

    The transfer status is expired

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case expired = "EXPIRED"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + failed + +
    +
    +
    +
    +
    +
    +

    The transfer status is failed

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case failed = "FAILED"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + inProgress + +
    +
    +
    +
    +
    +
    +

    The transfer status is in Progress

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case inProgress = "IN_PROGRESS"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + quoted + +
    +
    +
    +
    +
    +
    +

    The transfer status is quoted

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case quoted = "QUOTED"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + returned + +
    +
    +
    +
    +
    +
    +

    The transfer status is returned

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case returned = "RETURNED"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + scheduled + +
    +
    +
    +
    +
    +
    +

    The transfer status is scheduled

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case scheduled = "SCHEDULED"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + verificationRequired + +
    +
    +
    +
    +
    +
    +

    The verification required

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case verificationRequired = "VERIFICATION_REQUIRED"
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/Structs/HyperwalletTransferMethodConfiguration.html b/Structs/HyperwalletTransferMethodConfiguration.html new file mode 100644 index 00000000..a6b6049f --- /dev/null +++ b/Structs/HyperwalletTransferMethodConfiguration.html @@ -0,0 +1,523 @@ + + + + HyperwalletTransferMethodConfiguration Structure Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + HyperwalletTransferMethodConfiguration Structure Reference +

+ +
+ +
+ +
+
+

HyperwalletTransferMethodConfiguration

+
+
+ + 
public struct HyperwalletTransferMethodConfiguration : Codable
+ +
+
+

Representation of the transfer method configuration

+ +
+
+ +
+
+
+
    +
  • +
    + + + + country + +
    +
    +
    +
    +
    +
    +

    The country

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let country: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + currency + +
    +
    +
    +
    +
    +
    +

    The currency

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let currency: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + transferMethodType + +
    +
    +
    +
    +
    +
    +

    The transfer method type

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let transferMethodType: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + profile + +
    +
    +
    +
    +
    +
    +

    The profile type

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let profile: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + fieldGroups + +
    +
    +
    +
    +
    +
    +

    The HyperwalletFieldGroup, or nil if none exists

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let fieldGroups: Connection<HyperwalletFieldGroup>?
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/Structs/HyperwalletTransferMethodConfigurationFieldQuery.html b/Structs/HyperwalletTransferMethodConfigurationFieldQuery.html new file mode 100644 index 00000000..525d5eeb --- /dev/null +++ b/Structs/HyperwalletTransferMethodConfigurationFieldQuery.html @@ -0,0 +1,528 @@ + + + + HyperwalletTransferMethodConfigurationFieldQuery Structure Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + HyperwalletTransferMethodConfigurationFieldQuery Structure Reference +

+ +
+ +
+ +
+
+

HyperwalletTransferMethodConfigurationFieldQuery

+
+
+ + 
public struct HyperwalletTransferMethodConfigurationFieldQuery : GraphQlQuery, Hashable
+ +
+
+

The HyperwalletTransferMethodConfigurationFieldQuery struct defines and builds a query to retrieve the fields +required to create a transfer method (Bank Account, Bank Card, PayPal Account, Prepaid Card, Paper Check) +with the Hyperwallet platform.

+ +
+
+ +
+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Create a new HyperwalletTransferMethodConfigurationQuery from the country, currency, transferMethodType +and profile

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public init(country: String,
+            currency: String,
+            transferMethodType: String,
+            profile: String)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + +
    + + country + + +
    +

    the 2 letter ISO 3166-1 country code

    +
    +
    + + currency + + +
    +

    the 3 letter ISO 4217-1 currency code

    +
    +
    + + transferMethodType + + +
    +

    the TransferMethodType

    +
    +
    + + profile + + +
    +

    INDIVIDUAL or BUSINESS

    +
    +
    +
    +
    +
    +
    • +
  • +
    + + + + toGraphQl(userToken:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func toGraphQl(userToken: String) -> String
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + hash(into:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func hash(into hasher: inout Hasher)
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/Structs/HyperwalletTransferMethodConfigurationKeysQuery.html b/Structs/HyperwalletTransferMethodConfigurationKeysQuery.html new file mode 100644 index 00000000..746652bd --- /dev/null +++ b/Structs/HyperwalletTransferMethodConfigurationKeysQuery.html @@ -0,0 +1,464 @@ + + + + HyperwalletTransferMethodConfigurationKeysQuery Structure Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + HyperwalletTransferMethodConfigurationKeysQuery Structure Reference +

+ +
+ +
+ +
+
+

HyperwalletTransferMethodConfigurationKeysQuery

+
+
+ + 
public struct HyperwalletTransferMethodConfigurationKeysQuery : GraphQlQuery
+ +
+
+

The ‘HyperwalletTransferMethodConfigurationKeysQuery’ struct defines and builds a query to retrieve the key set +that is required to construct a HyperwalletTransferMethodConfigurationFieldQuery.

+ +

In addition to the key set, the query will also retrieve the processing time and fees associated with each +country, currency and transfer method type tuple.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + init(limit:) + +
    +
    +
    +
    +
    +
    +

    / Create a new HyperwalletTransferMethodConfigurationKeysQuery instance

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public init(limit: Int = 0)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + limit + + +
    +

    The maximum number of records that will be returned per page.

    +
    +
    +
    +
    +
    +
    • +
  • +
    + + + + toGraphQl(userToken:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func toGraphQl(userToken: String) -> String
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/Structs/HyperwalletTransferMethodType.html b/Structs/HyperwalletTransferMethodType.html new file mode 100644 index 00000000..f46e41f6 --- /dev/null +++ b/Structs/HyperwalletTransferMethodType.html @@ -0,0 +1,496 @@ + + + + HyperwalletTransferMethodType Structure Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + HyperwalletTransferMethodType Structure Reference +

+ +
+ +
+ +
+
+

HyperwalletTransferMethodType

+
+
+ + 
public struct HyperwalletTransferMethodType : Codable
+ +
+
+

Representation of transfer method type

+ +
+
+ +
+
+
+
    +
  • +
    + + + + code + +
    +
    +
    +
    +
    +
    +

    The country code

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let code: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + name + +
    +
    +
    +
    +
    +
    +

    The country name

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let name: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + fees + +
    +
    +
    +
    +
    +
    +

    The fees for transfer

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let fees: Connection<HyperwalletFee>?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + processingTimes + +
    +
    +
    +
    +
    +
    +

    The processing time for transfer

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let processingTimes: Connection<HyperwalletProcessingTime>?
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/Structs/HyperwalletTransferMethodTypesFeesAndProcessingTimesQuery.html b/Structs/HyperwalletTransferMethodTypesFeesAndProcessingTimesQuery.html new file mode 100644 index 00000000..5eff0edc --- /dev/null +++ b/Structs/HyperwalletTransferMethodTypesFeesAndProcessingTimesQuery.html @@ -0,0 +1,443 @@ + + + + HyperwalletTransferMethodTypesFeesAndProcessingTimesQuery Structure Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + HyperwalletTransferMethodTypesFeesAndProcessingTimesQuery Structure Reference +

+ +
+ +
+ +
+
+

HyperwalletTransferMethodTypesFeesAndProcessingTimesQuery

+
+
+ + 
public struct HyperwalletTransferMethodTypesFeesAndProcessingTimesQuery : GraphQlQuery, Hashable
+ +
+
+

The ‘HyperwalletTransferMethodTypesFeesAndProcessingTimesQuery’ struct defines +and builds a query to retrieve the processing time and fees associated with each country, currency +and transfer method type tuple. +that is required to construct a HyperwalletTransferMethodConfigurationFieldQuery.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + toGraphQl(userToken:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func toGraphQl(userToken: String) -> String
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + hash(into:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func hash(into hasher: inout Hasher)
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/Structs/HyperwalletTransferMethodUpdateConfigurationFieldQuery.html b/Structs/HyperwalletTransferMethodUpdateConfigurationFieldQuery.html new file mode 100644 index 00000000..4bd37ee5 --- /dev/null +++ b/Structs/HyperwalletTransferMethodUpdateConfigurationFieldQuery.html @@ -0,0 +1,489 @@ + + + + HyperwalletTransferMethodUpdateConfigurationFieldQuery Structure Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + HyperwalletTransferMethodUpdateConfigurationFieldQuery Structure Reference +

+ +
+ +
+ +
+
+

HyperwalletTransferMethodUpdateConfigurationFieldQuery

+
+
+ + 
public struct HyperwalletTransferMethodUpdateConfigurationFieldQuery : GraphQlQuery, Hashable
+ +
+
+

The HyperwalletTransferMethodUpdateConfigurationFieldQuery +struct defines and builds a query to retrieve the fields +required to update a transfer method (Bank Account, Bank Card, PayPal Account, Prepaid Card, Paper Check and Venmo) +with the Hyperwallet platform.

+ +
+
+ +
+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Create a new HyperwalletTransferMethodUpdateConfigurationFieldQuery from the transferMethodToken

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public init(transferMethodToken: String)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + transferMethodToken + + +
    +

    token from the transfer method

    +
    +
    +
    +
    +
    +
    • +
  • +
    + + + + toGraphQl(userToken:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func toGraphQl(userToken: String) -> String
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + hash(into:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func hash(into hasher: inout Hasher)
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/Structs/HyperwalletValidationMessage.html b/Structs/HyperwalletValidationMessage.html new file mode 100644 index 00000000..969e1c63 --- /dev/null +++ b/Structs/HyperwalletValidationMessage.html @@ -0,0 +1,469 @@ + + + + HyperwalletValidationMessage Structure Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + HyperwalletValidationMessage Structure Reference +

+ +
+ +
+ +
+
+

HyperwalletValidationMessage

+
+
+ + 
public struct HyperwalletValidationMessage : Codable
+ +
+
+

Representation of the transfer method configuration field validation message

+ +
+
+ +
+
+
+
    +
  • +
    + + + + length + +
    +
    +
    +
    +
    +
    +

    The validation message length, or nil if none exists

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let length: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + pattern + +
    +
    +
    +
    +
    +
    +

    The validation message pattern, or nil if none exists

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let pattern: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + empty + +
    +
    +
    +
    +
    +
    +

    The validation message empty, or nil if none exists

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let empty: String?
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/badge.svg b/badge.svg new file mode 100644 index 00000000..bfac0526 --- /dev/null +++ b/badge.svg @@ -0,0 +1,28 @@ + + + + + + + + + + + + + + + + documentation + + + documentation + + + 99% + + + 99% + + + diff --git a/changelog.html b/changelog.html new file mode 100644 index 00000000..e93545cb --- /dev/null +++ b/changelog.html @@ -0,0 +1,486 @@ + + + + CHANGELOG Reference + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + CHANGELOG Reference +

+ +
+ +
+ +
+
+ +

Changelog

+ +

1.0.0-beta19

+ +
+ +
    +
  • Updated ci to xcode version 15
    • +
  • Add privacy manifest
    • +
+ +

1.0.0-beta17

+ +
+ +
    +
  • Handle HTTP 401
    • +
+

1.0.0-beta16

+ +
    +
  • iOS upgrade to version 13
    • +
+

1.0.0-beta15

+ +
    +
  • Connection timeout increased
    • +
+

1.0.0-beta14

+ +
    +
  • Performance update for Add Transfer Method GraphQL
    • +
+

1.0.0-beta13

+ +
    +
  • Fixed Xcode 12 issue
    • +
+

1.0.0-beta12

+ +
    +
  • Added support for iOS 14
    • +
+

1.0.0-beta11

+ +
    +
  • Support Paper Check as a transfer method
    • +
  • Support update transfer method
    • +
  • Enhancements
    • +
+

1.0.0-beta10

+ +
    +
  • Added Venmo as a Transfer method
    • +
  • Added support for List Prepaid Card Balances
    • +
  • Enhancements
    • +
+

1.0.0-beta09

+ +
    +
  • Increased API response timeout
    • +
+

1.0.0-beta08

+ +
    +
  • Fixed Cocoapod issue
    • +
+

1.0.0-beta07

+ +
    +
  • Enhancements
    • +
+

1.0.0-beta06

+ +
    +
  • Added support to List User Balances
    • +
  • Enhancements
    • +
+

1.0.0-beta05

+ +
    +
  • Enhancements
    • +
+

1.0.0-beta04

+ +
    +
  • Added support to the following
    • +
  • Create Transfer
    • +
  • Schedule Transfer
    • +
  • Get Transfer
    • +
+

1.0.0-beta03

+ +
    +
  • Enhancements to Add Transfer Method
    • +
  • Added support to the following:
    • +
  • List Prepaid Cards
    • +
  • List Prepaid Card Receipts
    • +
  • List User Receipts
    • +
+

1.0.0-beta02

+ +
    +
  • Added PayPal as a Transfer method
    • +
  • Added support to get User object
    • +
+

1.0.0-beta01

+ +
    +
  • Initial beta release of Hyperwallet Core SDK for iOS. This beta release has the following functionality:
    • +
  • Create Bank Account and Bank Card for United States (USD)
    • +
  • Retrieve field requirements for bank Accounts and Bank Cards
    • +
  • List Accounts
    • +
  • Deactivate (Remove) Accounts
    • +
+ +
+
+ + +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/css/highlight.css b/css/highlight.css new file mode 100644 index 00000000..c170357c --- /dev/null +++ b/css/highlight.css @@ -0,0 +1,202 @@ +/*! Jazzy - https://github.com/realm/jazzy + * Copyright Realm Inc. + * SPDX-License-Identifier: MIT + */ +/* Credit to https://gist.github.com/wataru420/2048287 */ +.highlight .c { + color: #999988; + font-style: italic; } + +.highlight .err { + color: #a61717; + background-color: #e3d2d2; } + +.highlight .k { + color: #000000; + font-weight: bold; } + +.highlight .o { + color: #000000; + font-weight: bold; } + +.highlight .cm { + color: #999988; + font-style: italic; } + +.highlight .cp { + color: #999999; + font-weight: bold; } + +.highlight .c1 { + color: #999988; + font-style: italic; } + +.highlight .cs { + color: #999999; + font-weight: bold; + font-style: italic; } + +.highlight .gd { + color: #000000; + background-color: #ffdddd; } + +.highlight .gd .x { + color: #000000; + background-color: #ffaaaa; } + +.highlight .ge { + color: #000000; + font-style: italic; } + +.highlight .gr { + color: #aa0000; } + +.highlight .gh { + color: #999999; } + +.highlight .gi { + color: #000000; + background-color: #ddffdd; } + +.highlight .gi .x { + color: #000000; + background-color: #aaffaa; } + +.highlight .go { + color: #888888; } + +.highlight .gp { + color: #555555; } + +.highlight .gs { + font-weight: bold; } + +.highlight .gu { + color: #aaaaaa; } + +.highlight .gt { + color: #aa0000; } + +.highlight .kc { + color: #000000; + font-weight: bold; } + +.highlight .kd { + color: #000000; + font-weight: bold; } + +.highlight .kp { + color: #000000; + font-weight: bold; } + +.highlight .kr { + color: #000000; + font-weight: bold; } + +.highlight .kt { + color: #445588; } + +.highlight .m { + color: #009999; } + +.highlight .s { + color: #d14; } + +.highlight .na { + color: #008080; } + +.highlight .nb { + color: #0086B3; } + +.highlight .nc { + color: #445588; + font-weight: bold; } + +.highlight .no { + color: #008080; } + +.highlight .ni { + color: #800080; } + +.highlight .ne { + color: #990000; + font-weight: bold; } + +.highlight .nf { + color: #990000; } + +.highlight .nn { + color: #555555; } + +.highlight .nt { + color: #000080; } + +.highlight .nv { + color: #008080; } + +.highlight .ow { + color: #000000; + font-weight: bold; } + +.highlight .w { + color: #bbbbbb; } + +.highlight .mf { + color: #009999; } + +.highlight .mh { + color: #009999; } + +.highlight .mi { + color: #009999; } + +.highlight .mo { + color: #009999; } + +.highlight .sb { + color: #d14; } + +.highlight .sc { + color: #d14; } + +.highlight .sd { + color: #d14; } + +.highlight .s2 { + color: #d14; } + +.highlight .se { + color: #d14; } + +.highlight .sh { + color: #d14; } + +.highlight .si { + color: #d14; } + +.highlight .sx { + color: #d14; } + +.highlight .sr { + color: #009926; } + +.highlight .s1 { + color: #d14; } + +.highlight .ss { + color: #990073; } + +.highlight .bp { + color: #999999; } + +.highlight .vc { + color: #008080; } + +.highlight .vg { + color: #008080; } + +.highlight .vi { + color: #008080; } + +.highlight .il { + color: #009999; } diff --git a/css/jazzy.css b/css/jazzy.css new file mode 100644 index 00000000..c7bb9fe2 --- /dev/null +++ b/css/jazzy.css @@ -0,0 +1,404 @@ +/*! Jazzy - https://github.com/realm/jazzy + * Copyright Realm Inc. + * SPDX-License-Identifier: MIT + */ +*, *:before, *:after { + box-sizing: inherit; } + +body { + margin: 0; + background: #fff; + color: #333; + font: 16px/1.7 "Helvetica Neue", Helvetica, Arial, sans-serif; + letter-spacing: .2px; + -webkit-font-smoothing: antialiased; + box-sizing: border-box; } + +h1 { + font-size: 2rem; + font-weight: 700; + margin: 1.275em 0 0.6em; } + +h2 { + font-size: 1.75rem; + font-weight: 700; + margin: 1.275em 0 0.3em; } + +h3 { + font-size: 1.5rem; + font-weight: 700; + margin: 1em 0 0.3em; } + +h4 { + font-size: 1.25rem; + font-weight: 700; + margin: 1.275em 0 0.85em; } + +h5 { + font-size: 1rem; + font-weight: 700; + margin: 1.275em 0 0.85em; } + +h6 { + font-size: 1rem; + font-weight: 700; + margin: 1.275em 0 0.85em; + color: #777; } + +p { + margin: 0 0 1em; } + +ul, ol { + padding: 0 0 0 2em; + margin: 0 0 0.85em; } + +blockquote { + margin: 0 0 0.85em; + padding: 0 15px; + color: #858585; + border-left: 4px solid #e5e5e5; } + +img { + max-width: 100%; } + +a { + color: #4183c4; + text-decoration: none; } + a:hover, a:focus { + outline: 0; + text-decoration: underline; } + a.discouraged { + text-decoration: line-through; } + a.discouraged:hover, a.discouraged:focus { + text-decoration: underline line-through; } + +table { + background: #fff; + width: 100%; + border-collapse: collapse; + border-spacing: 0; + overflow: auto; + margin: 0 0 0.85em; } + +tr:nth-child(2n) { + background-color: #fbfbfb; } + +th, td { + padding: 6px 13px; + border: 1px solid #ddd; } + +hr { + height: 1px; + border: none; + background-color: #ddd; } + +pre { + margin: 0 0 1.275em; + padding: .85em 1em; + overflow: auto; + background: #f7f7f7; + font-size: .85em; + font-family: Consolas, "Liberation Mono", Menlo, Courier, monospace; } + +code { + font-family: Consolas, "Liberation Mono", Menlo, Courier, monospace; } + +.item-container p > code, .item-container li > code, .top-matter p > code, .top-matter li > code { + background: #f7f7f7; + padding: .2em; } + .item-container p > code:before, .item-container p > code:after, .item-container li > code:before, .item-container li > code:after, .top-matter p > code:before, .top-matter p > code:after, .top-matter li > code:before, .top-matter li > code:after { + letter-spacing: -.2em; + content: "\00a0"; } + +pre code { + padding: 0; + white-space: pre; } + +.content-wrapper { + display: flex; + flex-direction: column; } + @media (min-width: 768px) { + .content-wrapper { + flex-direction: row; } } +.header { + display: flex; + padding: 8px; + font-size: 0.875em; + background: #444; + color: #999; } + +.header-col { + margin: 0; + padding: 0 8px; } + +.header-col--primary { + flex: 1; } + +.header-link { + color: #fff; } + +.header-icon { + padding-right: 2px; + vertical-align: -3px; + height: 16px; } + +.breadcrumbs { + font-size: 0.875em; + padding: 8px 16px; + margin: 0; + background: #fbfbfb; + border-bottom: 1px solid #ddd; } + +.carat { + height: 10px; + margin: 0 5px; } + +.navigation { + order: 2; } + @media (min-width: 768px) { + .navigation { + order: 1; + width: 25%; + max-width: 300px; + padding-bottom: 64px; + overflow: hidden; + word-wrap: normal; + background: #fbfbfb; + border-right: 1px solid #ddd; } } +.nav-groups { + list-style-type: none; + padding-left: 0; } + +.nav-group-name { + border-bottom: 1px solid #ddd; + padding: 8px 0 8px 16px; } + +.nav-group-name-link { + color: #333; } + +.nav-group-tasks { + margin: 8px 0; + padding: 0 0 0 8px; } + +.nav-group-task { + font-size: 1em; + list-style-type: none; + white-space: nowrap; } + +.nav-group-task-link { + color: #808080; } + +.main-content { + order: 1; } + @media (min-width: 768px) { + .main-content { + order: 2; + flex: 1; + padding-bottom: 60px; } } +.section { + padding: 0 32px; + border-bottom: 1px solid #ddd; } + +.section-content { + max-width: 834px; + margin: 0 auto; + padding: 16px 0; } + +.section-name { + color: #666; + display: block; } + .section-name p { + margin-bottom: inherit; } + +.declaration .highlight { + overflow-x: initial; + padding: 8px 0; + margin: 0; + background-color: transparent; + border: none; } + +.task-group-section { + border-top: 1px solid #ddd; } + +.task-group { + padding-top: 0px; } + +.task-name-container a[name]:before { + content: ""; + display: block; } + +.section-name-container { + position: relative; } + .section-name-container .section-name-link { + position: absolute; + top: 0; + left: 0; + bottom: 0; + right: 0; + margin-bottom: 0; } + .section-name-container .section-name { + position: relative; + pointer-events: none; + z-index: 1; } + .section-name-container .section-name a { + pointer-events: auto; } + +.item-container { + padding: 0; } + +.item { + padding-top: 8px; + width: 100%; + list-style-type: none; } + .item a[name]:before { + content: ""; + display: block; } + .item .token, .item .direct-link { + display: inline-block; + text-indent: -20px; + padding-left: 3px; + margin-left: 20px; + font-size: 1rem; } + .item .declaration-note { + font-size: .85em; + color: #808080; + font-style: italic; } + +.pointer-container { + border-bottom: 1px solid #ddd; + left: -23px; + padding-bottom: 13px; + position: relative; + width: 110%; } + +.pointer { + left: 21px; + top: 7px; + display: block; + position: absolute; + width: 12px; + height: 12px; + border-left: 1px solid #ddd; + border-top: 1px solid #ddd; + background: #fff; + transform: rotate(45deg); } + +.height-container { + display: none; + position: relative; + width: 100%; + overflow: hidden; } + .height-container .section { + background: #fff; + border: 1px solid #ddd; + border-top-width: 0; + padding-top: 10px; + padding-bottom: 5px; + padding: 8px 16px; } + +.aside, .language { + padding: 6px 12px; + margin: 12px 0; + border-left: 5px solid #dddddd; + overflow-y: hidden; } + .aside .aside-title, .language .aside-title { + font-size: 9px; + letter-spacing: 2px; + text-transform: uppercase; + padding-bottom: 0; + margin: 0; + color: #aaa; + -webkit-user-select: none; } + .aside p:last-child, .language p:last-child { + margin-bottom: 0; } + +.language { + border-left: 5px solid #cde9f4; } + .language .aside-title { + color: #4183c4; } + +.aside-warning, .aside-deprecated, .aside-unavailable { + border-left: 5px solid #ff6666; } + .aside-warning .aside-title, .aside-deprecated .aside-title, .aside-unavailable .aside-title { + color: #ff0000; } + +.graybox { + border-collapse: collapse; + width: 100%; } + .graybox p { + margin: 0; + word-break: break-word; + min-width: 50px; } + .graybox td { + border: 1px solid #ddd; + padding: 5px 25px 5px 10px; + vertical-align: middle; } + .graybox tr td:first-of-type { + text-align: right; + padding: 7px; + vertical-align: top; + word-break: normal; + width: 40px; } + +.slightly-smaller { + font-size: 0.9em; } + +.footer { + padding: 8px 16px; + background: #444; + color: #ddd; + font-size: 0.8em; } + .footer p { + margin: 8px 0; } + .footer a { + color: #fff; } + +html.dash .header, html.dash .breadcrumbs, html.dash .navigation { + display: none; } + +html.dash .height-container { + display: block; } + +form[role=search] input { + font: 16px/1.7 "Helvetica Neue", Helvetica, Arial, sans-serif; + font-size: 14px; + line-height: 24px; + padding: 0 10px; + margin: 0; + border: none; + border-radius: 1em; } + .loading form[role=search] input { + background: white url(../img/spinner.gif) center right 4px no-repeat; } + +form[role=search] .tt-menu { + margin: 0; + min-width: 300px; + background: #fbfbfb; + color: #333; + border: 1px solid #ddd; } + +form[role=search] .tt-highlight { + font-weight: bold; } + +form[role=search] .tt-suggestion { + font: 16px/1.7 "Helvetica Neue", Helvetica, Arial, sans-serif; + padding: 0 8px; } + form[role=search] .tt-suggestion span { + display: table-cell; + white-space: nowrap; } + form[role=search] .tt-suggestion .doc-parent-name { + width: 100%; + text-align: right; + font-weight: normal; + font-size: 0.9em; + padding-left: 16px; } + +form[role=search] .tt-suggestion:hover, +form[role=search] .tt-suggestion.tt-cursor { + cursor: pointer; + background-color: #4183c4; + color: #fff; } + +form[role=search] .tt-suggestion:hover .doc-parent-name, +form[role=search] .tt-suggestion.tt-cursor .doc-parent-name { + color: #fff; } diff --git a/docsets/HyperwalletSDK.docset/Contents/Info.plist b/docsets/HyperwalletSDK.docset/Contents/Info.plist new file mode 100644 index 00000000..955f7a3f --- /dev/null +++ b/docsets/HyperwalletSDK.docset/Contents/Info.plist @@ -0,0 +1,20 @@ + + + + + CFBundleIdentifier + com.jazzy.hyperwalletsdk + CFBundleName + HyperwalletSDK + DocSetPlatformFamily + hyperwalletsdk + isDashDocset + + dashIndexFilePath + index.html + isJavaScriptEnabled + + DashDocSetFamily + dashtoc + + diff --git a/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes.html b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes.html new file mode 100644 index 00000000..21cf57c5 --- /dev/null +++ b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes.html @@ -0,0 +1,987 @@ + + + + Classes Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + Classes Reference +

+ +
+ +
+ +
+
+

Classes

+

The following classes are available globally.

+ +
+
+ +
+
+
+ +
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/Hyperwallet.html b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/Hyperwallet.html new file mode 100644 index 00000000..533ce2d9 --- /dev/null +++ b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/Hyperwallet.html @@ -0,0 +1,3532 @@ + + + + Hyperwallet Class Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + Hyperwallet Class Reference +

+ +
+ +
+ +
+
+

Hyperwallet

+
+
+ + 
@objcMembers
+public final class Hyperwallet : NSObject
+ +
+
+

The Hyperwallet class is an iOS specific implementation of the +Hyperwallet platform User APIs.

+ +

A single instance of the Hyperwallet class is maintained. Resetting the current instance by calling +setup(_: HyperwalletAuthenticationTokenProvider) is critical when switching between authenticated Users. +Failure to do so will result in incorrect access and incorrect modifications to User data.

+ +

Authentication with the Hyperwallet platform is accomplished through the usage of JSON Web Tokens. At +instantiation an HyperwalletAuthenticationTokenProvider is set as a member variable to provide +the Hyperwallet class with an authentication token upon request.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + shared + +
    +
    +
    +
    +
    +
    +

    Returns the previously initialized instance of the Hyperwallet Core SDK interface object

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public static var shared: Hyperwallet { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + clearInstance() + +
    +
    +
    +
    +
    +
    +

    Clears Hyperwallet instance.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public static func clearInstance()
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + setup(_:) + +
    +
    +
    +
    +
    +
    +

    Creates a new instance of the Hyperwallet Core SDK interface object. If a previously created instance exists, +it will be replaced.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public static func setup(_ provider: HyperwalletAuthenticationTokenProvider)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + provider + + +
    +

    a provider of Hyperwallet authentication tokens.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Retrieves a configuration if one exists - else using the authentication token from the provider, +it tries to fetch the configuration object again and returns it else error

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func getConfiguration(completion: @escaping (Configuration?, HyperwalletErrorType?) -> Void)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + completion + + +
    +

    the callback handler of responses from the Hyperwallet platform

    +
    +
    +
    +
    +
    +
    • +
  • +
    + + + + getUser(completion:) + +
    +
    +
    +
    +
    +
    +

    Returns the HyperwalletUser for the User associated with the authentication token returned from +HyperwalletAuthenticationTokenProvider.retrieveAuthenticationToken(_ : @escaping CompletionHandler) or nil +if none exists.

    + +

    The completion: @escaping (HyperwalletUser?, HyperwalletErrorType?) -> Void that is passed in to +this method invocation will receive the successful response(HyperwalletUser) or error(HyperwalletErrorType) +from processing the request.

    + +

    This function will request a new authentication token via HyperwalletAuthenticationTokenProvider +if the current one is expired or is about to expire.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func getUser(completion: @escaping (HyperwalletUser?, HyperwalletErrorType?) -> Void)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + completion + + +
    +

    the callback handler of responses from the Hyperwallet platform

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Creates a HyperwalletBankAccount for the User associated with the authentication token returned from +HyperwalletAuthenticationTokenProvider.retrieveAuthenticationToken(_ : @escaping CompletionHandler).

    + +

    The completion: @escaping (HyperwalletBankAccount?, HyperwalletErrorType?) -> Void that is passed in to this +method invocation will receive the successful response(HyperwalletBankAccount) or error(HyperwalletErrorType) +from processing the request.

    + +

    This function will request a new authentication token via HyperwalletAuthenticationTokenProvider +if the current one is expired or is about to expire.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func createBankAccount(account: HyperwalletBankAccount,
+                              completion: @escaping (HyperwalletBankAccount?, HyperwalletErrorType?) -> Void)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + account + + +
    +

    the HyperwalletBankAccount to be created

    +
    +
    + + completion + + +
    +

    the callback handler of responses from the Hyperwallet platform

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Creates a HyperwalletPaperCheck for the User associated with the authentication token returned from +HyperwalletAuthenticationTokenProvider.retrieveAuthenticationToken(_ : @escaping CompletionHandler).

    + +

    The completion: @escaping (HyperwalletPaperCheck?, HyperwalletErrorType?) -> Void +that is passed in to this method invocation will receive the successful response(HyperwalletPaperCheck) +or error(HyperwalletErrorType) from processing the request.

    + +

    This function will request a new authentication token via HyperwalletAuthenticationTokenProvider +if the current one is expired or is about to expire.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func createPaperCheck(
+    account: HyperwalletPaperCheck,
+    completion: @escaping (HyperwalletPaperCheck?, HyperwalletErrorType?) -> Void)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + account + + +
    +

    the HyperwalletPaperCheck to be created

    +
    +
    + + completion + + +
    +

    the callback handler of responses from the Hyperwallet platform

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Creates a HyperwalletBankCard for the User associated with the authentication token returned from +HyperwalletAuthenticationTokenProvider.retrieveAuthenticationToken(_ : @escaping CompletionHandler).

    + +

    The completion: @escaping (HyperwalletBankCard?, HyperwalletErrorType?) -> Void that is passed in to this +method invocation will receive the successful response(HyperwalletBankCard) or error(HyperwalletErrorType) +from processing the request.

    + +

    This function will request a new authentication token via HyperwalletAuthenticationTokenProvider +if the current one is expired or is about to expire.

    + +

    @param bankCard +@param listener

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func createBankCard(account: HyperwalletBankCard,
+                           completion: @escaping (HyperwalletBankCard?, HyperwalletErrorType?) -> Void)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + account + + +
    +

    the HyperwalletBankCard to be created

    +
    +
    + + completion + + +
    +

    the callback handler of responses from the Hyperwallet platform

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Creates a HyperwalletPayPalAccount for the User associated with the authentication token returned from +HyperwalletAuthenticationTokenProvider.retrieveAuthenticationToken(_ : @escaping CompletionHandler).

    + +

    The completion: @escaping (HyperwalletPayPalAccount?, HyperwalletErrorType?) -> Void that is passed in to this +method invocation will receive the successful response(HyperwalletPayPalAccount) or error(HyperwalletErrorType) +from processing the request.

    + +

    This function will request a new authentication token via HyperwalletAuthenticationTokenProvider +if the current one is expired or is about to expire.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func createPayPalAccount(account: HyperwalletPayPalAccount,
+                                completion: @escaping (HyperwalletPayPalAccount?, HyperwalletErrorType?) -> Void)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + account + + +
    +

    the HyperwalletPayPalAccount to be created

    +
    +
    + + completion + + +
    +

    the callback handler of responses from the Hyperwallet platform

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Creates a HyperwalletTransfer for the User associated with the authentication token returned from +HyperwalletAuthenticationTokenProvider.retrieveAuthenticationToken(_ : @escaping CompletionHandler).

    + +

    The completion: @escaping (HyperwalletTransfer?, HyperwalletErrorType?) -> Void that is passed in to this +method invocation will receive the successful response(HyperwalletTransfer) or error(HyperwalletErrorType) +from processing the request.

    + +

    This function will request a new authentication token via HyperwalletAuthenticationTokenProvider +if the current one is expired or is about to expire.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func createTransfer(transfer: HyperwalletTransfer,
+                           completion: @escaping (HyperwalletTransfer?, HyperwalletErrorType?) -> Void)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + transfer + + +
    +

    the HyperwalletTransfer to be created

    +
    +
    + + completion + + +
    +

    the callback handler of responses from the Hyperwallet platform

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Creates a HyperwalletVenmoAccount for the User associated with the authentication token returned from +HyperwalletAuthenticationTokenProvider.retrieveAuthenticationToken(_ : @escaping CompletionHandler).

    + +

    The completion: @escaping (HyperwalletVenmoAccount?, HyperwalletErrorType?) -> Void that is passed in to this +method invocation will receive the successful response(HyperwalletVenmoAccount) or error(HyperwalletErrorType) +from processing the request.

    + +

    This function will request a new authentication token via HyperwalletAuthenticationTokenProvider +if the current one is expired or is about to expire.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func createVenmoAccount(account: HyperwalletVenmoAccount,
+                               completion: @escaping (HyperwalletVenmoAccount?, HyperwalletErrorType?) -> Void)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + account + + +
    +

    the HyperwalletVenmoAccount to be created

    +
    +
    + + completion + + +
    +

    the callback handler of responses from the Hyperwallet platform

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Deactivates the HyperwalletBankAccount linked to the transfer method token specified. The +HyperwalletBankAccount being deactivated must belong to the User that is associated with the +authentication token returned from +HyperwalletAuthenticationTokenProvider.retrieveAuthenticationToken(_ : @escaping CompletionHandler).

    + +

    The completion: @escaping (HyperwalletStatusTransition?, HyperwalletErrorType?) -> Void that is passed in to +this method invocation will receive the successful response(HyperwalletStatusTransition) or +error(HyperwalletErrorType) from processing the request.

    + +

    This function will request a new authentication token via HyperwalletAuthenticationTokenProvider` +if the current one is expired or is about to expire.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func deactivateBankAccount(transferMethodToken: String,
+                                  notes: String? = nil,
+                                  completion: @escaping (HyperwalletStatusTransition?,
+                                                         HyperwalletErrorType?) -> Void)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + transferMethodToken + + +
    +

    the Hyperwallet specific unique identifier for the HyperwalletBankAccount + being deactivated

    +
    +
    + + notes + + +
    +

    a note regarding the status change

    +
    +
    + + completion + + +
    +

    the callback handler of responses from the Hyperwallet platform

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Deactivates the HyperwalletPaperCheck linked to the transfer method token specified. The +HyperwalletPaperCheck being deactivated must belong to the User that is associated with the +authentication token returned from +HyperwalletAuthenticationTokenProvider.retrieveAuthenticationToken(_ : @escaping CompletionHandler).

    + +

    The completion: @escaping (HyperwalletStatusTransition?, HyperwalletErrorType?) -> Void that is passed in to +this method invocation will receive the successful response(HyperwalletStatusTransition) or +error(HyperwalletErrorType) from processing the request.

    + +

    This function will request a new authentication token via HyperwalletAuthenticationTokenProvider` +if the current one is expired or is about to expire.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func deactivatePaperCheck(transferMethodToken: String,
+                                 notes: String? = nil,
+                                 completion: @escaping (HyperwalletStatusTransition?,
+                                                         HyperwalletErrorType?) -> Void)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + transferMethodToken + + +
    +

    the Hyperwallet specific unique identifier for the HyperwalletPaperCheck + being deactivated

    +
    +
    + + notes + + +
    +

    a note regarding the status change

    +
    +
    + + completion + + +
    +

    the callback handler of responses from the Hyperwallet platform

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Deactivates the HyperwalletBankCard linked to the transfer method token specified. The +HyperwalletBankCard being deactivated must belong to the User that is associated with the +authentication token returned from +HyperwalletAuthenticationTokenProvider.retrieveAuthenticationToken(_ : @escaping CompletionHandler).

    + +

    The completion: @escaping (HyperwalletStatusTransition?, HyperwalletErrorType?) -> Void that is passed in to +this method invocation will receive the successful response(HyperwalletStatusTransition) or +error(HyperwalletErrorType) from processing the request.

    + +

    This function will request a new authentication token via HyperwalletAuthenticationTokenProvider +if the current one is expired or is about to expire.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func deactivateBankCard(transferMethodToken: String,
+                               notes: String? = nil,
+                               completion: @escaping (HyperwalletStatusTransition?,
+                                                      HyperwalletErrorType?) -> Void)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + transferMethodToken + + +
    +

    the Hyperwallet specific unique identifier for the HyperwalletBankCard + being deactivated

    +
    +
    + + notes + + +
    +

    a note regarding the status change

    +
    +
    + + completion + + +
    +

    the callback handler of responses from the Hyperwallet platform

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Deactivates the HyperwalletPayPalAccount linked to the transfer method token specified. The +HyperwalletPayPalAccount being deactivated must belong to the User that is associated with the +authentication token returned from +HyperwalletAuthenticationTokenProvider.retrieveAuthenticationToken(_ : @escaping CompletionHandler).

    + +

    The completion: @escaping (HyperwalletStatusTransition?, HyperwalletErrorType?) -> Void that is passed in to +this method invocation will receive the successful response(HyperwalletStatusTransition) or +error(HyperwalletErrorType) from processing the request.

    + +

    This function will request a new authentication token via HyperwalletAuthenticationTokenProvider +if the current one is expired or is about to expire.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func deactivatePayPalAccount(transferMethodToken: String,
+                                    notes: String? = nil,
+                                    completion: @escaping (HyperwalletStatusTransition?,
+                                                           HyperwalletErrorType?) -> Void)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + transferMethodToken + + +
    +

    the Hyperwallet specific unique identifier for the HyperwalletPayPalAccount + being deactivated

    +
    +
    + + notes + + +
    +

    a note regarding the status change

    +
    +
    + + completion + + +
    +

    the callback handler of responses from the Hyperwallet platform

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Deactivates the HyperwalletVenmoAccount linked to the transfer method token specified. The +HyperwalletVenmoAccount being deactivated must belong to the User that is associated with the +authentication token returned from +HyperwalletAuthenticationTokenProvider.retrieveAuthenticationToken(_ : @escaping CompletionHandler).

    + +

    The completion: @escaping (HyperwalletStatusTransition?, HyperwalletErrorType?) -> Void that is passed in to +this method invocation will receive the successful response(HyperwalletStatusTransition) or +error(HyperwalletErrorType) from processing the request.

    + +

    This function will request a new authentication token via HyperwalletAuthenticationTokenProvider +if the current one is expired or is about to expire.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func deactivateVenmoAccount(transferMethodToken: String,
+                                   notes: String? = nil,
+                                   completion: @escaping (HyperwalletStatusTransition?,
+                                                          HyperwalletErrorType?) -> Void)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + transferMethodToken + + +
    +

    the Hyperwallet specific unique identifier for the HyperwalletVenmoAccount + being deactivated

    +
    +
    + + notes + + +
    +

    a note regarding the status change

    +
    +
    + + completion + + +
    +

    the callback handler of responses from the Hyperwallet platform

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Schedules the HyperwalletTransfer linked to the transfer method token specified.

    + +

    The completion: @escaping (HyperwalletStatusTransition?, HyperwalletErrorType?) -> Void that is passed in to +this method invocation will receive the successful response(HyperwalletStatusTransition) or +error(HyperwalletErrorType) from processing the request.

    + +

    This function will request a new authentication token via HyperwalletAuthenticationTokenProvider +if the current one is expired or is about to expire.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func scheduleTransfer(transferToken: String,
+                             notes: String? = nil,
+                             completion: @escaping (HyperwalletStatusTransition?, HyperwalletErrorType?) -> Void)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + transferToken + + +
    +

    the Hyperwallet specific unique identifier for the HyperwalletTransfer + being commited

    +
    +
    + + notes + + +
    +

    a note regarding the status change

    +
    +
    + + completion + + +
    +

    the callback handler of responses from the Hyperwallet platform

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Returns the HyperwalletBankAccount linked to the transfer method token specified, or nil if none exists.

    + +

    The completion: @escaping (HyperwalletBankAccount?, HyperwalletErrorType?) -> Void that is passed in to this +method invocation will receive the successful response(HyperwalletBankAccount) or error(HyperwalletErrorType) +from processing the request.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func getBankAccount(transferMethodToken: String,
+                           completion: @escaping (HyperwalletBankAccount?, HyperwalletErrorType?) -> Void)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + transferMethodToken + + +
    +

    the Hyperwallet specific unique identifier for the HyperwalletBankAccount + being requested

    +
    +
    + + completion + + +
    +

    the callback handler of responses from the Hyperwallet platform

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Returns the HyperwalletPaperCheck linked to the transfer method token specified, or nil if none exists.

    + +

    The completion: @escaping (HyperwalletPaperCheck?, HyperwalletErrorType?) -> Void +that is passed in to this method invocation will receive the successful response(HyperwalletPaperCheck) +or error(HyperwalletErrorType) from processing the request.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func getPaperCheck(
+    transferMethodToken: String,
+    completion: @escaping (HyperwalletPaperCheck?, HyperwalletErrorType?) -> Void)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + transferMethodToken + + +
    +

    the Hyperwallet specific unique identifier for the HyperwalletPaperCheck + being requested

    +
    +
    + + completion + + +
    +

    the callback handler of responses from the Hyperwallet platform

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Returns the HyperwalletBankCard linked to the transfer method token specified, or nil if none exists.

    + +

    The completion: @escaping (HyperwalletBankCard?, HyperwalletErrorType?) -> Void that is passed in to +this method invocation will receive the successful response(HyperwalletBankCard) or error(HyperwalletErrorType) +from processing the request.

    + +

    This function will request a new authentication token via HyperwalletAuthenticationTokenProvider +if the current one is expired or is about to expire.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func getBankCard(transferMethodToken: String,
+                        completion: @escaping (HyperwalletBankCard?, HyperwalletErrorType?) -> Void)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + transferMethodToken + + +
    +

    the Hyperwallet specific unique identifier for the HyperwalletBankCard + being requested

    +
    +
    + + completion + + +
    +

    the callback handler of responses from the Hyperwallet platform

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Returns the HyperwalletPayPalAccount linked to the transfer method token specified, or nil if none exists.

    + +

    The completion: @escaping (HyperwalletPayPalAccount?, HyperwalletErrorType?) -> Void that is passed in to this +method invocation will receive the successful response(HyperwalletPayPalAccount) or error(HyperwalletErrorType) +from processing the request.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func getPayPalAccount(transferMethodToken: String,
+                             completion: @escaping (HyperwalletPayPalAccount?, HyperwalletErrorType?) -> Void)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + transferMethodToken + + +
    +

    the Hyperwallet specific unique identifier for the HyperwalletPayPalAccount + being requested

    +
    +
    + + completion + + +
    +

    the callback handler of responses from the Hyperwallet platform

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Returns the HyperwalletPrepaidCard linked to the transfer method token specified, or nil if none exists.

    + +

    The completion: @escaping (HyperwalletPrepaidCard?, HyperwalletErrorType?) -> Void that is passed in to +this method invocation will receive the successful response(HyperwalletPrepaidCard) or +error(HyperwalletErrorType) from processing the request.

    + +

    This function will request a new authentication token via HyperwalletAuthenticationTokenProvider +if the current one is expired or is about to expire.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func getPrepaidCard(transferMethodToken: String,
+                           completion: @escaping (HyperwalletPrepaidCard?, HyperwalletErrorType?) -> Void)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + transferMethodToken + + +
    +

    the Hyperwallet specific unique identifier for the HyperwalletPrepaidCard + being requested

    +
    +
    + + completion + + +
    +

    the callback handler of responses from the Hyperwallet platform

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Returns the HyperwalletTransfer linked to the transfer method token specified, or nil if none exists.

    + +

    The completion: @escaping (HyperwalletTransfer?, HyperwalletErrorType?) -> Void that is passed in to this +method invocation will receive the successful response(HyperwalletTransfer) or error(HyperwalletErrorType) +from processing the request.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func getTransfer(transferToken: String,
+                        completion: @escaping (HyperwalletTransfer?, HyperwalletErrorType?) -> Void)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + transferToken + + +
    +

    the Hyperwallet specific unique identifier for the HyperwalletTransfer + being requested

    +
    +
    + + completion + + +
    +

    the callback handler of responses from the Hyperwallet platform

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Returns the HyperwalletVenmoAccount linked to the transfer method token specified, or nil if none exists.

    + +

    The completion: @escaping (HyperwalletVenmoAccount?, HyperwalletErrorType?) -> Void that is passed in to this +method invocation will receive the successful response(HyperwalletVenmoAccount) or error(HyperwalletErrorType) +from processing the request.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func getVenmoAccount(transferMethodToken: String,
+                            completion: @escaping (HyperwalletVenmoAccount?, HyperwalletErrorType?) -> Void)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + transferMethodToken + + +
    +

    the Hyperwallet specific unique identifier for the HyperwalletVenmoAccount + being requested

    +
    +
    + + completion + + +
    +

    the callback handler of responses from the Hyperwallet platform

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Returns the list of HyperwalletBankAccounts for the User associated with the authentication token +returned from +HyperwalletAuthenticationTokenProvider.retrieveAuthenticationToken(_ : @escaping CompletionHandler), +or nil if non exist.

    + +

    The ordering and filtering of HyperwalletBankAccounts will be based on the criteria specified within +the HyperwalletBankAccountQueryParam object, if it is not nil. Otherwise the default ordering and +filtering will be applied:

    + +
      +
    • Offset: 0
      • +
    • Limit: 10
      • +
    • Created Before: N/A
      • +
    • Created After: N/A
      • +
    • Type: Bank Account
      • +
    • Status: All
      • +
    • Sort By: Created On
      • +
    + +

    The completion: @escaping (HyperwalletPageList<HyperwalletBankAccount>?, HyperwalletErrorType?) -> Void that +is passed in to this method invocation will receive the successful +response(HyperwalletPageList?) or error(HyperwalletErrorType) from processing the +request.

    + +

    This function will request a new authentication token via HyperwalletAuthenticationTokenProvider +if the current one is expired or is about to expire.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func listBankAccounts(queryParam: HyperwalletBankAccountQueryParam? = nil,
+                             completion: @escaping (HyperwalletPageList<HyperwalletBankAccount>?,
+    HyperwalletErrorType?) -> Void)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + queryParam + + +
    +

    the ordering and filtering criteria

    +
    +
    + + completion + + +
    +

    the callback handler of responses from the Hyperwallet platform

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Returns the list of HyperwalletPaperChecks for the User associated with the authentication token +returned from +HyperwalletAuthenticationTokenProvider.retrieveAuthenticationToken(_ : @escaping CompletionHandler), +or nil if non exist.

    + +

    The ordering and filtering of HyperwalletPaperChecks will be based on the criteria specified within +the HyperwalletPaperCheckQueryParam object, if it is not nil. Otherwise the default ordering and +filtering will be applied:

    + +
      +
    • Offset: 0
      • +
    • Limit: 10
      • +
    • Created Before: N/A
      • +
    • Created After: N/A
      • +
    • Type: Paper Check
      • +
    • Status: All
      • +
    • Sort By: Created On
      • +
    + +

    The completion: @escaping (HyperwalletPageList<HyperwalletPaperCheck>?, HyperwalletErrorType?) -> Void +that is passed in to this method invocation will receive the successful +response(HyperwalletPageList?) or error(HyperwalletErrorType) from processing the +request.

    + +

    This function will request a new authentication token via HyperwalletAuthenticationTokenProvider +if the current one is expired or is about to expire.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func listPaperChecks(queryParam: HyperwalletPaperCheckQueryParam? = nil,
+                            completion: @escaping (HyperwalletPageList<HyperwalletPaperCheck>?,
+    HyperwalletErrorType?) -> Void)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + queryParam + + +
    +

    the ordering and filtering criteria

    +
    +
    + + completion + + +
    +

    the callback handler of responses from the Hyperwallet platform

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Returns the HyperwalletBankCard for the User associated with the authentication token returned from +HyperwalletAuthenticationTokenProvider.retrieveAuthenticationToken(_ : @escaping CompletionHandler), +or nil if non exist.

    + +

    The ordering and filtering of HyperwalletBankCard will be based on the criteria specified within the +HyperwalletBankAccountQueryParam object, if it is not nil. Otherwise the default ordering and +filtering will be applied.

    + +
      +
    • Offset: 0
      • +
    • Limit: 10
      • +
    • Created Before: N/A
      • +
    • Created After: N/A
      • +
    • Type: Bank Card
      • +
    • Status: All
      • +
    • Sort By: Created On
      • +
    + +

    The completion: @escaping (HyperwalletPageList<HyperwalletBankCard>?, HyperwalletErrorType?) -> Void that is +passed in to this method invocation will receive the successful +response(HyperwalletPageList?) or error(HyperwalletErrorType) from processing the request.

    + +

    This function will request a new authentication token via HyperwalletAuthenticationTokenProvider +if the current one is expired or is about to expire.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func listBankCards(queryParam: HyperwalletBankCardQueryParam? = nil,
+                          completion: @escaping (HyperwalletPageList<HyperwalletBankCard>?,
+                                                 HyperwalletErrorType?) -> Void)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + queryParam + + +
    +

    the ordering and filtering criteria

    +
    +
    + + completion + + +
    +

    the callback handler of responses from the Hyperwallet platform

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Returns the HyperwalletPayPalAccount for the User associated with the authentication token returned from +HyperwalletAuthenticationTokenProvider.retrieveAuthenticationToken(_ : @escaping CompletionHandler), +or nil if non exist.

    + +

    The ordering and filtering of HyperwalletPayPalAccount will be based on the criteria specified within the +HyperwalletPayPalAccountQueryParam object, if it is not nil. Otherwise the default ordering and +filtering will be applied.

    + +
      +
    • Offset: 0
      • +
    • Limit: 10
      • +
    • Created Before: N/A
      • +
    • Created After: N/A
      • +
    • Status: All
      • +
    • Sort By: Created On
      • +
    + +

    The completion: @escaping (HyperwalletPageList<HyperwalletPayPalAccount>?, HyperwalletErrorType?) -> Void +that is passed in to this method invocation will receive the successful +response(HyperwalletPageList?) or error(HyperwalletErrorType) from processing the +request.

    + +

    This function will request a new authentication token via HyperwalletAuthenticationTokenProvider +if the current one is expired or is about to expire.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func listPayPalAccounts(queryParam: HyperwalletPayPalAccountQueryParam? = nil,
+                               completion: @escaping (HyperwalletPageList<HyperwalletPayPalAccount>?,
+                                                      HyperwalletErrorType?) -> Void)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + queryParam + + +
    +

    the ordering and filtering criteria

    +
    +
    + + completion + + +
    +

    the callback handler of responses from the Hyperwallet platform

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Returns the HyperwalletTransferMethod (Bank Account, Bank Card, PayPay Account, Prepaid Card, Paper Checks) +for the User associated with the authentication token returned from +HyperwalletAuthenticationTokenProvider.retrieveAuthenticationToken(_ : @escaping CompletionHandler), +or nil if non exist.

    + +

    The ordering and filtering of HyperwalletBankCard will be based on the criteria specified within the +HyperwalletBankAccountQueryParam object, if it is not nil. Otherwise the default ordering and +filtering will be applied.

    + +
      +
    • Offset: 0
      • +
    • Limit: 10
      • +
    • Created Before: N/A
      • +
    • Created After: N/A
      • +
    • Type: All
      • +
    • Status: All
      • +
    • Sort By: Created On
      • +
    + +

    The completion: @escaping (HyperwalletPageList<HyperwalletTransferMethod>?, HyperwalletErrorType?) -> Void +that is passed in to this method invocation will receive the successful +response(HyperwalletPageList?) or error(HyperwalletErrorType) from processing +the request.

    + +

    This function will request a new authentication token via HyperwalletAuthenticationTokenProvider +if the current one is expired or is about to expire.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func listTransferMethods(queryParam: HyperwalletTransferMethodQueryParam? = nil,
+                                completion: @escaping (HyperwalletPageList<HyperwalletTransferMethod>?,
+    HyperwalletErrorType?) -> Void)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + queryParam + + +
    +

    the ordering and filtering criteria

    +
    +
    + + completion + + +
    +

    the callback handler of responses from the Hyperwallet platform

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Returns the HyperwalletPrepaidCard +for the User associated with the authentication token returned from +HyperwalletAuthenticationTokenProvider.retrieveAuthenticationToken(_ : @escaping CompletionHandler), +or nil if non exist.

    + +

    The ordering and filtering of HyperwalletPrepaidCard will be based on the criteria specified within the +HyperwalletPrepaidCardQueryParam object, if it is not nil. Otherwise the default ordering and +filtering will be applied.

    + +
      +
    • Offset: 0
      • +
    • Limit: 10
      • +
    • Created Before: N/A
      • +
    • Created After: N/A
      • +
    • Status: All
      • +
    • Sort By: Created On
      • +
    + +

    The completion: @escaping (HyperwalletPageList<HyperwalletPrepaidCard>?, HyperwalletErrorType?) -> Void +that is passed in to this method invocation will receive the successful +response(HyperwalletPageList?) or error(HyperwalletErrorType) from processing +the request.

    + +

    This function will request a new authentication token via HyperwalletAuthenticationTokenProvider +if the current one is expired or is about to expire.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func listPrepaidCards(queryParam: HyperwalletPrepaidCardQueryParam? = nil,
+                             completion: @escaping (HyperwalletPageList<HyperwalletPrepaidCard>?,
+    HyperwalletErrorType?) -> Void)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + queryParam + + +
    +

    the ordering and filtering criteria

    +
    +
    + + completion + + +
    +

    the callback handler of responses from the Hyperwallet platform

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Returns the HyperwalletVenmoAccount for the User associated with the authentication token returned from +HyperwalletAuthenticationTokenProvider.retrieveAuthenticationToken(_ : @escaping CompletionHandler), +or nil if non exist.

    + +

    The ordering and filtering of HyperwalletVenmoAccount will be based on the criteria specified within the +HyperwalletVenmoQueryParam object, if it is not nil. Otherwise the default ordering and +filtering will be applied.

    + +
      +
    • Offset: 0
      • +
    • Limit: 10
      • +
    • Created Before: N/A
      • +
    • Created After: N/A
      • +
    • Status: All
      • +
    • Sort By: Created On
      • +
    + +

    The completion: @escaping (HyperwalletPageList<HyperwalletVenmoAccount>?, HyperwalletErrorType?) -> Void +that is passed in to this method invocation will receive the successful +response(HyperwalletPageList?) or error(HyperwalletErrorType) from processing the +request.

    + +

    This function will request a new authentication token via HyperwalletAuthenticationTokenProvider +if the current one is expired or is about to expire.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func listVenmoAccounts(queryParam: HyperwalletVenmoQueryParam? = nil,
+                              completion: @escaping (HyperwalletPageList<HyperwalletVenmoAccount>?,
+                                                     HyperwalletErrorType?) -> Void)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + queryParam + + +
    +

    the ordering and filtering criteria

    +
    +
    + + completion + + +
    +

    the callback handler of responses from the Hyperwallet platform

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Returns the list of receipts for the User associated with the authentication token.

    + +

    The ordering and filtering of HyperwalletReceipt will be based on the criteria specified within the +HyperwalletReceiptQueryParam object, if it is not nil. Otherwise the default ordering and +filtering will be applied.

    + +
      +
    • Offset: 0
      • +
    • Limit: 10
      • +
    • Created Before: N/A
      • +
    • Created After: N/A
      • +
    • Currency: All
      • +
    • Sort By: Created On
      • +
    + +

    The completion: @escaping (HyperwalletPageList<HyperwalletReceipt>?, HyperwalletErrorType?) -> Void +that is passed in to this method invocation will receive the successful +response(HyperwalletPageList?) or error(HyperwalletErrorType) from processing +the request.

    + +

    This function will request a new authentication token via HyperwalletAuthenticationTokenProvider +if the current one is expired or is about to expire.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func listUserReceipts(queryParam: HyperwalletReceiptQueryParam? = nil,
+                             completion: @escaping (HyperwalletPageList<HyperwalletReceipt>?,
+    HyperwalletErrorType?) -> Void)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + queryParam + + +
    +

    the ordering and filtering criteria

    +
    +
    + + completion + + +
    +

    the callback handler of responses from the Hyperwallet platform

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The filtering of HyperwalletReceipt will be based on the criteria specified within the +HyperwalletReceiptQueryParam object. CreatedAfter needs to be provided to get the receipts. +Receipts are returned sorted in ascending order of creation date

    + +
      +
    • Created Before: N/A
      • +
    • Created After: “Some Date”
      • +
    • Currency: All
      • +
    + +

    The completion: @escaping (HyperwalletPageList<HyperwalletReceipt>?, HyperwalletErrorType?) -> Void +that is passed in to this method invocation will receive the successful +response(HyperwalletPageList?) or error(HyperwalletErrorType) from processing +the request.

    + +

    This function will request a new authentication token via HyperwalletAuthenticationTokenProvider +if the current one is expired or is about to expire.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func listPrepaidCardReceipts(prepaidCardToken: String,
+                                    queryParam: HyperwalletReceiptQueryParam? = nil,
+                                    completion: @escaping (HyperwalletPageList<HyperwalletReceipt>?,
+    HyperwalletErrorType?) -> Void)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + queryParam + + +
    +

    the ordering and filtering criteria

    +
    +
    + + completion + + +
    +

    the callback handler of responses from the Hyperwallet platform

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Returns the list of transfers for the User associated with the authentication token.

    + +

    The ordering and filtering of HyperwalletTransfer will be based on the criteria specified within the +HyperwalletTransferQueryParam object, if it is not nil. Otherwise the default ordering and +filtering will be applied.

    + +
      +
    • Offset: 0
      • +
    • Limit: 10
      • +
    • Created Before: N/A
      • +
    • Created After: N/A
      • +
    • clientTransferId: N/A
      • +
    • destinationToken: N/A
      • +
    • sourceToken: N/A
      • +
    + +

    The completion: @escaping (HyperwalletPageList<HyperwalletTransfer>?, HyperwalletErrorType?) -> Void +that is passed in to this method invocation will receive the successful +response(HyperwalletPageList?) or error(HyperwalletErrorType) from processing +the request.

    + +

    This function will request a new authentication token via HyperwalletAuthenticationTokenProvider +if the current one is expired or is about to expire.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func listTransfers(queryParam: HyperwalletTransferQueryParam? = nil,
+                          completion: @escaping (HyperwalletPageList<HyperwalletTransfer>?,
+    HyperwalletErrorType?) -> Void)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + queryParam + + +
    +

    the ordering and filtering criteria

    +
    +
    + + completion + + +
    +

    the callback handler of responses from the Hyperwallet platform

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Returns the transfer method configuration field set for the User that is associated with the authentication +token returned from +HyperwalletAuthenticationTokenProvider.retrieveAuthenticationToken(_ : @escaping CompletionHandler).

    + +

    The completion: @escaping (HyperwalletTransferMethodConfigurationField?, HyperwalletErrorType?) -> Void +that is passed in to this method invocation will receive the successful +response(HyperwalletTransferMethodConfigurationField) or error(HyperwalletErrorType) from processing the +request.

    + +

    This function will request a new authentication token via HyperwalletAuthenticationTokenProvider +if the current one is expired or is about to expire.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func retrieveTransferMethodConfigurationFields(
+    request: HyperwalletTransferMethodConfigurationFieldQuery,
+    completion: @escaping (HyperwalletTransferMethodConfigurationField?, HyperwalletErrorType?) -> Void)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + request + + +
    +

    containing a transfer method configuration key tuple of country, currency, + transfer method type and profile

    +
    +
    + + completion + + +
    +

    the callback handler of responses from the Hyperwallet platform

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Returns the transfer method update configuration fields set for the User that is associated with +the authentication token returned from +HyperwalletAuthenticationTokenProvider.retrieveAuthenticationToken(_ : @escaping CompletionHandler).

    + +

    The completion: @escaping (HyperwalletTransferMethodUpdateConfigurationField?, HyperwalletErrorType?) -> Void +that is passed in to this method invocation will receive the successful +response(HyperwalletTransferMethodUpdateConfigurationField) or error(HyperwalletErrorType) from processing the +request.

    + +

    This function will request a new authentication token via HyperwalletAuthenticationTokenProvider +if the current one is expired or is about to expire.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func retrieveTransferMethodUpdateConfigurationFields(
+    request: HyperwalletTransferMethodUpdateConfigurationFieldQuery,
+    completion: @escaping (HyperwalletTransferMethodUpdateConfigurationField?, HyperwalletErrorType?) -> Void)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + request + + +
    +

    GraphQL query containing transfer method token and required configuration fields

    +
    +
    + + completion + + +
    +

    the callback handler of responses from the Hyperwallet platform

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Returns the transfer method configuration key set for the User that is associated +with the authentication token returned from +HyperwalletAuthenticationTokenProvider.retrieveAuthenticationToken(_ : @escaping CompletionHandler).

    + +

    The completion: @escaping (HyperwalletTransferMethodConfigurationKey?, HyperwalletErrorType?) -> Void +that is passed in to this method invocation will receive the successful +response(HyperwalletTransferMethodConfigurationKey) or error(HyperwalletErrorType) from processing the +request.

    + +

    This function will request a new authentication token via HyperwalletAuthenticationTokenProvider +if the current one is expired or is about to expire.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func retrieveTransferMethodConfigurationKeys(
+    request: HyperwalletTransferMethodConfigurationKeysQuery,
+    completion: @escaping (HyperwalletTransferMethodConfigurationKey?, HyperwalletErrorType?) -> Void)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + request + + +
    +

    containing the transfer method configuration key query

    +
    +
    + + completion + + +
    +

    the callback handler of responses from the Hyperwallet platform

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Returns the transfer method types, processing times, and fees for the User that is associated +with the authentication token returned from +HyperwalletAuthenticationTokenProvider.retrieveAuthenticationToken(_ : @escaping CompletionHandler).

    + +

    The completion: @escaping (HyperwalletTransferMethodConfigurationKey?, HyperwalletErrorType?) -> Void +that is passed in to this method invocation will receive the successful +response(HyperwalletTransferMethodConfigurationKey) or +error(HyperwalletErrorType) from processing the +request.

    + +

    This function will request a new authentication token via HyperwalletAuthenticationTokenProvider +if the current one is expired or is about to expire.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func retrieveTransferMethodTypesFeesAndProcessingTimes(
+    request: HyperwalletTransferMethodTypesFeesAndProcessingTimesQuery,
+    completion: @escaping (HyperwalletTransferMethodConfigurationKey?,
+                           HyperwalletErrorType?) -> Void)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + request + + +
    +

    containing the transfer method configuration key query

    +
    +
    + + completion + + +
    +

    the callback handler of responses from the Hyperwallet platform

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Updates the HyperwalletBankAccount for the User associated with the authentication token returned from +HyperwalletAuthenticationTokenProvider.retrieveAuthenticationToken(_ : @escaping CompletionHandler).

    + +

    To identify the HyperwalletBankAccount that is going to be updated, the transfer method token must be +set as part of the HyperwalletBankAccount object passed in.

    + +

    The completion: @escaping (HyperwalletBankAccount?, HyperwalletErrorType?) -> Void that is passed in to this +method invocation will receive the successful response(HyperwalletBankAccount) or error(HyperwalletErrorType) +from processing the request.

    + +

    This function will request a new authentication token via HyperwalletAuthenticationTokenProvider +if the current one is expired or is about to expire.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func updateBankAccount(account: HyperwalletBankAccount,
+                              completion: @escaping (HyperwalletBankAccount?, HyperwalletErrorType?) -> Void)
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Updates the HyperwalletPaperCheck for the User associated with the authentication token returned from +HyperwalletAuthenticationTokenProvider.retrieveAuthenticationToken(_ : @escaping CompletionHandler).

    + +

    To identify the HyperwalletPaperCheck that is going to be updated, the transfer method token must be +set as part of the HyperwalletPaperCheck object passed in.

    + +

    The completion: @escaping (HyperwalletPaperCheck?, HyperwalletErrorType?) -> Void +that is passed in to this method invocation will receive the successful response(HyperwalletPaperCheck) +or error(HyperwalletErrorType) from processing the request.

    + +

    This function will request a new authentication token via HyperwalletAuthenticationTokenProvider +if the current one is expired or is about to expire.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func updatePaperCheck(
+    account: HyperwalletPaperCheck,
+    completion: @escaping (HyperwalletPaperCheck?, HyperwalletErrorType?) -> Void)
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Updates the HyperwalletBankCard for the User associated with the authentication token returned from +HyperwalletAuthenticationTokenProvider.retrieveAuthenticationToken(_ : @escaping CompletionHandler).

    + +

    To identify the HyperwalletBankCard that is going to be updated, the transfer method token must be +set as part of the HyperwalletBankCard object passed in.

    + +

    The completion: @escaping (HyperwalletBankCard?, HyperwalletErrorType?) -> Void that is passed in to this +method invocation will receive the successful response(HyperwalletBankCard) or error(HyperwalletErrorType) from +processing the request.

    + +

    This function will request a new authentication token via HyperwalletAuthenticationTokenProvider +if the current one is expired or is about to expire.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func updateBankCard(account: HyperwalletBankCard,
+                           completion: @escaping (HyperwalletBankCard?, HyperwalletErrorType?) -> Void)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + account + + +
    +

    the HyperwalletBankCard to be updated

    +
    +
    + + completion + + +
    +

    the callback handler of responses from the Hyperwallet platform

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Updates the HyperwalletPayPalAccount for the User associated with the authentication token returned from +HyperwalletAuthenticationTokenProvider.retrieveAuthenticationToken(_ : @escaping CompletionHandler).

    + +

    To identify the HyperwalletPayPalAccount that is going to be updated, the transfer method token must be +set as part of the HyperwalletPayPalAccount object passed in.

    + +

    The completion: @escaping (HyperwalletPayPalAccount?, HyperwalletErrorType?) -> Void that is passed in to this +method invocation will receive the successful response(HyperwalletPayPalAccount) or error(HyperwalletErrorType) +from processing the request.

    + +

    This function will request a new authentication token via HyperwalletAuthenticationTokenProvider +if the current one is expired or is about to expire.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func updatePayPalAccount(account: HyperwalletPayPalAccount,
+                                completion: @escaping (HyperwalletPayPalAccount?, HyperwalletErrorType?) -> Void)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + account + + +
    +

    the HyperwalletPayPalAccount to be updated

    +
    +
    + + completion + + +
    +

    the callback handler of responses from the Hyperwallet platform

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Updates the HyperwalletVenmoAccount for the User associated with the authentication token returned from +HyperwalletAuthenticationTokenProvider.retrieveAuthenticationToken(_ : @escaping CompletionHandler).

    + +

    To identify the HyperwalletVenmoAccount that is going to be updated, the transfer method token must be +set as part of the HyperwalletVenmoAccount object passed in.

    + +

    The completion: @escaping (HyperwalletVenmoAccount?, HyperwalletErrorType?) -> Void that is passed in to this +method invocation will receive the successful response(HyperwalletVenmoAccount) or error(HyperwalletErrorType) +from processing the request.

    + +

    This function will request a new authentication token via HyperwalletAuthenticationTokenProvider +if the current one is expired or is about to expire.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func updateVenmoAccount(account: HyperwalletVenmoAccount,
+                               completion: @escaping (HyperwalletVenmoAccount?, HyperwalletErrorType?) -> Void)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + account + + +
    +

    the HyperwalletVenmoAccount to be updated

    +
    +
    + + completion + + +
    +

    the callback handler of responses from the Hyperwallet platform

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Returns the list of balances for the User associated with the authentication token.

    + +

    The ordering and filtering of HyperwalletBalance will be based on the criteria specified within the +HyperwalletBalanceQueryParam object, if it is not nil. Otherwise the default ordering and +filtering will be applied.

    + +
      +
    • Offset: 0
      • +
    • Limit: 10
      • +
    • Currency: All
      • +
    • Sort By: currency
      • +
    + +

    The completion: @escaping (HyperwalletPageList<HyperwalletBalance>?, HyperwalletErrorType?) -> Void +that is passed in to this method invocation will receive the successful +response(HyperwalletPageList?) or error(HyperwalletErrorType) from processing +the request.

    + +

    This function will request a new authentication token via HyperwalletAuthenticationTokenProvider +if the current one is expired or is about to expire.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func listUserBalances(queryParam: HyperwalletBalanceQueryParam? = nil,
+                             completion: @escaping (HyperwalletPageList<HyperwalletBalance>?,
+    HyperwalletErrorType?) -> Void)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + queryParam + + +
    +

    the ordering and filtering criteria

    +
    +
    + + completion + + +
    +

    the callback handler of responses from the Hyperwallet platform

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Returns the list of prepaid card balances for the User associated with the authentication token.

    + +

    The ordering and filtering of HyperwalletBalance will be based on the criteria specified within the +HyperwalletPrepaidCardBalanceQueryParam object, if it is not nil. Otherwise the default ordering and +filtering will be applied.

    + +
      +
    • Offset: 0
      • +
    • Limit: 10
      • +
    • Sort By: currency
      • +
    + +

    The completion: @escaping (HyperwalletPageList<HyperwalletBalance>?, HyperwalletErrorType?) -> Void +that is passed in to this method invocation will receive the successful +response(HyperwalletPageList?) or error(HyperwalletErrorType) from processing +the request.

    + +

    This function will request a new authentication token via HyperwalletAuthenticationTokenProvider +if the current one is expired or is about to expire.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func listPrepaidCardBalances(prepaidCardToken: String,
+                                    queryParam: HyperwalletPrepaidCardBalanceQueryParam? = nil,
+                                    completion: @escaping (HyperwalletPageList<HyperwalletBalance>?,
+                                                           HyperwalletErrorType?) -> Void)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + prepaidCardToken + + +
    +

    the prepaid card token

    +
    +
    + + queryParam + + +
    +

    the ordering and filtering criteria

    +
    +
    + + completion + + +
    +

    the callback handler of responses from the Hyperwallet platform

    +
    +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/HyperwalletBalanceQueryParam.html b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/HyperwalletBalanceQueryParam.html new file mode 100644 index 00000000..8e3d847e --- /dev/null +++ b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/HyperwalletBalanceQueryParam.html @@ -0,0 +1,443 @@ + + + + HyperwalletBalanceQueryParam Class Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + HyperwalletBalanceQueryParam Class Reference +

+ +
+ +
+ +
+
+

HyperwalletBalanceQueryParam

+
+
+ + 
public class HyperwalletBalanceQueryParam : QueryParam
+ +
+
+

Representation of the balance QueryParam fields.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + currency + +
    +
    +
    +
    +
    +
    +

    A value that identifies the currency of balance

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var currency: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + QuerySortable + +
    +
    +
    +
    +
    +
    +

    Representation of the sortable fields

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public enum QuerySortable : String
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/HyperwalletBalanceQueryParam/QuerySortable.html b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/HyperwalletBalanceQueryParam/QuerySortable.html new file mode 100644 index 00000000..9df76aa1 --- /dev/null +++ b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/HyperwalletBalanceQueryParam/QuerySortable.html @@ -0,0 +1,496 @@ + + + + QuerySortable Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + QuerySortable Enumeration Reference +

+ +
+ +
+ +
+
+

QuerySortable

+
+
+ + 
public enum QuerySortable : String
+ +
+
+

Representation of the sortable fields

+ +
+
+ +
+
+
+
    +
  • +
    + + + + ascendantAmount + +
    +
    +
    +
    +
    +
    +

    Sort the result by ascendant amount

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case ascendantAmount = "+amount"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + ascendantCurrency + +
    +
    +
    +
    +
    +
    +

    Sort the result by ascendant currency

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case ascendantCurrency = "+currency"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + descendantAmount + +
    +
    +
    +
    +
    +
    +

    Sort the result by descendant amount

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case descendantAmount = "-amount"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + descendantCurrency + +
    +
    +
    +
    +
    +
    +

    Sort the result by descendant currency

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case descendantCurrency = "-currency"
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/HyperwalletBankAccount.html b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/HyperwalletBankAccount.html new file mode 100644 index 00000000..f2db6385 --- /dev/null +++ b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/HyperwalletBankAccount.html @@ -0,0 +1,1607 @@ + + + + HyperwalletBankAccount Class Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + HyperwalletBankAccount Class Reference +

+ +
+ +
+ +
+
+

HyperwalletBankAccount

+
+
+ + 
@objcMembers
+public final class HyperwalletBankAccount : HyperwalletTransferMethod
+ +
+
+

Representation of the user’s bank account

+ +
+
+ +
+
+
+
    +
  • +
    + + + + init(from:) + +
    +
    +
    +
    +
    +
    +

    The required initializer

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public required init(from decoder: Decoder) throws
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + addressLine1 + +
    +
    +
    +
    +
    +
    +

    The bank account holder’s street address.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var addressLine1: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + addressLine2 + +
    +
    +
    +
    +
    +
    +

    The bank account holder’s address, second line.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var addressLine2: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + bankAccountId + +
    +
    +
    +
    +
    +
    +

    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 var bankAccountId: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + bankAccountPurpose + +
    +
    +
    +
    +
    +
    +

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

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var bankAccountPurpose: String? { get }
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The user’s relationship with the bank account holder.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var bankAccountRelationship: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + bankId + +
    +
    +
    +
    +
    +
    +

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

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var bankId: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + bankName + +
    +
    +
    +
    +
    +
    +

    The bank name.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var bankName: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + branchId + +
    +
    +
    +
    +
    +
    +

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

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var branchId: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + branchName + +
    +
    +
    +
    +
    +
    +

    The branch name.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var branchName: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + businessContactRole + +
    +
    +
    +
    +
    +
    +

    The bank account holder’s role in the organization.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var businessContactRole: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + businessName + +
    +
    +
    +
    +
    +
    +

    The name of the bank account holder’s business.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var businessName: String? { get }
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

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

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var businessRegistrationCountry: String? { get }
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

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

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var businessRegistrationId: String? { get }
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

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

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var businessRegistrationStateProvince: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + businessType + +
    +
    +
    +
    +
    +
    +

    The bank account holder’s business type.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var businessType: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + city + +
    +
    +
    +
    +
    +
    +

    The bank account holder’s city.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var city: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + country + +
    +
    +
    +
    +
    +
    +

    The bank account holder’s country.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var country: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + countryOfBirth + +
    +
    +
    +
    +
    +
    +

    The bank account holder’s birth country.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var countryOfBirth: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + countryOfNationality + +
    +
    +
    +
    +
    +
    +

    The bank account holder’s nationality country.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var countryOfNationality: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + dateOfBirth + +
    +
    +
    +
    +
    +
    +

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

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var dateOfBirth: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + driversLicenseId + +
    +
    +
    +
    +
    +
    +

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

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var driversLicenseId: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + employerId + +
    +
    +
    +
    +
    +
    +

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

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var employerId: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + firstName + +
    +
    +
    +
    +
    +
    +

    The bank account holder’s first name.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var firstName: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + gender + +
    +
    +
    +
    +
    +
    +

    The bank account holder’s gender.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var gender: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + governmentId + +
    +
    +
    +
    +
    +
    +

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

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var governmentId: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + governmentIdType + +
    +
    +
    +
    +
    +
    +

    The bank account holder’s government ID type.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var governmentIdType: String? { get }
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The account number at the intermediary bank.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var intermediaryBankAccountId: String? { get }
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The intermediary bank street address.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var intermediaryBankAddressLine1: String? { get }
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The intermediary bank street address, second line.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var intermediaryBankAddressLine2: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + intermediaryBankCity + +
    +
    +
    +
    +
    +
    +

    The intermediary bank city.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var intermediaryBankCity: String? { get }
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The intermediary bank country.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var intermediaryBankCountry: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + intermediaryBankId + +
    +
    +
    +
    +
    +
    +

    The intermediary bank’s 11-character SWIFT code.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var intermediaryBankId: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + intermediaryBankName + +
    +
    +
    +
    +
    +
    +

    The intermediary bank name.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var intermediaryBankName: String? { get }
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The intermediary bank postal code.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var intermediaryBankPostalCode: String? { get }
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The intermediary bank state, province or region.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var intermediaryBankStateProvince: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + lastName + +
    +
    +
    +
    +
    +
    +

    The bank account holder’s last name.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var lastName: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + middleName + +
    +
    +
    +
    +
    +
    +

    The bank account holder’s middle name.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var middleName: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + mobileNumber + +
    +
    +
    +
    +
    +
    +

    The bank account holder’s cell phone number.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var mobileNumber: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + passportId + +
    +
    +
    +
    +
    +
    +

    The bank account holder’s passport number.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var passportId: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + phoneNumber + +
    +
    +
    +
    +
    +
    +

    The bank account holder’s phone number.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var phoneNumber: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + postalCode + +
    +
    +
    +
    +
    +
    +

    The bank account holder’s postal code.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var postalCode: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + stateProvince + +
    +
    +
    +
    +
    +
    +

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

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var stateProvince: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + wireInstructions + +
    +
    +
    +
    +
    +
    +

    The wire transfer instructions

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var wireInstructions: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + Builder + +
    +
    +
    +
    +
    +
    +

    A helper class to build the HyperwalletBankAccount instance.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public final class Builder
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/HyperwalletBankAccount/Builder.html b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/HyperwalletBankAccount/Builder.html new file mode 100644 index 00000000..5736577b --- /dev/null +++ b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/HyperwalletBankAccount/Builder.html @@ -0,0 +1,2805 @@ + + + + Builder Class Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + Builder Class Reference +

+ +
+ +
+ +
+
+

Builder

+
+
+ + 
public final class Builder
+ +
+
+

A helper class to build the HyperwalletBankAccount instance.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + init(token:) + +
    +
    +
    +
    +
    +
    +

    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

    +
    +
    +
    +
    +
    +
    • +
  • +
    + + + + addressLine1(_:) + +
    +
    +
    +
    +
    +
    +

    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.

    +
    +
    +
    +
    • +
  • +
    + + + + addressLine2(_:) + +
    +
    +
    +
    +
    +
    +

    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.

    +
    +
    +
    +
    • +
  • +
    + + + + bankAccountId(_:) + +
    +
    +
    +
    +
    +
    +

    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.

    +
    +
    +
    +
    • +
  • +
    + + + + bankId(_:) + +
    +
    +
    +
    +
    +
    +

    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.

    +
    +
    +
    +
    • +
  • +
    + + + + bankName(_:) + +
    +
    +
    +
    +
    +
    +

    Sets the bank name.

    + +
    +
    +

    Declaration

    +
    +

    Swift

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

    Parameters

    + + + + + + + +
    + + bankName + + +
    +

    The bank name

    +
    +
    +
    +
    +

    Return Value

    +

    a self HyperwalletBankAccount.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + branchId(_:) + +
    +
    +
    +
    +
    +
    +

    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.

    +
    +
    +
    +
    • +
  • +
    + + + + branchName(_:) + +
    +
    +
    +
    +
    +
    +

    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.

    +
    +
    +
    +
    • +
  • +
    + + + + businessName(_:) + +
    +
    +
    +
    +
    +
    +

    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.

    +
    +
    +
    +
    • +
  • +
    + + + + businessType(_:) + +
    +
    +
    +
    +
    +
    +

    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.

    +
    +
    +
    +
    • +
  • +
    + + + + city(_:) + +
    +
    +
    +
    +
    +
    +

    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.

    +
    +
    +
    +
    • +
  • +
    + + + + country(_:) + +
    +
    +
    +
    +
    +
    +

    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.

    +
    +
    +
    +
    • +
  • +
    + + + + countryOfBirth(_:) + +
    +
    +
    +
    +
    +
    +

    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.

    +
    +
    +
    +
    • +
  • +
    + + + + dateOfBirth(_:) + +
    +
    +
    +
    +
    +
    +

    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.

    +
    +
    +
    +
    • +
  • +
    + + + + driversLicenseId(_:) + +
    +
    +
    +
    +
    +
    +

    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.

    +
    +
    +
    +
    • +
  • +
    + + + + employerId(_:) + +
    +
    +
    +
    +
    +
    +

    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.

    +
    +
    +
    +
    • +
  • +
    + + + + firstName(_:) + +
    +
    +
    +
    +
    +
    +

    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.

    +
    +
    +
    +
    • +
  • +
    + + + + gender(_:) + +
    +
    +
    +
    +
    +
    +

    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.

    +
    +
    +
    +
    • +
  • +
    + + + + governmentId(_:) + +
    +
    +
    +
    +
    +
    +

    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.

    +
    +
    +
    +
    • +
  • +
    + + + + governmentIdType(_:) + +
    +
    +
    +
    +
    +
    +

    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.

    +
    +
    +
    +
    • +
  • +
    + + + + lastName(_:) + +
    +
    +
    +
    +
    +
    +

    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.

    +
    +
    +
    +
    • +
  • +
    + + + + middleName(_:) + +
    +
    +
    +
    +
    +
    +

    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.

    +
    +
    +
    +
    • +
  • +
    + + + + mobileNumber(_:) + +
    +
    +
    +
    +
    +
    +

    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.

    +
    +
    +
    +
    • +
  • +
    + + + + passportId(_:) + +
    +
    +
    +
    +
    +
    +

    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.

    +
    +
    +
    +
    • +
  • +
    + + + + phoneNumber(_:) + +
    +
    +
    +
    +
    +
    +

    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.

    +
    +
    +
    +
    • +
  • +
    + + + + postalCode(_:) + +
    +
    +
    +
    +
    +
    +

    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.

    +
    +
    +
    +
    • +
  • +
    + + + + profileType(_:) + +
    +
    +
    +
    +
    +
    +

    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.

    +
    +
    +
    +
    • +
  • +
    + + + + stateProvince(_:) + +
    +
    +
    +
    +
    +
    +

    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.

    +
    +
    +
    +
    • +
  • +
    + + + + type(_:) + +
    +
    +
    +
    +
    +
    +

    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.

    +
    +
    +
    +
    • +
  • +
    + + + + wireInstructions(_:) + +
    +
    +
    +
    +
    +
    +

    Sets wire transfer instructions.

    + +
    +
    +

    Declaration

    +
    +

    Swift

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

    Parameters

    + + + + + + + +
    + + wireInstructions + + +
    +

    Wire transfer instructions.

    +
    +
    +
    +
    +

    Return Value

    +

    a self HyperwalletBankAccount.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + build() + +
    +
    +
    +
    +
    +
    +

    Builds a new instance of the HyperwalletBankAccount.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func build() -> HyperwalletBankAccount
    + +
    +
    +
    +

    Return Value

    +

    a new instance of the HyperwalletBankAccount.

    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/HyperwalletBankAccountQueryParam.html b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/HyperwalletBankAccountQueryParam.html new file mode 100644 index 00000000..204990ae --- /dev/null +++ b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/HyperwalletBankAccountQueryParam.html @@ -0,0 +1,414 @@ + + + + HyperwalletBankAccountQueryParam Class Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + HyperwalletBankAccountQueryParam Class Reference +

+ +
+ +
+ +
+
+

HyperwalletBankAccountQueryParam

+
+
+ + 
public class HyperwalletBankAccountQueryParam : HyperwalletTransferMethodQueryParam
+ +
+
+

Representation of the bank account query parameters.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + toQuery() + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    override public func toQuery() -> [String : String]
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/HyperwalletBankCard.html b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/HyperwalletBankCard.html new file mode 100644 index 00000000..ae6bb6f8 --- /dev/null +++ b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/HyperwalletBankCard.html @@ -0,0 +1,552 @@ + + + + HyperwalletBankCard Class Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + HyperwalletBankCard Class Reference +

+ +
+ +
+ +
+
+

HyperwalletBankCard

+
+
+ + 
@objcMembers
+public class HyperwalletBankCard : HyperwalletTransferMethod
+ +
+
+

Representation of the user’s bank card

+ +
+
+ +
+
+
+
    +
  • +
    + + + + init(from:) + +
    +
    +
    +
    +
    +
    +

    The required initializer

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public required init(from decoder: Decoder) throws
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + cardBrand + +
    +
    +
    +
    +
    +
    +

    The card brand

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var cardBrand: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + cardNumber + +
    +
    +
    +
    +
    +
    +

    The card number

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var cardNumber: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + cardType + +
    +
    +
    +
    +
    +
    +

    The card type

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var cardType: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + dateOfExpiry + +
    +
    +
    +
    +
    +
    +

    The expiration date.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var dateOfExpiry: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + Builder + +
    +
    +
    +
    +
    +
    +

    A helper class to build the HyperwalletBankCard instance.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public final class Builder
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/HyperwalletBankCard/Builder.html b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/HyperwalletBankCard/Builder.html new file mode 100644 index 00000000..ca269cb5 --- /dev/null +++ b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/HyperwalletBankCard/Builder.html @@ -0,0 +1,687 @@ + + + + Builder Class Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + Builder Class Reference +

+ +
+ +
+ +
+
+

Builder

+
+
+ + 
public final class Builder
+ +
+
+

A helper class to build the HyperwalletBankCard instance.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + init(token:) + +
    +
    +
    +
    +
    +
    +

    Creates a new instance of the HyperwalletBankCard.Builder based on the required parameter to update +Bank card.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public init(token: String)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + token + + +
    +

    The bank card token.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Creates a new instance of the HyperwalletBankCard.Builder based on the required parameters to create +Bank card.

    + +
    +
    +

    Declaration

    +
    +

    Swift

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

    Parameters

    + + + + + + + + + + + + + + + +
    + + transferMethodCountry + + +
    +

    The bank card country.

    +
    +
    + + transferMethodCurrency + + +
    +

    The bank card currency.

    +
    +
    + + transferMethodProfileType + + +
    +

    The method profile type

    +
    +
    +
    +
    +
    +
    • +
  • +
    + + + + build() + +
    +
    +
    +
    +
    +
    +

    Builds a new instance of the HyperwalletBankCard.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func build() -> HyperwalletBankCard
    + +
    +
    +
    +

    Return Value

    +

    a new instance of the HyperwalletBankCard.

    +
    +
    +
    +
    • +
  • +
    + + + + cardNumber(_:) + +
    +
    +
    +
    +
    +
    +

    Sets the card number

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func cardNumber(_ cardNumber: String) -> Builder
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + cardNumber + + +
    +

    The 16-digit card number

    +
    +
    +
    +
    +

    Return Value

    +

    a self reference of HyperwalletBankCard.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + cvv(_:) + +
    +
    +
    +
    +
    +
    +

    Sets the card security code which is embossed or printed on the card.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func cvv(_ cvv: String) -> Builder
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + cvv + + +
    +

    the card security code which is embossed or printed on the card

    +
    +
    +
    +
    +

    Return Value

    +

    a self reference of HyperwalletBankCard.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + dateOfExpiry(_:) + +
    +
    +
    +
    +
    +
    +

    Sets the expiration date.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func dateOfExpiry(_ dateOfExpiry: String) -> Builder
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + dateOfExpiry + + +
    +

    the expiration date for the card (YYYY-MM).

    +
    +
    +
    +
    +

    Return Value

    +

    a self reference of HyperwalletBankCard.Builder instance.

    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/HyperwalletBankCardQueryParam.html b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/HyperwalletBankCardQueryParam.html new file mode 100644 index 00000000..80307340 --- /dev/null +++ b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/HyperwalletBankCardQueryParam.html @@ -0,0 +1,414 @@ + + + + HyperwalletBankCardQueryParam Class Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + HyperwalletBankCardQueryParam Class Reference +

+ +
+ +
+ +
+
+

HyperwalletBankCardQueryParam

+
+
+ + 
public class HyperwalletBankCardQueryParam : HyperwalletTransferMethodQueryParam
+ +
+
+

Representation of the bank card query parameters.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + toQuery() + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    override public func toQuery() -> [String : String]
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/HyperwalletPaperCheck.html b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/HyperwalletPaperCheck.html new file mode 100644 index 00000000..c0b16b4f --- /dev/null +++ b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/HyperwalletPaperCheck.html @@ -0,0 +1,1174 @@ + + + + HyperwalletPaperCheck Class Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + HyperwalletPaperCheck Class Reference +

+ +
+ +
+ +
+
+

HyperwalletPaperCheck

+
+
+ + 
@objcMembers
+public class HyperwalletPaperCheck : HyperwalletTransferMethod
+ +
+
+

Representation of the user’s paper check

+ +
+
+ +
+
+
+
    +
  • +
    + + + + init(from:) + +
    +
    +
    +
    +
    +
    +

    The required initializer

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public required init(from decoder: Decoder) throws
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The user’s relationship with the bank account holder.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var bankAccountRelationship: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + addressLine1 + +
    +
    +
    +
    +
    +
    +

    The bank account holder’s street address.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var addressLine1: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + addressLine2 + +
    +
    +
    +
    +
    +
    +

    The bank account holder’s address, second line.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var addressLine2: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + city + +
    +
    +
    +
    +
    +
    +

    The bank account holder’s city.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var city: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + country + +
    +
    +
    +
    +
    +
    +

    The bank account holder’s country.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var country: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + postalCode + +
    +
    +
    +
    +
    +
    +

    The bank account holder’s postal code.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var postalCode: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + stateProvince + +
    +
    +
    +
    +
    +
    +

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

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var stateProvince: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + shippingMethod + +
    +
    +
    +
    +
    +
    +

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

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var shippingMethod: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + businessName + +
    +
    +
    +
    +
    +
    +

    The name of the bank account holder’s business.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var businessName: String? { get }
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

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

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var businessRegistrationCountry: String? { get }
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

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

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var businessRegistrationId: String? { get }
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

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

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var businessRegistrationStateProvince: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + businessType + +
    +
    +
    +
    +
    +
    +

    The bank account holder’s business type.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var businessType: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + countryOfBirth + +
    +
    +
    +
    +
    +
    +

    The bank account holder’s birth country.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var countryOfBirth: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + countryOfNationality + +
    +
    +
    +
    +
    +
    +

    The bank account holder’s nationality country.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var countryOfNationality: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + dateOfBirth + +
    +
    +
    +
    +
    +
    +

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

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var dateOfBirth: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + driversLicenseId + +
    +
    +
    +
    +
    +
    +

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

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var driversLicenseId: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + employerId + +
    +
    +
    +
    +
    +
    +

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

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var employerId: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + firstName + +
    +
    +
    +
    +
    +
    +

    The bank account holder’s first name.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var firstName: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + gender + +
    +
    +
    +
    +
    +
    +

    The bank account holder’s gender.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var gender: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + governmentId + +
    +
    +
    +
    +
    +
    +

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

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var governmentId: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + governmentIdType + +
    +
    +
    +
    +
    +
    +

    The bank account holder’s government ID type.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var governmentIdType: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + phoneNumber + +
    +
    +
    +
    +
    +
    +

    The bank account holder’s phone number.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var phoneNumber: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + mobileNumber + +
    +
    +
    +
    +
    +
    +

    The bank account holder’s cell phone number.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var mobileNumber: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + lastName + +
    +
    +
    +
    +
    +
    +

    The bank account holder’s last name.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var lastName: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + middleName + +
    +
    +
    +
    +
    +
    +

    The bank account holder’s middle name.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var middleName: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + passportId + +
    +
    +
    +
    +
    +
    +

    The bank account holder’s passport number.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var passportId: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + Builder + +
    +
    +
    +
    +
    +
    +

    A helper class to build the HyperwalletPaperCheck instance.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public final class Builder
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/HyperwalletPaperCheck/Builder.html b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/HyperwalletPaperCheck/Builder.html new file mode 100644 index 00000000..cf393d04 --- /dev/null +++ b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/HyperwalletPaperCheck/Builder.html @@ -0,0 +1,2003 @@ + + + + Builder Class Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + Builder Class Reference +

+ +
+ +
+ +
+
+

Builder

+
+
+ + 
public final class Builder
+ +
+
+

A helper class to build the HyperwalletPaperCheck instance.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + init(token:) + +
    +
    +
    +
    +
    +
    +

    Creates a new instance of the HyperwalletPaperCheck.Builder +based on the required parameter to updaate Bank card.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public init(token: String)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + token + + +
    +

    The bank card token.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Creates a new instance of the HyperwalletPaperCheck.Builder +based on the required parameters to create paper check.

    + +
    +
    +

    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, i.e, PAPER_CHECK

    +
    +
    +
    +
    +
    +
    • +
  • +
    + + + + addressLine1(_:) + +
    +
    +
    +
    +
    +
    +

    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 HyperwalletPaperCheck.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + addressLine2(_:) + +
    +
    +
    +
    +
    +
    +

    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 HyperwalletPaperCheck.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 HyperwalletPaperCheck.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + city(_:) + +
    +
    +
    +
    +
    +
    +

    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 HyperwalletPaperCheck.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + country(_:) + +
    +
    +
    +
    +
    +
    +

    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 HyperwalletPaperCheck.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + postalCode(_:) + +
    +
    +
    +
    +
    +
    +

    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 HyperwalletPaperCheck.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + shippingMethod(_:) + +
    +
    +
    +
    +
    +
    +

    Sets the shipping method for paper check.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func shippingMethod(_ shippingMethod: String) -> Builder
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + shippingMethod + + +
    +

    The bank account holder’s postal code.

    +
    +
    +
    +
    +

    Return Value

    +

    a self HyperwalletPaperCheck.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + stateProvince(_:) + +
    +
    +
    +
    +
    +
    +

    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 HyperwalletPaperCheck.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + profileType(_:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    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 HyperwalletPaperCheck.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + lastName(_:) + +
    +
    +
    +
    +
    +
    +

    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 HyperwalletPaperCheck.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + middleName(_:) + +
    +
    +
    +
    +
    +
    +

    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 HyperwalletPaperCheck.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + mobileNumber(_:) + +
    +
    +
    +
    +
    +
    +

    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 HyperwalletPaperCheck.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + passportId(_:) + +
    +
    +
    +
    +
    +
    +

    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 HyperwalletPaperCheck.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + phoneNumber(_:) + +
    +
    +
    +
    +
    +
    +

    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 HyperwalletPaperCheck.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + countryOfBirth(_:) + +
    +
    +
    +
    +
    +
    +

    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 HyperwalletPaperCheck.Builder instance.

    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

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

    Parameters

    + + + + + + + +
    + + countryOfNationality + + +
    +

    The bank account holder’s birth country.

    +
    +
    +
    +
    +

    Return Value

    +

    a self HyperwalletPaperCheck.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + dateOfBirth(_:) + +
    +
    +
    +
    +
    +
    +

    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 HyperwalletPaperCheck.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + driversLicenseId(_:) + +
    +
    +
    +
    +
    +
    +

    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 HyperwalletPaperCheck.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + employerId(_:) + +
    +
    +
    +
    +
    +
    +

    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 HyperwalletPaperCheck.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + firstName(_:) + +
    +
    +
    +
    +
    +
    +

    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 HyperwalletPaperCheck.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + gender(_:) + +
    +
    +
    +
    +
    +
    +

    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 HyperwalletPaperCheck.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + governmentId(_:) + +
    +
    +
    +
    +
    +
    +

    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 HyperwalletPaperCheck.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + governmentIdType(_:) + +
    +
    +
    +
    +
    +
    +

    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 HyperwalletPaperCheck.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 HyperwalletPaperCheck.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + businessName(_:) + +
    +
    +
    +
    +
    +
    +

    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 HyperwalletPaperCheck.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 HyperwalletPaperCheck.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 HyperwalletPaperCheck.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 HyperwalletPaperCheck.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + businessType(_:) + +
    +
    +
    +
    +
    +
    +

    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 HyperwalletPaperCheck.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + build() + +
    +
    +
    +
    +
    +
    +

    Builds a new instance of the HyperwalletPaperCheck.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func build() -> HyperwalletPaperCheck
    + +
    +
    +
    +

    Return Value

    +

    a new instance of the HyperwalletPaperCheck.

    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/HyperwalletPaperCheckQueryParam.html b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/HyperwalletPaperCheckQueryParam.html new file mode 100644 index 00000000..bfee60cd --- /dev/null +++ b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/HyperwalletPaperCheckQueryParam.html @@ -0,0 +1,414 @@ + + + + HyperwalletPaperCheckQueryParam Class Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + HyperwalletPaperCheckQueryParam Class Reference +

+ +
+ +
+ +
+
+

HyperwalletPaperCheckQueryParam

+
+
+ + 
public class HyperwalletPaperCheckQueryParam : HyperwalletTransferMethodQueryParam
+ +
+
+

Representation of the paper check query parameters.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + toQuery() + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    override public func toQuery() -> [String : String]
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/HyperwalletPayPalAccount.html b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/HyperwalletPayPalAccount.html new file mode 100644 index 00000000..7c0bac50 --- /dev/null +++ b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/HyperwalletPayPalAccount.html @@ -0,0 +1,471 @@ + + + + HyperwalletPayPalAccount Class Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + HyperwalletPayPalAccount Class Reference +

+ +
+ +
+ +
+
+

HyperwalletPayPalAccount

+
+
+ + 
@objcMembers
+public final class HyperwalletPayPalAccount : HyperwalletTransferMethod
+ +
+
+

Representation of the user’s PayPal account

+ +
+
+ +
+
+
+
    +
  • +
    + + + + init(from:) + +
    +
    +
    +
    +
    +
    +

    The required initializer

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public required init(from decoder: Decoder) throws
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + email + +
    +
    +
    +
    +
    +
    +

    The email address.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var email: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + Builder + +
    +
    +
    +
    +
    +
    +

    A helper class to build the HyperwalletPayPalAccount instance.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public final class Builder
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/HyperwalletPayPalAccount/Builder.html b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/HyperwalletPayPalAccount/Builder.html new file mode 100644 index 00000000..bf0c2320 --- /dev/null +++ b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/HyperwalletPayPalAccount/Builder.html @@ -0,0 +1,637 @@ + + + + Builder Class Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + Builder Class Reference +

+ +
+ +
+ +
+
+

Builder

+
+
+ + 
public final class Builder
+ +
+
+

A helper class to build the HyperwalletPayPalAccount instance.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + init(token:) + +
    +
    +
    +
    +
    +
    +

    Creates a new instance of the HyperwalletPayPalAccount based on the required parameter to update +PayPal account.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public init(token: String)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + token + + +
    +

    The PayPal account token.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Creates a new instance of the HyperwalletPayPalAccount based on the required parameters to create +PayPal account.

    + +
    +
    +

    Declaration

    +
    +

    Swift

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

    Parameters

    + + + + + + + + + + + + + + + +
    + + transferMethodCountry + + +
    +

    The PayPal account country.

    +
    +
    + + transferMethodCurrency + + +
    +

    The PayPal account currency.

    +
    +
    + + transferMethodProfileType + + +
    +

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

    +
    +
    +
    +
    +
    +
    • +
  • +
    + + + + email(_:) + +
    +
    +
    +
    +
    +
    +

    Sets the email address

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func email(_ email: String) -> Builder
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + email + + +
    +

    The email address user want to create a PayPal account

    +
    +
    +
    +
    +

    Return Value

    +

    a self HyperwalletPayPalAccount.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + profileType(_:) + +
    +
    +
    +
    +
    +
    +

    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.

    +
    +
    +
    +
    • +
  • +
    + + + + build() + +
    +
    +
    +
    +
    +
    +

    Builds a new instance of the HyperwalletPayPalAccount.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func build() -> HyperwalletPayPalAccount
    + +
    +
    +
    +

    Return Value

    +

    a new instance of the HyperwalletPayPalAccount.

    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/HyperwalletPayPalAccountQueryParam.html b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/HyperwalletPayPalAccountQueryParam.html new file mode 100644 index 00000000..f64ecb3c --- /dev/null +++ b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/HyperwalletPayPalAccountQueryParam.html @@ -0,0 +1,414 @@ + + + + HyperwalletPayPalAccountQueryParam Class Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + HyperwalletPayPalAccountQueryParam Class Reference +

+ +
+ +
+ +
+
+

HyperwalletPayPalAccountQueryParam

+
+
+ + 
public class HyperwalletPayPalAccountQueryParam : HyperwalletTransferMethodQueryParam
+ +
+
+

Representation of the PayPal account query parameters.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + toQuery() + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    override public func toQuery() -> [String : String]
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/HyperwalletPrepaidCard.html b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/HyperwalletPrepaidCard.html new file mode 100644 index 00000000..e1c40411 --- /dev/null +++ b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/HyperwalletPrepaidCard.html @@ -0,0 +1,633 @@ + + + + HyperwalletPrepaidCard Class Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + HyperwalletPrepaidCard Class Reference +

+ +
+ +
+ +
+
+

HyperwalletPrepaidCard

+
+
+ + 
@objcMembers
+public final class HyperwalletPrepaidCard : HyperwalletTransferMethod
+ +
+
+

Representation of the user’s Prepaid card account

+ +
+
+ +
+
+
+
    +
  • +
    + + + + init(from:) + +
    +
    +
    +
    +
    +
    +

    The required initializer

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public required init(from decoder: Decoder) throws
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + cardType + +
    +
    +
    +
    +
    +
    +

    The prepaid card’s type

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var cardType: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + cardPackage + +
    +
    +
    +
    +
    +
    +

    The prepaid card’s package

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var cardPackage: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + cardNumber + +
    +
    +
    +
    +
    +
    +

    The prepaid card’s number

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var cardNumber: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + cardBrand + +
    +
    +
    +
    +
    +
    +

    The prepaid card’s brand

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var cardBrand: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + dateOfExpiry + +
    +
    +
    +
    +
    +
    +

    The prepaid card’s expiry date

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var dateOfExpiry: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + primaryCardToken + +
    +
    +
    +
    +
    +
    +

    The primary prepaid card’s token

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var primaryCardToken: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + userToken + +
    +
    +
    +
    +
    +
    +

    The prepaid card’s user token (instant issue cards only)

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var userToken: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + Builder + +
    +
    +
    +
    +
    +
    +

    A helper class to build the HyperwalletPrepaidCard instance.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public final class Builder
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/HyperwalletPrepaidCard/Builder.html b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/HyperwalletPrepaidCard/Builder.html new file mode 100644 index 00000000..2837f1c0 --- /dev/null +++ b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/HyperwalletPrepaidCard/Builder.html @@ -0,0 +1,615 @@ + + + + Builder Class Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + Builder Class Reference +

+ +
+ +
+ +
+
+

Builder

+
+
+ + 
public final class Builder
+ +
+
+

A helper class to build the HyperwalletPrepaidCard instance.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + init(token:) + +
    +
    +
    +
    +
    +
    +

    Creates a new instance of the HyperwalletPayPalAccount based on the required parameter to update +PayPal account.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public init(token: String)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + token + + +
    +

    The PayPal account token.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Creates a new instance of the HyperwalletPrepaidCard based on the required parameters to create +prepaid card account.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public init(transferMethodProfileType: String)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + transferMethodProfileType + + +
    +

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

    +
    +
    +
    +
    +
    +
    • +
  • +
    + + + + cardPackage(_:) + +
    +
    +
    +
    +
    +
    +

    Sets the card package

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func cardPackage(_ cardPackage: String) -> Builder
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + cardPackage + + +
    +

    The card package name or identifier. You must provide an exact cardPackage value + that has been been configured for the program or leave it blank. + If left blank, the default card package will be automatically selected.

    +
    +
    +
    +
    +

    Return Value

    +

    a self HyperwalletPrepaidCard.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + userToken(_:) + +
    +
    +
    +
    +
    +
    +

    Sets userToken for an instant issue card

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func userToken(_ userToken: String) -> Builder
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + userToken + + +
    +

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

    +
    +
    +
    +
    +

    Return Value

    +

    a self HyperwalletPrepaidCard.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + build() + +
    +
    +
    +
    +
    +
    +

    Builds a new instance of the HyperwalletPrepaidCard.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func build() -> HyperwalletPrepaidCard
    + +
    +
    +
    +

    Return Value

    +

    a new instance of the HyperwalletPrepaidCard.

    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/HyperwalletPrepaidCardBalanceQueryParam.html b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/HyperwalletPrepaidCardBalanceQueryParam.html new file mode 100644 index 00000000..d303dd83 --- /dev/null +++ b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/HyperwalletPrepaidCardBalanceQueryParam.html @@ -0,0 +1,416 @@ + + + + HyperwalletPrepaidCardBalanceQueryParam Class Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + HyperwalletPrepaidCardBalanceQueryParam Class Reference +

+ +
+ +
+ +
+
+

HyperwalletPrepaidCardBalanceQueryParam

+
+
+ + 
public class HyperwalletPrepaidCardBalanceQueryParam : QueryParam
+ +
+
+

Representation of the prepaid card balance QueryParam fields.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + QuerySortable + +
    +
    +
    +
    +
    +
    +

    Representation of the sortable fields

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public enum QuerySortable : String
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/HyperwalletPrepaidCardBalanceQueryParam/QuerySortable.html b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/HyperwalletPrepaidCardBalanceQueryParam/QuerySortable.html new file mode 100644 index 00000000..d8cd2c83 --- /dev/null +++ b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/HyperwalletPrepaidCardBalanceQueryParam/QuerySortable.html @@ -0,0 +1,496 @@ + + + + QuerySortable Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + QuerySortable Enumeration Reference +

+ +
+ +
+ +
+
+

QuerySortable

+
+
+ + 
public enum QuerySortable : String
+ +
+
+

Representation of the sortable fields

+ +
+
+ +
+
+
+
    +
  • +
    + + + + ascendantAmount + +
    +
    +
    +
    +
    +
    +

    Sort the result by ascendant amount

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case ascendantAmount = "+amount"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + ascendantCurrency + +
    +
    +
    +
    +
    +
    +

    Sort the result by ascendant currency

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case ascendantCurrency = "+currency"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + descendantAmount + +
    +
    +
    +
    +
    +
    +

    Sort the result by descendant amount

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case descendantAmount = "-amount"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + descendantCurrency + +
    +
    +
    +
    +
    +
    +

    Sort the result by descendant currency

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case descendantCurrency = "-currency"
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/HyperwalletPrepaidCardQueryParam.html b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/HyperwalletPrepaidCardQueryParam.html new file mode 100644 index 00000000..cb97a392 --- /dev/null +++ b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/HyperwalletPrepaidCardQueryParam.html @@ -0,0 +1,414 @@ + + + + HyperwalletPrepaidCardQueryParam Class Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + HyperwalletPrepaidCardQueryParam Class Reference +

+ +
+ +
+ +
+
+

HyperwalletPrepaidCardQueryParam

+
+
+ + 
public class HyperwalletPrepaidCardQueryParam : HyperwalletTransferMethodQueryParam
+ +
+
+

Representation of the prepaid card query parameters.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + toQuery() + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    override public func toQuery() -> [String : String]
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/HyperwalletReceiptQueryParam.html b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/HyperwalletReceiptQueryParam.html new file mode 100644 index 00000000..97924761 --- /dev/null +++ b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/HyperwalletReceiptQueryParam.html @@ -0,0 +1,443 @@ + + + + HyperwalletReceiptQueryParam Class Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + HyperwalletReceiptQueryParam Class Reference +

+ +
+ +
+ +
+
+

HyperwalletReceiptQueryParam

+
+
+ + 
public class HyperwalletReceiptQueryParam : QueryParam
+ +
+
+

Representation of the user receipts QueryParam fields.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + currency + +
    +
    +
    +
    +
    +
    +

    A value that identifies the user receipts currency.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var currency: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + QuerySortable + +
    +
    +
    +
    +
    +
    +

    Representation of the field’s sortable

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public enum QuerySortable : String
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/HyperwalletReceiptQueryParam/QuerySortable.html b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/HyperwalletReceiptQueryParam/QuerySortable.html new file mode 100644 index 00000000..1629787c --- /dev/null +++ b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/HyperwalletReceiptQueryParam/QuerySortable.html @@ -0,0 +1,604 @@ + + + + QuerySortable Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + QuerySortable Enumeration Reference +

+ +
+ +
+ +
+
+

QuerySortable

+
+
+ + 
public enum QuerySortable : String
+ +
+
+

Representation of the field’s sortable

+ +
+
+ +
+
+
+
    +
  • +
    + + + + ascendantAmount + +
    +
    +
    +
    +
    +
    +

    Sort the result by ascendant amount

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case ascendantAmount = "+amount"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + ascendantCreatedOn + +
    +
    +
    +
    +
    +
    +

    Sort the result by ascendant created on

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case ascendantCreatedOn = "+createdOn"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + ascendantCurrency + +
    +
    +
    +
    +
    +
    +

    Sort the result by ascendant currency

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case ascendantCurrency = "+currency"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + ascendantType + +
    +
    +
    +
    +
    +
    +

    Sort the result by ascendant type

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case ascendantType = "+type"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + descendantAmount + +
    +
    +
    +
    +
    +
    +

    Sort the result by descendant amount

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case descendantAmount = "-amount"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + descendantCreatedOn + +
    +
    +
    +
    +
    +
    +

    Sort the result by descendant created on

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case descendantCreatedOn = "-createdOn"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + descendantCurrency + +
    +
    +
    +
    +
    +
    +

    Sort the result by descendant currency

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case descendantCurrency = "-currency"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + descendantType + +
    +
    +
    +
    +
    +
    +

    Sort the result by descendant type

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case descendantType = "-type"
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/HyperwalletTransferMethod.html b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/HyperwalletTransferMethod.html new file mode 100644 index 00000000..e99a14c4 --- /dev/null +++ b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/HyperwalletTransferMethod.html @@ -0,0 +1,821 @@ + + + + HyperwalletTransferMethod Class Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + HyperwalletTransferMethod Class Reference +

+ +
+ +
+ +
+
+

HyperwalletTransferMethod

+
+
+ + 
@objcMembers
+public class HyperwalletTransferMethod : NSObject, Codable
+ +
+
+

Representation of the transfer method (bank account, bank card, PayPal account, prepaid card, paper check).

+ +
+
+ +
+
+
+
    +
  • +
    + + + + TransferMethodField + +
    +
    +
    +
    +
    +
    +

    Representation of the transfer method’s field type

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public enum TransferMethodField : String
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + TransferMethodType + +
    +
    +
    +
    +
    +
    +

    Representation of the transfer method’s type

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public enum TransferMethodType : String
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + init() + +
    +
    +
    +
    +
    +
    +

    Creates a new instance of the HyperwalletTransferMethod

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    override public init()
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + init(from:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public required init(from decoder: Decoder) throws
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + encode(to:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func encode(to encoder: Encoder) throws
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + getField(_:) + +
    +
    +
    +
    +
    +
    +

    Gets the field value

    + +
    +
    +

    Declaration

    +
    +

    Swift

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

    Parameters

    + + + + + + + +
    + + fieldName + + +
    +

    The TransferMethodField type raw value

    +
    +
    +
    +
    +

    Return Value

    +

    Returns the field value, or nil if none exists.

    +
    +
    +
    +
    • +
  • +
    + + + + setField(key:value:) + +
    +
    +
    +
    +
    +
    +

    Sets the field value based on the key

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func setField(key: TransferMethodField.RawValue, value: String)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + key + + +
    +

    The TransferMethodField.RawValue value

    +
    +
    + + value + + +
    +

    The value

    +
    +
    +
    +
    +
    +
    • +
  • +
    + + + + createdOn + +
    +
    +
    +
    +
    +
    +

    The transfer method’s created time

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var createdOn: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + profileType + +
    +
    +
    +
    +
    +
    +

    The transfer method holder’s profile type, e.g. INDIVIDUAL or BUSINESS.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var profileType: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + status + +
    +
    +
    +
    +
    +
    +

    The transfer method’s status

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var status: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + token + +
    +
    +
    +
    +
    +
    +

    The transfer method’s token

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var token: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + transferMethodCountry + +
    +
    +
    +
    +
    +
    +

    The transfer method’s country

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var transferMethodCountry: String? { get }
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The transfer method’s currency

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var transferMethodCurrency: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + type + +
    +
    +
    +
    +
    +
    +

    The transfer method’s type

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var type: String? { get }
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/HyperwalletTransferMethod/TransferMethodField.html b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/HyperwalletTransferMethod/TransferMethodField.html new file mode 100644 index 00000000..3937fd3d --- /dev/null +++ b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/HyperwalletTransferMethod/TransferMethodField.html @@ -0,0 +1,2038 @@ + + + + TransferMethodField Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + TransferMethodField Enumeration Reference +

+ +
+ +
+ +
+
+

TransferMethodField

+
+
+ + 
public enum TransferMethodField : String
+ +
+
+

Representation of the transfer method’s field type

+ +
+
+ +
+
+
+
    +
  • +
    + + + + createdOn + +
    +
    +
    +
    +
    +
    +

    The datetime when the transfer method was created on.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case createdOn
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + status + +
    +
    +
    +
    +
    +
    +

    The transfer method status transition.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case status
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + token + +
    +
    +
    +
    +
    +
    +

    The transfer method identifier.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case token
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + transferMethodCountry + +
    +
    +
    +
    +
    +
    +

    The transfer method country.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case transferMethodCountry
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The transfer method currency.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case transferMethodCurrency
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + type + +
    +
    +
    +
    +
    +
    +

    The transfer method type.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case type
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + addressLine1 + +
    +
    +
    +
    +
    +
    +

    The bank account holder’s street address.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case addressLine1
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + addressLine2 + +
    +
    +
    +
    +
    +
    +

    The bank account holder’s address, second line.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case addressLine2
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + bankAccountId + +
    +
    +
    +
    +
    +
    +

    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

    + 
    case bankAccountId
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + bankAccountPurpose + +
    +
    +
    +
    +
    +
    +

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

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case bankAccountPurpose
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The user’s relationship with the bank account holder.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case bankAccountRelationship
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + bankId + +
    +
    +
    +
    +
    +
    +

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

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case bankId
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + bankName + +
    +
    +
    +
    +
    +
    +

    The bank name.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case bankName
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + branchId + +
    +
    +
    +
    +
    +
    +

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

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case branchId
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + branchName + +
    +
    +
    +
    +
    +
    +

    The branch name

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case branchName
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + businessContactRole + +
    +
    +
    +
    +
    +
    +

    The bank account holder’s role in the organization.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case businessContactRole
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + businessName + +
    +
    +
    +
    +
    +
    +

    The name of the transfer method holder’s business

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case businessName
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The country where the transfer method holder’s business is registered

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case businessRegistrationCountry
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

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

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case businessRegistrationId
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

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

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case businessRegistrationStateProvince
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + businessType + +
    +
    +
    +
    +
    +
    +

    The bank account holder’s business type.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case businessType
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + city + +
    +
    +
    +
    +
    +
    +

    The bank account holder’s city.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case city
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + country + +
    +
    +
    +
    +
    +
    +

    The bank account holder’s country.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case country
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + countryOfBirth + +
    +
    +
    +
    +
    +
    +

    The country where bank account holder born

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case countryOfBirth
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + countryOfNationality + +
    +
    +
    +
    +
    +
    +

    The Nationality of the bank account holder

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case countryOfNationality
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + dateOfBirth + +
    +
    +
    +
    +
    +
    +

    The bank account holder’s date of birth.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case dateOfBirth
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + driversLicenseId + +
    +
    +
    +
    +
    +
    +

    The LicenseId of the bank account holder

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case driversLicenseId
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + employerId + +
    +
    +
    +
    +
    +
    +

    The employer Id of the bank account holder

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case employerId
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + firstName + +
    +
    +
    +
    +
    +
    +

    The bank account holder’s first name.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case firstName
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + gender + +
    +
    +
    +
    +
    +
    +

    The bank account holder’s gender

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case gender
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + governmentId + +
    +
    +
    +
    +
    +
    +

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

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case governmentId
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + governmentIdType + +
    +
    +
    +
    +
    +
    +

    The bank account holder’s government IdType

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case governmentIdType
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The bank account holder’s Intermediary Bank AccountId

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case intermediaryBankAccountId
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The bank account holder’s Intermediary Bank AddressLine1

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case intermediaryBankAddressLine1
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The bank account holder’s Intermediary Bank AddressLine2

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case intermediaryBankAddressLine2
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + intermediaryBankCity + +
    +
    +
    +
    +
    +
    +

    The bank account holder’s Intermediary Bank’s City

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case intermediaryBankCity
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The bank account holder’s Intermediary Bank’s Country

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case intermediaryBankCountry
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + intermediaryBankId + +
    +
    +
    +
    +
    +
    +

    The bank account holder’s Intermediary Bank Id

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case intermediaryBankId
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + intermediaryBankName + +
    +
    +
    +
    +
    +
    +

    The bank account holder’s Intermediary Bank Name

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case intermediaryBankName
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The bank account holder’s Intermediary PostalCode:

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case intermediaryBankPostalCode
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The bank account holder’s Intermediary Bank’s State and Province

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case intermediaryBankStateProvince
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + lastName + +
    +
    +
    +
    +
    +
    +

    The bank account holder’s last name.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case lastName
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + middleName + +
    +
    +
    +
    +
    +
    +

    The bank account holder’s middle name.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case middleName
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + mobileNumber + +
    +
    +
    +
    +
    +
    +

    The bank account holder’s mobile number

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case mobileNumber
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + passportId + +
    +
    +
    +
    +
    +
    +

    The bank account holder’s passport Id

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case passportId
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + phoneNumber + +
    +
    +
    +
    +
    +
    +

    The bank account holder’s phone number.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case phoneNumber
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + postalCode + +
    +
    +
    +
    +
    +
    +

    The bank account holder’s postal code.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case postalCode
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + profileType + +
    +
    +
    +
    +
    +
    +

    The bank account holder’s profile type.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case profileType
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + stateProvince + +
    +
    +
    +
    +
    +
    +

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

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case stateProvince
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + wireInstructions + +
    +
    +
    +
    +
    +
    +

    The wire transfer instructions

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case wireInstructions
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + cardBrand + +
    +
    +
    +
    +
    +
    +

    The card brand.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case cardBrand
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + cardNumber + +
    +
    +
    +
    +
    +
    +

    The 16-digit card number.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case cardNumber
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + cardType + +
    +
    +
    +
    +
    +
    +

    The bank card type.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case cardType
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + cvv + +
    +
    +
    +
    +
    +
    +

    The card security code which is embossed or printed on the card.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case cvv
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + dateOfExpiry + +
    +
    +
    +
    +
    +
    +

    The expiration date for the card (YYYY-MM).

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case dateOfExpiry
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + primaryCardToken + +
    +
    +
    +
    +
    +
    +

    The primary card token

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case primaryCardToken
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + email + +
    +
    +
    +
    +
    +
    +

    The email address associated with the PayPal account.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case email
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + accountId + +
    +
    +
    +
    +
    +
    +

    The mobile number associated with the Venmo account.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case accountId
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + cardPackage + +
    +
    +
    +
    +
    +
    +

    The card’s package

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case cardPackage
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + userToken + +
    +
    +
    +
    +
    +
    +

    The user token

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case userToken
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + shippingMethod + +
    +
    +
    +
    +
    +
    +

    The shipping method

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case shippingMethod
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/HyperwalletTransferMethod/TransferMethodType.html b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/HyperwalletTransferMethod/TransferMethodType.html new file mode 100644 index 00000000..6b258ab7 --- /dev/null +++ b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/HyperwalletTransferMethod/TransferMethodType.html @@ -0,0 +1,577 @@ + + + + TransferMethodType Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + TransferMethodType Enumeration Reference +

+ +
+ +
+ +
+
+

TransferMethodType

+
+
+ + 
public enum TransferMethodType : String
+ +
+
+

Representation of the transfer method’s type

+ +
+
+ +
+
+
+
    +
  • +
    + + + + bankAccount + +
    +
    +
    +
    +
    +
    +

    When the transfer method is Bank Account

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case bankAccount = "BANK_ACCOUNT"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + bankCard + +
    +
    +
    +
    +
    +
    +

    When the transfer method is Bank Card

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case bankCard = "BANK_CARD"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + payPalAccount + +
    +
    +
    +
    +
    +
    +

    When the transfer method is PayPal Account

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case payPalAccount = "PAYPAL_ACCOUNT"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + wireAccount + +
    +
    +
    +
    +
    +
    +

    When the transfer method is Wire Account

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case wireAccount = "WIRE_ACCOUNT"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + prepaidCard + +
    +
    +
    +
    +
    +
    +

    When the transfer method is Prepaid Card

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case prepaidCard = "PREPAID_CARD"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + venmoAccount + +
    +
    +
    +
    +
    +
    +

    When the transfer method is Venmo Account

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case venmoAccount = "VENMO_ACCOUNT"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + paperCheck + +
    +
    +
    +
    +
    +
    +

    when transfer method is paper check

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case paperCheck = "PAPER_CHECK"
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/HyperwalletTransferMethodQueryParam.html b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/HyperwalletTransferMethodQueryParam.html new file mode 100644 index 00000000..ccf6b0f4 --- /dev/null +++ b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/HyperwalletTransferMethodQueryParam.html @@ -0,0 +1,552 @@ + + + + HyperwalletTransferMethodQueryParam Class Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + HyperwalletTransferMethodQueryParam Class Reference +

+ +
+ +
+ +
+
+

HyperwalletTransferMethodQueryParam

+
+
+ + 
public class HyperwalletTransferMethodQueryParam : QueryParam
+ +
+
+

Representation of the common transfer method’s query parameters.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + status + +
    +
    +
    +
    +
    +
    +

    Returns transfer method with this status.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var status: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + type + +
    +
    +
    +
    +
    +
    +

    Returns transfer method of that type

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var type: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + QueryStatus + +
    +
    +
    +
    +
    +
    +

    Representation of the transfer method status

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public enum QueryStatus : String
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + QuerySortable + +
    +
    +
    +
    +
    +
    +

    Representation of the field’s sortable

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public enum QuerySortable : String
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + QueryType + +
    +
    +
    +
    +
    +
    +

    Representation of the transfer method’s type

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public enum QueryType : String
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + toQuery() + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    override public func toQuery() -> [String : String]
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/HyperwalletTransferMethodQueryParam/QuerySortable.html b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/HyperwalletTransferMethodQueryParam/QuerySortable.html new file mode 100644 index 00000000..9610f5fc --- /dev/null +++ b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/HyperwalletTransferMethodQueryParam/QuerySortable.html @@ -0,0 +1,496 @@ + + + + QuerySortable Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + QuerySortable Enumeration Reference +

+ +
+ +
+ +
+
+

QuerySortable

+
+
+ + 
public enum QuerySortable : String
+ +
+
+

Representation of the field’s sortable

+ +
+
+ +
+
+
+
    +
  • +
    + + + + ascendantCreatedOn + +
    +
    +
    +
    +
    +
    +

    Sort the result by ascendant created on

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case ascendantCreatedOn = "+createdOn"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + ascendantStatus + +
    +
    +
    +
    +
    +
    +

    Sort the result by ascendant status

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case ascendantStatus = "+status"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + descendantCreatedOn + +
    +
    +
    +
    +
    +
    +

    Sort the result by descendant created on

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case descendantCreatedOn = "-createdOn"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + descendantStatus + +
    +
    +
    +
    +
    +
    +

    Sort the result by descendant status

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case descendantStatus = "-status"
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/HyperwalletTransferMethodQueryParam/QueryStatus.html b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/HyperwalletTransferMethodQueryParam/QueryStatus.html new file mode 100644 index 00000000..87122bbe --- /dev/null +++ b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/HyperwalletTransferMethodQueryParam/QueryStatus.html @@ -0,0 +1,577 @@ + + + + QueryStatus Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + QueryStatus Enumeration Reference +

+ +
+ +
+ +
+
+

QueryStatus

+
+
+ + 
public enum QueryStatus : String
+ +
+
+

Representation of the transfer method status

+ +
+
+ +
+
+
+
    +
  • +
    + + + + activated + +
    +
    +
    +
    +
    +
    +

    Filter by activated transfer methods

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case activated = "ACTIVATED"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + deActivated + +
    +
    +
    +
    +
    +
    +

    Filter by deActivated transfer methods

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case deActivated = "DE_ACTIVATED"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + invalid + +
    +
    +
    +
    +
    +
    +

    Filter only invalid transfer methods

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case invalid = "INVALID"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + lostOrStolen + +
    +
    +
    +
    +
    +
    +

    Filter only lost or stolen prepaid cards

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case lostOrStolen = "LOST_OR_STOLEN"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + preActivated + +
    +
    +
    +
    +
    +
    +

    Filter by preActivated prepaid cards

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case preActivated = "PRE_ACTIVATED"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + suspended + +
    +
    +
    +
    +
    +
    +

    Filter only suspended prepaid cards

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case suspended = "SUSPENDED"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + verified + +
    +
    +
    +
    +
    +
    +

    Filter only verified transfer methods

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case verified = "VERIFIED"
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/HyperwalletTransferMethodQueryParam/QueryType.html b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/HyperwalletTransferMethodQueryParam/QueryType.html new file mode 100644 index 00000000..e5c1eac4 --- /dev/null +++ b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/HyperwalletTransferMethodQueryParam/QueryType.html @@ -0,0 +1,577 @@ + + + + QueryType Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + QueryType Enumeration Reference +

+ +
+ +
+ +
+
+

QueryType

+
+
+ + 
public enum QueryType : String
+ +
+
+

Representation of the transfer method’s type

+ +
+
+ +
+
+
+
    +
  • +
    + + + + bankAccount + +
    +
    +
    +
    +
    +
    +

    When the transfer method is Bank Account

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case bankAccount = "BANK_ACCOUNT"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + bankCard + +
    +
    +
    +
    +
    +
    +

    When the transfer method is Bank Card

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case bankCard = "BANK_CARD"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + payPalAccount + +
    +
    +
    +
    +
    +
    +

    When the transfer method is PayPal Account

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case payPalAccount = "PAYPAL_ACCOUNT"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + wireAccount + +
    +
    +
    +
    +
    +
    +

    When the transfer method is Wire Account

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case wireAccount = "WIRE_ACCOUNT"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + prepaidCard + +
    +
    +
    +
    +
    +
    +

    When the transfer method is Prepaid Card

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case prepaidCard = "PREPAID_CARD"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + venmoAccount + +
    +
    +
    +
    +
    +
    +

    When the transfer method is Venmo Account

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case venmoAccount = "VENMO_ACCOUNT"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + paperCheck + +
    +
    +
    +
    +
    +
    +

    When the transfer method is Paper Check

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case paperCheck = "PAPER_CHECK"
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/HyperwalletTransferQueryParam.html b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/HyperwalletTransferQueryParam.html new file mode 100644 index 00000000..741fc448 --- /dev/null +++ b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/HyperwalletTransferQueryParam.html @@ -0,0 +1,469 @@ + + + + HyperwalletTransferQueryParam Class Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + HyperwalletTransferQueryParam Class Reference +

+ +
+ +
+ +
+
+

HyperwalletTransferQueryParam

+
+
+ + 
public class HyperwalletTransferQueryParam : QueryParam
+ +
+
+

Representation of the user transfers QueryParams fields.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + clientTransferId + +
    +
    +
    +
    +
    +
    +

    A value that identifies the client transfer id.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var clientTransferId: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + destinationToken + +
    +
    +
    +
    +
    +
    +

    A value that identifies the destination token.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var destinationToken: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + sourceToken + +
    +
    +
    +
    +
    +
    +

    A value that identifies the source token.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var sourceToken: String?
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/HyperwalletUser.html b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/HyperwalletUser.html new file mode 100644 index 00000000..0f07e832 --- /dev/null +++ b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/HyperwalletUser.html @@ -0,0 +1,1879 @@ + + + + HyperwalletUser Class Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + HyperwalletUser Class Reference +

+ +
+ +
+ +
+
+

HyperwalletUser

+
+
+ + 
@objcMembers
+public class HyperwalletUser : NSObject, Codable
+ +
+
+

Representation of the Hyperwallet’s user.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + UserField + +
    +
    +
    +
    +
    +
    +

    Representation of the user field type.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public enum UserField : String
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + BusinessType + +
    +
    +
    +
    +
    +
    +

    The business type.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public enum BusinessType : String
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + BusinessContactRole + +
    +
    +
    +
    +
    +
    +

    The user’s role in the organization.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public enum BusinessContactRole : String
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + Gender + +
    +
    +
    +
    +
    +
    +

    Representation of the gender.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public enum Gender : String
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + ProfileType + +
    +
    +
    +
    +
    +
    +

    Representation of the user’s profile type.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public enum ProfileType : String
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + Status + +
    +
    +
    +
    +
    +
    +

    Representation of the user account status type.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public enum Status : String
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + VerificationStatus + +
    +
    +
    +
    +
    +
    +

    Representation of the user’s verification status type.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public enum VerificationStatus : String, Codable
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + init(from:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public required init(from decoder: Decoder) throws
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + addressLine1 + +
    +
    +
    +
    +
    +
    +

    The user’s street address.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var addressLine1: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + addressLine2 + +
    +
    +
    +
    +
    +
    +

    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 }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + businessContactCity + +
    +
    +
    +
    +
    +
    +

    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 }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + businessContactRole + +
    +
    +
    +
    +
    +
    +

    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 }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + businessName + +
    +
    +
    +
    +
    +
    +

    The business name.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var businessName: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + businessOperatingName + +
    +
    +
    +
    +
    +
    +

    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 }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + businessType + +
    +
    +
    +
    +
    +
    +

    The business type

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var businessType: BusinessType? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + city + +
    +
    +
    +
    +
    +
    +

    The user’s city.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var city: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + clientUserId + +
    +
    +
    +
    +
    +
    +

    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 }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + country + +
    +
    +
    +
    +
    +
    +

    The user’s country.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var country: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + countryOfBirth + +
    +
    +
    +
    +
    +
    +

    The user’s birth country.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var countryOfBirth: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + countryOfNationality + +
    +
    +
    +
    +
    +
    +

    The user’s country of citizenship or nationality.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var countryOfNationality: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + createdOn + +
    +
    +
    +
    +
    +
    +

    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 }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + dateOfBirth + +
    +
    +
    +
    +
    +
    +

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

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var dateOfBirth: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + driversLicenseId + +
    +
    +
    +
    +
    +
    +

    The user’s driver’s license number.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var driversLicenseId: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + email + +
    +
    +
    +
    +
    +
    +

    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 }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + employerId + +
    +
    +
    +
    +
    +
    +

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

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var employerId: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + firstName + +
    +
    +
    +
    +
    +
    +

    The user’s first name.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var firstName: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + gender + +
    +
    +
    +
    +
    +
    +

    The user’s gender.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var gender: Gender? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + governmentId + +
    +
    +
    +
    +
    +
    +

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

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var governmentId: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + governmentIdType + +
    +
    +
    +
    +
    +
    +

    The user’s government ID type.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var governmentIdType: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + language + +
    +
    +
    +
    +
    +
    +

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

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var language: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + lastName + +
    +
    +
    +
    +
    +
    +

    The user’s last name.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var lastName: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + middleName + +
    +
    +
    +
    +
    +
    +

    The user’s middle name.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var middleName: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + mobileNumber + +
    +
    +
    +
    +
    +
    +

    The user’s cell phone number.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var mobileNumber: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + passportId + +
    +
    +
    +
    +
    +
    +

    The user’s passport number.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var passportId: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + phoneNumber + +
    +
    +
    +
    +
    +
    +

    The user’s phone number.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var phoneNumber: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + postalCode + +
    +
    +
    +
    +
    +
    +

    The user’s postal code.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var postalCode: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + profileType + +
    +
    +
    +
    +
    +
    +

    The user’s profile type. See ProfileType

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var profileType: ProfileType? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + programToken + +
    +
    +
    +
    +
    +
    +

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

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var programToken: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + stateProvince + +
    +
    +
    +
    +
    +
    +

    The user’s state, province or region.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var stateProvince: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + status + +
    +
    +
    +
    +
    +
    +

    The user account status.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var status: Status? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + timeZone + +
    +
    +
    +
    +
    +
    +

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

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var timeZone: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + token + +
    +
    +
    +
    +
    +
    +

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

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var token: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + verificationStatus + +
    +
    +
    +
    +
    +
    +

    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 }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + encode(to:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func encode(to encoder: Encoder) throws
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + getField(_:) + +
    +
    +
    +
    +
    +
    +

    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.

    +
    +
    +
    +
    • +
  • +
    + + + + Builder + +
    +
    +
    +
    +
    +
    +

    A helper class to build the HyperwalletUser instance.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public final class Builder
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/HyperwalletUser/Builder.html b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/HyperwalletUser/Builder.html new file mode 100644 index 00000000..c0e5d993 --- /dev/null +++ b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/HyperwalletUser/Builder.html @@ -0,0 +1,2645 @@ + + + + Builder Class Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + Builder Class Reference +

+ +
+ +
+ +
+
+

Builder

+
+
+ + 
public final class Builder
+ +
+
+

A helper class to build the HyperwalletUser instance.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + addressLine1(_:) + +
    +
    +
    +
    +
    +
    +

    Sets the user’s street address.

    + +
    +
    +

    Declaration

    +
    +

    Swift

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

    Parameters

    + + + + + + + +
    + + addressLine1 + + +
    +

    The user’s street address

    +
    +
    +
    +
    +

    Return Value

    +

    a self reference of HyperwalletUser.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + addressLine2(_:) + +
    +
    +
    +
    +
    +
    +

    Sets the user’s address, second line.

    + +
    +
    +

    Declaration

    +
    +

    Swift

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

    Parameters

    + + + + + + + +
    + + addressLine2 + + +
    +

    The user’s address, second line.

    +
    +
    +
    +
    +

    Return Value

    +

    a self reference of HyperwalletUser.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + build() + +
    +
    +
    +
    +
    +
    +

    Builds a new instance of the HyperwalletUser.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func build() -> HyperwalletUser
    + +
    +
    +
    +

    Return Value

    +

    a new instance of the HyperwalletUser.

    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Sets the business contact’s street address.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func businessContactAddressLine1(_ businessContactAddressLine1: String) -> Builder
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + businessContactAddressLine1 + + +
    +

    The business contact’s street address.

    +
    +
    +
    +
    +

    Return Value

    +

    a self reference of HyperwalletUser.Builder instance.

    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Sets the business contact’s address, second line.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func businessContactAddressLine2(_ businessContactAddressLine2: String) -> Builder
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + businessContactAddressLine2 + + +
    +

    The business contact’s address, second line.

    +
    +
    +
    +
    +

    Return Value

    +

    a self reference of HyperwalletUser.Builder instance.

    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Sets the business contact’s city.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func businessContactCity(_ businessContactCity: String) -> Builder
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + businessContactCity + + +
    +

    The business contact’s city.

    +
    +
    +
    +
    +

    Return Value

    +

    a self reference of HyperwalletUser.Builder instance.

    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Sets the business contact’s country.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func businessContactCountry(_ businessContactCountry: String) -> Builder
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + businessContactCountry + + +
    +

    The business contact’s city.

    +
    +
    +
    +
    +

    Return Value

    +

    a self reference of HyperwalletUser.Builder instance.

    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Sets the business contact’s postal code.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func businessContactPostalCode(_ businessContactPostalCode: String) -> Builder
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + businessContactPostalCode + + +
    +

    The business contact’s postal code.

    +
    +
    +
    +
    +

    Return Value

    +

    a self reference of HyperwalletUser.Builder instance.

    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Sets the user’s role in the organization.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func businessContactRole(_ businessContactRole: BusinessContactRole) -> Builder
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + businessContactPostalCode + + + +
    +
    +
    +

    Return Value

    +

    a self reference of HyperwalletUser.Builder instance.

    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Sets the business contact’s state, province or region.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func businessContactStateProvince(_ businessContactStateProvince: String) -> Builder
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + businessContactStateProvince + + +
    +

    The business contact’s state, province or region.

    +
    +
    +
    +
    +

    Return Value

    +

    a self reference of HyperwalletUser.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + businessName(_:) + +
    +
    +
    +
    +
    +
    +

    Sets the business name.

    + +
    +
    +

    Declaration

    +
    +

    Swift

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

    Parameters

    + + + + + + + +
    + + businessName + + +
    +

    The business name.

    +
    +
    +
    +
    +

    Return Value

    +

    a self reference of HyperwalletUser.Builder instance.

    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Sets the business’ operating name.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func businessOperatingName(_ businessOperatingName: String) -> Builder
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + businessName + + +
    +

    The business’ operating name.

    +
    +
    +
    +
    +

    Return Value

    +

    a self reference of HyperwalletUser.Builder instance.

    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Sets the country where the business is registered.

    + +
    +
    +

    Declaration

    +
    +

    Swift

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

    Parameters

    + + + + + + + +
    + + businessRegistrationCountry + + +
    +

    The country where the business is registered.

    +
    +
    +
    +
    +

    Return Value

    +

    a self reference of HyperwalletUser.Builder instance.

    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Sets the business registration number or identifier assigned by a government body.

    + +
    +
    +

    Declaration

    +
    +

    Swift

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

    Parameters

    + + + + + + + +
    + + businessRegistrationId + + +
    +

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

    +
    +
    +
    +
    +

    Return Value

    +

    a self reference of HyperwalletUser.Builder instance.

    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Sets the state, province or region where the business is registered.

    + +
    +
    +

    Declaration

    +
    +

    Swift

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

    Parameters

    + + + + + + + +
    + + businessRegistrationStateProvince + + +
    +

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

    +
    +
    +
    +
    +

    Return Value

    +

    a self reference of HyperwalletUser.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + businessType(_:) + +
    +
    +
    +
    +
    +
    +

    Sets the business type.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func businessType(_ businessType: BusinessType) -> Builder
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + businessRegistrationStateProvince + + +
    +

    The BusinessType.

    +
    +
    +
    +
    +

    Return Value

    +

    a self reference of HyperwalletUser.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + city(_:) + +
    +
    +
    +
    +
    +
    +

    Sets the user’s city.

    + +
    +
    +

    Declaration

    +
    +

    Swift

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

    Parameters

    + + + + + + + +
    + + city + + +
    +

    The user’s city.

    +
    +
    +
    +
    +

    Return Value

    +

    a self reference of HyperwalletUser.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + country(_:) + +
    +
    +
    +
    +
    +
    +

    Sets the user’s country.

    + +
    +
    +

    Declaration

    +
    +

    Swift

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

    Parameters

    + + + + + + + +
    + + country + + +
    +

    The user’s country.

    +
    +
    +
    +
    +

    Return Value

    +

    a self reference of HyperwalletUser.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + countryOfBirth(_:) + +
    +
    +
    +
    +
    +
    +

    Sets the user’s birth country.

    + +
    +
    +

    Declaration

    +
    +

    Swift

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

    Parameters

    + + + + + + + +
    + + country + + +
    +

    The user’s birth country.

    +
    +
    +
    +
    +

    Return Value

    +

    a self reference of HyperwalletUser.Builder instance.

    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Sets the user’s country of citizenship or nationality.

    + +
    +
    +

    Declaration

    +
    +

    Swift

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

    Parameters

    + + + + + + + +
    + + countryOfNationality + + +
    +

    The user’s country of citizenship or nationality.

    +
    +
    +
    +
    +

    Return Value

    +

    a self reference of HyperwalletUser.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + createdOn(_:) + +
    +
    +
    +
    +
    +
    +

    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) -> Builder
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + createdOn + + +
    +

    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.

    +
    +
    +
    +
    +

    Return Value

    +

    a self reference of HyperwalletUser.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + dateOfBirth(_:) + +
    +
    +
    +
    +
    +
    +

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

    + +
    +
    +

    Declaration

    +
    +

    Swift

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

    Parameters

    + + + + + + + +
    + + dateOfBirth + + +
    +

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

    +
    +
    +
    +
    +

    Return Value

    +

    a self reference of HyperwalletUser.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + driversLicenseId(_:) + +
    +
    +
    +
    +
    +
    +

    Sets the user’s driver’s license number.

    + +
    +
    +

    Declaration

    +
    +

    Swift

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

    Parameters

    + + + + + + + +
    + + driversLicenseId + + +
    +

    The user’s driver’s license number.

    +
    +
    +
    +
    +

    Return Value

    +

    a self reference of HyperwalletUser.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + email(_:) + +
    +
    +
    +
    +
    +
    +

    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) -> Builder
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + driversLicenseId + + +
    +

    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.

    +
    +
    +
    +
    +

    Return Value

    +

    a self reference of HyperwalletUser.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + employerId(_:) + +
    +
    +
    +
    +
    +
    +

    Sets the user’s employer identifier, generally used for tax purposes.

    + +
    +
    +

    Declaration

    +
    +

    Swift

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

    Parameters

    + + + + + + + +
    + + employerId + + +
    +

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

    +
    +
    +
    +
    +

    Return Value

    +

    a self reference of HyperwalletUser.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + firstName(_:) + +
    +
    +
    +
    +
    +
    +

    Sets the user’s first name.

    + +
    +
    +

    Declaration

    +
    +

    Swift

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

    Parameters

    + + + + + + + +
    + + firstName + + +
    +

    The user’s first name.

    +
    +
    +
    +
    +

    Return Value

    +

    a self reference of HyperwalletUser.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + gender(_:) + +
    +
    +
    +
    +
    +
    +

    Sets the user’s gender.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func gender(_ gender: Gender) -> Builder
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + gender + + +
    +

    The Gender.

    +
    +
    +
    +
    +

    Return Value

    +

    a self reference of HyperwalletUser.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + governmentId(_:) + +
    +
    +
    +
    +
    +
    +

    Sets the user’s government ID number, such as a Social Security Number.

    + +
    +
    +

    Declaration

    +
    +

    Swift

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

    Parameters

    + + + + + + + +
    + + governmentId + + +
    +

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

    +
    +
    +
    +
    +

    Return Value

    +

    a self reference of HyperwalletUser.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + governmentIdType(_:) + +
    +
    +
    +
    +
    +
    +

    Sets the user’s government ID type.

    + +
    +
    +

    Declaration

    +
    +

    Swift

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

    Parameters

    + + + + + + + +
    + + governmentIdType + + +
    +

    The user’s government ID type.

    +
    +
    +
    +
    +

    Return Value

    +

    a self reference of HyperwalletUser.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + language(_:) + +
    +
    +
    +
    +
    +
    +

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

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func language(_ language: String) -> Builder
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + language + + +
    +

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

    +
    +
    +
    +
    +

    Return Value

    +

    a self reference of HyperwalletUser.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + lastName(_:) + +
    +
    +
    +
    +
    +
    +

    Sets the user’s last name.

    + +
    +
    +

    Declaration

    +
    +

    Swift

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

    Parameters

    + + + + + + + +
    + + lastName + + +
    +

    The user’s last name.

    +
    +
    +
    +
    +

    Return Value

    +

    a self reference of HyperwalletUser.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + middleName(_:) + +
    +
    +
    +
    +
    +
    +

    Sets the user’s middle name.

    + +
    +
    +

    Declaration

    +
    +

    Swift

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

    Parameters

    + + + + + + + +
    + + middleName + + +
    +

    The user’s middle name.

    +
    +
    +
    +
    +

    Return Value

    +

    a self reference of HyperwalletUser.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + mobileNumber(_:) + +
    +
    +
    +
    +
    +
    +

    Sets the user’s cell phone number.

    + +
    +
    +

    Declaration

    +
    +

    Swift

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

    Parameters

    + + + + + + + +
    + + middleName + + +
    +

    The user’s middle name.

    +
    +
    +
    +
    +

    Return Value

    +

    a self reference of HyperwalletUser.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + passportId(_:) + +
    +
    +
    +
    +
    +
    +

    Sets the user’s passport number.

    + +
    +
    +

    Declaration

    +
    +

    Swift

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

    Parameters

    + + + + + + + +
    + + passportId + + +
    +

    The user’s passport number.

    +
    +
    +
    +
    +

    Return Value

    +

    a self reference of HyperwalletUser.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + phoneNumber(_:) + +
    +
    +
    +
    +
    +
    +

    Sets the user’s phone number.

    + +
    +
    +

    Declaration

    +
    +

    Swift

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

    Parameters

    + + + + + + + +
    + + passportId + + +
    +

    The user’s phone number.

    +
    +
    +
    +
    +

    Return Value

    +

    a self reference of HyperwalletUser.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + postalCode(_:) + +
    +
    +
    +
    +
    +
    +

    Sets the user’s postal code.

    + +
    +
    +

    Declaration

    +
    +

    Swift

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

    Parameters

    + + + + + + + +
    + + postalCode + + +
    +

    The user’s postal code.

    +
    +
    +
    +
    +

    Return Value

    +

    a self reference of HyperwalletUser.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + profileType(_:) + +
    +
    +
    +
    +
    +
    +

    Sets the user’s profile type.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func profileType(_ profileType: ProfileType) -> Builder
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + profileType + + +
    +

    The ProfileType.

    +
    +
    +
    +
    +

    Return Value

    +

    a self reference of HyperwalletUser.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + programToken(_:) + +
    +
    +
    +
    +
    +
    +

    Sets the unique identifier for the program to which the user will belong.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func programToken(_ programToken: String) -> Builder
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + programToken + + +
    +

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

    +
    +
    +
    +
    +

    Return Value

    +

    a self reference of HyperwalletUser.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + setField(key:value:) + +
    +
    +
    +
    +
    +
    +

    Sets the field value based on the UserField

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func setField(key: UserField, value: String) -> Builder
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + key + + +
    +

    The UserField value

    +
    +
    + + value + + +
    +

    The value

    +
    +
    +
    +
    +
    +
    • +
  • +
    + + + + setField(key:value:) + +
    +
    +
    +
    +
    +
    +

    Sets the field value based on the UserField.RawValue

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func setField(key: UserField.RawValue, value: String) -> Builder
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + key + + +
    +

    The UserField.RawValue value

    +
    +
    + + value + + +
    +

    The value

    +
    +
    +
    +
    +
    +
    • +
  • +
    + + + + stateProvince(_:) + +
    +
    +
    +
    +
    +
    +

    Sets the user’s state, province or region.

    + +
    +
    +

    Declaration

    +
    +

    Swift

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

    Parameters

    + + + + + + + +
    + + stateProvince + + +
    +

    The user’s state, province or region.

    +
    +
    +
    +
    +

    Return Value

    +

    a self reference of HyperwalletUser.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + status(_:) + +
    +
    +
    +
    +
    +
    +

    Sets the user account status.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func status(_ status: Status) -> Builder
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + status + + +
    +

    The user’s state, province or region.

    +
    +
    +
    +
    +

    Return Value

    +

    a self reference of HyperwalletUser.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + timeZone(_:) + +
    +
    +
    +
    +
    +
    +

    Sets the local time of a region or a country. e.g. GMT, PST, …

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func timeZone(_ timeZone: String) -> Builder
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + timeZone + + +
    +

    The local time of a region or a country.

    +
    +
    +
    +
    +

    Return Value

    +

    a self reference of HyperwalletUser.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + token(_:) + +
    +
    +
    +
    +
    +
    +

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

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func token(_ token: String) -> Builder
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + token + + +
    +

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

    +
    +
    +
    +
    +

    Return Value

    +

    a self reference of HyperwalletUser.Builder instance.

    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    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) -> Builder
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + verificationStatus + + +
    +

    The 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.Builder instance.

    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/HyperwalletUser/BusinessContactRole.html b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/HyperwalletUser/BusinessContactRole.html new file mode 100644 index 00000000..291d303b --- /dev/null +++ b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/HyperwalletUser/BusinessContactRole.html @@ -0,0 +1,469 @@ + + + + BusinessContactRole Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + BusinessContactRole Enumeration Reference +

+ +
+ +
+ +
+
+

BusinessContactRole

+
+
+ + 
public enum BusinessContactRole : String
+ +
+
+

The user’s role in the organization.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + director + +
    +
    +
    +
    +
    +
    +

    The director role

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case director = "DIRECTOR"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + other + +
    +
    +
    +
    +
    +
    +

    The other role

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case other = "OTHER"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + owner + +
    +
    +
    +
    +
    +
    +

    The owner role

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case owner = "OWNER"
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/HyperwalletUser/BusinessType.html b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/HyperwalletUser/BusinessType.html new file mode 100644 index 00000000..0c8b2837 --- /dev/null +++ b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/HyperwalletUser/BusinessType.html @@ -0,0 +1,442 @@ + + + + BusinessType Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + BusinessType Enumeration Reference +

+ +
+ +
+ +
+
+

BusinessType

+
+
+ + 
public enum BusinessType : String
+ +
+
+

The business type.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + corporation + +
    +
    +
    +
    +
    +
    +

    The corporation business type

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case corporation = "CORPORATION"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + partnership + +
    +
    +
    +
    +
    +
    +

    The partnership business type

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case partnership = "PARTNERSHIP"
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/HyperwalletUser/Gender.html b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/HyperwalletUser/Gender.html new file mode 100644 index 00000000..3beaebde --- /dev/null +++ b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/HyperwalletUser/Gender.html @@ -0,0 +1,442 @@ + + + + Gender Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + Gender Enumeration Reference +

+ +
+ +
+ +
+
+

Gender

+
+
+ + 
public enum Gender : String
+ +
+
+

Representation of the gender.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + female + +
    +
    +
    +
    +
    +
    +

    The female gender

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case female = "FEMALE"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + male + +
    +
    +
    +
    +
    +
    +

    The male gender

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case male = "MALE"
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/HyperwalletUser/ProfileType.html b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/HyperwalletUser/ProfileType.html new file mode 100644 index 00000000..1fe02214 --- /dev/null +++ b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/HyperwalletUser/ProfileType.html @@ -0,0 +1,442 @@ + + + + ProfileType Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + ProfileType Enumeration Reference +

+ +
+ +
+ +
+
+

ProfileType

+
+
+ + 
public enum ProfileType : String
+ +
+
+

Representation of the user’s profile type.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + business + +
    +
    +
    +
    +
    +
    +

    The business profile type.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case business = "BUSINESS"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + individual + +
    +
    +
    +
    +
    +
    +

    The individual profile type.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case individual = "INDIVIDUAL"
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/HyperwalletUser/Status.html b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/HyperwalletUser/Status.html new file mode 100644 index 00000000..dc45ef55 --- /dev/null +++ b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/HyperwalletUser/Status.html @@ -0,0 +1,523 @@ + + + + Status Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + Status Enumeration Reference +

+ +
+ +
+ +
+
+

Status

+
+
+ + 
public enum Status : String
+ +
+
+

Representation of the user account status type.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + activated + +
    +
    +
    +
    +
    +
    +

    The user account is activated.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case activated = "ACTIVATED"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + deactivated + +
    +
    +
    +
    +
    +
    +

    The user account is deactivated.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case deactivated = "DE_ACTIVATED"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + frozen + +
    +
    +
    +
    +
    +
    +

    The user account is frozen.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case frozen = "FROZEN"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + locked + +
    +
    +
    +
    +
    +
    +

    The user account is locked.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case locked = "LOCKED"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + preActivated + +
    +
    +
    +
    +
    +
    +

    The user account is pre activated.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case preActivated = "PRE_ACTIVATED"
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/HyperwalletUser/UserField.html b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/HyperwalletUser/UserField.html new file mode 100644 index 00000000..89a96a38 --- /dev/null +++ b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/HyperwalletUser/UserField.html @@ -0,0 +1,1553 @@ + + + + UserField Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + UserField Enumeration Reference +

+ +
+ +
+ +
+
+

UserField

+
+
+ + 
public enum UserField : String
+ +
+
+

Representation of the user field type.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + addressLine1 + +
    +
    +
    +
    +
    +
    +

    The user’s street address.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case addressLine1
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + addressLine2 + +
    +
    +
    +
    +
    +
    +

    The user’s address, second line.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case addressLine2
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The business contact’s street address.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case businessContactAddressLine1
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The business contact’s address, second line.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case businessContactAddressLine2
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + businessContactCity + +
    +
    +
    +
    +
    +
    +

    The business contact’s city.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case businessContactCity
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The business contact’s country.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case businessContactCountry
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The business contact’s postal code.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case businessContactPostalCode
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + businessContactRole + +
    +
    +
    +
    +
    +
    +

    The user’s role in the organization.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case businessContactRole
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The business contact’s state, province or region.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case businessContactStateProvince
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + businessName + +
    +
    +
    +
    +
    +
    +

    The business name.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case businessName
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + businessOperatingName + +
    +
    +
    +
    +
    +
    +

    The business’ operating name.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case businessOperatingName
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The country where the business is registered.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case businessRegistrationCountry
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

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

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case businessRegistrationId
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

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

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case businessRegistrationStateProvince
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + businessType + +
    +
    +
    +
    +
    +
    +

    The business type.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case businessType
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + city + +
    +
    +
    +
    +
    +
    +

    The user’s city.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case city
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + clientUserId + +
    +
    +
    +
    +
    +
    +

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

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case clientUserId
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + country + +
    +
    +
    +
    +
    +
    +

    The user’s country.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case country
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + countryOfBirth + +
    +
    +
    +
    +
    +
    +

    The user’s birth country.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case countryOfBirth
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + countryOfNationality + +
    +
    +
    +
    +
    +
    +

    The user’s country of citizenship or nationality.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case countryOfNationality
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + createdOn + +
    +
    +
    +
    +
    +
    +

    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

    + 
    case createdOn
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + dateOfBirth + +
    +
    +
    +
    +
    +
    +

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

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case dateOfBirth
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + driversLicenseId + +
    +
    +
    +
    +
    +
    +

    The user’s driver’s license number.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case driversLicenseId
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + email + +
    +
    +
    +
    +
    +
    +

    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

    + 
    case email
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + employerId + +
    +
    +
    +
    +
    +
    +

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

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case employerId
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + firstName + +
    +
    +
    +
    +
    +
    +

    The user’s first name.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case firstName
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + gender + +
    +
    +
    +
    +
    +
    +

    The user’s gender.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case gender
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + governmentId + +
    +
    +
    +
    +
    +
    +

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

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case governmentId
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + governmentIdType + +
    +
    +
    +
    +
    +
    +

    The user’s government ID type.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case governmentIdType
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + language + +
    +
    +
    +
    +
    +
    +

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

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case language
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + lastName + +
    +
    +
    +
    +
    +
    +

    The user’s last name.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case lastName
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + middleName + +
    +
    +
    +
    +
    +
    +

    The user’s middle name.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case middleName
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + mobileNumber + +
    +
    +
    +
    +
    +
    +

    The user’s cell phone number.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case mobileNumber
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + passportId + +
    +
    +
    +
    +
    +
    +

    The user’s passport number.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case passportId
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + phoneNumber + +
    +
    +
    +
    +
    +
    +

    The user’s phone number.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case phoneNumber
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + postalCode + +
    +
    +
    +
    +
    +
    +

    The user’s postal code.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case postalCode
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + profileType + +
    +
    +
    +
    +
    +
    +

    The user’s postal code.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case profileType
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + programToken + +
    +
    +
    +
    +
    +
    +

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

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case programToken
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + stateProvince + +
    +
    +
    +
    +
    +
    +

    The user’s state, province or region.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case stateProvince
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + status + +
    +
    +
    +
    +
    +
    +

    The user account status.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case status
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + timeZone + +
    +
    +
    +
    +
    +
    +

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

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case timeZone
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + token + +
    +
    +
    +
    +
    +
    +

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

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case token
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + verificationStatus + +
    +
    +
    +
    +
    +
    +

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

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case verificationStatus
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/HyperwalletUser/VerificationStatus.html b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/HyperwalletUser/VerificationStatus.html new file mode 100644 index 00000000..55ca2481 --- /dev/null +++ b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/HyperwalletUser/VerificationStatus.html @@ -0,0 +1,523 @@ + + + + VerificationStatus Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + VerificationStatus Enumeration Reference +

+ +
+ +
+ +
+
+

VerificationStatus

+
+
+ + 
public enum VerificationStatus : String, Codable
+ +
+
+

Representation of the user’s verification status type.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + failed + +
    +
    +
    +
    +
    +
    +

    The user’s verification status is fail. Temporary status before changing to REQUIRED.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case failed = "FAILED"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + notRequired + +
    +
    +
    +
    +
    +
    +

    The user’s verification status is not require.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case notRequired = "NOT_REQUIRED"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + required + +
    +
    +
    +
    +
    +
    +

    The user’s verification status is require.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case required = "REQUIRED"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + underReview + +
    +
    +
    +
    +
    +
    +

    The user’s verification status is under review.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case underReview = "UNDER_REVIEW"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + verified + +
    +
    +
    +
    +
    +
    +

    The user’s verification status is verified.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case verified = "VERIFIED"
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/HyperwalletVenmoAccount.html b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/HyperwalletVenmoAccount.html new file mode 100644 index 00000000..8d5065a1 --- /dev/null +++ b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/HyperwalletVenmoAccount.html @@ -0,0 +1,471 @@ + + + + HyperwalletVenmoAccount Class Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + HyperwalletVenmoAccount Class Reference +

+ +
+ +
+ +
+
+

HyperwalletVenmoAccount

+
+
+ + 
@objcMembers
+public final class HyperwalletVenmoAccount : HyperwalletTransferMethod
+ +
+
+

Representation of the user’s Venmo account

+ +
+
+ +
+
+
+
    +
  • +
    + + + + init(from:) + +
    +
    +
    +
    +
    +
    +

    The required initializer

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public required init(from decoder: Decoder) throws
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + accountId + +
    +
    +
    +
    +
    +
    +

    The accountId as phone number.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var accountId: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + Builder + +
    +
    +
    +
    +
    +
    +

    A helper class to build the HyperwalletVenmoAccount instance.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public final class Builder
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/HyperwalletVenmoAccount/Builder.html b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/HyperwalletVenmoAccount/Builder.html new file mode 100644 index 00000000..2c03ba5c --- /dev/null +++ b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/HyperwalletVenmoAccount/Builder.html @@ -0,0 +1,637 @@ + + + + Builder Class Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + Builder Class Reference +

+ +
+ +
+ +
+
+

Builder

+
+
+ + 
public final class Builder
+ +
+
+

A helper class to build the HyperwalletVenmoAccount instance.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + init(token:) + +
    +
    +
    +
    +
    +
    +

    Creates a new instance of the HyperwalletVenmoAccount based on the required parameter to update +Venmo account.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public init(token: String)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + token + + +
    +

    The Venmo account token.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Creates a new instance of the HyperwalletVenmoAccount based on the required parameters to create +Venmo account.

    + +
    +
    +

    Declaration

    +
    +

    Swift

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

    Parameters

    + + + + + + + + + + + + + + + +
    + + transferMethodCountry + + +
    +

    The Venmo account country.

    +
    +
    + + transferMethodCurrency + + +
    +

    The Venmo account currency.

    +
    +
    + + transferMethodProfileType + + +
    +

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

    +
    +
    +
    +
    +
    +
    • +
  • +
    + + + + accountId(_:) + +
    +
    +
    +
    +
    +
    +

    Sets the accountId address

    + +
    +
    +

    Declaration

    +
    +

    Swift

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

    Parameters

    + + + + + + + +
    + + accountId + + +
    +

    The accountId as phone number user want to create a Venmo account

    +
    +
    +
    +
    +

    Return Value

    +

    a self HyperwalletVenmoAccount.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + profileType(_:) + +
    +
    +
    +
    +
    +
    +

    Sets the bank account holder’s profile type.

    + +
    +
    +

    Declaration

    +
    +

    Swift

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

    Parameters

    + + + + + + + +
    + + profileType + + +
    +

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

    +
    +
    +
    +
    +

    Return Value

    +

    a self HyperwalletVenmoAccount.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + build() + +
    +
    +
    +
    +
    +
    +

    Builds a new instance of the HyperwalletVenmoAccount.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func build() -> HyperwalletVenmoAccount
    + +
    +
    +
    +

    Return Value

    +

    a new instance of the HyperwalletVenmoAccount.

    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/HyperwalletVenmoQueryParam.html b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/HyperwalletVenmoQueryParam.html new file mode 100644 index 00000000..0fa7a27b --- /dev/null +++ b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/HyperwalletVenmoQueryParam.html @@ -0,0 +1,414 @@ + + + + HyperwalletVenmoQueryParam Class Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + HyperwalletVenmoQueryParam Class Reference +

+ +
+ +
+ +
+
+

HyperwalletVenmoQueryParam

+
+
+ + 
public class HyperwalletVenmoQueryParam : HyperwalletTransferMethodQueryParam
+ +
+
+

Representation of the common Venmo’s query parameters.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + toQuery() + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    override public func toQuery() -> [String : String]
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/QueryParam.html b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/QueryParam.html new file mode 100644 index 00000000..dda9fa54 --- /dev/null +++ b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Classes/QueryParam.html @@ -0,0 +1,552 @@ + + + + QueryParam Class Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + QueryParam Class Reference +

+ +
+ +
+ +
+
+

QueryParam

+
+
+ + 
public class QueryParam
+ +
+
+

Representation of the common query parameters.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + createdAfter + +
    +
    +
    +
    +
    +
    +

    Returns user receipts created after this datetime.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var createdAfter: Date?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + createdBefore + +
    +
    +
    +
    +
    +
    +

    Returns user receipts created before this datetime.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var createdBefore: Date?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + limit + +
    +
    +
    +
    +
    +
    +

    The maximum number of records that will be returned per page

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var limit: Int?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + offset + +
    +
    +
    +
    +
    +
    +

    The number of records to skip. If no filters are applied, records will be skipped from the beginning +(based on default sort criteria). Default value is 0. Range is from 0 to {n-1} where n = number of +matching records for the query.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var offset: Int?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + sortBy + +
    +
    +
    +
    +
    +
    +

    The user receipts attribute to sort the result set by.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var sortBy: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + init() + +
    +
    +
    +
    +
    +
    +

    Creates a new instance of QueryParam]

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public init()
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Enums.html b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Enums.html new file mode 100644 index 00000000..05ccd59a --- /dev/null +++ b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Enums.html @@ -0,0 +1,493 @@ + + + + Enumerations Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + Enumerations Reference +

+ +
+ +
+ +
+
+

Enumerations

+

The following enumerations are available globally.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + HyperwalletErrorType + +
    +
    +
    +
    +
    +
    +

    The HyperwalletErrorType is the error type returned By Hyperwallet SDK.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public enum HyperwalletErrorType : Error, LocalizedError
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The HyperwalletAuthenticationErrorType is the authentication error type returned By Hyperwallet SDK.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public enum HyperwalletAuthenticationErrorType : LocalizedError
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + HyperwalletErrorGroup + +
    +
    +
    +
    +
    +
    +

    Representation of the error type group

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public enum HyperwalletErrorGroup : String
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + HyperwalletDataType + +
    +
    +
    +
    +
    +
    +

    Representation of the transfer method configuration field data type

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public enum HyperwalletDataType : String, Codable
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Enums/HyperwalletAuthenticationErrorType.html b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Enums/HyperwalletAuthenticationErrorType.html new file mode 100644 index 00000000..c0e0eebe --- /dev/null +++ b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Enums/HyperwalletAuthenticationErrorType.html @@ -0,0 +1,479 @@ + + + + HyperwalletAuthenticationErrorType Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + HyperwalletAuthenticationErrorType Enumeration Reference +

+ +
+ +
+ +
+
+

HyperwalletAuthenticationErrorType

+
+
+ + 
public enum HyperwalletAuthenticationErrorType : LocalizedError
+ +
+
+

The HyperwalletAuthenticationErrorType is the authentication error type returned By Hyperwallet SDK.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + expired(_:) + +
    +
    +
    +
    +
    +
    + +
      +
    • expired: Returned when the authenticated session is expired
      • +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case expired(_: String)
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + unexpected(_:) + +
    +
    +
    +
    +
    +
    + +
      +
    • unexpected: Returned when an unexpected behavior happened.
      • +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case unexpected(_: String)
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + message() + +
    +
    +
    +
    +
    +
    +

    Gets the AuthenticationErrorType error message

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func message() -> String
    + +
    +
    +
    +

    Return Value

    +

    An error message detail

    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Enums/HyperwalletDataType.html b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Enums/HyperwalletDataType.html new file mode 100644 index 00000000..026b6b8d --- /dev/null +++ b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Enums/HyperwalletDataType.html @@ -0,0 +1,685 @@ + + + + HyperwalletDataType Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + HyperwalletDataType Enumeration Reference +

+ +
+ +
+ +
+
+

HyperwalletDataType

+
+
+ + 
public enum HyperwalletDataType : String, Codable
+ +
+
+

Representation of the transfer method configuration field data type

+ +
+
+ +
+
+
+
    +
  • +
    + + + + text + +
    +
    +
    +
    +
    +
    +

    The text field type

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case text = "TEXT"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + selection + +
    +
    +
    +
    +
    +
    +

    The selecion option field type

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case selection = "SELECTION"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + boolean + +
    +
    +
    +
    +
    +
    +

    The boolean field type

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case boolean = "BOOLEAN"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + number + +
    +
    +
    +
    +
    +
    +

    The numeric field type

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case number = "NUMBER"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + range + +
    +
    +
    +
    +
    +
    +

    The range field type

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case range = "RANGE"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + date + +
    +
    +
    +
    +
    +
    +

    The date field type

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case date = "DATE"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + datetime + +
    +
    +
    +
    +
    +
    +

    The datetime field type

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case datetime = "DATETIME"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + expiryDate + +
    +
    +
    +
    +
    +
    +

    The expiry date field type

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case expiryDate = "EXPIRY_DATE"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + phone + +
    +
    +
    +
    +
    +
    +

    The phone field type

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case phone = "PHONE"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + email + +
    +
    +
    +
    +
    +
    +

    The email field type

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case email = "EMAIL"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + file + +
    +
    +
    +
    +
    +
    +

    The file field type

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case file = "FILE"
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Enums/HyperwalletErrorGroup.html b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Enums/HyperwalletErrorGroup.html new file mode 100644 index 00000000..86ffd4c0 --- /dev/null +++ b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Enums/HyperwalletErrorGroup.html @@ -0,0 +1,496 @@ + + + + HyperwalletErrorGroup Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + HyperwalletErrorGroup Enumeration Reference +

+ +
+ +
+ +
+
+

HyperwalletErrorGroup

+
+
+ + 
public enum HyperwalletErrorGroup : String
+ +
+
+

Representation of the error type group

+ +
+
+ +
+
+
+
    +
  • +
    + + + + business + +
    +
    +
    +
    +
    +
    +

    Returned when a business error is thrown

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case business = "BUSINESS_ERROR"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + unexpected + +
    +
    +
    +
    +
    +
    +

    Returned when an unexpected error is thrown

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case unexpected = "UNEXPECTED_ERROR"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + connection + +
    +
    +
    +
    +
    +
    +

    Returned when a connection error is thrown

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case connection = "CONNECTION_ERROR"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + authentication + +
    +
    +
    +
    +
    +
    +

    Returned when a authentication error is thrown

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case authentication = "AUTHENTICATION_ERROR"
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Enums/HyperwalletErrorType.html b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Enums/HyperwalletErrorType.html new file mode 100644 index 00000000..b647041c --- /dev/null +++ b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Enums/HyperwalletErrorType.html @@ -0,0 +1,778 @@ + + + + HyperwalletErrorType Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + HyperwalletErrorType Enumeration Reference +

+ +
+ +
+ +
+
+

HyperwalletErrorType

+
+
+ + 
public enum HyperwalletErrorType : Error, LocalizedError
+ +
+
+

The HyperwalletErrorType is the error type returned By Hyperwallet SDK.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + http(_:_:) + +
    +
    +
    +
    +
    +
    +

    Returned when an HTTP code is not in the range 2xx.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case http(_: HyperwalletErrors, _: Int)
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + parseError(_:) + +
    +
    +
    +
    +
    +
    +

    Returned when a response parser process throws error.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case parseError(_: HyperwalletErrors)
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + notInitialized(_:) + +
    +
    +
    +
    +
    +
    +

    Returned when the SDK was not initialized properly.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case notInitialized(_: HyperwalletErrors)
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + invalidUrl(_:) + +
    +
    +
    +
    +
    +
    +

    Returned when a provided URL is not valid

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case invalidUrl(_: HyperwalletErrors)
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Returned when a transaction is explicitly aborted.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case transactionAborted(_: HyperwalletErrors)
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Returned on authentication failure

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case authenticationError(_: HyperwalletAuthenticationErrorType)
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + unexpected(_:) + +
    +
    +
    +
    +
    +
    +

    Returned when an unexpected behavior happened.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case unexpected(_: HyperwalletErrors)
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + graphQlErrors(_:) + +
    +
    +
    +
    +
    +
    +

    Returned when a GraphQL parser process throws error.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case graphQlErrors(_: HyperwalletErrors)
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + invalidRequest(_:) + +
    +
    +
    +
    +
    +
    +

    Returned when some step-in builds the request throws error.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case invalidRequest(_: HyperwalletErrors)
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + connectionError(_:) + +
    +
    +
    +
    +
    +
    +

    Returned when during the connection process throws error.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case connectionError(_: HyperwalletErrors)
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + group + +
    +
    +
    +
    +
    +
    +

    The error type group

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var group: HyperwalletErrorGroup { get }
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Gets the HyperwalletErrors based on the ErrorType

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func getHyperwalletErrors() -> HyperwalletErrors?
    + +
    +
    +
    +

    Return Value

    +

    An instance of HyperwalletErrors or nil

    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Gets the AuthenticationErrorType on the ErrorType

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func getAuthenticationError() -> HyperwalletAuthenticationErrorType?
    + +
    +
    +
    +

    Return Value

    +

    An instance of AuthenticationErrorType or nil

    +
    +
    +
    +
    • +
  • +
    + + + + getHttpCode() + +
    +
    +
    +
    +
    +
    +

    Gets the HTTP Code based on the ErrorType.http

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func getHttpCode() -> Int?
    + +
    +
    +
    +

    Return Value

    +

    The HTTP Code or return nil

    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Extensions.html b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Extensions.html new file mode 100644 index 00000000..20b5b17c --- /dev/null +++ b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Extensions.html @@ -0,0 +1,409 @@ + + + + Extensions Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + Extensions Reference +

+ +
+ +
+ +
+
+

Extensions

+

The following extensions are available globally.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + ISO8601DateFormatter + +
    +
    +
    +
    +
    +
    +

    Date extension.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public extension ISO8601DateFormatter
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Extensions/ISO8601DateFormatter.html b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Extensions/ISO8601DateFormatter.html new file mode 100644 index 00000000..042704dd --- /dev/null +++ b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Extensions/ISO8601DateFormatter.html @@ -0,0 +1,416 @@ + + + + ISO8601DateFormatter Extension Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + ISO8601DateFormatter Extension Reference +

+ +
+ +
+ +
+
+

ISO8601DateFormatter

+
+
+ + 
public extension ISO8601DateFormatter
+ +
+
+

Date extension.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + ignoreTimeZone + +
    +
    +
    +
    +
    +
    +

    The thread-safe date formatter to work with ISO8601 date representations. + The time zone is ignored.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    static let ignoreTimeZone: ISO8601DateFormatter
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Guides.html b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Guides.html new file mode 100644 index 00000000..e2ee1cb8 --- /dev/null +++ b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Guides.html @@ -0,0 +1,399 @@ + + + + Guides Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + Guides Reference +

+ +
+ +
+ +
+
+

Guides

+

The following guides are available globally.

+ +
+
+ +
+
+
+ +
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Protocols.html b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Protocols.html new file mode 100644 index 00000000..f8e5d133 --- /dev/null +++ b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Protocols.html @@ -0,0 +1,501 @@ + + + + Protocols Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + Protocols Reference +

+ +
+ +
+ +
+
+

Protocols

+

The following protocols are available globally.

+ +
+
+ +
+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    The HyperwalletAuthenticationTokenProvider protocol provides the Hyperwallet iOS Core SDK with an +abstraction to retrieve an authentication token. An authentication token is a JSON Web Token that will be used +to authenticate the User to the Hyperwallet platform.

    + +

    Implementations of HyperwalletAuthenticationTokenProvider are expected to be non-blocking and thread safe.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public protocol HyperwalletAuthenticationTokenProvider
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The HyperwalletTransferMethodConfigurationField protocol for processing the transfer method +configuration field result from the Hyperwallet platform.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public protocol HyperwalletTransferMethodConfigurationField
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The HyperwalletTransferMethodConfigurationKey protocol for processing the transfer method configuration +key result from the Hyperwallet platform.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public protocol HyperwalletTransferMethodConfigurationKey
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The HyperwalletTransferMethodUpdateConfigurationField protocol for processing the update transfer method +configuration field result from the Hyperwallet platform.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public protocol HyperwalletTransferMethodUpdateConfigurationField
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Protocols/HyperwalletAuthenticationTokenProvider.html b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Protocols/HyperwalletAuthenticationTokenProvider.html new file mode 100644 index 00000000..59790d43 --- /dev/null +++ b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Protocols/HyperwalletAuthenticationTokenProvider.html @@ -0,0 +1,511 @@ + + + + HyperwalletAuthenticationTokenProvider Protocol Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + HyperwalletAuthenticationTokenProvider Protocol Reference +

+ +
+ +
+ +
+
+

HyperwalletAuthenticationTokenProvider

+
+
+ + 
@objc
+public protocol HyperwalletAuthenticationTokenProvider
+ +
+
+

The HyperwalletAuthenticationTokenProvider protocol provides the Hyperwallet iOS Core SDK with an +abstraction to retrieve an authentication token. An authentication token is a JSON Web Token that will be used +to authenticate the User to the Hyperwallet platform.

+ +

Implementations of HyperwalletAuthenticationTokenProvider are expected to be non-blocking and thread safe.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + CompletionHandler + +
    +
    +
    +
    +
    +
    +

    A callback interface to handle the submission of an authentication token or an error message in case of failure.

    + +

    The authentication token is a JSON web token that contains as part of its claim set the principal that will +be interacting with the Hyperwallet platform.

    + +

    Authentication token will be used until it expires.

    + +

    The HyperwalletAuthenticationErrorType will contain error in case authentication token +is not retrieved successfully.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    typealias CompletionHandler = (_ authenticationToken: String?, _ error: Error?) -> Void
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + authenticationToken + + +
    +

    a JWT token identifying a Hyperwallet User principal

    +
    +
    + + error + + +
    +

    an HyperwalletAuthenticationErrorType indicating the cause of the authentication + token retrieval error

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Invoked when the Hyperwallet iOS Core SDK requires an authentication token.

    + +

    Implementations of this function are expected to call the +HyperwalletAuthenticationTokenProvider.CompletionHandler(String, nil) method when an authentication token is +retrieved and the HyperwalletAuthenticationTokenProvider.CompletionHandler(nil, AuthenticationErrorType) +when an authentication token is not retrieved.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    func retrieveAuthenticationToken(completionHandler: @escaping CompletionHandler)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + completionHandler + + +
    +

    A completion handler for authentication tokens

    +
    +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Protocols/HyperwalletTransferMethodConfigurationField.html b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Protocols/HyperwalletTransferMethodConfigurationField.html new file mode 100644 index 00000000..7614e9f2 --- /dev/null +++ b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Protocols/HyperwalletTransferMethodConfigurationField.html @@ -0,0 +1,451 @@ + + + + HyperwalletTransferMethodConfigurationField Protocol Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + HyperwalletTransferMethodConfigurationField Protocol Reference +

+ +
+ +
+ +
+
+

HyperwalletTransferMethodConfigurationField

+
+
+ + 
public protocol HyperwalletTransferMethodConfigurationField
+ +
+
+

The HyperwalletTransferMethodConfigurationField protocol for processing the transfer method +configuration field result from the Hyperwallet platform.

+ +
+
+ +
+
+
+ +
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Protocols/HyperwalletTransferMethodConfigurationKey.html b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Protocols/HyperwalletTransferMethodConfigurationKey.html new file mode 100644 index 00000000..70ab07ae --- /dev/null +++ b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Protocols/HyperwalletTransferMethodConfigurationKey.html @@ -0,0 +1,532 @@ + + + + HyperwalletTransferMethodConfigurationKey Protocol Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + HyperwalletTransferMethodConfigurationKey Protocol Reference +

+ +
+ +
+ +
+
+

HyperwalletTransferMethodConfigurationKey

+
+
+ + 
public protocol HyperwalletTransferMethodConfigurationKey
+ +
+
+

The HyperwalletTransferMethodConfigurationKey protocol for processing the transfer method configuration +key result from the Hyperwallet platform.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + countries() + +
    +
    +
    +
    +
    +
    +

    Returns the list of countries

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    func countries() -> [HyperwalletCountry]?
    + +
    +
    +
    +

    Return Value

    +

    a list of HyperwalletCountry object

    +
    +
    +
    +
    • +
  • +
    + + + + currencies(from:) + +
    +
    +
    +
    +
    +
    +

    Returns the list of currencies based on the country

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    func currencies(from countryCode: String) -> [HyperwalletCurrency]?
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + countryCode + + +
    +

    the 2 letter ISO 3166-1 country code

    +
    +
    +
    +
    +

    Return Value

    +

    a list of HyperwalletCurrency object

    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Returns the list of transfer method types based on the parameters

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    func transferMethodTypes(countryCode: String, currencyCode: String) -> [HyperwalletTransferMethodType]?
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + countryCode + + +
    +

    the 2 letter ISO 3166-1 country code

    +
    +
    + + currencyCode + + +
    +

    the 3 letter ISO 4217-1 currency code

    +
    +
    +
    +
    +

    Return Value

    +

    a list of HyperwalletTransferMethodTypes

    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Protocols/HyperwalletTransferMethodUpdateConfigurationField.html b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Protocols/HyperwalletTransferMethodUpdateConfigurationField.html new file mode 100644 index 00000000..0a52147c --- /dev/null +++ b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Protocols/HyperwalletTransferMethodUpdateConfigurationField.html @@ -0,0 +1,420 @@ + + + + HyperwalletTransferMethodUpdateConfigurationField Protocol Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + HyperwalletTransferMethodUpdateConfigurationField Protocol Reference +

+ +
+ +
+ +
+
+

HyperwalletTransferMethodUpdateConfigurationField

+
+
+ + 
public protocol HyperwalletTransferMethodUpdateConfigurationField
+ +
+
+

The HyperwalletTransferMethodUpdateConfigurationField protocol for processing the update transfer method +configuration field result from the Hyperwallet platform.

+ +
+
+ +
+
+
+ +
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Structs.html b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Structs.html new file mode 100644 index 00000000..173da0d9 --- /dev/null +++ b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Structs.html @@ -0,0 +1,1208 @@ + + + + Structures Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + Structures Reference +

+ +
+ +
+ +
+
+

Structures

+

The following structures are available globally.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + Configuration + +
    +
    +
    +
    +
    +
    +

    Configuration object retrieved on successful authentication

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public struct Configuration : Codable
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + HyperwalletErrors + +
    +
    +
    +
    +
    +
    +

    Representation of the Hyperwallet error list

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public struct HyperwalletErrors : Decodable
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + HyperwalletError + +
    +
    +
    +
    +
    +
    +

    Representation of the Hyperwallet error entity.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public struct HyperwalletError : Decodable
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + HyperwalletBalance + +
    +
    +
    +
    +
    +
    +

    Details of the balance.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public struct HyperwalletBalance : Decodable
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + Connection + +
    +
    +
    +
    +
    +
    +

    Representation of the GraphQL’s Connection type

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public struct Connection<T> : Codable where T : Decodable, T : Encodable
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + HyperwalletCountry + +
    +
    +
    +
    +
    +
    +

    Representation of a HyperwalletCountry node

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public struct HyperwalletCountry : Codable
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + HyperwalletCurrency + +
    +
    +
    +
    +
    +
    +

    Representation of a HyperwalletCurrency node

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public struct HyperwalletCurrency : Codable
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + HyperwalletFee + +
    +
    +
    +
    +
    +
    +

    Representation of the fee

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public struct HyperwalletFee : Codable, Hashable
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + HyperwalletField + +
    +
    +
    +
    +
    +
    +

    Representation of the transfer method configuration field

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public struct HyperwalletField : Codable
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + HyperwalletFieldGroup + +
    +
    +
    +
    +
    +
    +

    Representation of list of HyperwalletField and the group to which it belongs

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public struct HyperwalletFieldGroup : Codable
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Representation of the transfer method configuration field selection option

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public struct HyperwalletFieldSelectionOption : Codable
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Representation of the transfer method configuration field processing times

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public struct HyperwalletProcessingTime : Codable
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Representation of transfer method type

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public struct HyperwalletTransferMethodType : Codable
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Representation of the transfer method configuration field validation message

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public struct HyperwalletValidationMessage : Codable
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Representation of the transfer method configuration

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public struct HyperwalletTransferMethodConfiguration : Codable
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + HyperwalletMask + +
    +
    +
    +
    +
    +
    +

    Representation of the transfer method configuration field mask

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public struct HyperwalletMask : Codable
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Representation of the transfer method configuration field conditionalPatterns

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public struct HyperwalletConditionalPattern : Codable
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The HyperwalletTransferMethodConfigurationFieldQuery struct defines and builds a query to retrieve the fields +required to create a transfer method (Bank Account, Bank Card, PayPal Account, Prepaid Card, Paper Check) +with the Hyperwallet platform.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public struct HyperwalletTransferMethodConfigurationFieldQuery : GraphQlQuery, Hashable
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The ‘HyperwalletTransferMethodConfigurationKeysQuery’ struct defines and builds a query to retrieve the key set +that is required to construct a HyperwalletTransferMethodConfigurationFieldQuery.

    + +

    In addition to the key set, the query will also retrieve the processing time and fees associated with each +country, currency and transfer method type tuple.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public struct HyperwalletTransferMethodConfigurationKeysQuery : GraphQlQuery
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The ‘HyperwalletTransferMethodTypesFeesAndProcessingTimesQuery’ struct defines +and builds a query to retrieve the processing time and fees associated with each country, currency +and transfer method type tuple. +that is required to construct a HyperwalletTransferMethodConfigurationFieldQuery.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public struct HyperwalletTransferMethodTypesFeesAndProcessingTimesQuery : GraphQlQuery, Hashable
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The HyperwalletTransferMethodUpdateConfigurationFieldQuery +struct defines and builds a query to retrieve the fields +required to update a transfer method (Bank Account, Bank Card, PayPal Account, Prepaid Card, Paper Check and Venmo) +with the Hyperwallet platform.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public struct HyperwalletTransferMethodUpdateConfigurationFieldQuery : GraphQlQuery, Hashable
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + HyperwalletPageList + +
    +
    +
    +
    +
    +
    +

    Representation of subset content from a dataset

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public struct HyperwalletPageList<ListType> : Decodable where ListType : Decodable
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + HyperwalletPageLink + +
    +
    +
    +
    +
    +
    +

    Representation of the page link

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public struct HyperwalletPageLink : Decodable
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Representation of the relationship between the current document and the linked document

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public struct HyperwalletPageParameter : Decodable
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Details of the transaction.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public struct HyperwalletReceiptDetails : Decodable
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + HyperwalletReceipt + +
    +
    +
    +
    +
    +
    +

    Representation of the Hyperwallet’s receipt.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public struct HyperwalletReceipt : Decodable, Equatable
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Representation of the status transition.

    + +

    The status transition describes a status change for an existing bank account, bank card, PayPal account, +prepaid card, paper check or payment.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public struct HyperwalletStatusTransition : Codable
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Representation of a HyperwalletForeignExchange

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public struct HyperwalletForeignExchange : Codable
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + HyperwalletTransfer + +
    +
    +
    +
    +
    +
    +

    Representation of a HyperwalletTransfer

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public struct HyperwalletTransfer : Codable
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Structs/Configuration.html b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Structs/Configuration.html new file mode 100644 index 00000000..3d84c083 --- /dev/null +++ b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Structs/Configuration.html @@ -0,0 +1,523 @@ + + + + Configuration Structure Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + Configuration Structure Reference +

+ +
+ +
+ +
+
+

Configuration

+
+
+ + 
public struct Configuration : Codable
+ +
+
+

Configuration object retrieved on successful authentication

+ +
+
+ +
+
+
+
    +
  • +
    + + + + environment + +
    +
    +
    +
    +
    +
    +

    The environment type

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let environment: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + insightsUrl + +
    +
    +
    +
    +
    +
    +

    The insights Url

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let insightsUrl: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + issuer + +
    +
    +
    +
    +
    +
    +

    The issuer

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let issuer: String
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + userToken + +
    +
    +
    +
    +
    +
    +

    The user token

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let userToken: String
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + programModel + +
    +
    +
    +
    +
    +
    +

    The program model

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let programModel: String?
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Structs/Connection.html b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Structs/Connection.html new file mode 100644 index 00000000..fc8555e8 --- /dev/null +++ b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Structs/Connection.html @@ -0,0 +1,415 @@ + + + + Connection Structure Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + Connection Structure Reference +

+ +
+ +
+ +
+
+

Connection

+
+
+ + 
public struct Connection<T> : Codable where T : Decodable, T : Encodable
+ +
+
+

Representation of the GraphQL’s Connection type

+ +
+
+ +
+
+
+
    +
  • +
    + + + + nodes + +
    +
    +
    +
    +
    +
    +

    Array of Connection type

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let nodes: [T]?
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Structs/HyperwalletBalance.html b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Structs/HyperwalletBalance.html new file mode 100644 index 00000000..227221b3 --- /dev/null +++ b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Structs/HyperwalletBalance.html @@ -0,0 +1,442 @@ + + + + HyperwalletBalance Structure Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + HyperwalletBalance Structure Reference +

+ +
+ +
+ +
+
+

HyperwalletBalance

+
+
+ + 
public struct HyperwalletBalance : Decodable
+ +
+
+

Details of the balance.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + currency + +
    +
    +
    +
    +
    +
    +

    The currency of balance

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let currency: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + amount + +
    +
    +
    +
    +
    +
    +

    The amount of balance

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let amount: String?
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Structs/HyperwalletConditionalPattern.html b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Structs/HyperwalletConditionalPattern.html new file mode 100644 index 00000000..932b9394 --- /dev/null +++ b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Structs/HyperwalletConditionalPattern.html @@ -0,0 +1,442 @@ + + + + HyperwalletConditionalPattern Structure Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + HyperwalletConditionalPattern Structure Reference +

+ +
+ +
+ +
+
+

HyperwalletConditionalPattern

+
+
+ + 
public struct HyperwalletConditionalPattern : Codable
+ +
+
+

Representation of the transfer method configuration field conditionalPatterns

+ +
+
+ +
+
+
+
    +
  • +
    + + + + pattern + +
    +
    +
    +
    +
    +
    +

    The pattern

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let pattern: String
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + regex + +
    +
    +
    +
    +
    +
    +

    The regex

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let regex: String
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Structs/HyperwalletCountry.html b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Structs/HyperwalletCountry.html new file mode 100644 index 00000000..a8f0db3a --- /dev/null +++ b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Structs/HyperwalletCountry.html @@ -0,0 +1,469 @@ + + + + HyperwalletCountry Structure Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + HyperwalletCountry Structure Reference +

+ +
+ +
+ +
+
+

HyperwalletCountry

+
+
+ + 
public struct HyperwalletCountry : Codable
+ +
+
+

Representation of a HyperwalletCountry node

+ +
+
+ +
+
+
+
    +
  • +
    + + + + code + +
    +
    +
    +
    +
    +
    +

    The 2 letter ISO 3166-1 country code

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let code: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + name + +
    +
    +
    +
    +
    +
    +

    The country name

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let name: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + currencies + +
    +
    +
    +
    +
    +
    +

    The HyperwalletCurrency nodes that connect to this country node

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let currencies: Connection<HyperwalletCurrency>?
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Structs/HyperwalletCurrency.html b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Structs/HyperwalletCurrency.html new file mode 100644 index 00000000..a87f6787 --- /dev/null +++ b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Structs/HyperwalletCurrency.html @@ -0,0 +1,469 @@ + + + + HyperwalletCurrency Structure Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + HyperwalletCurrency Structure Reference +

+ +
+ +
+ +
+
+

HyperwalletCurrency

+
+
+ + 
public struct HyperwalletCurrency : Codable
+ +
+
+

Representation of a HyperwalletCurrency node

+ +
+
+ +
+
+
+
    +
  • +
    + + + + code + +
    +
    +
    +
    +
    +
    +

    The 3 letter ISO 4217-1 currency code

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let code: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + name + +
    +
    +
    +
    +
    +
    +

    The currency name

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let name: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + transferMethodTypes + +
    +
    +
    +
    +
    +
    +

    The HyperwalletTransferMethodType nodes that connect to this currency node

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let transferMethodTypes: Connection<HyperwalletTransferMethodType>?
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Structs/HyperwalletError.html b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Structs/HyperwalletError.html new file mode 100644 index 00000000..31fb4730 --- /dev/null +++ b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Structs/HyperwalletError.html @@ -0,0 +1,578 @@ + + + + HyperwalletError Structure Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + HyperwalletError Structure Reference +

+ +
+ +
+ +
+
+

HyperwalletError

+
+
+ + 
public struct HyperwalletError : Decodable
+ +
+
+

Representation of the Hyperwallet error entity.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + message + +
    +
    +
    +
    +
    +
    +

    The error message

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public private(set) var message: String { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + code + +
    +
    +
    +
    +
    +
    +

    The error code

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public private(set) var code: String { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + fieldName + +
    +
    +
    +
    +
    +
    +

    The field name

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public private(set) var fieldName: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + relatedResources + +
    +
    +
    +
    +
    +
    +

    The list of related resources

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public private(set) var relatedResources: [String]? { get }
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Creates an instance of HyperwalletError

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public init(message: String, code: String, fieldName: String? = nil, relatedResources: [String]? = nil)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + +
    + + message + + +
    +

    The error message

    +
    +
    + + code + + +
    +

    The error code

    +
    +
    + + fieldName + + +
    +

    The field name. By the default is nil

    +
    +
    + + relatedResources + + +
    +

    The list of related resources. By the default is nil

    +
    +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Structs/HyperwalletErrors.html b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Structs/HyperwalletErrors.html new file mode 100644 index 00000000..ad42a97a --- /dev/null +++ b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Structs/HyperwalletErrors.html @@ -0,0 +1,574 @@ + + + + HyperwalletErrors Structure Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + HyperwalletErrors Structure Reference +

+ +
+ +
+ +
+
+

HyperwalletErrors

+
+
+ + 
public struct HyperwalletErrors : Decodable
+ +
+
+

Representation of the Hyperwallet error list

+ +
+
+ +
+
+
+
    +
  • +
    + + + + errorList + +
    +
    +
    +
    +
    +
    +

    The error list

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public private(set) var errorList: [HyperwalletError]? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + originalError + +
    +
    +
    +
    +
    +
    +

    The original error

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public private(set) var originalError: Error? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + CodingKeys + +
    +
    +
    +
    +
    +
    +

    The CodingKeys for Hyperwallet errors

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public enum CodingKeys : String, CodingKey
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + init(errorList:) + +
    +
    +
    +
    +
    +
    +

    Creates an instance of HyperwalletErrors

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public init(errorList: [HyperwalletError])
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + errorList + + +
    +

    The HyperwalletError list.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Creates an instance of HyperwalletErrors

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public init(errorList: [HyperwalletError], originalError: Error?)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + errorList + + +
    +

    The HyperwalletError list.

    +
    +
    + + originalError + + +
    +

    The original error.

    +
    +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Structs/HyperwalletErrors/CodingKeys.html b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Structs/HyperwalletErrors/CodingKeys.html new file mode 100644 index 00000000..e00cf2eb --- /dev/null +++ b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Structs/HyperwalletErrors/CodingKeys.html @@ -0,0 +1,418 @@ + + + + CodingKeys Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + CodingKeys Enumeration Reference +

+ +
+ +
+ +
+
+

CodingKeys

+
+
+ + 
public enum CodingKeys : String, CodingKey
+ +
+
+

The CodingKeys for Hyperwallet errors

+ +
+
+ +
+
+
+
    +
  • +
    + + + + errorList + +
    +
    +
    +
    +
    +
    + +
      +
    • errorList: The list of errors
      • +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case errorList = "errors"
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Structs/HyperwalletFee.html b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Structs/HyperwalletFee.html new file mode 100644 index 00000000..1705ad48 --- /dev/null +++ b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Structs/HyperwalletFee.html @@ -0,0 +1,523 @@ + + + + HyperwalletFee Structure Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + HyperwalletFee Structure Reference +

+ +
+ +
+ +
+
+

HyperwalletFee

+
+
+ + 
public struct HyperwalletFee : Codable, Hashable
+ +
+
+

Representation of the fee

+ +
+
+ +
+
+
+
    +
  • +
    + + + + feeRateType + +
    +
    +
    +
    +
    +
    +

    The fee rate type (FLAT or PERCENT)

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let feeRateType: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + value + +
    +
    +
    +
    +
    +
    +

    The fee value

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var value: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + currency + +
    +
    +
    +
    +
    +
    +

    The fee currency

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var currency: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + minimum + +
    +
    +
    +
    +
    +
    +

    The minimum fee, or nil if none exists

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let minimum: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + maximum + +
    +
    +
    +
    +
    +
    +

    The maximum fee, or nil if none exists

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let maximum: String?
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Structs/HyperwalletField.html b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Structs/HyperwalletField.html new file mode 100644 index 00000000..f8227f43 --- /dev/null +++ b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Structs/HyperwalletField.html @@ -0,0 +1,766 @@ + + + + HyperwalletField Structure Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + HyperwalletField Structure Reference +

+ +
+ +
+ +
+
+

HyperwalletField

+
+
+ + 
public struct HyperwalletField : Codable
+ +
+
+

Representation of the transfer method configuration field

+ +
+
+ +
+
+
+
    +
  • +
    + + + + dataType + +
    +
    +
    +
    +
    +
    +

    The field data type, or nil if none exists

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let dataType: HyperwalletDataType.RawValue?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + fieldSelectionOptions + +
    +
    +
    +
    +
    +
    +

    The list of selection option, or nil if none exists

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let fieldSelectionOptions: [HyperwalletFieldSelectionOption]?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + isRequired + +
    +
    +
    +
    +
    +
    +

    Indicate if the field is mandatory, or nil if none exists

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let isRequired: Bool?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + isEditable + +
    +
    +
    +
    +
    +
    +

    Indicate if the field is editable, or nil if none exists

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let isEditable: Bool?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + label + +
    +
    +
    +
    +
    +
    +

    The field label

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let label: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + maxLength + +
    +
    +
    +
    +
    +
    +

    The field maximum length, or nil if none exists

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let maxLength: Int?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + minLength + +
    +
    +
    +
    +
    +
    +

    The field minimum length, or nil if none exists

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let minLength: Int?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + name + +
    +
    +
    +
    +
    +
    +

    The field name, or nil if none exists

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let name: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + placeholder + +
    +
    +
    +
    +
    +
    +

    The field placeholder, or nil if none exists

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let placeholder: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + regularExpression + +
    +
    +
    +
    +
    +
    +

    The regular expression to validate the field value, or nil if none exists

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let regularExpression: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + validationMessage + +
    +
    +
    +
    +
    +
    +

    The validation message

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let validationMessage: HyperwalletValidationMessage?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + value + +
    +
    +
    +
    +
    +
    +

    The field value

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let value: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + mask + +
    +
    +
    +
    +
    +
    +

    The mask, or nil if none exists

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let mask: HyperwalletMask?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + fieldValueMasked + +
    +
    +
    +
    +
    +
    +

    Indicate if the field is masked, or nil if none exists

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let fieldValueMasked: Bool?
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Structs/HyperwalletFieldGroup.html b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Structs/HyperwalletFieldGroup.html new file mode 100644 index 00000000..32fc413c --- /dev/null +++ b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Structs/HyperwalletFieldGroup.html @@ -0,0 +1,442 @@ + + + + HyperwalletFieldGroup Structure Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + HyperwalletFieldGroup Structure Reference +

+ +
+ +
+ +
+
+

HyperwalletFieldGroup

+
+
+ + 
public struct HyperwalletFieldGroup : Codable
+ +
+
+

Representation of list of HyperwalletField and the group to which it belongs

+ +
+
+ +
+
+
+
    +
  • +
    + + + + group + +
    +
    +
    +
    +
    +
    +

    The group

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let group: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + fields + +
    +
    +
    +
    +
    +
    +

    The list of HyperwalletField

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let fields: [HyperwalletField]?
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Structs/HyperwalletFieldSelectionOption.html b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Structs/HyperwalletFieldSelectionOption.html new file mode 100644 index 00000000..57d8d1c3 --- /dev/null +++ b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Structs/HyperwalletFieldSelectionOption.html @@ -0,0 +1,442 @@ + + + + HyperwalletFieldSelectionOption Structure Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + HyperwalletFieldSelectionOption Structure Reference +

+ +
+ +
+ +
+
+

HyperwalletFieldSelectionOption

+
+
+ + 
public struct HyperwalletFieldSelectionOption : Codable
+ +
+
+

Representation of the transfer method configuration field selection option

+ +
+
+ +
+
+
+
    +
  • +
    + + + + label + +
    +
    +
    +
    +
    +
    +

    The label

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let label: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + value + +
    +
    +
    +
    +
    +
    +

    The value

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let value: String?
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Structs/HyperwalletForeignExchange.html b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Structs/HyperwalletForeignExchange.html new file mode 100644 index 00000000..392e11fd --- /dev/null +++ b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Structs/HyperwalletForeignExchange.html @@ -0,0 +1,523 @@ + + + + HyperwalletForeignExchange Structure Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + HyperwalletForeignExchange Structure Reference +

+ +
+ +
+ +
+
+

HyperwalletForeignExchange

+
+
+ + 
public struct HyperwalletForeignExchange : Codable
+ +
+
+

Representation of a HyperwalletForeignExchange

+ +
+
+ +
+
+
+
    +
  • +
    + + + + destinationAmount + +
    +
    +
    +
    +
    +
    +

    The destination amount

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let destinationAmount: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + destinationCurrency + +
    +
    +
    +
    +
    +
    +

    The destination currency

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let destinationCurrency: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + rate + +
    +
    +
    +
    +
    +
    +

    The rate

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let rate: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + sourceAmount + +
    +
    +
    +
    +
    +
    +

    The source amount

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let sourceAmount: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + sourceCurrency + +
    +
    +
    +
    +
    +
    +

    The source currency

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let sourceCurrency: String?
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Structs/HyperwalletMask.html b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Structs/HyperwalletMask.html new file mode 100644 index 00000000..f883a900 --- /dev/null +++ b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Structs/HyperwalletMask.html @@ -0,0 +1,469 @@ + + + + HyperwalletMask Structure Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + HyperwalletMask Structure Reference +

+ +
+ +
+ +
+
+

HyperwalletMask

+
+
+ + 
public struct HyperwalletMask : Codable
+ +
+
+

Representation of the transfer method configuration field mask

+ +
+
+ +
+
+
+
    +
  • +
    + + + + conditionalPatterns + +
    +
    +
    +
    +
    +
    +

    The conditional pattern, or nil if none exists

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let conditionalPatterns: [HyperwalletConditionalPattern]?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + defaultPattern + +
    +
    +
    +
    +
    +
    +

    The default pattern

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let defaultPattern: String
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + scrubRegex + +
    +
    +
    +
    +
    +
    +

    The scrub regex, or nil if none exists

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let scrubRegex: String?
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Structs/HyperwalletPageLink.html b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Structs/HyperwalletPageLink.html new file mode 100644 index 00000000..91b3af47 --- /dev/null +++ b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Structs/HyperwalletPageLink.html @@ -0,0 +1,442 @@ + + + + HyperwalletPageLink Structure Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + HyperwalletPageLink Structure Reference +

+ +
+ +
+ +
+
+

HyperwalletPageLink

+
+
+ + 
public struct HyperwalletPageLink : Decodable
+ +
+
+

Representation of the page link

+ +
+
+ +
+
+
+ +
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Structs/HyperwalletPageList.html b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Structs/HyperwalletPageList.html new file mode 100644 index 00000000..e6700a47 --- /dev/null +++ b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Structs/HyperwalletPageList.html @@ -0,0 +1,523 @@ + + + + HyperwalletPageList Structure Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + HyperwalletPageList Structure Reference +

+ +
+ +
+ +
+
+

HyperwalletPageList

+
+
+ + 
public struct HyperwalletPageList<ListType> : Decodable where ListType : Decodable
+ +
+
+

Representation of subset content from a dataset

+ +
+
+ +
+
+
+
    +
  • +
    + + + + count + +
    +
    +
    +
    +
    +
    +

    The amount of the dataset

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let count: Int?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + data + +
    +
    +
    +
    +
    +
    +

    The ListType items

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let data: [ListType]?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + limit + +
    +
    +
    +
    +
    +
    +

    The maximum number of records that will be returned per page

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let limit: Int?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + links + +
    +
    +
    +
    +
    +
    +

    The links

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let links: [HyperwalletPageLink]?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + offset + +
    +
    +
    +
    +
    +
    +

    The number of records to skip.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let offset: Int?
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Structs/HyperwalletPageParameter.html b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Structs/HyperwalletPageParameter.html new file mode 100644 index 00000000..00cf8d52 --- /dev/null +++ b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Structs/HyperwalletPageParameter.html @@ -0,0 +1,415 @@ + + + + HyperwalletPageParameter Structure Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + HyperwalletPageParameter Structure Reference +

+ +
+ +
+ +
+
+

HyperwalletPageParameter

+
+
+ + 
public struct HyperwalletPageParameter : Decodable
+ +
+
+

Representation of the relationship between the current document and the linked document

+ +
+
+ +
+
+
+
    +
  • +
    + + + + rel + +
    +
    +
    +
    +
    +
    +

    The relationship

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let rel: String?
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Structs/HyperwalletProcessingTime.html b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Structs/HyperwalletProcessingTime.html new file mode 100644 index 00000000..f5799105 --- /dev/null +++ b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Structs/HyperwalletProcessingTime.html @@ -0,0 +1,496 @@ + + + + HyperwalletProcessingTime Structure Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + HyperwalletProcessingTime Structure Reference +

+ +
+ +
+ +
+
+

HyperwalletProcessingTime

+
+
+ + 
public struct HyperwalletProcessingTime : Codable
+ +
+
+

Representation of the transfer method configuration field processing times

+ +
+
+ +
+
+
+
    +
  • +
    + + + + country + +
    +
    +
    +
    +
    +
    +

    The country to process

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let country: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + currency + +
    +
    +
    +
    +
    +
    +

    The currency to process

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let currency: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + transferMethodType + +
    +
    +
    +
    +
    +
    +

    The transfer method type

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let transferMethodType: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + value + +
    +
    +
    +
    +
    +
    +

    The value to process

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let value: String?
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Structs/HyperwalletReceipt.html b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Structs/HyperwalletReceipt.html new file mode 100644 index 00000000..1a36b57f --- /dev/null +++ b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Structs/HyperwalletReceipt.html @@ -0,0 +1,794 @@ + + + + HyperwalletReceipt Structure Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + HyperwalletReceipt Structure Reference +

+ +
+ +
+ +
+
+

HyperwalletReceipt

+
+
+ + 
public struct HyperwalletReceipt : Decodable, Equatable
+ +
+
+

Representation of the Hyperwallet’s receipt.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + amount + +
    +
    +
    +
    +
    +
    +

    The gross amount of the transaction.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let amount: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + createdOn + +
    +
    +
    +
    +
    +
    +

    The datetime the transaction was created on in ISO 8601 format ‘YYYY-MM-DDThh:mm:ss’ (UTC timezone)

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let createdOn: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + currency + +
    +
    +
    +
    +
    +
    +

    The 3-letter currency code for the transaction.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let currency: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + destinationToken + +
    +
    +
    +
    +
    +
    +

    A token identifying where the funds were sent.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let destinationToken: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + details + +
    +
    +
    +
    +
    +
    +

    Details of the transaction.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let details: HyperwalletReceiptDetails?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + entry + +
    +
    +
    +
    +
    +
    +

    The type of transaction.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let entry: HyperwalletEntryType?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + fee + +
    +
    +
    +
    +
    +
    +

    The fee amount.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let fee: String?
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The 3-letter currency code for the foreign exchange.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let foreignExchangeCurrency: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + foreignExchangeRate + +
    +
    +
    +
    +
    +
    +

    The foreign exchange rate.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let foreignExchangeRate: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + journalId + +
    +
    +
    +
    +
    +
    +

    The journal entry number for the transaction.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let journalId: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + sourceToken + +
    +
    +
    +
    +
    +
    +

    A token identifying the source of funds.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let sourceToken: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + type + +
    +
    +
    +
    +
    +
    +

    The transaction type.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let type: HyperwalletReceiptType?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + ==(_:_:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public static func == (lhs: HyperwalletReceipt, rhs: HyperwalletReceipt) -> Bool
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The transaction type.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public enum HyperwalletReceiptType : String, Decodable
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + HyperwalletEntryType + +
    +
    +
    +
    +
    +
    +

    The entry type.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public enum HyperwalletEntryType : String, Decodable
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Structs/HyperwalletReceipt/HyperwalletEntryType.html b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Structs/HyperwalletReceipt/HyperwalletEntryType.html new file mode 100644 index 00000000..176aa76b --- /dev/null +++ b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Structs/HyperwalletReceipt/HyperwalletEntryType.html @@ -0,0 +1,442 @@ + + + + HyperwalletEntryType Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + HyperwalletEntryType Enumeration Reference +

+ +
+ +
+ +
+
+

HyperwalletEntryType

+
+
+ + 
public enum HyperwalletEntryType : String, Decodable
+ +
+
+

The entry type.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + credit + +
    +
    +
    +
    +
    +
    +

    The credit entry type

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case credit = "CREDIT"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + debit + +
    +
    +
    +
    +
    +
    +

    The debit entry type

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case debit = "DEBIT"
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Structs/HyperwalletReceipt/HyperwalletReceiptType.html b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Structs/HyperwalletReceipt/HyperwalletReceiptType.html new file mode 100644 index 00000000..a3390654 --- /dev/null +++ b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Structs/HyperwalletReceipt/HyperwalletReceiptType.html @@ -0,0 +1,3727 @@ + + + + HyperwalletReceiptType Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + HyperwalletReceiptType Enumeration Reference +

+ +
+ +
+ +
+
+

HyperwalletReceiptType

+
+
+ + 
public enum HyperwalletReceiptType : String, Decodable
+ +
+
+

The transaction type.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + annualFee + +
    +
    +
    +
    +
    +
    +

    The annual fee

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case annualFee = "ANNUAL_FEE"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + annualFeeRefund + +
    +
    +
    +
    +
    +
    +

    The annual fee refund

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case annualFeeRefund = "ANNUAL_FEE_REFUND"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + customerServiceFee + +
    +
    +
    +
    +
    +
    +

    The customer service fee

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case customerServiceFee = "CUSTOMER_SERVICE_FEE"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The customer service fee refund

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case customerServiceFeeRefund = "CUSTOMER_SERVICE_FEE_REFUND"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + expeditedShippingFee + +
    +
    +
    +
    +
    +
    +

    The expedited shipping fee

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case expeditedShippingFee = "EXPEDITED_SHIPPING_FEE"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + genericFeeRefund + +
    +
    +
    +
    +
    +
    +

    The generic fee refund

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case genericFeeRefund = "GENERIC_FEE_REFUND"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + monthlyFee + +
    +
    +
    +
    +
    +
    +

    The monthly fee

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case monthlyFee = "MONTHLY_FEE"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + monthlyFeeRefund + +
    +
    +
    +
    +
    +
    +

    The monthly fee refund

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case monthlyFeeRefund = "MONTHLY_FEE_REFUND"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + paymentExpiryFee + +
    +
    +
    +
    +
    +
    +

    The payment expiry fee

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case paymentExpiryFee = "PAYMENT_EXPIRY_FEE"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + paymentFee + +
    +
    +
    +
    +
    +
    +

    The payment fee

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case paymentFee = "PAYMENT_FEE"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + processingFee + +
    +
    +
    +
    +
    +
    +

    The processing fee

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case processingFee = "PROCESSING_FEE"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + standardShippingFee + +
    +
    +
    +
    +
    +
    +

    The standard shipping fee

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case standardShippingFee = "STANDARD_SHIPPING_FEE"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + transferFee + +
    +
    +
    +
    +
    +
    +

    The transfer fee

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case transferFee = "TRANSFER_FEE"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + adjustment + +
    +
    +
    +
    +
    +
    +

    The adjustment

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case adjustment = "ADJUSTMENT"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + deposit + +
    +
    +
    +
    +
    +
    +

    The deposit

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case deposit = "DEPOSIT"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + foreignExchange + +
    +
    +
    +
    +
    +
    +

    The foreign exchange

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case foreignExchange = "FOREIGN_EXCHANGE"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + manualAdjustment + +
    +
    +
    +
    +
    +
    +

    The manual adjustment

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case manualAdjustment = "MANUAL_ADJUSTMENT"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + paymentExpiration + +
    +
    +
    +
    +
    +
    +

    The payment expiration

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case paymentExpiration = "PAYMENT_EXPIRATION"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The bank account transfer fee

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case bankAccountTransferFee = "BANK_ACCOUNT_TRANSFER_FEE"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The bank account transfer return

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case bankAccountTransferReturn = "BANK_ACCOUNT_TRANSFER_RETURN"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The bank account transfer return fee

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case bankAccountTransferReturnFee = "BANK_ACCOUNT_TRANSFER_RETURN_FEE"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + transferToBankAccount + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case transferToBankAccount = "TRANSFER_TO_BANK_ACCOUNT"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + cardActivationFee + +
    +
    +
    +
    +
    +
    +

    The card activation fee

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case cardActivationFee = "CARD_ACTIVATION_FEE"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The card activation fee waiver

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case cardActivationFeeWaiver = "CARD_ACTIVATION_FEE_WAIVER"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + cardFee + +
    +
    +
    +
    +
    +
    +

    The card fee

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case cardFee = "CARD_FEE"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The manual transfer to prepaid card

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case manualTransferToPrepaidCard = "MANUAL_TRANSFER_TO_PREPAID_CARD"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The prepaid card balance inquiry fee

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case prepaidCardBalanceInquiryFee = "PREPAID_CARD_BALANCE_INQUIRY_FEE"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The prepaid card cash advance

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case prepaidCardCashAdvance = "PREPAID_CARD_CASH_ADVANCE"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The prepaid card disputed charge refund

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case prepaidCardDisputedChargeRefund = "PREPAID_CARD_DISPUTED_CHARGE_REFUND"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The prepaid card dispute deposit

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case prepaidCardDisputeDeposit = "PREPAID_CARD_DISPUTE_DEPOSIT"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The prepaid card domestic cash withdrawal fee

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case prepaidCardDomesticCashWithdrawalFee = "PREPAID_CARD_DOMESTIC_CASH_WITHDRAWAL_FEE"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The prepaid card exchange rate difference

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case prepaidCardExchangeRateDifference = "PREPAID_CARD_EXCHANGE_RATE_DIFFERENCE"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The prepaid card manual unload

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case prepaidCardManualUnload = "PREPAID_CARD_MANUAL_UNLOAD"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The prepaid card overseas cash withdrawal fee

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case prepaidCardOverseasCashWithdrawalFee = "PREPAID_CARD_OVERSEAS_CASH_WITHDRAWAL_FEE"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The prepaid card pin change fee

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case prepaidCardPinChangeFee = "PREPAID_CARD_PIN_CHANGE_FEE"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + prepaidCardRefund + +
    +
    +
    +
    +
    +
    +

    The prepaid card refund

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case prepaidCardRefund = "PREPAID_CARD_REFUND"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The prepaid card replacement fee

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case prepaidCardReplacementFee = "PREPAID_CARD_REPLACEMENT_FEE"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The prepaid card sale reversal

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case prepaidCardSaleReversal = "PREPAID_CARD_SALE_REVERSAL"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + prepaidCardUnload + +
    +
    +
    +
    +
    +
    +

    The prepaid card unload

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case prepaidCardUnload = "PREPAID_CARD_UNLOAD"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + transferToDebitCard + +
    +
    +
    +
    +
    +
    +

    The transfer to debit card

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case transferToDebitCard = "TRANSFER_TO_DEBIT_CARD"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + transferToPrepaidCard + +
    +
    +
    +
    +
    +
    +

    The transfer to prepaid card

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case transferToPrepaidCard = "TRANSFER_TO_PREPAID_CARD"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The prepaid card account deposit

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case prepaidCardAccountDeposit = "PREPAID_CARD_ACCOUNT_DEPOSIT"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + prepaidCardAccountFee + +
    +
    +
    +
    +
    +
    +

    The prepaid card account fee

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case prepaidCardAccountFee = "PREPAID_CARD_ACCOUNT_FEE"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The prepaid card annual fee discount

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case prepaidCardAnnualFeeDiscount = "PREPAID_CARD_ANNUAL_FEE_DISCOUNT"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The prepaid card bill reprint fee

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case prepaidCardBillReprintFee = "PREPAID_CARD_BILL_REPRINT_FEE"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The prepaid card atm or cash advance fee

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case prepaidCardAtmOrCashAdvanceFee = "PREPAID_CARD_ATM_OR_CASH_ADVANCE_FEE"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The prepaid card cash advance chargeback

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case prepaidCardCashAdvanceChargeback = "PREPAID_CARD_CASH_ADVANCE_CHARGEBACK"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The prepaid card cash advance chargeback reversal

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case prepaidCardCashAdvanceChargebackReversal = "PREPAID_CARD_CASH_ADVANCE_CHARGEBACK_REVERSAL"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The prepaid card cash advance repress

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case prepaidCardCashAdvanceRepress = "PREPAID_CARD_CASH_ADVANCE_REPRESS"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The prepaid card cash advance repress reversal

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case prepaidCardCashAdvanceRepressReversal = "PREPAID_CARD_CASH_ADVANCE_REPRESS_REVERSAL"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + prepaidCardChargeback + +
    +
    +
    +
    +
    +
    +

    The prepaid card chargeback

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case prepaidCardChargeback = "PREPAID_CARD_CHARGEBACK"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The prepaid card chargeback refund

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case prepaidCardChargebackRefund = "PREPAID_CARD_CHARGEBACK_REFUND"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The prepaid card chargeback refund reversal

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case prepaidCardChargebackRefundReversal = "PREPAID_CARD_CHARGEBACK_REFUND_REVERSAL"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The prepaid card chargeback reversal

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case prepaidCardChargebackReversal = "PREPAID_CARD_CHARGEBACK_REVERSAL"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The prepaid card commission or fee

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case prepaidCardCommissionOrFee = "PREPAID_CARD_COMMISSION_OR_FEE"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The prepaid card debit transfer

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case prepaidCardDebitTransfer = "PREPAID_CARD_DEBIT_TRANSFER"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The prepaid card document request fee

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case prepaidCardDocumentRequestFee = "PREPAID_CARD_DOCUMENT_REQUEST_FEE"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The prepaid card emergency cash

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case prepaidCardEmergencyCash = "PREPAID_CARD_EMERGENCY_CASH"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The prepaid card emergency card

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case prepaidCardEmergencyCard = "PREPAID_CARD_EMERGENCY_CARD"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + prepaidCardIncome + +
    +
    +
    +
    +
    +
    +

    The prepaid card income

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case prepaidCardIncome = "PREPAID_CARD_INCOME"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + prepaidCardLoadFee + +
    +
    +
    +
    +
    +
    +

    The prepaid card load fee

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case prepaidCardLoadFee = "PREPAID_CARD_LOAD_FEE"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The prepaid card overdue payment interest

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case prepaidCardOverduePaymentInterest = "PREPAID_CARD_OVERDUE_PAYMENT_INTEREST"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + prepaidCardPayment + +
    +
    +
    +
    +
    +
    +

    The prepaid card payment

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case prepaidCardPayment = "PREPAID_CARD_PAYMENT"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The prepaid card pin reprint fee

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case prepaidCardPinReprintFee = "PREPAID_CARD_PIN_REPRINT_FEE"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The prepaid card priority pass fee

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case prepaidCardPriorityPassFee = "PREPAID_CARD_PRIORITY_PASS_FEE"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The prepaid card priority pass renewal

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case prepaidCardPriorityPassRenewal = "PREPAID_CARD_PRIORITY_PASS_RENEWAL"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The prepaid card recurring interest

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case prepaidCardRecurringInterest = "PREPAID_CARD_RECURRING_INTEREST"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The prepaid card refund repress

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case prepaidCardRefundRepress = "PREPAID_CARD_REFUND_REPRESS"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The prepaid card refund repress reversal

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case prepaidCardRefundRepressReversal = "PREPAID_CARD_REFUND_REPRESS_REVERSAL"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The prepaid card statement fee

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case prepaidCardStatementFee = "PREPAID_CARD_STATEMENT_FEE"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The prepaid card telephone support fee

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case prepaidCardTelephoneSupportFee = "PREPAID_CARD_TELEPHONE_SUPPORT_FEE"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The prepaid card transfer fee

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case prepaidCardTransferFee = "PREPAID_CARD_TRANSFER_FEE"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The prepaid card transfer return

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case prepaidCardTransferReturn = "PREPAID_CARD_TRANSFER_RETURN"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The prepaid card bank withdrawal chargeback

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case prepaidCardBankWithdrawalChargeback = "PREPAID_CARD_BANK_WITHDRAWAL_CHARGEBACK"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + prepaidCardRefundfee + +
    +
    +
    +
    +
    +
    +

    The prepaid card refund fee

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case prepaidCardRefundfee = "PREPAID_CARD_REFUND_FEE"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The prepaid card monthly maintenance fee

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case prepaidCardMonthlyMaintenanceFee = "PREPAID_CARD_MONTHLY_MAINTENANCE_FEE"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The prepaid card transaction fee

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case prepaidCardTransactionFee = "PREPAID_CARD_TRANSACTION_FEE"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + prepaidCardSmsFee + +
    +
    +
    +
    +
    +
    +

    The prepaid card sms fee

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case prepaidCardSmsFee = "PREPAID_CARD_SMS_FEE"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The prepaid card declined authorization fee

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case prepaidCardDeclinedAuthorizationFee = "PREPAID_CARD_DECLINED_AUTHORIZATION_FEE"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + fispc + +
    +
    +
    +
    +
    +
    +

    The prepaid card purchases

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case fispc = "FISPC"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + donation + +
    +
    +
    +
    +
    +
    +

    The donation

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case donation = "DONATION"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + donationFee + +
    +
    +
    +
    +
    +
    +

    The donation fee

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case donationFee = "DONATION_FEE"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + donationReturn + +
    +
    +
    +
    +
    +
    +

    The donation return

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case donationReturn = "DONATION_RETURN"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + merchantPayment + +
    +
    +
    +
    +
    +
    +

    The merchant payment

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case merchantPayment = "MERCHANT_PAYMENT"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + merchantPaymentFee + +
    +
    +
    +
    +
    +
    +

    The merchant payment fee

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case merchantPaymentFee = "MERCHANT_PAYMENT_FEE"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + merchantPaymentRefund + +
    +
    +
    +
    +
    +
    +

    The merchant payment refund

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case merchantPaymentRefund = "MERCHANT_PAYMENT_REFUND"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + merchantPaymentReturn + +
    +
    +
    +
    +
    +
    +

    The merchant payment return

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case merchantPaymentReturn = "MERCHANT_PAYMENT_RETURN"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The money gram transfer return

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case moneygramTransferReturn = "MONEYGRAM_TRANSFER_RETURN"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + transferToMoneygram + +
    +
    +
    +
    +
    +
    +

    The transfer to money gram

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case transferToMoneygram = "TRANSFER_TO_MONEYGRAM"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + paperCheckFee + +
    +
    +
    +
    +
    +
    +

    The paper check fee

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case paperCheckFee = "PAPER_CHECK_FEE"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + paperCheckRefund + +
    +
    +
    +
    +
    +
    +

    The paper check refund

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case paperCheckRefund = "PAPER_CHECK_REFUND"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + transferToPaperCheck + +
    +
    +
    +
    +
    +
    +

    The transfer to paper check

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case transferToPaperCheck = "TRANSFER_TO_PAPER_CHECK"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + accountClosure + +
    +
    +
    +
    +
    +
    +

    The account to be closed

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case accountClosure = "ACCOUNT_CLOSURE"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + accountClosureFee + +
    +
    +
    +
    +
    +
    +

    The account closure fee

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case accountClosureFee = "ACCOUNT_CLOSURE_FEE"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + accountUnload + +
    +
    +
    +
    +
    +
    +

    The account unload

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case accountUnload = "ACCOUNT_UNLOAD"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + dormantUserFee + +
    +
    +
    +
    +
    +
    +

    The dormant user fee

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case dormantUserFee = "DORMANT_USER_FEE"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + dormantUserFeeRefund + +
    +
    +
    +
    +
    +
    +

    The dormant user fee refund

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case dormantUserFeeRefund = "DORMANT_USER_FEE_REFUND"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + payment + +
    +
    +
    +
    +
    +
    +

    The payment

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case payment = "PAYMENT"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + paymentCancellation + +
    +
    +
    +
    +
    +
    +

    The payment cancellation

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case paymentCancellation = "PAYMENT_CANCELLATION"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + paymentReversal + +
    +
    +
    +
    +
    +
    +

    The payment reversal

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case paymentReversal = "PAYMENT_REVERSAL"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + paymentReversalFee + +
    +
    +
    +
    +
    +
    +

    The payment reversal fee

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case paymentReversalFee = "PAYMENT_REVERSAL_FEE"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + paymentReturn + +
    +
    +
    +
    +
    +
    +

    The payment return

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case paymentReturn = "PAYMENT_RETURN"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The transfer to program account

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case transferToProgramAccount = "TRANSFER_TO_PROGRAM_ACCOUNT"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + transferToUser + +
    +
    +
    +
    +
    +
    +

    The transfer to user

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case transferToUser = "TRANSFER_TO_USER"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The virtual incentive cancellation

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case virtualIncentiveCancellation = "VIRTUAL_INCENTIVE_CANCELLATION"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The virtual incentive issuance

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case virtualIncentiveIssuance = "VIRTUAL_INCENTIVE_ISSUANCE"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The virtual incentive purchase

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case virtualIncentivePurchase = "VIRTUAL_INCENTIVE_PURCHASE"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The virtual incentive refund

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case virtualIncentiveRefund = "VIRTUAL_INCENTIVE_REFUND"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The transfer to western union

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case transferToWesternUnion = "TRANSFER_TO_WESTERN_UNION"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + transferToWubsWire + +
    +
    +
    +
    +
    +
    +

    The transfer to wubs wire

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case transferToWubsWire = "TRANSFER_TO_WUBS_WIRE"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The western union transfer return

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case westernUnionTransferReturn = "WESTERN_UNION_TRANSFER_RETURN"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The wubs wire transfer return

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case wubsWireTransferReturn = "WUBS_WIRE_TRANSFER_RETURN"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + transferToWire + +
    +
    +
    +
    +
    +
    +

    The transfer to Wire

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case transferToWire = "TRANSFER_TO_WIRE"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + wireTransferFee + +
    +
    +
    +
    +
    +
    +

    The wire transfer fee

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case wireTransferFee = "WIRE_TRANSFER_FEE"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + wireTransferReturn + +
    +
    +
    +
    +
    +
    +

    The wire transfer return

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case wireTransferReturn = "WIRE_TRANSFER_RETURN"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + prepaidCardSale + +
    +
    +
    +
    +
    +
    +

    The prepaid card sale

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case prepaidCardSale = "PREPAID_CARD_SALE"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Transfer to PayPal account

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case transferToPayPalAccount = "TRANSFER_TO_PAYPAL_ACCOUNT"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Return to Paypal Account

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case paypalAccountTransferReturn = "PAYPAL_ACCOUNT_TRANSFER_RETURN"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Transfer to Venmo account

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case transferToVenmoAccount = "TRANSFER_TO_VENMO_ACCOUNT"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Return to Venmo account

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case venmoAccountTransferReturn = "VENMO_ACCOUNT_TRANSFER_RETURN"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + transferToBankCard + +
    +
    +
    +
    +
    +
    +

    Transfer To Bank Card

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case transferToBankCard = "TRANSFER_TO_BANK_CARD"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + unknown + +
    +
    +
    +
    +
    +
    +

    Default - unknown transfer type

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case unknown = "UNKNOWN_RECEIPT_TYPE"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + init(from:) + +
    +
    +
    +
    +
    +
    +

    A safe initializer for creating a HyperwalletReceiptType object

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public init(from decoder: Decoder) throws
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + decoder + + +
    +

    The decoder to read data from.

    +
    +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Structs/HyperwalletReceiptDetails.html b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Structs/HyperwalletReceiptDetails.html new file mode 100644 index 00000000..39d7bfda --- /dev/null +++ b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Structs/HyperwalletReceiptDetails.html @@ -0,0 +1,1306 @@ + + + + HyperwalletReceiptDetails Structure Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + HyperwalletReceiptDetails Structure Reference +

+ +
+ +
+ +
+
+

HyperwalletReceiptDetails

+
+
+ + 
public struct HyperwalletReceiptDetails : Decodable
+ +
+
+

Details of the transaction.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + bankAccountId + +
    +
    +
    +
    +
    +
    +

    The bank account number, IBAN or equivalent

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let bankAccountId: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + bankAccountPurpose + +
    +
    +
    +
    +
    +
    +

    The bank account type, e.g. CHECKING or SAVINGS

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let bankAccountPurpose: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + bankId + +
    +
    +
    +
    +
    +
    +

    The bank code, BIC/SWIFT or equivalent

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let bankId: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + bankName + +
    +
    +
    +
    +
    +
    +

    The bank name

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let bankName: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + branchAddressLine1 + +
    +
    +
    +
    +
    +
    +

    The branch address, first line

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let branchAddressLine1: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + branchAddressLine2 + +
    +
    +
    +
    +
    +
    +

    The branch address, second line

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let branchAddressLine2: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + branchCity + +
    +
    +
    +
    +
    +
    +

    The branch city

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let branchCity: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + branchCountry + +
    +
    +
    +
    +
    +
    +

    The 2-letter country code of the branch

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let branchCountry: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + branchId + +
    +
    +
    +
    +
    +
    +

    The branch code or equivalent

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let branchId: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + branchName + +
    +
    +
    +
    +
    +
    +

    The branch name

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let branchName: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + branchPostalCode + +
    +
    +
    +
    +
    +
    +

    The branch postal code

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let branchPostalCode: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + branchStateProvince + +
    +
    +
    +
    +
    +
    +

    The branch state or province

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let branchStateProvince: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + cardExpiryDate + +
    +
    +
    +
    +
    +
    +

    The card expiry date in YYYY-MM format

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let cardExpiryDate: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + cardHolderName + +
    +
    +
    +
    +
    +
    +

    The card holder’s full name

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let cardHolderName: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + cardNumber + +
    +
    +
    +
    +
    +
    +

    The card number

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let cardNumber: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + charityName + +
    +
    +
    +
    +
    +
    +

    The name of the charity that is receiving the donation

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let charityName: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + checkNumber + +
    +
    +
    +
    +
    +
    +

    The paper check number

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let checkNumber: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + clientPaymentId + +
    +
    +
    +
    +
    +
    +

    The client-assigned transaction identifier

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let clientPaymentId: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + memo + +
    +
    +
    +
    +
    +
    +

    An internal note added by a client operator

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let memo: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + notes + +
    +
    +
    +
    +
    +
    +

    A description for the receipt

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let notes: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + payeeAddressLine1 + +
    +
    +
    +
    +
    +
    +

    The payee’s address first line

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let payeeAddressLine1: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + payeeAddressLine2 + +
    +
    +
    +
    +
    +
    +

    The payee’s address, second line

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let payeeAddressLine2: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + payeeCity + +
    +
    +
    +
    +
    +
    +

    The payee’s city

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let payeeCity: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + payeeCountry + +
    +
    +
    +
    +
    +
    +

    The payee’s 2-letter country code

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let payeeCountry: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + payeeEmail + +
    +
    +
    +
    +
    +
    +

    The payee’s email address on record

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let payeeEmail: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + payeeName + +
    +
    +
    +
    +
    +
    +

    The payee’s full name

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let payeeName: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + payeePostalCode + +
    +
    +
    +
    +
    +
    +

    The payee’s postal code, ZIP code or equivalent

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let payeePostalCode: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + payeeStateProvince + +
    +
    +
    +
    +
    +
    +

    The payee’s state or province

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let payeeStateProvince: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + payerName + +
    +
    +
    +
    +
    +
    +

    The payer’s full name

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let payerName: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + paymentExpiryDate + +
    +
    +
    +
    +
    +
    +

    The payment expiry date in YYYY-MM-DD format

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let paymentExpiryDate: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + returnOrRecallReason + +
    +
    +
    +
    +
    +
    +

    The reason for returning or recalling the payment

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let returnOrRecallReason: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + securityAnswer + +
    +
    +
    +
    +
    +
    +

    The answer to the securityQuestion

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let securityAnswer: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + securityQuestion + +
    +
    +
    +
    +
    +
    +

    A security question

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let securityQuestion: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + website + +
    +
    +
    +
    +
    +
    +

    The URL of the client website where the virtual incentive was accrued

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let website: String?
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Structs/HyperwalletStatusTransition.html b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Structs/HyperwalletStatusTransition.html new file mode 100644 index 00000000..0f49064c --- /dev/null +++ b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Structs/HyperwalletStatusTransition.html @@ -0,0 +1,610 @@ + + + + HyperwalletStatusTransition Structure Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + HyperwalletStatusTransition Structure Reference +

+ +
+ +
+ +
+
+

HyperwalletStatusTransition

+
+
+ + 
public struct HyperwalletStatusTransition : Codable
+ +
+
+

Representation of the status transition.

+ +

The status transition describes a status change for an existing bank account, bank card, PayPal account, +prepaid card, paper check or payment.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + createdOn + +
    +
    +
    +
    +
    +
    +

    The datetime the status changed in ISO 8601 format (YYYY-MM-DDThh:mm:ss). Note that the timezone used is UTC, +therefore there is no time offset.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let createdOn: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + fromStatus + +
    +
    +
    +
    +
    +
    +

    The status before the transition.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let fromStatus: Status?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + notes + +
    +
    +
    +
    +
    +
    +

    Comments regarding the status change.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let notes: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + token + +
    +
    +
    +
    +
    +
    +

    The unique, auto-generated status transition identifier.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let token: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + toStatus + +
    +
    +
    +
    +
    +
    +

    The status after the transition.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let toStatus: Status?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + transition + +
    +
    +
    +
    +
    +
    +

    The new status of the resource.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let transition: Status?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + Status + +
    +
    +
    +
    +
    +
    +

    Representation of the status.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public enum Status : String, Codable
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + Builder + +
    +
    +
    +
    +
    +
    +

    A helper class to build the HyperwalletStatusTransition instance.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public class Builder
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Structs/HyperwalletStatusTransition/Builder.html b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Structs/HyperwalletStatusTransition/Builder.html new file mode 100644 index 00000000..77e4e4eb --- /dev/null +++ b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Structs/HyperwalletStatusTransition/Builder.html @@ -0,0 +1,476 @@ + + + + Builder Class Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + Builder Class Reference +

+ +
+ +
+ +
+
+

Builder

+
+
+ + 
public class Builder
+ +
+
+

A helper class to build the HyperwalletStatusTransition instance.

+ +
+
+ +
+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Initialization of Builder

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public init(notes: String? = nil, transition: Status)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + notes + + +
    +

    Comments regarding the status change

    +
    +
    + + transition + + +
    +

    The new status of the resource

    +
    +
    +
    +
    +
    +
    • +
  • +
    + + + + build() + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func build() -> HyperwalletStatusTransition
    + +
    +
    +
    +

    Return Value

    +

    a new instance of the HyperwalletTransfer.

    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Structs/HyperwalletStatusTransition/Status.html b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Structs/HyperwalletStatusTransition/Status.html new file mode 100644 index 00000000..d6d85d27 --- /dev/null +++ b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Structs/HyperwalletStatusTransition/Status.html @@ -0,0 +1,982 @@ + + + + Status Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + Status Enumeration Reference +

+ +
+ +
+ +
+
+

Status

+
+
+ + 
public enum Status : String, Codable
+ +
+
+

Representation of the status.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + activated + +
    +
    +
    +
    +
    +
    +

    The status is activate.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case activated = "ACTIVATED"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + cancelled + +
    +
    +
    +
    +
    +
    +

    The status is cancel.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case cancelled = "CANCELLED"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + completed + +
    +
    +
    +
    +
    +
    +

    The status is complete.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case completed = "COMPLETED"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + deactivated + +
    +
    +
    +
    +
    +
    +

    The status is deactivate.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case deactivated = "DE_ACTIVATED"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + expired + +
    +
    +
    +
    +
    +
    +

    The status is expire.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case expired = "EXPIRED"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + failed + +
    +
    +
    +
    +
    +
    +

    The status is fail.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case failed = "FAILED"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + inProgress + +
    +
    +
    +
    +
    +
    +

    The status is in progress.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case inProgress = "IN_PROGRESS"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + invalid + +
    +
    +
    +
    +
    +
    +

    The status is invalid.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case invalid = "INVALID"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + lostOrStolen + +
    +
    +
    +
    +
    +
    +

    The status is lost or stolen.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case lostOrStolen = "LOST_OR_STOLEN"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The status is pending account activation.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case pendingAccountActivation = "PENDING_ACCOUNT_ACTIVATION"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + pendingIdVerification + +
    +
    +
    +
    +
    +
    +

    The status is pending identity verification.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case pendingIdVerification = "PENDING_ID_VERIFICATION"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The status is pending tax verification.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case pendingTaxVerification = "PENDING_TAX_VERIFICATION"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The status is pending transaction verification.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case pendingTransactionVerification = "PENDING_TRANSACTION_VERIFICATION"
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The status is pending transfer method action.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case pendingTransferMethodAction = "PENDING_TRANSACTION_METHOD_ACTION"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + quoted + +
    +
    +
    +
    +
    +
    +

    The status is quoted

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case quoted = "QUOTED"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + recalled + +
    +
    +
    +
    +
    +
    +

    The status is recall.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case recalled = "RECALLED"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + returned + +
    +
    +
    +
    +
    +
    +

    The status is return.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case returned = "RETURNED"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + scheduled + +
    +
    +
    +
    +
    +
    +

    The status is schedule.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case scheduled = "SCHEDULED"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + suspended + +
    +
    +
    +
    +
    +
    +

    The status is suspend.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case suspended = "SUSPENDED"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + unsuspended + +
    +
    +
    +
    +
    +
    +

    The status is not suspended.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case unsuspended = "UNSUSPENDED"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + verificationRequired + +
    +
    +
    +
    +
    +
    +

    The status is verification required

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case verificationRequired = "VERIFICATION_REQUIRED"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + verified + +
    +
    +
    +
    +
    +
    +

    The status is verified.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case verified = "VERIFIED"
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Structs/HyperwalletTransfer.html b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Structs/HyperwalletTransfer.html new file mode 100644 index 00000000..735255ab --- /dev/null +++ b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Structs/HyperwalletTransfer.html @@ -0,0 +1,876 @@ + + + + HyperwalletTransfer Structure Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + HyperwalletTransfer Structure Reference +

+ +
+ +
+ +
+
+

HyperwalletTransfer

+
+
+ + 
public struct HyperwalletTransfer : Codable
+ +
+
+

Representation of a HyperwalletTransfer

+ +
+
+ +
+
+
+
    +
  • +
    + + + + clientTransferId + +
    +
    +
    +
    +
    +
    +

    A value that identifies the client transfer id.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let clientTransferId: String
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + createdOn + +
    +
    +
    +
    +
    +
    +

    The created date

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let createdOn: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + destinationAmount + +
    +
    +
    +
    +
    +
    +

    The destination amount

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let destinationAmount: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + destinationCurrency + +
    +
    +
    +
    +
    +
    +

    The destination currency

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let destinationCurrency: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + destinationFeeAmount + +
    +
    +
    +
    +
    +
    +

    The destination amount

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let destinationFeeAmount: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + destinationToken + +
    +
    +
    +
    +
    +
    +

    The destination token

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let destinationToken: String
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + expiresOn + +
    +
    +
    +
    +
    +
    +

    The expiresOn

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let expiresOn: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + foreignExchanges + +
    +
    +
    +
    +
    +
    +

    The list of foreignExchanges

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let foreignExchanges: [HyperwalletForeignExchange]?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + memo + +
    +
    +
    +
    +
    +
    +

    The memo

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let memo: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + notes + +
    +
    +
    +
    +
    +
    +

    The notes to add

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let notes: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + sourceAmount + +
    +
    +
    +
    +
    +
    +

    The source amount

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let sourceAmount: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + sourceCurrency + +
    +
    +
    +
    +
    +
    +

    The source currency

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let sourceCurrency: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + sourceFeeAmount + +
    +
    +
    +
    +
    +
    +

    The source fee

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let sourceFeeAmount: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + sourceToken + +
    +
    +
    +
    +
    +
    +

    The source token

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let sourceToken: String
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + status + +
    +
    +
    +
    +
    +
    +

    The transfer status

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let status: HyperwalletTransferStatus?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + token + +
    +
    +
    +
    +
    +
    +

    The token

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let token: String?
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Representation of a HyperwalletTransferStatus

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public enum HyperwalletTransferStatus : String, Codable
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + Builder + +
    +
    +
    +
    +
    +
    +

    A helper class to build the HyperwalletTransfer instance.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public class Builder
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Structs/HyperwalletTransfer/Builder.html b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Structs/HyperwalletTransfer/Builder.html new file mode 100644 index 00000000..78fac57b --- /dev/null +++ b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Structs/HyperwalletTransfer/Builder.html @@ -0,0 +1,798 @@ + + + + Builder Class Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + Builder Class Reference +

+ +
+ +
+ +
+
+

Builder

+
+
+ + 
public class Builder
+ +
+
+

A helper class to build the HyperwalletTransfer instance.

+ +
+
+ +
+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Creates a new instance of the HyperwalletTransfer.Builder based on the required parameters to create +a transfer.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public init(clientTransferId: String, sourceToken: String, destinationToken: String)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + clientTransferId + + +
    +

    A client defined transfer identifier. + This is the unique ID assigned to the transfer on your system. + Max 50 characters.

    +
    +
    + + sourceToken + + +
    +

    A token identifying the source of funds. + It can be a prepaid card token prefixed with trm- or user token prefixed with usr-.

    +
    +
    + + destinationToken + + +
    +

    A token identifying where the funds have been sent. + It is your merchant account token prefixed with act-.

    +
    +
    +
    +
    +
    +
    • +
  • +
    + + + + destinationAmount(_:) + +
    +
    +
    +
    +
    +
    +

    Sets the transfer destination amount.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func destinationAmount(_ destinationAmount: String?) -> Builder
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + destinationAmount + + +
    +

    The payment amount in the specified currency loaded into + your merchant account.

    +
    +
    +
    +
    +

    Return Value

    +

    a self HyperwalletTransfer.Builder instance.

    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Sets the transfer destination currency.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func destinationCurrency(_ destinationCurrency: String?) -> Builder
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + destinationCurrency + + +
    +

    The currency of the payment amount loaded into your merchant + account in ISO 4217 format.

    +
    +
    +
    +
    +

    Return Value

    +

    a self HyperwalletTransfer.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + memo(_:) + +
    +
    +
    +
    +
    +
    +

    Sets the transfer memo.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func memo(_ memo: String?) -> Builder
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + memo + + +
    +

    An internal memo for the SpendBack transfer (will not be visible to + the user making the payment).

    +
    +
    +
    +
    +

    Return Value

    +

    a self HyperwalletTransfer.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + notes(_:) + +
    +
    +
    +
    +
    +
    +

    Sets the transfer notes.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func notes(_ notes: String?) -> Builder
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + notes + + +
    +

    A description for the SpendBack transfer.

    +
    +
    +
    +
    +

    Return Value

    +

    a self HyperwalletTransfer.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + sourceAmount(_:) + +
    +
    +
    +
    +
    +
    +

    Sets the transfer source amount.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func sourceAmount(_ sourceAmount: String?) -> Builder
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + sourceAmount + + +
    +

    The payment amount in the specified currency that is debited + from the sourceToken.

    +
    +
    +
    +
    +

    Return Value

    +

    a self HyperwalletTransfer.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + sourceCurrency(_:) + +
    +
    +
    +
    +
    +
    +

    Sets the transfer source currency.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func sourceCurrency(_ sourceCurrency: String?) -> Builder
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + sourceCurrency + + +
    +

    The currency of the payment amount debited from the sourceToken + in ISO 4217 format.

    +
    +
    +
    +
    +

    Return Value

    +

    a self HyperwalletTransfer.Builder instance.

    +
    +
    +
    +
    • +
  • +
    + + + + build() + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func build() -> HyperwalletTransfer
    + +
    +
    +
    +

    Return Value

    +

    a new instance of the HyperwalletTransfer.

    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Structs/HyperwalletTransfer/HyperwalletTransferStatus.html b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Structs/HyperwalletTransfer/HyperwalletTransferStatus.html new file mode 100644 index 00000000..078b5a2a --- /dev/null +++ b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Structs/HyperwalletTransfer/HyperwalletTransferStatus.html @@ -0,0 +1,631 @@ + + + + HyperwalletTransferStatus Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + HyperwalletTransferStatus Enumeration Reference +

+ +
+ +
+ +
+
+

HyperwalletTransferStatus

+
+
+ + 
public enum HyperwalletTransferStatus : String, Codable
+ +
+
+

Representation of a HyperwalletTransferStatus

+ +
+
+ +
+
+
+
    +
  • +
    + + + + cancelled + +
    +
    +
    +
    +
    +
    +

    The transfer status is cancelled

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case cancelled = "CANCELLED"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + completed + +
    +
    +
    +
    +
    +
    +

    The transfer status is completed

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case completed = "COMPLETED"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + expired + +
    +
    +
    +
    +
    +
    +

    The transfer status is expired

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case expired = "EXPIRED"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + failed + +
    +
    +
    +
    +
    +
    +

    The transfer status is failed

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case failed = "FAILED"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + inProgress + +
    +
    +
    +
    +
    +
    +

    The transfer status is in Progress

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case inProgress = "IN_PROGRESS"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + quoted + +
    +
    +
    +
    +
    +
    +

    The transfer status is quoted

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case quoted = "QUOTED"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + returned + +
    +
    +
    +
    +
    +
    +

    The transfer status is returned

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case returned = "RETURNED"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + scheduled + +
    +
    +
    +
    +
    +
    +

    The transfer status is scheduled

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case scheduled = "SCHEDULED"
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + verificationRequired + +
    +
    +
    +
    +
    +
    +

    The verification required

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case verificationRequired = "VERIFICATION_REQUIRED"
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Structs/HyperwalletTransferMethodConfiguration.html b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Structs/HyperwalletTransferMethodConfiguration.html new file mode 100644 index 00000000..a6b6049f --- /dev/null +++ b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Structs/HyperwalletTransferMethodConfiguration.html @@ -0,0 +1,523 @@ + + + + HyperwalletTransferMethodConfiguration Structure Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + HyperwalletTransferMethodConfiguration Structure Reference +

+ +
+ +
+ +
+
+

HyperwalletTransferMethodConfiguration

+
+
+ + 
public struct HyperwalletTransferMethodConfiguration : Codable
+ +
+
+

Representation of the transfer method configuration

+ +
+
+ +
+
+
+
    +
  • +
    + + + + country + +
    +
    +
    +
    +
    +
    +

    The country

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let country: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + currency + +
    +
    +
    +
    +
    +
    +

    The currency

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let currency: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + transferMethodType + +
    +
    +
    +
    +
    +
    +

    The transfer method type

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let transferMethodType: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + profile + +
    +
    +
    +
    +
    +
    +

    The profile type

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let profile: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + fieldGroups + +
    +
    +
    +
    +
    +
    +

    The HyperwalletFieldGroup, or nil if none exists

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let fieldGroups: Connection<HyperwalletFieldGroup>?
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Structs/HyperwalletTransferMethodConfigurationFieldQuery.html b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Structs/HyperwalletTransferMethodConfigurationFieldQuery.html new file mode 100644 index 00000000..525d5eeb --- /dev/null +++ b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Structs/HyperwalletTransferMethodConfigurationFieldQuery.html @@ -0,0 +1,528 @@ + + + + HyperwalletTransferMethodConfigurationFieldQuery Structure Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + HyperwalletTransferMethodConfigurationFieldQuery Structure Reference +

+ +
+ +
+ +
+
+

HyperwalletTransferMethodConfigurationFieldQuery

+
+
+ + 
public struct HyperwalletTransferMethodConfigurationFieldQuery : GraphQlQuery, Hashable
+ +
+
+

The HyperwalletTransferMethodConfigurationFieldQuery struct defines and builds a query to retrieve the fields +required to create a transfer method (Bank Account, Bank Card, PayPal Account, Prepaid Card, Paper Check) +with the Hyperwallet platform.

+ +
+
+ +
+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Create a new HyperwalletTransferMethodConfigurationQuery from the country, currency, transferMethodType +and profile

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public init(country: String,
+            currency: String,
+            transferMethodType: String,
+            profile: String)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + +
    + + country + + +
    +

    the 2 letter ISO 3166-1 country code

    +
    +
    + + currency + + +
    +

    the 3 letter ISO 4217-1 currency code

    +
    +
    + + transferMethodType + + +
    +

    the TransferMethodType

    +
    +
    + + profile + + +
    +

    INDIVIDUAL or BUSINESS

    +
    +
    +
    +
    +
    +
    • +
  • +
    + + + + toGraphQl(userToken:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func toGraphQl(userToken: String) -> String
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + hash(into:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func hash(into hasher: inout Hasher)
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Structs/HyperwalletTransferMethodConfigurationKeysQuery.html b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Structs/HyperwalletTransferMethodConfigurationKeysQuery.html new file mode 100644 index 00000000..746652bd --- /dev/null +++ b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Structs/HyperwalletTransferMethodConfigurationKeysQuery.html @@ -0,0 +1,464 @@ + + + + HyperwalletTransferMethodConfigurationKeysQuery Structure Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + HyperwalletTransferMethodConfigurationKeysQuery Structure Reference +

+ +
+ +
+ +
+
+

HyperwalletTransferMethodConfigurationKeysQuery

+
+
+ + 
public struct HyperwalletTransferMethodConfigurationKeysQuery : GraphQlQuery
+ +
+
+

The ‘HyperwalletTransferMethodConfigurationKeysQuery’ struct defines and builds a query to retrieve the key set +that is required to construct a HyperwalletTransferMethodConfigurationFieldQuery.

+ +

In addition to the key set, the query will also retrieve the processing time and fees associated with each +country, currency and transfer method type tuple.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + init(limit:) + +
    +
    +
    +
    +
    +
    +

    / Create a new HyperwalletTransferMethodConfigurationKeysQuery instance

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public init(limit: Int = 0)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + limit + + +
    +

    The maximum number of records that will be returned per page.

    +
    +
    +
    +
    +
    +
    • +
  • +
    + + + + toGraphQl(userToken:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func toGraphQl(userToken: String) -> String
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Structs/HyperwalletTransferMethodType.html b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Structs/HyperwalletTransferMethodType.html new file mode 100644 index 00000000..f46e41f6 --- /dev/null +++ b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Structs/HyperwalletTransferMethodType.html @@ -0,0 +1,496 @@ + + + + HyperwalletTransferMethodType Structure Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + HyperwalletTransferMethodType Structure Reference +

+ +
+ +
+ +
+
+

HyperwalletTransferMethodType

+
+
+ + 
public struct HyperwalletTransferMethodType : Codable
+ +
+
+

Representation of transfer method type

+ +
+
+ +
+
+
+
    +
  • +
    + + + + code + +
    +
    +
    +
    +
    +
    +

    The country code

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let code: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + name + +
    +
    +
    +
    +
    +
    +

    The country name

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let name: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + fees + +
    +
    +
    +
    +
    +
    +

    The fees for transfer

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let fees: Connection<HyperwalletFee>?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + processingTimes + +
    +
    +
    +
    +
    +
    +

    The processing time for transfer

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let processingTimes: Connection<HyperwalletProcessingTime>?
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Structs/HyperwalletTransferMethodTypesFeesAndProcessingTimesQuery.html b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Structs/HyperwalletTransferMethodTypesFeesAndProcessingTimesQuery.html new file mode 100644 index 00000000..5eff0edc --- /dev/null +++ b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Structs/HyperwalletTransferMethodTypesFeesAndProcessingTimesQuery.html @@ -0,0 +1,443 @@ + + + + HyperwalletTransferMethodTypesFeesAndProcessingTimesQuery Structure Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + HyperwalletTransferMethodTypesFeesAndProcessingTimesQuery Structure Reference +

+ +
+ +
+ +
+
+

HyperwalletTransferMethodTypesFeesAndProcessingTimesQuery

+
+
+ + 
public struct HyperwalletTransferMethodTypesFeesAndProcessingTimesQuery : GraphQlQuery, Hashable
+ +
+
+

The ‘HyperwalletTransferMethodTypesFeesAndProcessingTimesQuery’ struct defines +and builds a query to retrieve the processing time and fees associated with each country, currency +and transfer method type tuple. +that is required to construct a HyperwalletTransferMethodConfigurationFieldQuery.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + toGraphQl(userToken:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func toGraphQl(userToken: String) -> String
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + hash(into:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func hash(into hasher: inout Hasher)
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Structs/HyperwalletTransferMethodUpdateConfigurationFieldQuery.html b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Structs/HyperwalletTransferMethodUpdateConfigurationFieldQuery.html new file mode 100644 index 00000000..4bd37ee5 --- /dev/null +++ b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Structs/HyperwalletTransferMethodUpdateConfigurationFieldQuery.html @@ -0,0 +1,489 @@ + + + + HyperwalletTransferMethodUpdateConfigurationFieldQuery Structure Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + HyperwalletTransferMethodUpdateConfigurationFieldQuery Structure Reference +

+ +
+ +
+ +
+
+

HyperwalletTransferMethodUpdateConfigurationFieldQuery

+
+
+ + 
public struct HyperwalletTransferMethodUpdateConfigurationFieldQuery : GraphQlQuery, Hashable
+ +
+
+

The HyperwalletTransferMethodUpdateConfigurationFieldQuery +struct defines and builds a query to retrieve the fields +required to update a transfer method (Bank Account, Bank Card, PayPal Account, Prepaid Card, Paper Check and Venmo) +with the Hyperwallet platform.

+ +
+
+ +
+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Create a new HyperwalletTransferMethodUpdateConfigurationFieldQuery from the transferMethodToken

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public init(transferMethodToken: String)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + transferMethodToken + + +
    +

    token from the transfer method

    +
    +
    +
    +
    +
    +
    • +
  • +
    + + + + toGraphQl(userToken:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func toGraphQl(userToken: String) -> String
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + hash(into:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func hash(into hasher: inout Hasher)
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Structs/HyperwalletValidationMessage.html b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Structs/HyperwalletValidationMessage.html new file mode 100644 index 00000000..969e1c63 --- /dev/null +++ b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/Structs/HyperwalletValidationMessage.html @@ -0,0 +1,469 @@ + + + + HyperwalletValidationMessage Structure Reference + + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + HyperwalletValidationMessage Structure Reference +

+ +
+ +
+ +
+
+

HyperwalletValidationMessage

+
+
+ + 
public struct HyperwalletValidationMessage : Codable
+ +
+
+

Representation of the transfer method configuration field validation message

+ +
+
+ +
+
+
+
    +
  • +
    + + + + length + +
    +
    +
    +
    +
    +
    +

    The validation message length, or nil if none exists

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let length: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + pattern + +
    +
    +
    +
    +
    +
    +

    The validation message pattern, or nil if none exists

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let pattern: String?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + empty + +
    +
    +
    +
    +
    +
    +

    The validation message empty, or nil if none exists

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let empty: String?
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/changelog.html b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/changelog.html new file mode 100644 index 00000000..e93545cb --- /dev/null +++ b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/changelog.html @@ -0,0 +1,486 @@ + + + + CHANGELOG Reference + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + CHANGELOG Reference +

+ +
+ +
+ +
+
+ +

Changelog

+ +

1.0.0-beta19

+ +
+ +
    +
  • Updated ci to xcode version 15
    • +
  • Add privacy manifest
    • +
+ +

1.0.0-beta17

+ +
+ +
    +
  • Handle HTTP 401
    • +
+

1.0.0-beta16

+ +
    +
  • iOS upgrade to version 13
    • +
+

1.0.0-beta15

+ +
    +
  • Connection timeout increased
    • +
+

1.0.0-beta14

+ +
    +
  • Performance update for Add Transfer Method GraphQL
    • +
+

1.0.0-beta13

+ +
    +
  • Fixed Xcode 12 issue
    • +
+

1.0.0-beta12

+ +
    +
  • Added support for iOS 14
    • +
+

1.0.0-beta11

+ +
    +
  • Support Paper Check as a transfer method
    • +
  • Support update transfer method
    • +
  • Enhancements
    • +
+

1.0.0-beta10

+ +
    +
  • Added Venmo as a Transfer method
    • +
  • Added support for List Prepaid Card Balances
    • +
  • Enhancements
    • +
+

1.0.0-beta09

+ +
    +
  • Increased API response timeout
    • +
+

1.0.0-beta08

+ +
    +
  • Fixed Cocoapod issue
    • +
+

1.0.0-beta07

+ +
    +
  • Enhancements
    • +
+

1.0.0-beta06

+ +
    +
  • Added support to List User Balances
    • +
  • Enhancements
    • +
+

1.0.0-beta05

+ +
    +
  • Enhancements
    • +
+

1.0.0-beta04

+ +
    +
  • Added support to the following
    • +
  • Create Transfer
    • +
  • Schedule Transfer
    • +
  • Get Transfer
    • +
+

1.0.0-beta03

+ +
    +
  • Enhancements to Add Transfer Method
    • +
  • Added support to the following:
    • +
  • List Prepaid Cards
    • +
  • List Prepaid Card Receipts
    • +
  • List User Receipts
    • +
+

1.0.0-beta02

+ +
    +
  • Added PayPal as a Transfer method
    • +
  • Added support to get User object
    • +
+

1.0.0-beta01

+ +
    +
  • Initial beta release of Hyperwallet Core SDK for iOS. This beta release has the following functionality:
    • +
  • Create Bank Account and Bank Card for United States (USD)
    • +
  • Retrieve field requirements for bank Accounts and Bank Cards
    • +
  • List Accounts
    • +
  • Deactivate (Remove) Accounts
    • +
+ +
+
+ + +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/css/highlight.css b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/css/highlight.css new file mode 100644 index 00000000..c170357c --- /dev/null +++ b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/css/highlight.css @@ -0,0 +1,202 @@ +/*! Jazzy - https://github.com/realm/jazzy + * Copyright Realm Inc. + * SPDX-License-Identifier: MIT + */ +/* Credit to https://gist.github.com/wataru420/2048287 */ +.highlight .c { + color: #999988; + font-style: italic; } + +.highlight .err { + color: #a61717; + background-color: #e3d2d2; } + +.highlight .k { + color: #000000; + font-weight: bold; } + +.highlight .o { + color: #000000; + font-weight: bold; } + +.highlight .cm { + color: #999988; + font-style: italic; } + +.highlight .cp { + color: #999999; + font-weight: bold; } + +.highlight .c1 { + color: #999988; + font-style: italic; } + +.highlight .cs { + color: #999999; + font-weight: bold; + font-style: italic; } + +.highlight .gd { + color: #000000; + background-color: #ffdddd; } + +.highlight .gd .x { + color: #000000; + background-color: #ffaaaa; } + +.highlight .ge { + color: #000000; + font-style: italic; } + +.highlight .gr { + color: #aa0000; } + +.highlight .gh { + color: #999999; } + +.highlight .gi { + color: #000000; + background-color: #ddffdd; } + +.highlight .gi .x { + color: #000000; + background-color: #aaffaa; } + +.highlight .go { + color: #888888; } + +.highlight .gp { + color: #555555; } + +.highlight .gs { + font-weight: bold; } + +.highlight .gu { + color: #aaaaaa; } + +.highlight .gt { + color: #aa0000; } + +.highlight .kc { + color: #000000; + font-weight: bold; } + +.highlight .kd { + color: #000000; + font-weight: bold; } + +.highlight .kp { + color: #000000; + font-weight: bold; } + +.highlight .kr { + color: #000000; + font-weight: bold; } + +.highlight .kt { + color: #445588; } + +.highlight .m { + color: #009999; } + +.highlight .s { + color: #d14; } + +.highlight .na { + color: #008080; } + +.highlight .nb { + color: #0086B3; } + +.highlight .nc { + color: #445588; + font-weight: bold; } + +.highlight .no { + color: #008080; } + +.highlight .ni { + color: #800080; } + +.highlight .ne { + color: #990000; + font-weight: bold; } + +.highlight .nf { + color: #990000; } + +.highlight .nn { + color: #555555; } + +.highlight .nt { + color: #000080; } + +.highlight .nv { + color: #008080; } + +.highlight .ow { + color: #000000; + font-weight: bold; } + +.highlight .w { + color: #bbbbbb; } + +.highlight .mf { + color: #009999; } + +.highlight .mh { + color: #009999; } + +.highlight .mi { + color: #009999; } + +.highlight .mo { + color: #009999; } + +.highlight .sb { + color: #d14; } + +.highlight .sc { + color: #d14; } + +.highlight .sd { + color: #d14; } + +.highlight .s2 { + color: #d14; } + +.highlight .se { + color: #d14; } + +.highlight .sh { + color: #d14; } + +.highlight .si { + color: #d14; } + +.highlight .sx { + color: #d14; } + +.highlight .sr { + color: #009926; } + +.highlight .s1 { + color: #d14; } + +.highlight .ss { + color: #990073; } + +.highlight .bp { + color: #999999; } + +.highlight .vc { + color: #008080; } + +.highlight .vg { + color: #008080; } + +.highlight .vi { + color: #008080; } + +.highlight .il { + color: #009999; } diff --git a/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/css/jazzy.css b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/css/jazzy.css new file mode 100644 index 00000000..c7bb9fe2 --- /dev/null +++ b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/css/jazzy.css @@ -0,0 +1,404 @@ +/*! Jazzy - https://github.com/realm/jazzy + * Copyright Realm Inc. + * SPDX-License-Identifier: MIT + */ +*, *:before, *:after { + box-sizing: inherit; } + +body { + margin: 0; + background: #fff; + color: #333; + font: 16px/1.7 "Helvetica Neue", Helvetica, Arial, sans-serif; + letter-spacing: .2px; + -webkit-font-smoothing: antialiased; + box-sizing: border-box; } + +h1 { + font-size: 2rem; + font-weight: 700; + margin: 1.275em 0 0.6em; } + +h2 { + font-size: 1.75rem; + font-weight: 700; + margin: 1.275em 0 0.3em; } + +h3 { + font-size: 1.5rem; + font-weight: 700; + margin: 1em 0 0.3em; } + +h4 { + font-size: 1.25rem; + font-weight: 700; + margin: 1.275em 0 0.85em; } + +h5 { + font-size: 1rem; + font-weight: 700; + margin: 1.275em 0 0.85em; } + +h6 { + font-size: 1rem; + font-weight: 700; + margin: 1.275em 0 0.85em; + color: #777; } + +p { + margin: 0 0 1em; } + +ul, ol { + padding: 0 0 0 2em; + margin: 0 0 0.85em; } + +blockquote { + margin: 0 0 0.85em; + padding: 0 15px; + color: #858585; + border-left: 4px solid #e5e5e5; } + +img { + max-width: 100%; } + +a { + color: #4183c4; + text-decoration: none; } + a:hover, a:focus { + outline: 0; + text-decoration: underline; } + a.discouraged { + text-decoration: line-through; } + a.discouraged:hover, a.discouraged:focus { + text-decoration: underline line-through; } + +table { + background: #fff; + width: 100%; + border-collapse: collapse; + border-spacing: 0; + overflow: auto; + margin: 0 0 0.85em; } + +tr:nth-child(2n) { + background-color: #fbfbfb; } + +th, td { + padding: 6px 13px; + border: 1px solid #ddd; } + +hr { + height: 1px; + border: none; + background-color: #ddd; } + +pre { + margin: 0 0 1.275em; + padding: .85em 1em; + overflow: auto; + background: #f7f7f7; + font-size: .85em; + font-family: Consolas, "Liberation Mono", Menlo, Courier, monospace; } + +code { + font-family: Consolas, "Liberation Mono", Menlo, Courier, monospace; } + +.item-container p > code, .item-container li > code, .top-matter p > code, .top-matter li > code { + background: #f7f7f7; + padding: .2em; } + .item-container p > code:before, .item-container p > code:after, .item-container li > code:before, .item-container li > code:after, .top-matter p > code:before, .top-matter p > code:after, .top-matter li > code:before, .top-matter li > code:after { + letter-spacing: -.2em; + content: "\00a0"; } + +pre code { + padding: 0; + white-space: pre; } + +.content-wrapper { + display: flex; + flex-direction: column; } + @media (min-width: 768px) { + .content-wrapper { + flex-direction: row; } } +.header { + display: flex; + padding: 8px; + font-size: 0.875em; + background: #444; + color: #999; } + +.header-col { + margin: 0; + padding: 0 8px; } + +.header-col--primary { + flex: 1; } + +.header-link { + color: #fff; } + +.header-icon { + padding-right: 2px; + vertical-align: -3px; + height: 16px; } + +.breadcrumbs { + font-size: 0.875em; + padding: 8px 16px; + margin: 0; + background: #fbfbfb; + border-bottom: 1px solid #ddd; } + +.carat { + height: 10px; + margin: 0 5px; } + +.navigation { + order: 2; } + @media (min-width: 768px) { + .navigation { + order: 1; + width: 25%; + max-width: 300px; + padding-bottom: 64px; + overflow: hidden; + word-wrap: normal; + background: #fbfbfb; + border-right: 1px solid #ddd; } } +.nav-groups { + list-style-type: none; + padding-left: 0; } + +.nav-group-name { + border-bottom: 1px solid #ddd; + padding: 8px 0 8px 16px; } + +.nav-group-name-link { + color: #333; } + +.nav-group-tasks { + margin: 8px 0; + padding: 0 0 0 8px; } + +.nav-group-task { + font-size: 1em; + list-style-type: none; + white-space: nowrap; } + +.nav-group-task-link { + color: #808080; } + +.main-content { + order: 1; } + @media (min-width: 768px) { + .main-content { + order: 2; + flex: 1; + padding-bottom: 60px; } } +.section { + padding: 0 32px; + border-bottom: 1px solid #ddd; } + +.section-content { + max-width: 834px; + margin: 0 auto; + padding: 16px 0; } + +.section-name { + color: #666; + display: block; } + .section-name p { + margin-bottom: inherit; } + +.declaration .highlight { + overflow-x: initial; + padding: 8px 0; + margin: 0; + background-color: transparent; + border: none; } + +.task-group-section { + border-top: 1px solid #ddd; } + +.task-group { + padding-top: 0px; } + +.task-name-container a[name]:before { + content: ""; + display: block; } + +.section-name-container { + position: relative; } + .section-name-container .section-name-link { + position: absolute; + top: 0; + left: 0; + bottom: 0; + right: 0; + margin-bottom: 0; } + .section-name-container .section-name { + position: relative; + pointer-events: none; + z-index: 1; } + .section-name-container .section-name a { + pointer-events: auto; } + +.item-container { + padding: 0; } + +.item { + padding-top: 8px; + width: 100%; + list-style-type: none; } + .item a[name]:before { + content: ""; + display: block; } + .item .token, .item .direct-link { + display: inline-block; + text-indent: -20px; + padding-left: 3px; + margin-left: 20px; + font-size: 1rem; } + .item .declaration-note { + font-size: .85em; + color: #808080; + font-style: italic; } + +.pointer-container { + border-bottom: 1px solid #ddd; + left: -23px; + padding-bottom: 13px; + position: relative; + width: 110%; } + +.pointer { + left: 21px; + top: 7px; + display: block; + position: absolute; + width: 12px; + height: 12px; + border-left: 1px solid #ddd; + border-top: 1px solid #ddd; + background: #fff; + transform: rotate(45deg); } + +.height-container { + display: none; + position: relative; + width: 100%; + overflow: hidden; } + .height-container .section { + background: #fff; + border: 1px solid #ddd; + border-top-width: 0; + padding-top: 10px; + padding-bottom: 5px; + padding: 8px 16px; } + +.aside, .language { + padding: 6px 12px; + margin: 12px 0; + border-left: 5px solid #dddddd; + overflow-y: hidden; } + .aside .aside-title, .language .aside-title { + font-size: 9px; + letter-spacing: 2px; + text-transform: uppercase; + padding-bottom: 0; + margin: 0; + color: #aaa; + -webkit-user-select: none; } + .aside p:last-child, .language p:last-child { + margin-bottom: 0; } + +.language { + border-left: 5px solid #cde9f4; } + .language .aside-title { + color: #4183c4; } + +.aside-warning, .aside-deprecated, .aside-unavailable { + border-left: 5px solid #ff6666; } + .aside-warning .aside-title, .aside-deprecated .aside-title, .aside-unavailable .aside-title { + color: #ff0000; } + +.graybox { + border-collapse: collapse; + width: 100%; } + .graybox p { + margin: 0; + word-break: break-word; + min-width: 50px; } + .graybox td { + border: 1px solid #ddd; + padding: 5px 25px 5px 10px; + vertical-align: middle; } + .graybox tr td:first-of-type { + text-align: right; + padding: 7px; + vertical-align: top; + word-break: normal; + width: 40px; } + +.slightly-smaller { + font-size: 0.9em; } + +.footer { + padding: 8px 16px; + background: #444; + color: #ddd; + font-size: 0.8em; } + .footer p { + margin: 8px 0; } + .footer a { + color: #fff; } + +html.dash .header, html.dash .breadcrumbs, html.dash .navigation { + display: none; } + +html.dash .height-container { + display: block; } + +form[role=search] input { + font: 16px/1.7 "Helvetica Neue", Helvetica, Arial, sans-serif; + font-size: 14px; + line-height: 24px; + padding: 0 10px; + margin: 0; + border: none; + border-radius: 1em; } + .loading form[role=search] input { + background: white url(../img/spinner.gif) center right 4px no-repeat; } + +form[role=search] .tt-menu { + margin: 0; + min-width: 300px; + background: #fbfbfb; + color: #333; + border: 1px solid #ddd; } + +form[role=search] .tt-highlight { + font-weight: bold; } + +form[role=search] .tt-suggestion { + font: 16px/1.7 "Helvetica Neue", Helvetica, Arial, sans-serif; + padding: 0 8px; } + form[role=search] .tt-suggestion span { + display: table-cell; + white-space: nowrap; } + form[role=search] .tt-suggestion .doc-parent-name { + width: 100%; + text-align: right; + font-weight: normal; + font-size: 0.9em; + padding-left: 16px; } + +form[role=search] .tt-suggestion:hover, +form[role=search] .tt-suggestion.tt-cursor { + cursor: pointer; + background-color: #4183c4; + color: #fff; } + +form[role=search] .tt-suggestion:hover .doc-parent-name, +form[role=search] .tt-suggestion.tt-cursor .doc-parent-name { + color: #fff; } diff --git a/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/img/carat.png b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/img/carat.png new file mode 100755 index 00000000..29d2f7fd Binary files /dev/null and b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/img/carat.png differ diff --git a/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/img/dash.png b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/img/dash.png new file mode 100755 index 00000000..6f694c7a Binary files /dev/null and b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/img/dash.png differ diff --git a/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/img/gh.png b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/img/gh.png new file mode 100755 index 00000000..628da97c Binary files /dev/null and b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/img/gh.png differ diff --git a/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/img/spinner.gif b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/img/spinner.gif new file mode 100644 index 00000000..e3038d0a Binary files /dev/null and b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/img/spinner.gif differ diff --git a/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/index.html b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/index.html new file mode 100644 index 00000000..875b1ab4 --- /dev/null +++ b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/index.html @@ -0,0 +1,1033 @@ + + + + HyperwalletSDK Reference + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + HyperwalletSDK Reference +

+ +
+ +
+ +
+
+ +

Hyperwallet iOS Core SDK

+ +

Platforms +Build Status +Coverage Status

+ +

CocoaPods +Carthage compatible

+ +

NOTE: This is a beta product available for use in your mobile app. If you are interested in using this product, please notify your Relationship Manager and / or Project Manager to support you during the integration process.

+ +

Welcome to Hyperwallet’s iOS SDK. This library will help you create transfer methods in your iOS app, such as bank account, PayPal account, etc. See our iOS Integration Guide to get started!

+ +

Note that this SDK is geared towards those who only require backend data, which means you will have to build your own UI.

+ +

We also provide an out-of-the-box Hyperwallet iOS UI SDK for you if you decide not to build your own UI.

+

Prerequisites

+ +
    +
  • A Hyperwallet merchant account
    • +
  • Set Up your server to manage the user’s authentication process on the Hyperwallet platform. See the Authentication section for more information.
    • +
  • iOS 13.0+
    • +
  • Xcode 10.2+
    • +
  • Swift 5.0
    • +
+

Installation

+ +

Use Carthage or CocoaPods to integrate to HyperwalletSDK.

+

Carthage

+ +

Specify it in your Cartfile:

+
github "hyperwallet/hyperwallet-ios-sdk" "1.0.0-beta17"
+
+

CocoaPods

+ +

Specify it in your Podfile:

+
pod 'HyperwalletSDK', '~> 1.0.0-beta17'
+
+

Initialization

+ +

After you’re done installing the SDK, you need to initialize an instance in order to utilize core SDK functions. Also, you need to provide a HyperwalletAuthenticationTokenProvider object to retrieve an authentication token.

+ +

Add in the header:

+
import HyperwalletSDK
+
+ +

Initialize the HyperwalletSDK with a HyperwalletAuthenticationTokenProvider implementation instance:

+
Hyperwallet.setup(authenticationTokenProvider :HyperwalletAuthenticationTokenProvider)
+
+

Authentication

+ +

Your server side should be able to send a POST request to Hyperwallet endpoint /rest/v3/users/{user-token}/authentication-token to retrieve an authentication token. +Then, you need to provide a class (an authentication provider) which implements HyperwalletAuthenticationTokenProvider to retrieve an authentication token from your server.

+ +

An example implementation using the URLRequest from Swift Foundation :

+
import Foundation
+import HyperwalletSDK
+
+public class AuthenticationTokenProvider: HyperwalletAuthenticationTokenProvider {
+    private let url = URL(string: "http://your/server/to/retrieve/authenticationToken")!
+
+    public func retrieveAuthenticationToken(
+        completionHandler: @escaping HyperwalletAuthenticationTokenProvider.CompletionHandler) {
+
+        var request = URLRequest(url: url)
+        request.httpMethod = "POST"
+        request.addValue("application/json", forHTTPHeaderField: "Content-Type")
+
+        let defaultSession = URLSession(configuration: .default)
+        let task = defaultSession.dataTask(with: request) {(data, response, error) in
+            DispatchQueue.main.async {
+                    guard let data = data,
+                        let clientToken = String(data: data, encoding: .utf8),
+                        let response = response as? HTTPURLResponse else {
+                            completionHandler(nil, HyperwalletAuthenticationErrorType.unexpected(error?.localizedDescription ??
+                                "authentication token cannot be retrieved"))
+                            return
+                    }
+
+                    switch response.statusCode {
+                        case 200 ..< 300:
+                            completionHandler(clientToken, nil)
+
+                        default:
+                            completionHandler(nil, HyperwalletAuthenticationErrorType
+                                .unexpected("authentication token cannot be retrieved"))
+                }
+            }
+        }
+        task.resume()
+    }
+}
+
+

Usage

+ +

The functions in the core SDK are available to use once the authentication is done.

+

Get User

+
Hyperwallet.shared.getUser { (user, error) in
+    guard error == nil else {
+        print(error?.getHyperwalletErrors()?.errorList?)
+        return
+    }
+
+    print(user?.firstName)
+    print(user?.lastName)
+}
+
+

Create PayPal Account

+
let payPalAccount = HyperwalletPayPalAccount.Builder(transferMethodCountry: "US", transferMethodCurrency: "USD")
+    .email("test@paypal.com")
+    .build()
+
+Hyperwallet.shared.createPayPalAccount(account: payPalAccount, completion: { (result, error) in
+    // Code to handle successful response or error
+    // On successful creation, response (HyperwalletPayPalAccount in this case) will contain information about the user’s PayPal account
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure of PayPal account creation
+})
+
+

Get PayPal Account

+
Hyperwallet.shared.getPayPalAccount(transferMethodToken: "123123", completion: { (result, error) in
+    // On success, response (HyperwalletPayPalAccount? in this case) will contain information about the user’s PayPal account or nil if not exist.
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure
+})
+
+

Update PayPal Account

+
let payPalAccount = HyperwalletPayPalAccount.Builder(token: "trm-12345")
+    .email("test@paypal.com")
+    .build()
+
+Hyperwallet.shared.updatePayPalAccount(account: payPalAccount, completion: { (result, error) in
+    // Code to handle successful response or error
+    // On successful update, response (HyperwalletPayPalAccount in this case) will contain information about the user’s PayPal account
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure of PayPal account updating
+})
+
+

Deactivate PayPal Account

+
Hyperwallet.shared.deactivatePayPalAccount(transferMethodToken: "trm-12345", notes: "deactivate PayPal account", completion: { (result, error) in
+    // Code to handle successful response or error
+    // On successful deactivation, response (HyperwalletStatusTransition in this case) will contain information about the status transition
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure of PayPal account deactivation
+})
+
+

List PayPal Account

+
let payPalQueryParam = HyperwalletPayPalAccountQueryParam()
+payPalQueryParam.status = HyperwalletPayPalAccountQueryParam.QueryStatus.activated.rawValue
+payPalQueryParam.sortBy = HyperwalletTransferMethodQueryParam.QuerySortable.ascendantCreatedOn.rawValue
+
+Hyperwallet.shared.listPayPalAccounts(queryParam: payPalQueryParam) { (result, error) in
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure
+    guard error == nil else {
+        print(error?.getHyperwalletErrors()?.errorList?)
+        return
+    }
+
+    // On success, response (HyperwalletPageList<HyperwalletPayPalAccount>? in this case) will contain information about or nil if not exist.
+    if let payPalAccounts = result?.data {
+        for payPalAccount in payPalAccounts {
+        print(payPalAccount.getField(fieldName: .token) ?? "")
+        }
+    }
+}
+
+

Create Venmo Account

+
let venmoAccount = HyperwalletVenmoAccount.Builder(transferMethodCountry: "US", transferMethodCurrency: "USD")
+    .accountId("9876543210")
+    .build()
+
+Hyperwallet.shared.createVenmoAccount(account: venmoAccount, completion: { (result, error) in
+    // Code to handle successful response or error
+    // On successful creation, response (HyperwalletVenmoAccount in this case) will contain information about the user’s Venmo account
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure of Venmo account creation
+})
+
+

Get Venmo Account

+
Hyperwallet.shared.getVenmoAccount(transferMethodToken: "123123", completion: { (result, error) in
+    // On success, response (HyperwalletVenmoAccount? in this case) will contain information about the user’s Venmo account or nil if not exist.
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure
+})
+
+

Update Venmo Account

+
let venmoAccount = HyperwalletVenmoAccount.Builder(token: "trm-12345")
+    .accountId("9876543210")
+    .build()
+
+Hyperwallet.shared.updateVenmoAccount(account: venmoAccount, completion: { (result, error) in
+    // Code to handle successful response or error
+    // On successful update, response (HyperwalletVenmoAccount in this case) will contain information about the user’s Venmo account
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure of Venmo account updating
+})
+
+

Deactivate Venmo Account

+
Hyperwallet.shared.deactivateVenmoAccount(transferMethodToken: "trm-12345", notes: "deactivate Venmo account", completion: { (result, error) in
+    // Code to handle successful response or error
+    // On successful deactivation, response (HyperwalletStatusTransition in this case) will contain information about the status transition
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure of Venmo account deactivation
+})
+
+

List Venmo Account

+
let venmoQueryParam = HyperwalletVenmoQueryParam()
+venmoQueryParam.status = HyperwalletVenmoQueryParam.QueryStatus.activated.rawValue
+venmoQueryParam.sortBy = HyperwalletVenmoQueryParam.QuerySortable.ascendantCreatedOn.rawValue
+
+Hyperwallet.shared.listVenmoAccounts(queryParam: venmoQueryParam) { (result, error) in
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure
+    guard error == nil else {
+        print(error?.getHyperwalletErrors()?.errorList?)
+        return
+    }
+
+    // On success, response (HyperwalletPageList<HyperwalletVenmoAccount>? in this case) will contain information about or nil if not exist.
+    if let venmoAccounts = result?.data {
+        for venmoAccount in venmoAccounts {
+           print(venmoAccount.getField(fieldName: .token) ?? "")
+        }
+    }
+}
+
+

Create Bank Account

+
let bankAccount = HyperwalletBankAccount.Builder(transferMethodCountry: "US",   
+                                                 transferMethodCurrency: "USD",
+                                                 transferMethodProfileType: "INDIVIDUAL")
+.bankAccountId("12345")
+.branchId("123456")
+.bankAccountPurpose(.checking)
+.build()
+
+Hyperwallet.shared.createBankAccount(account: bankAccount, completion: { (result, error) in
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure of account creation
+    guard error == nil else {
+        print(error?.getHyperwalletErrors()?.errorList?)
+        return
+    }   
+
+    // On successful creation, response (HyperwalletBankAccount in this case) payload will contain information about the account created
+    print(result)
+})
+
+

Get Bank Account

+
Hyperwallet.shared.getBankAccount(transferMethodToken: "123123", completion: { (result, error) in
+    // On success, response (HyperwalletBankCard? in this case) will contain information about the user’s bank account or nil if not exist.
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure
+})
+
+

Update Bank Account

+
let bankAccount = HyperwalletBankAccount
+.Builder(token: "12345")
+.branchId("026009593")
+.build()
+
+Hyperwallet.shared.updateBankAccount(account: bankAccount, completion: { (response, error) in
+    // Code to handle successful response or error
+    // On successful update, response (HyperwalletBankAccount in this case) payload will contain information about the account updated
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure of account updating
+})
+
+

Deactivate Bank Account

+
Hyperwallet.shared.deactivateBankAccount(transferMethodToken: "trm-12345", notes: "deactivate bank account", completion: { (result, error) in
+    // Code to handle successful response or error
+    // On successful deactivation, response (HyperwalletStatusTransition in this case) will contain information about the status transition
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure of account deactivation
+})
+
+

List Bank Account

+
let bankAccountQueryParam = HyperwalletBankAccountQueryParam()
+bankAccountQueryParam.status = HyperwalletBankAccountQueryParam.QueryStatus.activated.rawValue
+bankAccountQueryParam.sortBy = HyperwalletBankAccountQueryParam.QuerySortable.ascendantCreatedOn.rawValue
+
+Hyperwallet.shared.listBankAccounts(queryParam: bankAccountQueryParam) { (result, error) in
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure
+    guard error == nil else {
+        print(error?.getHyperwalletErrors()?.errorList?)
+        return
+    }
+
+    // On success, response (HyperwalletPageList<HyperwalletBankAccount>? in this case) will contain information about or nil if not exist.
+    if let bankAccounts = result?.data {
+        for bankAccount in bankAccounts {
+            print(bankAccount.token ?? "")
+        }
+    }
+}
+
+

Create Paper Check

+
let paperCheck = HyperwalletPaperCheck.Builder(transferMethodCountry: "US",   
+                                               transferMethodCurrency: "USD",
+                                               transferMethodProfileType: "INDIVIDUAL")
+.shippingMethod("STANDARD")
+.build()
+
+Hyperwallet.shared.createPaperCheck(account: paperCheck, completion: { (result, error) in
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure of account creation
+    guard error == nil else {
+        print(error?.getHyperwalletErrors()?.errorList?)
+        return
+    }   
+
+    // On successful creation, response (HyperwalletPaperCheck in this case) payload will contain information about the paper check created
+    print(result)
+})
+
+

Get Paper Check

+
Hyperwallet.shared.getPaperCheck(transferMethodToken: "123123", completion: { (result, error) in
+    // On success, response (HyperwalletPaperCheck? in this case) will contain information about the user’s paper check or nil if not exist.
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure
+})
+
+

Update Paper Check

+
let paperCheck = HyperwalletPaperCheck
+.Builder(token: "12345")
+.shippingMethod("STANDARD")
+.build()
+
+Hyperwallet.shared.updatePaperCheck(account: paperCheck, completion: { (response, error) in
+    // Code to handle successful response or error
+    // On successful update, response (HyperwalletPaperCheck in this case) payload will contain information about the paper check updated
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure while updating
+})
+
+

Deactivate Paper Check

+
Hyperwallet.shared.deactivatePaperCheck(transferMethodToken: "trm-12345", notes: "deactivate paper check", completion: { (result, error) in
+    // Code to handle successful response or error
+    // On successful deactivation, response (HyperwalletStatusTransition in this case) will contain information about the status transition
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure
+})
+
+

List Paper Check

+
let paperCheckQueryParam = HyperwalletPaperCheckQueryParam()
+paperCheckQueryParam.status = HyperwalletPaperCheckQueryParam.QueryStatus.activated.rawValue
+paperCheckQueryParam.sortBy = HyperwalletPaperCheckQueryParam.QuerySortable.ascendantCreatedOn.rawValue
+
+Hyperwallet.shared.listPaperChecks(queryParam: paperCheckQueryParam) { (result, error) in
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure
+    guard error == nil else {
+        print(error?.getHyperwalletErrors()?.errorList?)
+        return
+    }
+
+    // On success, response (HyperwalletPageList<HyperwalletPaperCheck>? in this case) will contain information about or nil if not exist.
+    if let paperChecks = result?.data {
+        for paperCheck in paperChecks {
+            print(paperCheck.token ?? "")
+        }
+    }
+}
+
+

Create Bank Card

+
let bankCard = HyperwalletBankCard.Builder(transferMethodCountry: "US",
+                                           transferMethodCurrency: "USD",
+                                           transferMethodProfileType: "INDIVIDUAL")
+.cardNumber("1234123412341234")
+.dateOfExpiry("2022-12")
+.cvv("123")
+.build()
+
+Hyperwallet.shared.createBankCard(account: bankCard, completion: { (result, error) in
+    // Code to handle successful response or error
+    // On successful creation, response (HyperwalletBankCard in this case) will contain information about the user’s bank card
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure of bank card creation
+})
+
+

Get Bank Card

+
Hyperwallet.shared.getBankCard(transferMethodToken: "123123", completion: { (result, error) in
+    // On success, response (HyperwalletBankCard? in this case) will contain information about the user’s bank card or nil if not exist.
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure
+})
+
+

Update Bank Card

+
let bankCard = HyperwalletBankCard
+.Builder(token: "trm-12345")
+.dateOfExpiry("2022-12")
+.build()
+
+Hyperwallet.shared.updateBankCard(account: bankCard, completion: { (result, error) in
+    // Code to handle successful response or error
+    // On successful update, response (HyperwalletBankCard in this case) will contain information about the user’s bank card
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure of bank card updating
+})
+
+

Deactivate Bank Card

+
Hyperwallet.shared.deactivateBankCard(transferMethodToken: "trm-12345", notes: "deactivate bank card", completion: { (result, error) in
+    // Code to handle successful response or error
+    // On successful deactivation, response (HyperwalletStatusTransition in this case) will contain information about the status transition
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure of bank card deactivation
+})
+
+

List Bank Card

+
let bankCardQueryParam = HyperwalletBankCardQueryParam()
+bankCardQueryParam.status = HyperwalletBankCardQueryParam.QueryStatus.activated.rawValue
+bankCardQueryParam.sortBy = HyperwalletBankCardQueryParam.QuerySortable.ascendantCreatedOn.rawValue
+
+Hyperwallet.shared.listBankCards(queryParam: bankCardQueryParam) { (result, error) in
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure
+    guard error == nil else {
+        print(error?.getHyperwalletErrors()?.errorList?)
+        return
+    }
+
+    // On success, response (HyperwalletPageList<HyperwalletBankCard>? in this case) will contain information about or nil if not exist.
+    if let bankCards = result?.data {
+        for bankCard in bankCards {
+            print(bankCard.token ?? "")
+        }
+    }
+}
+
+

Get Prepaid Card

+
Hyperwallet.shared.getPrepaidCard(transferMethodToken: "123123", completion: { (result, error) in
+    // On success, response (HyperwalletPrepaidCard? in this case) will contain information about the user’s prepaid card or nil if not exist.
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure
+})
+
+

List Prepaid Cards

+
let prepaidCardQueryParam = HyperwalletPrepaidCardQueryParam()
+prepaidCardQueryParam.status = HyperwalletPrepaidCardQueryParam.QueryStatus.activated.rawValue
+prepaidCardQueryParam.sortBy = HyperwalletPrepaidCardQueryParam.QuerySortable.ascendantCreatedOn.rawValue
+
+Hyperwallet.shared.listPrepaidCards(queryParam: prepaidCardQueryParam) { (result, error) in
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure
+    guard error == nil else {
+        print(error?.getHyperwalletErrors()?.errorList?)
+        return
+    }
+
+    // On success, response (HyperwalletPageList<HyperwalletPrepaidCard>? in this case) will contain information about or nil if not exist.
+    if let prepaidCards = result?.data {
+        for prepaidCard in prepaidCards {
+            print(prepaidCard.token)
+        }
+    }
+}
+
+

List Prepaid Card Receipts

+
let receiptQueryParam = HyperwalletReceiptQueryParam()
+receiptQueryParam.createdAfter = ISO8601DateFormatter.ignoreTimeZone.date(from: "2016-12-01T00:00:00")
+
+Hyperwallet.shared.listPrepaidCardReceipts(prepaidCardToken: prepaidCardToken,
+                                           queryParam: receiptQueryParam,
+                                           completion: { (result, error) in
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure
+    guard error == nil else {
+        print(error?.getHyperwalletErrors()?.errorList?)
+        return
+    }
+
+    // On success, response (HyperwalletPageList<HyperwalletReceipt>? in this case) will contain information about or nil if not exist.
+    if let receipts = result?.data {
+        for receipt in receipts {
+            print(receipt.destinationToken ?? "")
+        }
+    }
+}
+
+

List User Receipts

+
let receiptQueryParam = HyperwalletReceiptQueryParam()
+receiptQueryParam.createdAfter = ISO8601DateFormatter.ignoreTimeZone.date(from: "2018-12-01T00:00:00")
+receiptQueryParam.currency = "USD"
+receiptQueryParam.sortBy = HyperwalletReceiptQueryParam.QuerySortable.descendantAmount.rawValue
+
+Hyperwallet.shared.listUserReceipts(queryParam: receiptQueryParam) { (result, error) in
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure
+    guard error == nil else {
+        print(error?.getHyperwalletErrors()?.errorList?)
+        return
+        }
+
+    // On success, response (HyperwalletPageList<HyperwalletReceipt>? in this case) will contain information about or nil if not exist.
+    if let receipts = result?.data {
+        for receipt in receipts {
+            print(receipt.destinationToken ?? "")
+        }
+    }
+}
+
+

List Transfer Methods

+
let transferMethodQueryParam = HyperwalletTransferMethodQueryParam()
+transferMethodQueryParam.sortBy = HyperwalletTransferMethodQueryParam.QuerySortable.ascendantCreatedOn.rawValue
+
+Hyperwallet.shared.listTransferMethods(queryParam: transferMethodQueryParam) { (result, error) in
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure
+    guard error == nil else {
+        print(error?.getHyperwalletErrors()?.errorList?)
+        return
+    }
+
+    // On success, response (HyperwalletPageList<HyperwalletTransferMethod>? in this case) will contain information about or nil if not exist.
+    if let transferMethods = result?.data {
+        for transferMethod in transferMethods {
+            print(transferMethod.token ?? "")
+        }
+    }
+}
+
+

Create Transfer

+
let transfer = HyperwalletTransfer.Builder(clientTransferId: "6712348070812",
+                                           sourceToken: "source-token",
+                                           destinationToken: "destination-token")
+    .sourceAmount("100")
+    .sourceCurrency("CAD")
+    .destinationAmount("62.29")
+    .destinationCurrency("USD")
+    .memo("TransferClientId56387")
+    .notes("Partial-Balance Transfer")
+    .build()
+
+Hyperwallet.shared.createTransfer(transfer: transfer, completion: { (result, error) in
+    //Code to handle successful response or error
+    //On successfull creation, response (HyperwalletTransfer in this case) will contain information about the transfer
+    //in case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure of transfer creation
+})
+
+

Schedule Transfer

+
Hyperwallet.shared.scheduleTransfer(transferToken: "trf-123456", completion: { (result, error) in
+    //Code to handle successful response or error
+    // On successful scheduling, response (HyperwalletStatusTransition in this case) will contain information about the status transition
+    //in case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure of transfer creation
+})
+
+

Get Transfer

+
Hyperwallet.shared.getTransfer(transferToken: "trf-123456", completion: { (result, error) in
+    // On success, response (HyperwalletTransfer? in this case) will contain information about the transfer or nil if not exist.
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure
+})
+
+

List Transfers

+
Hyperwallet.shared.listTransfers { (result, error) in
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure
+    guard error == nil else {
+        print(error?.getHyperwalletErrors()?.errorList?)
+        return
+    }
+
+    // On success, response (HyperwalletPageList<HyperwalletTransfer>? in this case) will contain information about or nil if not exist.
+    if let transfers = result?.data {
+        for transfer in transfers {
+            print(transfer.token ?? "")
+        }
+    }
+})
+
+

List User Balances

+
let balanceQueryParam = HyperwalletBalanceQueryParam()
+balanceQueryParam.currency = "USD"
+balanceQueryParam.sortBy = HyperwalletBalanceQueryParam.QuerySortable.descendantAmount.rawValue
+
+Hyperwallet.shared.listUserBalances(queryParam: balanceQueryParam) { (result, error) in
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure
+    guard error == nil else {
+    print(error?.getHyperwalletErrors()?.errorList?)
+    return
+    }
+
+    // On success, response (HyperwalletPageList<HyperwalletBalance>? in this case) will contain information about or nil if not exist.
+    if let balances = result?.data {
+        for balance in balances {
+            print(balance.amount ?? "")
+        }
+    }
+}
+
+

List Prepaid Card Balances

+
let prepaidCardBalanceQueryParam = HyperwalletPrepaidCardBalanceQueryParam()
+prepaidCardBalanceQueryParam.sortBy = HyperwalletPrepaidCardBalanceQueryParam.QuerySortable.descendantAmount.rawValue
+
+Hyperwallet.shared.listPrepaidCardBalances(prepaidCardToken: "trm-1234", queryParam: prepaidCardBalanceQueryParam) { (result, error) in
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure
+    guard error == nil else {
+    print(error?.getHyperwalletErrors()?.errorList?)
+    return
+    }
+
+    // On success, response (HyperwalletPageList<HyperwalletBalance>? in this case) will contain information about or nil if not exist.
+    if let balances = result?.data {
+        for balance in balances {
+            print(balance.amount ?? "")
+        }
+    }
+}
+
+

Transfer Method Configurations

+

Get countries, currencies

+
let keysQuery = HyperwalletTransferMethodConfigurationKeysQuery()
+
+Hyperwallet.shared.retrieveTransferMethodConfigurationKeys(request: keysQuery) { (result, error) in
+
+    guard error == nil else {
+        print(error?.getHyperwalletErrors()?.errorList?)
+        return
+    }
+
+    guard let result = result else { return }
+    // Get countries
+    let countries = result.countries()
+
+    // Get currencies based on the first available country code
+    var currencies: [HyperwalletCurrency]?
+    if let countries = result.countries(), !countries.isEmpty {
+        currencies = result.currencies(from: countries.first!.code)
+    }
+
+    print(countries)
+    print(currencies)
+}
+
+

Get transfer method types, fees and processing times for Country and Currency

+
let country = "CA"
+let currency = "CAD"
+let keysQuery = HyperwalletTransferMethodTypesFeesAndProcessingTimesQuery(country: country, currency: currency)
+
+Hyperwallet
+    .shared
+    .retrieveTransferMethodTypesFeesAndProcessingTimes(request: keysQuery) { (result, error) in
+    guard error == nil else {
+        print(error?.getHyperwalletErrors()?.errorList?)
+        return
+    }
+
+    guard let result = result else { return }
+
+    // Get transfer method types based on the first country code and its first currency code
+    transferMethodTypes = result.transferMethodTypes(countryCode: country, currencyCode: currency)
+    print(transferMethodTypes)
+    print(transferMethodTypes?.first?.fees)
+    print(transferMethodTypes?.first?.processingTimes)
+}
+
+

Get fields for a transfer method type

+
let fieldQuery = HyperwalletTransferMethodConfigurationFieldQuery(country: "CA",
+                                                                  currency: "USD",
+                                                                  transferMethodType: "BANK_ACCOUNT",
+                                                                  profile: "INDIVIDUAL")
+
+Hyperwallet.shared.retrieveTransferMethodConfigurationFields(request: fieldQuery) { (result, error) in
+
+    guard error == nil else {
+        print(error?.getHyperwalletErrors()?.errorList?)
+        return
+    }
+
+    guard let result = result else { return }
+
+    print(result.transferMethodType()))
+    print(result.fieldGroups()?.fields))
+}
+
+

Get fields for updating transfer method

+
let fieldQuery = HyperwalletTransferMethodUpdateConfigurationFieldQuery(transferMethodToken: "trm-0000001")
+
+Hyperwallet.shared.retrieveTransferMethodUpdateConfigurationFields(request: fieldQuery) { (result, error) in
+    guard error == nil else {
+        print(error?.getHyperwalletErrors()?.errorList)
+        return
+    }
+
+    guard let result = result else { return }
+
+    print(result.transferMethodUpdateConfiguration()?.fieldGroups?.nodes)
+    print(result.transferMethodUpdateConfiguration()?.transferMethodType)
+}
+
+

License

+ +

The Hyperwallet iOS SDK is open source and available under the MIT license

+ +
+
+ + +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/js/jazzy.js b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/js/jazzy.js new file mode 100755 index 00000000..19844166 --- /dev/null +++ b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/js/jazzy.js @@ -0,0 +1,74 @@ +// Jazzy - https://github.com/realm/jazzy +// Copyright Realm Inc. +// SPDX-License-Identifier: MIT + +window.jazzy = {'docset': false} +if (typeof window.dash != 'undefined') { + document.documentElement.className += ' dash' + window.jazzy.docset = true +} +if (navigator.userAgent.match(/xcode/i)) { + document.documentElement.className += ' xcode' + window.jazzy.docset = true +} + +function toggleItem($link, $content) { + var animationDuration = 300; + $link.toggleClass('token-open'); + $content.slideToggle(animationDuration); +} + +function itemLinkToContent($link) { + return $link.parent().parent().next(); +} + +// On doc load + hash-change, open any targetted item +function openCurrentItemIfClosed() { + if (window.jazzy.docset) { + return; + } + var $link = $(`a[name="${location.hash.substring(1)}"]`).nextAll('.token'); + $content = itemLinkToContent($link); + if ($content.is(':hidden')) { + toggleItem($link, $content); + } +} + +$(openCurrentItemIfClosed); +$(window).on('hashchange', openCurrentItemIfClosed); + +// On item link ('token') click, toggle its discussion +$('.token').on('click', function(event) { + if (window.jazzy.docset) { + return; + } + var $link = $(this); + toggleItem($link, itemLinkToContent($link)); + + // Keeps the document from jumping to the hash. + var href = $link.attr('href'); + if (history.pushState) { + history.pushState({}, '', href); + } else { + location.hash = href; + } + event.preventDefault(); +}); + +// Clicks on links to the current, closed, item need to open the item +$("a:not('.token')").on('click', function() { + if (location == this.href) { + openCurrentItemIfClosed(); + } +}); + +// KaTeX rendering +if ("katex" in window) { + $($('.math').each( (_, element) => { + katex.render(element.textContent, element, { + displayMode: $(element).hasClass('m-block'), + throwOnError: false, + trust: true + }); + })) +} diff --git a/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/js/jazzy.search.js b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/js/jazzy.search.js new file mode 100644 index 00000000..359cdbb8 --- /dev/null +++ b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/js/jazzy.search.js @@ -0,0 +1,74 @@ +// Jazzy - https://github.com/realm/jazzy +// Copyright Realm Inc. +// SPDX-License-Identifier: MIT + +$(function(){ + var $typeahead = $('[data-typeahead]'); + var $form = $typeahead.parents('form'); + var searchURL = $form.attr('action'); + + function displayTemplate(result) { + return result.name; + } + + function suggestionTemplate(result) { + var t = '
'; + t += '' + result.name + ''; + if (result.parent_name) { + t += '' + result.parent_name + ''; + } + t += '
'; + return t; + } + + $typeahead.one('focus', function() { + $form.addClass('loading'); + + $.getJSON(searchURL).then(function(searchData) { + const searchIndex = lunr(function() { + this.ref('url'); + this.field('name'); + this.field('abstract'); + for (const [url, doc] of Object.entries(searchData)) { + this.add({url: url, name: doc.name, abstract: doc.abstract}); + } + }); + + $typeahead.typeahead( + { + highlight: true, + minLength: 3, + autoselect: true + }, + { + limit: 10, + display: displayTemplate, + templates: { suggestion: suggestionTemplate }, + source: function(query, sync) { + const lcSearch = query.toLowerCase(); + const results = searchIndex.query(function(q) { + q.term(lcSearch, { boost: 100 }); + q.term(lcSearch, { + boost: 10, + wildcard: lunr.Query.wildcard.TRAILING + }); + }).map(function(result) { + var doc = searchData[result.ref]; + doc.url = result.ref; + return doc; + }); + sync(results); + } + } + ); + $form.removeClass('loading'); + $typeahead.trigger('focus'); + }); + }); + + var baseURL = searchURL.slice(0, -"search.json".length); + + $typeahead.on('typeahead:select', function(e, result) { + window.location = baseURL + result.url; + }); +}); diff --git a/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/js/jquery.min.js b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/js/jquery.min.js new file mode 100644 index 00000000..7f37b5d9 --- /dev/null +++ b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/js/jquery.min.js @@ -0,0 +1,2 @@ +/*! jQuery v3.7.1 | (c) OpenJS Foundation and other contributors | jquery.org/license */ +!function(e,t){"use strict";"object"==typeof module&&"object"==typeof module.exports?module.exports=e.document?t(e,!0):function(e){if(!e.document)throw new Error("jQuery requires a window with a document");return t(e)}:t(e)}("undefined"!=typeof window?window:this,function(ie,e){"use strict";var oe=[],r=Object.getPrototypeOf,ae=oe.slice,g=oe.flat?function(e){return oe.flat.call(e)}:function(e){return oe.concat.apply([],e)},s=oe.push,se=oe.indexOf,n={},i=n.toString,ue=n.hasOwnProperty,o=ue.toString,a=o.call(Object),le={},v=function(e){return"function"==typeof e&&"number"!=typeof e.nodeType&&"function"!=typeof e.item},y=function(e){return null!=e&&e===e.window},C=ie.document,u={type:!0,src:!0,nonce:!0,noModule:!0};function m(e,t,n){var r,i,o=(n=n||C).createElement("script");if(o.text=e,t)for(r in u)(i=t[r]||t.getAttribute&&t.getAttribute(r))&&o.setAttribute(r,i);n.head.appendChild(o).parentNode.removeChild(o)}function x(e){return null==e?e+"":"object"==typeof e||"function"==typeof e?n[i.call(e)]||"object":typeof e}var t="3.7.1",l=/HTML$/i,ce=function(e,t){return new ce.fn.init(e,t)};function c(e){var t=!!e&&"length"in e&&e.length,n=x(e);return!v(e)&&!y(e)&&("array"===n||0===t||"number"==typeof t&&0+~]|"+ge+")"+ge+"*"),x=new RegExp(ge+"|>"),j=new RegExp(g),A=new RegExp("^"+t+"$"),D={ID:new RegExp("^#("+t+")"),CLASS:new RegExp("^\\.("+t+")"),TAG:new RegExp("^("+t+"|[*])"),ATTR:new RegExp("^"+p),PSEUDO:new RegExp("^"+g),CHILD:new RegExp("^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\("+ge+"*(even|odd|(([+-]|)(\\d*)n|)"+ge+"*(?:([+-]|)"+ge+"*(\\d+)|))"+ge+"*\\)|)","i"),bool:new RegExp("^(?:"+f+")$","i"),needsContext:new RegExp("^"+ge+"*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\("+ge+"*((?:-\\d)?\\d*)"+ge+"*\\)|)(?=[^-]|$)","i")},N=/^(?:input|select|textarea|button)$/i,q=/^h\d$/i,L=/^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/,H=/[+~]/,O=new RegExp("\\\\[\\da-fA-F]{1,6}"+ge+"?|\\\\([^\\r\\n\\f])","g"),P=function(e,t){var n="0x"+e.slice(1)-65536;return t||(n<0?String.fromCharCode(n+65536):String.fromCharCode(n>>10|55296,1023&n|56320))},M=function(){V()},R=J(function(e){return!0===e.disabled&&fe(e,"fieldset")},{dir:"parentNode",next:"legend"});try{k.apply(oe=ae.call(ye.childNodes),ye.childNodes),oe[ye.childNodes.length].nodeType}catch(e){k={apply:function(e,t){me.apply(e,ae.call(t))},call:function(e){me.apply(e,ae.call(arguments,1))}}}function I(t,e,n,r){var i,o,a,s,u,l,c,f=e&&e.ownerDocument,p=e?e.nodeType:9;if(n=n||[],"string"!=typeof t||!t||1!==p&&9!==p&&11!==p)return n;if(!r&&(V(e),e=e||T,C)){if(11!==p&&(u=L.exec(t)))if(i=u[1]){if(9===p){if(!(a=e.getElementById(i)))return n;if(a.id===i)return k.call(n,a),n}else if(f&&(a=f.getElementById(i))&&I.contains(e,a)&&a.id===i)return k.call(n,a),n}else{if(u[2])return k.apply(n,e.getElementsByTagName(t)),n;if((i=u[3])&&e.getElementsByClassName)return k.apply(n,e.getElementsByClassName(i)),n}if(!(h[t+" "]||d&&d.test(t))){if(c=t,f=e,1===p&&(x.test(t)||m.test(t))){(f=H.test(t)&&U(e.parentNode)||e)==e&&le.scope||((s=e.getAttribute("id"))?s=ce.escapeSelector(s):e.setAttribute("id",s=S)),o=(l=Y(t)).length;while(o--)l[o]=(s?"#"+s:":scope")+" "+Q(l[o]);c=l.join(",")}try{return k.apply(n,f.querySelectorAll(c)),n}catch(e){h(t,!0)}finally{s===S&&e.removeAttribute("id")}}}return re(t.replace(ve,"$1"),e,n,r)}function W(){var r=[];return function e(t,n){return r.push(t+" ")>b.cacheLength&&delete e[r.shift()],e[t+" "]=n}}function F(e){return e[S]=!0,e}function $(e){var t=T.createElement("fieldset");try{return!!e(t)}catch(e){return!1}finally{t.parentNode&&t.parentNode.removeChild(t),t=null}}function B(t){return function(e){return fe(e,"input")&&e.type===t}}function _(t){return function(e){return(fe(e,"input")||fe(e,"button"))&&e.type===t}}function z(t){return function(e){return"form"in e?e.parentNode&&!1===e.disabled?"label"in e?"label"in e.parentNode?e.parentNode.disabled===t:e.disabled===t:e.isDisabled===t||e.isDisabled!==!t&&R(e)===t:e.disabled===t:"label"in e&&e.disabled===t}}function X(a){return F(function(o){return o=+o,F(function(e,t){var n,r=a([],e.length,o),i=r.length;while(i--)e[n=r[i]]&&(e[n]=!(t[n]=e[n]))})})}function U(e){return e&&"undefined"!=typeof e.getElementsByTagName&&e}function V(e){var t,n=e?e.ownerDocument||e:ye;return n!=T&&9===n.nodeType&&n.documentElement&&(r=(T=n).documentElement,C=!ce.isXMLDoc(T),i=r.matches||r.webkitMatchesSelector||r.msMatchesSelector,r.msMatchesSelector&&ye!=T&&(t=T.defaultView)&&t.top!==t&&t.addEventListener("unload",M),le.getById=$(function(e){return r.appendChild(e).id=ce.expando,!T.getElementsByName||!T.getElementsByName(ce.expando).length}),le.disconnectedMatch=$(function(e){return i.call(e,"*")}),le.scope=$(function(){return T.querySelectorAll(":scope")}),le.cssHas=$(function(){try{return T.querySelector(":has(*,:jqfake)"),!1}catch(e){return!0}}),le.getById?(b.filter.ID=function(e){var t=e.replace(O,P);return function(e){return e.getAttribute("id")===t}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&C){var n=t.getElementById(e);return n?[n]:[]}}):(b.filter.ID=function(e){var n=e.replace(O,P);return function(e){var t="undefined"!=typeof e.getAttributeNode&&e.getAttributeNode("id");return t&&t.value===n}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&C){var n,r,i,o=t.getElementById(e);if(o){if((n=o.getAttributeNode("id"))&&n.value===e)return[o];i=t.getElementsByName(e),r=0;while(o=i[r++])if((n=o.getAttributeNode("id"))&&n.value===e)return[o]}return[]}}),b.find.TAG=function(e,t){return"undefined"!=typeof t.getElementsByTagName?t.getElementsByTagName(e):t.querySelectorAll(e)},b.find.CLASS=function(e,t){if("undefined"!=typeof t.getElementsByClassName&&C)return t.getElementsByClassName(e)},d=[],$(function(e){var t;r.appendChild(e).innerHTML="",e.querySelectorAll("[selected]").length||d.push("\\["+ge+"*(?:value|"+f+")"),e.querySelectorAll("[id~="+S+"-]").length||d.push("~="),e.querySelectorAll("a#"+S+"+*").length||d.push(".#.+[+~]"),e.querySelectorAll(":checked").length||d.push(":checked"),(t=T.createElement("input")).setAttribute("type","hidden"),e.appendChild(t).setAttribute("name","D"),r.appendChild(e).disabled=!0,2!==e.querySelectorAll(":disabled").length&&d.push(":enabled",":disabled"),(t=T.createElement("input")).setAttribute("name",""),e.appendChild(t),e.querySelectorAll("[name='']").length||d.push("\\["+ge+"*name"+ge+"*="+ge+"*(?:''|\"\")")}),le.cssHas||d.push(":has"),d=d.length&&new RegExp(d.join("|")),l=function(e,t){if(e===t)return a=!0,0;var n=!e.compareDocumentPosition-!t.compareDocumentPosition;return n||(1&(n=(e.ownerDocument||e)==(t.ownerDocument||t)?e.compareDocumentPosition(t):1)||!le.sortDetached&&t.compareDocumentPosition(e)===n?e===T||e.ownerDocument==ye&&I.contains(ye,e)?-1:t===T||t.ownerDocument==ye&&I.contains(ye,t)?1:o?se.call(o,e)-se.call(o,t):0:4&n?-1:1)}),T}for(e in I.matches=function(e,t){return I(e,null,null,t)},I.matchesSelector=function(e,t){if(V(e),C&&!h[t+" "]&&(!d||!d.test(t)))try{var n=i.call(e,t);if(n||le.disconnectedMatch||e.document&&11!==e.document.nodeType)return n}catch(e){h(t,!0)}return 0":{dir:"parentNode",first:!0}," ":{dir:"parentNode"},"+":{dir:"previousSibling",first:!0},"~":{dir:"previousSibling"}},preFilter:{ATTR:function(e){return e[1]=e[1].replace(O,P),e[3]=(e[3]||e[4]||e[5]||"").replace(O,P),"~="===e[2]&&(e[3]=" "+e[3]+" "),e.slice(0,4)},CHILD:function(e){return e[1]=e[1].toLowerCase(),"nth"===e[1].slice(0,3)?(e[3]||I.error(e[0]),e[4]=+(e[4]?e[5]+(e[6]||1):2*("even"===e[3]||"odd"===e[3])),e[5]=+(e[7]+e[8]||"odd"===e[3])):e[3]&&I.error(e[0]),e},PSEUDO:function(e){var t,n=!e[6]&&e[2];return D.CHILD.test(e[0])?null:(e[3]?e[2]=e[4]||e[5]||"":n&&j.test(n)&&(t=Y(n,!0))&&(t=n.indexOf(")",n.length-t)-n.length)&&(e[0]=e[0].slice(0,t),e[2]=n.slice(0,t)),e.slice(0,3))}},filter:{TAG:function(e){var t=e.replace(O,P).toLowerCase();return"*"===e?function(){return!0}:function(e){return fe(e,t)}},CLASS:function(e){var t=s[e+" "];return t||(t=new RegExp("(^|"+ge+")"+e+"("+ge+"|$)"))&&s(e,function(e){return t.test("string"==typeof e.className&&e.className||"undefined"!=typeof e.getAttribute&&e.getAttribute("class")||"")})},ATTR:function(n,r,i){return function(e){var t=I.attr(e,n);return null==t?"!="===r:!r||(t+="","="===r?t===i:"!="===r?t!==i:"^="===r?i&&0===t.indexOf(i):"*="===r?i&&-1:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i;function T(e,n,r){return v(n)?ce.grep(e,function(e,t){return!!n.call(e,t,e)!==r}):n.nodeType?ce.grep(e,function(e){return e===n!==r}):"string"!=typeof n?ce.grep(e,function(e){return-1)[^>]*|#([\w-]+))$/;(ce.fn.init=function(e,t,n){var r,i;if(!e)return this;if(n=n||k,"string"==typeof e){if(!(r="<"===e[0]&&">"===e[e.length-1]&&3<=e.length?[null,e,null]:S.exec(e))||!r[1]&&t)return!t||t.jquery?(t||n).find(e):this.constructor(t).find(e);if(r[1]){if(t=t instanceof ce?t[0]:t,ce.merge(this,ce.parseHTML(r[1],t&&t.nodeType?t.ownerDocument||t:C,!0)),w.test(r[1])&&ce.isPlainObject(t))for(r in t)v(this[r])?this[r](t[r]):this.attr(r,t[r]);return this}return(i=C.getElementById(r[2]))&&(this[0]=i,this.length=1),this}return e.nodeType?(this[0]=e,this.length=1,this):v(e)?void 0!==n.ready?n.ready(e):e(ce):ce.makeArray(e,this)}).prototype=ce.fn,k=ce(C);var E=/^(?:parents|prev(?:Until|All))/,j={children:!0,contents:!0,next:!0,prev:!0};function A(e,t){while((e=e[t])&&1!==e.nodeType);return e}ce.fn.extend({has:function(e){var t=ce(e,this),n=t.length;return this.filter(function(){for(var e=0;e\x20\t\r\n\f]*)/i,Ce=/^$|^module$|\/(?:java|ecma)script/i;xe=C.createDocumentFragment().appendChild(C.createElement("div")),(be=C.createElement("input")).setAttribute("type","radio"),be.setAttribute("checked","checked"),be.setAttribute("name","t"),xe.appendChild(be),le.checkClone=xe.cloneNode(!0).cloneNode(!0).lastChild.checked,xe.innerHTML="",le.noCloneChecked=!!xe.cloneNode(!0).lastChild.defaultValue,xe.innerHTML="",le.option=!!xe.lastChild;var ke={thead:[1,"","
"],col:[2,"","
"],tr:[2,"","
"],td:[3,"","
"],_default:[0,"",""]};function Se(e,t){var n;return n="undefined"!=typeof e.getElementsByTagName?e.getElementsByTagName(t||"*"):"undefined"!=typeof e.querySelectorAll?e.querySelectorAll(t||"*"):[],void 0===t||t&&fe(e,t)?ce.merge([e],n):n}function Ee(e,t){for(var n=0,r=e.length;n",""]);var je=/<|&#?\w+;/;function Ae(e,t,n,r,i){for(var o,a,s,u,l,c,f=t.createDocumentFragment(),p=[],d=0,h=e.length;d\s*$/g;function Re(e,t){return fe(e,"table")&&fe(11!==t.nodeType?t:t.firstChild,"tr")&&ce(e).children("tbody")[0]||e}function Ie(e){return e.type=(null!==e.getAttribute("type"))+"/"+e.type,e}function We(e){return"true/"===(e.type||"").slice(0,5)?e.type=e.type.slice(5):e.removeAttribute("type"),e}function Fe(e,t){var n,r,i,o,a,s;if(1===t.nodeType){if(_.hasData(e)&&(s=_.get(e).events))for(i in _.remove(t,"handle events"),s)for(n=0,r=s[i].length;n").attr(n.scriptAttrs||{}).prop({charset:n.scriptCharset,src:n.url}).on("load error",i=function(e){r.remove(),i=null,e&&t("error"===e.type?404:200,e.type)}),C.head.appendChild(r[0])},abort:function(){i&&i()}}});var Jt,Kt=[],Zt=/(=)\?(?=&|$)|\?\?/;ce.ajaxSetup({jsonp:"callback",jsonpCallback:function(){var e=Kt.pop()||ce.expando+"_"+jt.guid++;return this[e]=!0,e}}),ce.ajaxPrefilter("json jsonp",function(e,t,n){var r,i,o,a=!1!==e.jsonp&&(Zt.test(e.url)?"url":"string"==typeof e.data&&0===(e.contentType||"").indexOf("application/x-www-form-urlencoded")&&Zt.test(e.data)&&"data");if(a||"jsonp"===e.dataTypes[0])return r=e.jsonpCallback=v(e.jsonpCallback)?e.jsonpCallback():e.jsonpCallback,a?e[a]=e[a].replace(Zt,"$1"+r):!1!==e.jsonp&&(e.url+=(At.test(e.url)?"&":"?")+e.jsonp+"="+r),e.converters["script json"]=function(){return o||ce.error(r+" was not called"),o[0]},e.dataTypes[0]="json",i=ie[r],ie[r]=function(){o=arguments},n.always(function(){void 0===i?ce(ie).removeProp(r):ie[r]=i,e[r]&&(e.jsonpCallback=t.jsonpCallback,Kt.push(r)),o&&v(i)&&i(o[0]),o=i=void 0}),"script"}),le.createHTMLDocument=((Jt=C.implementation.createHTMLDocument("").body).innerHTML="
",2===Jt.childNodes.length),ce.parseHTML=function(e,t,n){return"string"!=typeof e?[]:("boolean"==typeof t&&(n=t,t=!1),t||(le.createHTMLDocument?((r=(t=C.implementation.createHTMLDocument("")).createElement("base")).href=C.location.href,t.head.appendChild(r)):t=C),o=!n&&[],(i=w.exec(e))?[t.createElement(i[1])]:(i=Ae([e],t,o),o&&o.length&&ce(o).remove(),ce.merge([],i.childNodes)));var r,i,o},ce.fn.load=function(e,t,n){var r,i,o,a=this,s=e.indexOf(" ");return-1").append(ce.parseHTML(e)).find(r):e)}).always(n&&function(e,t){a.each(function(){n.apply(this,o||[e.responseText,t,e])})}),this},ce.expr.pseudos.animated=function(t){return ce.grep(ce.timers,function(e){return t===e.elem}).length},ce.offset={setOffset:function(e,t,n){var r,i,o,a,s,u,l=ce.css(e,"position"),c=ce(e),f={};"static"===l&&(e.style.position="relative"),s=c.offset(),o=ce.css(e,"top"),u=ce.css(e,"left"),("absolute"===l||"fixed"===l)&&-1<(o+u).indexOf("auto")?(a=(r=c.position()).top,i=r.left):(a=parseFloat(o)||0,i=parseFloat(u)||0),v(t)&&(t=t.call(e,n,ce.extend({},s))),null!=t.top&&(f.top=t.top-s.top+a),null!=t.left&&(f.left=t.left-s.left+i),"using"in t?t.using.call(e,f):c.css(f)}},ce.fn.extend({offset:function(t){if(arguments.length)return void 0===t?this:this.each(function(e){ce.offset.setOffset(this,t,e)});var e,n,r=this[0];return r?r.getClientRects().length?(e=r.getBoundingClientRect(),n=r.ownerDocument.defaultView,{top:e.top+n.pageYOffset,left:e.left+n.pageXOffset}):{top:0,left:0}:void 0},position:function(){if(this[0]){var e,t,n,r=this[0],i={top:0,left:0};if("fixed"===ce.css(r,"position"))t=r.getBoundingClientRect();else{t=this.offset(),n=r.ownerDocument,e=r.offsetParent||n.documentElement;while(e&&(e===n.body||e===n.documentElement)&&"static"===ce.css(e,"position"))e=e.parentNode;e&&e!==r&&1===e.nodeType&&((i=ce(e).offset()).top+=ce.css(e,"borderTopWidth",!0),i.left+=ce.css(e,"borderLeftWidth",!0))}return{top:t.top-i.top-ce.css(r,"marginTop",!0),left:t.left-i.left-ce.css(r,"marginLeft",!0)}}},offsetParent:function(){return this.map(function(){var e=this.offsetParent;while(e&&"static"===ce.css(e,"position"))e=e.offsetParent;return e||J})}}),ce.each({scrollLeft:"pageXOffset",scrollTop:"pageYOffset"},function(t,i){var o="pageYOffset"===i;ce.fn[t]=function(e){return M(this,function(e,t,n){var r;if(y(e)?r=e:9===e.nodeType&&(r=e.defaultView),void 0===n)return r?r[i]:e[t];r?r.scrollTo(o?r.pageXOffset:n,o?n:r.pageYOffset):e[t]=n},t,e,arguments.length)}}),ce.each(["top","left"],function(e,n){ce.cssHooks[n]=Ye(le.pixelPosition,function(e,t){if(t)return t=Ge(e,n),_e.test(t)?ce(e).position()[n]+"px":t})}),ce.each({Height:"height",Width:"width"},function(a,s){ce.each({padding:"inner"+a,content:s,"":"outer"+a},function(r,o){ce.fn[o]=function(e,t){var n=arguments.length&&(r||"boolean"!=typeof e),i=r||(!0===e||!0===t?"margin":"border");return M(this,function(e,t,n){var r;return y(e)?0===o.indexOf("outer")?e["inner"+a]:e.document.documentElement["client"+a]:9===e.nodeType?(r=e.documentElement,Math.max(e.body["scroll"+a],r["scroll"+a],e.body["offset"+a],r["offset"+a],r["client"+a])):void 0===n?ce.css(e,t,i):ce.style(e,t,n,i)},s,n?e:void 0,n)}})}),ce.each(["ajaxStart","ajaxStop","ajaxComplete","ajaxError","ajaxSuccess","ajaxSend"],function(e,t){ce.fn[t]=function(e){return this.on(t,e)}}),ce.fn.extend({bind:function(e,t,n){return this.on(e,null,t,n)},unbind:function(e,t){return this.off(e,null,t)},delegate:function(e,t,n,r){return this.on(t,e,n,r)},undelegate:function(e,t,n){return 1===arguments.length?this.off(e,"**"):this.off(t,e||"**",n)},hover:function(e,t){return this.on("mouseenter",e).on("mouseleave",t||e)}}),ce.each("blur focus focusin focusout resize scroll click dblclick mousedown mouseup mousemove mouseover mouseout mouseenter mouseleave change select submit keydown keypress keyup contextmenu".split(" "),function(e,n){ce.fn[n]=function(e,t){return 00){var c=e.utils.clone(r)||{};c.position=[a,l],c.index=s.length,s.push(new e.Token(i.slice(a,o),c))}a=o+1}}return s},e.tokenizer.separator=/[\s\-]+/,e.Pipeline=function(){this._stack=[]},e.Pipeline.registeredFunctions=Object.create(null),e.Pipeline.registerFunction=function(t,r){r in this.registeredFunctions&&e.utils.warn("Overwriting existing registered function: "+r),t.label=r,e.Pipeline.registeredFunctions[t.label]=t},e.Pipeline.warnIfFunctionNotRegistered=function(t){var r=t.label&&t.label in this.registeredFunctions;r||e.utils.warn("Function is not registered with pipeline. This may cause problems when serialising the index.\n",t)},e.Pipeline.load=function(t){var r=new e.Pipeline;return t.forEach(function(t){var i=e.Pipeline.registeredFunctions[t];if(!i)throw new Error("Cannot load unregistered function: "+t);r.add(i)}),r},e.Pipeline.prototype.add=function(){var t=Array.prototype.slice.call(arguments);t.forEach(function(t){e.Pipeline.warnIfFunctionNotRegistered(t),this._stack.push(t)},this)},e.Pipeline.prototype.after=function(t,r){e.Pipeline.warnIfFunctionNotRegistered(r);var i=this._stack.indexOf(t);if(i==-1)throw new Error("Cannot find existingFn");i+=1,this._stack.splice(i,0,r)},e.Pipeline.prototype.before=function(t,r){e.Pipeline.warnIfFunctionNotRegistered(r);var i=this._stack.indexOf(t);if(i==-1)throw new Error("Cannot find existingFn");this._stack.splice(i,0,r)},e.Pipeline.prototype.remove=function(e){var t=this._stack.indexOf(e);t!=-1&&this._stack.splice(t,1)},e.Pipeline.prototype.run=function(e){for(var t=this._stack.length,r=0;r1&&(se&&(r=n),s!=e);)i=r-t,n=t+Math.floor(i/2),s=this.elements[2*n];return s==e?2*n:s>e?2*n:sa?l+=2:o==a&&(t+=r[u+1]*i[l+1],u+=2,l+=2);return t},e.Vector.prototype.similarity=function(e){return this.dot(e)/this.magnitude()||0},e.Vector.prototype.toArray=function(){for(var e=new Array(this.elements.length/2),t=1,r=0;t0){var o,a=s.str.charAt(0);a in s.node.edges?o=s.node.edges[a]:(o=new e.TokenSet,s.node.edges[a]=o),1==s.str.length&&(o["final"]=!0),n.push({node:o,editsRemaining:s.editsRemaining,str:s.str.slice(1)})}if(0!=s.editsRemaining){if("*"in s.node.edges)var u=s.node.edges["*"];else{var u=new e.TokenSet;s.node.edges["*"]=u}if(0==s.str.length&&(u["final"]=!0),n.push({node:u,editsRemaining:s.editsRemaining-1,str:s.str}),s.str.length>1&&n.push({node:s.node,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)}),1==s.str.length&&(s.node["final"]=!0),s.str.length>=1){if("*"in s.node.edges)var l=s.node.edges["*"];else{var l=new e.TokenSet;s.node.edges["*"]=l}1==s.str.length&&(l["final"]=!0),n.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var c,h=s.str.charAt(0),d=s.str.charAt(1);d in s.node.edges?c=s.node.edges[d]:(c=new e.TokenSet,s.node.edges[d]=c),1==s.str.length&&(c["final"]=!0),n.push({node:c,editsRemaining:s.editsRemaining-1,str:h+s.str.slice(2)})}}}return i},e.TokenSet.fromString=function(t){for(var r=new e.TokenSet,i=r,n=0,s=t.length;n=e;t--){var r=this.uncheckedNodes[t],i=r.child.toString();i in this.minimizedNodes?r.parent.edges[r["char"]]=this.minimizedNodes[i]:(r.child._str=i,this.minimizedNodes[i]=r.child),this.uncheckedNodes.pop()}},e.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},e.Index.prototype.search=function(t){return this.query(function(r){var i=new e.QueryParser(t,r);i.parse()})},e.Index.prototype.query=function(t){for(var r=new e.Query(this.fields),i=Object.create(null),n=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),u=0;u1?this._b=1:this._b=e},e.Builder.prototype.k1=function(e){this._k1=e},e.Builder.prototype.add=function(t,r){var i=t[this._ref],n=Object.keys(this._fields);this._documents[i]=r||{},this.documentCount+=1;for(var s=0;s=this.length)return e.QueryLexer.EOS;var t=this.str.charAt(this.pos);return this.pos+=1,t},e.QueryLexer.prototype.width=function(){return this.pos-this.start},e.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},e.QueryLexer.prototype.backup=function(){this.pos-=1},e.QueryLexer.prototype.acceptDigitRun=function(){var t,r;do t=this.next(),r=t.charCodeAt(0);while(r>47&&r<58);t!=e.QueryLexer.EOS&&this.backup()},e.QueryLexer.prototype.more=function(){return this.pos1&&(t.backup(),t.emit(e.QueryLexer.TERM)),t.ignore(),t.more())return e.QueryLexer.lexText},e.QueryLexer.lexEditDistance=function(t){return t.ignore(),t.acceptDigitRun(),t.emit(e.QueryLexer.EDIT_DISTANCE),e.QueryLexer.lexText},e.QueryLexer.lexBoost=function(t){return t.ignore(),t.acceptDigitRun(),t.emit(e.QueryLexer.BOOST),e.QueryLexer.lexText},e.QueryLexer.lexEOS=function(t){t.width()>0&&t.emit(e.QueryLexer.TERM)},e.QueryLexer.termSeparator=e.tokenizer.separator,e.QueryLexer.lexText=function(t){for(;;){var r=t.next();if(r==e.QueryLexer.EOS)return e.QueryLexer.lexEOS;if(92!=r.charCodeAt(0)){if(":"==r)return e.QueryLexer.lexField;if("~"==r)return t.backup(),t.width()>0&&t.emit(e.QueryLexer.TERM),e.QueryLexer.lexEditDistance;if("^"==r)return t.backup(),t.width()>0&&t.emit(e.QueryLexer.TERM),e.QueryLexer.lexBoost;if("+"==r&&1===t.width())return t.emit(e.QueryLexer.PRESENCE),e.QueryLexer.lexText;if("-"==r&&1===t.width())return t.emit(e.QueryLexer.PRESENCE),e.QueryLexer.lexText;if(r.match(e.QueryLexer.termSeparator))return e.QueryLexer.lexTerm}else t.escapeCharacter()}},e.QueryParser=function(t,r){this.lexer=new e.QueryLexer(t),this.query=r,this.currentClause={},this.lexemeIdx=0},e.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var t=e.QueryParser.parseClause;t;)t=t(this);return this.query},e.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},e.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},e.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},e.QueryParser.parseClause=function(t){var r=t.peekLexeme();if(void 0!=r)switch(r.type){case e.QueryLexer.PRESENCE:return e.QueryParser.parsePresence;case e.QueryLexer.FIELD:return e.QueryParser.parseField;case e.QueryLexer.TERM:return e.QueryParser.parseTerm;default:var i="expected either a field or a term, found "+r.type;throw r.str.length>=1&&(i+=" with value '"+r.str+"'"),new e.QueryParseError(i,r.start,r.end)}},e.QueryParser.parsePresence=function(t){var r=t.consumeLexeme();if(void 0!=r){switch(r.str){case"-":t.currentClause.presence=e.Query.presence.PROHIBITED;break;case"+":t.currentClause.presence=e.Query.presence.REQUIRED;break;default:var i="unrecognised presence operator'"+r.str+"'";throw new e.QueryParseError(i,r.start,r.end)}var n=t.peekLexeme();if(void 0==n){var i="expecting term or field, found nothing";throw new e.QueryParseError(i,r.start,r.end)}switch(n.type){case e.QueryLexer.FIELD:return e.QueryParser.parseField;case e.QueryLexer.TERM:return e.QueryParser.parseTerm;default:var i="expecting term or field, found '"+n.type+"'";throw new e.QueryParseError(i,n.start,n.end)}}},e.QueryParser.parseField=function(t){var r=t.consumeLexeme();if(void 0!=r){if(t.query.allFields.indexOf(r.str)==-1){var i=t.query.allFields.map(function(e){return"'"+e+"'"}).join(", "),n="unrecognised field '"+r.str+"', possible fields: "+i;throw new e.QueryParseError(n,r.start,r.end)}t.currentClause.fields=[r.str];var s=t.peekLexeme();if(void 0==s){var n="expecting term, found nothing";throw new e.QueryParseError(n,r.start,r.end)}switch(s.type){case e.QueryLexer.TERM:return e.QueryParser.parseTerm;default:var n="expecting term, found '"+s.type+"'";throw new e.QueryParseError(n,s.start,s.end)}}},e.QueryParser.parseTerm=function(t){var r=t.consumeLexeme();if(void 0!=r){t.currentClause.term=r.str.toLowerCase(),r.str.indexOf("*")!=-1&&(t.currentClause.usePipeline=!1);var i=t.peekLexeme();if(void 0==i)return void t.nextClause();switch(i.type){case e.QueryLexer.TERM:return t.nextClause(),e.QueryParser.parseTerm;case e.QueryLexer.FIELD:return t.nextClause(),e.QueryParser.parseField;case e.QueryLexer.EDIT_DISTANCE:return e.QueryParser.parseEditDistance;case e.QueryLexer.BOOST:return e.QueryParser.parseBoost;case e.QueryLexer.PRESENCE:return t.nextClause(),e.QueryParser.parsePresence;default:var n="Unexpected lexeme type '"+i.type+"'";throw new e.QueryParseError(n,i.start,i.end)}}},e.QueryParser.parseEditDistance=function(t){var r=t.consumeLexeme();if(void 0!=r){var i=parseInt(r.str,10);if(isNaN(i)){var n="edit distance must be numeric";throw new e.QueryParseError(n,r.start,r.end)}t.currentClause.editDistance=i;var s=t.peekLexeme();if(void 0==s)return void t.nextClause();switch(s.type){case e.QueryLexer.TERM:return t.nextClause(),e.QueryParser.parseTerm;case e.QueryLexer.FIELD:return t.nextClause(),e.QueryParser.parseField;case e.QueryLexer.EDIT_DISTANCE:return e.QueryParser.parseEditDistance;case e.QueryLexer.BOOST:return e.QueryParser.parseBoost;case e.QueryLexer.PRESENCE:return t.nextClause(),e.QueryParser.parsePresence;default:var n="Unexpected lexeme type '"+s.type+"'";throw new e.QueryParseError(n,s.start,s.end)}}},e.QueryParser.parseBoost=function(t){var r=t.consumeLexeme();if(void 0!=r){var i=parseInt(r.str,10);if(isNaN(i)){var n="boost must be numeric";throw new e.QueryParseError(n,r.start,r.end)}t.currentClause.boost=i;var s=t.peekLexeme();if(void 0==s)return void t.nextClause();switch(s.type){case e.QueryLexer.TERM:return t.nextClause(),e.QueryParser.parseTerm;case e.QueryLexer.FIELD:return t.nextClause(),e.QueryParser.parseField;case e.QueryLexer.EDIT_DISTANCE:return e.QueryParser.parseEditDistance;case e.QueryLexer.BOOST:return e.QueryParser.parseBoost;case e.QueryLexer.PRESENCE:return t.nextClause(),e.QueryParser.parsePresence;default:var n="Unexpected lexeme type '"+s.type+"'";throw new e.QueryParseError(n,s.start,s.end)}}},function(e,t){"function"==typeof define&&define.amd?define(t):"object"==typeof exports?module.exports=t():e.lunr=t()}(this,function(){return e})}(); diff --git a/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/js/typeahead.jquery.js b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/js/typeahead.jquery.js new file mode 100644 index 00000000..3a2d2ab0 --- /dev/null +++ b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/js/typeahead.jquery.js @@ -0,0 +1,1694 @@ +/*! + * typeahead.js 1.3.1 + * https://github.com/corejavascript/typeahead.js + * Copyright 2013-2020 Twitter, Inc. and other contributors; Licensed MIT + */ + + +(function(root, factory) { + if (typeof define === "function" && define.amd) { + define([ "jquery" ], function(a0) { + return factory(a0); + }); + } else if (typeof module === "object" && module.exports) { + module.exports = factory(require("jquery")); + } else { + factory(root["jQuery"]); + } +})(this, function($) { + var _ = function() { + "use strict"; + return { + isMsie: function() { + return /(msie|trident)/i.test(navigator.userAgent) ? navigator.userAgent.match(/(msie |rv:)(\d+(.\d+)?)/i)[2] : false; + }, + isBlankString: function(str) { + return !str || /^\s*$/.test(str); + }, + escapeRegExChars: function(str) { + return str.replace(/[\-\[\]\/\{\}\(\)\*\+\?\.\\\^\$\|]/g, "\\$&"); + }, + isString: function(obj) { + return typeof obj === "string"; + }, + isNumber: function(obj) { + return typeof obj === "number"; + }, + isArray: $.isArray, + isFunction: $.isFunction, + isObject: $.isPlainObject, + isUndefined: function(obj) { + return typeof obj === "undefined"; + }, + isElement: function(obj) { + return !!(obj && obj.nodeType === 1); + }, + isJQuery: function(obj) { + return obj instanceof $; + }, + toStr: function toStr(s) { + return _.isUndefined(s) || s === null ? "" : s + ""; + }, + bind: $.proxy, + each: function(collection, cb) { + $.each(collection, reverseArgs); + function reverseArgs(index, value) { + return cb(value, index); + } + }, + map: $.map, + filter: $.grep, + every: function(obj, test) { + var result = true; + if (!obj) { + return result; + } + $.each(obj, function(key, val) { + if (!(result = test.call(null, val, key, obj))) { + return false; + } + }); + return !!result; + }, + some: function(obj, test) { + var result = false; + if (!obj) { + return result; + } + $.each(obj, function(key, val) { + if (result = test.call(null, val, key, obj)) { + return false; + } + }); + return !!result; + }, + mixin: $.extend, + identity: function(x) { + return x; + }, + clone: function(obj) { + return $.extend(true, {}, obj); + }, + getIdGenerator: function() { + var counter = 0; + return function() { + return counter++; + }; + }, + templatify: function templatify(obj) { + return $.isFunction(obj) ? obj : template; + function template() { + return String(obj); + } + }, + defer: function(fn) { + setTimeout(fn, 0); + }, + debounce: function(func, wait, immediate) { + var timeout, result; + return function() { + var context = this, args = arguments, later, callNow; + later = function() { + timeout = null; + if (!immediate) { + result = func.apply(context, args); + } + }; + callNow = immediate && !timeout; + clearTimeout(timeout); + timeout = setTimeout(later, wait); + if (callNow) { + result = func.apply(context, args); + } + return result; + }; + }, + throttle: function(func, wait) { + var context, args, timeout, result, previous, later; + previous = 0; + later = function() { + previous = new Date(); + timeout = null; + result = func.apply(context, args); + }; + return function() { + var now = new Date(), remaining = wait - (now - previous); + context = this; + args = arguments; + if (remaining <= 0) { + clearTimeout(timeout); + timeout = null; + previous = now; + result = func.apply(context, args); + } else if (!timeout) { + timeout = setTimeout(later, remaining); + } + return result; + }; + }, + stringify: function(val) { + return _.isString(val) ? val : JSON.stringify(val); + }, + guid: function() { + function _p8(s) { + var p = (Math.random().toString(16) + "000000000").substr(2, 8); + return s ? "-" + p.substr(0, 4) + "-" + p.substr(4, 4) : p; + } + return "tt-" + _p8() + _p8(true) + _p8(true) + _p8(); + }, + noop: function() {} + }; + }(); + var WWW = function() { + "use strict"; + var defaultClassNames = { + wrapper: "twitter-typeahead", + input: "tt-input", + hint: "tt-hint", + menu: "tt-menu", + dataset: "tt-dataset", + suggestion: "tt-suggestion", + selectable: "tt-selectable", + empty: "tt-empty", + open: "tt-open", + cursor: "tt-cursor", + highlight: "tt-highlight" + }; + return build; + function build(o) { + var www, classes; + classes = _.mixin({}, defaultClassNames, o); + www = { + css: buildCss(), + classes: classes, + html: buildHtml(classes), + selectors: buildSelectors(classes) + }; + return { + css: www.css, + html: www.html, + classes: www.classes, + selectors: www.selectors, + mixin: function(o) { + _.mixin(o, www); + } + }; + } + function buildHtml(c) { + return { + wrapper: '', + menu: '
' + }; + } + function buildSelectors(classes) { + var selectors = {}; + _.each(classes, function(v, k) { + selectors[k] = "." + v; + }); + return selectors; + } + function buildCss() { + var css = { + wrapper: { + position: "relative", + display: "inline-block" + }, + hint: { + position: "absolute", + top: "0", + left: "0", + borderColor: "transparent", + boxShadow: "none", + opacity: "1" + }, + input: { + position: "relative", + verticalAlign: "top", + backgroundColor: "transparent" + }, + inputWithNoHint: { + position: "relative", + verticalAlign: "top" + }, + menu: { + position: "absolute", + top: "100%", + left: "0", + zIndex: "100", + display: "none" + }, + ltr: { + left: "0", + right: "auto" + }, + rtl: { + left: "auto", + right: " 0" + } + }; + if (_.isMsie()) { + _.mixin(css.input, { + backgroundImage: "url(data:image/gif;base64,R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7)" + }); + } + return css; + } + }(); + var EventBus = function() { + "use strict"; + var namespace, deprecationMap; + namespace = "typeahead:"; + deprecationMap = { + render: "rendered", + cursorchange: "cursorchanged", + select: "selected", + autocomplete: "autocompleted" + }; + function EventBus(o) { + if (!o || !o.el) { + $.error("EventBus initialized without el"); + } + this.$el = $(o.el); + } + _.mixin(EventBus.prototype, { + _trigger: function(type, args) { + var $e = $.Event(namespace + type); + this.$el.trigger.call(this.$el, $e, args || []); + return $e; + }, + before: function(type) { + var args, $e; + args = [].slice.call(arguments, 1); + $e = this._trigger("before" + type, args); + return $e.isDefaultPrevented(); + }, + trigger: function(type) { + var deprecatedType; + this._trigger(type, [].slice.call(arguments, 1)); + if (deprecatedType = deprecationMap[type]) { + this._trigger(deprecatedType, [].slice.call(arguments, 1)); + } + } + }); + return EventBus; + }(); + var EventEmitter = function() { + "use strict"; + var splitter = /\s+/, nextTick = getNextTick(); + return { + onSync: onSync, + onAsync: onAsync, + off: off, + trigger: trigger + }; + function on(method, types, cb, context) { + var type; + if (!cb) { + return this; + } + types = types.split(splitter); + cb = context ? bindContext(cb, context) : cb; + this._callbacks = this._callbacks || {}; + while (type = types.shift()) { + this._callbacks[type] = this._callbacks[type] || { + sync: [], + async: [] + }; + this._callbacks[type][method].push(cb); + } + return this; + } + function onAsync(types, cb, context) { + return on.call(this, "async", types, cb, context); + } + function onSync(types, cb, context) { + return on.call(this, "sync", types, cb, context); + } + function off(types) { + var type; + if (!this._callbacks) { + return this; + } + types = types.split(splitter); + while (type = types.shift()) { + delete this._callbacks[type]; + } + return this; + } + function trigger(types) { + var type, callbacks, args, syncFlush, asyncFlush; + if (!this._callbacks) { + return this; + } + types = types.split(splitter); + args = [].slice.call(arguments, 1); + while ((type = types.shift()) && (callbacks = this._callbacks[type])) { + syncFlush = getFlush(callbacks.sync, this, [ type ].concat(args)); + asyncFlush = getFlush(callbacks.async, this, [ type ].concat(args)); + syncFlush() && nextTick(asyncFlush); + } + return this; + } + function getFlush(callbacks, context, args) { + return flush; + function flush() { + var cancelled; + for (var i = 0, len = callbacks.length; !cancelled && i < len; i += 1) { + cancelled = callbacks[i].apply(context, args) === false; + } + return !cancelled; + } + } + function getNextTick() { + var nextTickFn; + if (window.setImmediate) { + nextTickFn = function nextTickSetImmediate(fn) { + setImmediate(function() { + fn(); + }); + }; + } else { + nextTickFn = function nextTickSetTimeout(fn) { + setTimeout(function() { + fn(); + }, 0); + }; + } + return nextTickFn; + } + function bindContext(fn, context) { + return fn.bind ? fn.bind(context) : function() { + fn.apply(context, [].slice.call(arguments, 0)); + }; + } + }(); + var highlight = function(doc) { + "use strict"; + var defaults = { + node: null, + pattern: null, + tagName: "strong", + className: null, + wordsOnly: false, + caseSensitive: false, + diacriticInsensitive: false + }; + var accented = { + A: "[AaªÀ-Åà-åĀ-ąǍǎȀ-ȃȦȧᴬᵃḀḁẚẠ-ảₐ℀℁℻⒜Ⓐⓐ㍱-㍴㎀-㎄㎈㎉㎩-㎯㏂㏊㏟㏿Ａａ]", + B: "[BbᴮᵇḂ-ḇℬ⒝Ⓑⓑ㍴㎅-㎇㏃㏈㏔㏝Ｂｂ]", + C: "[CcÇçĆ-čᶜ℀ℂ℃℅℆ℭⅭⅽ⒞Ⓒⓒ㍶㎈㎉㎝㎠㎤㏄-㏇Ｃｃ]", + D: "[DdĎďDŽ-džDZ-dzᴰᵈḊ-ḓⅅⅆⅮⅾ⒟Ⓓⓓ㋏㍲㍷-㍹㎗㎭-㎯㏅㏈Ｄｄ]", + E: "[EeÈ-Ëè-ëĒ-ěȄ-ȇȨȩᴱᵉḘ-ḛẸ-ẽₑ℡ℯℰⅇ⒠Ⓔⓔ㉐㋍㋎Ｅｅ]", + F: "[FfᶠḞḟ℉ℱ℻⒡Ⓕⓕ㎊-㎌㎙ff-fflＦｆ]", + G: "[GgĜ-ģǦǧǴǵᴳᵍḠḡℊ⒢Ⓖⓖ㋌㋍㎇㎍-㎏㎓㎬㏆㏉㏒㏿Ｇｇ]", + H: "[HhĤĥȞȟʰᴴḢ-ḫẖℋ-ℎ⒣Ⓗⓗ㋌㍱㎐-㎔㏊㏋㏗Ｈｈ]", + I: "[IiÌ-Ïì-ïĨ-İIJijǏǐȈ-ȋᴵᵢḬḭỈ-ịⁱℐℑℹⅈⅠ-ⅣⅥ-ⅨⅪⅫⅰ-ⅳⅵ-ⅸⅺⅻ⒤Ⓘⓘ㍺㏌㏕fiffiＩｉ]", + J: "[JjIJ-ĵLJ-njǰʲᴶⅉ⒥ⒿⓙⱼＪｊ]", + K: "[KkĶķǨǩᴷᵏḰ-ḵK⒦Ⓚⓚ㎄㎅㎉㎏㎑㎘㎞㎢㎦㎪㎸㎾㏀㏆㏍-㏏Ｋｋ]", + L: "[LlĹ-ŀLJ-ljˡᴸḶḷḺ-ḽℒℓ℡Ⅼⅼ⒧Ⓛⓛ㋏㎈㎉㏐-㏓㏕㏖㏿flfflＬｌ]", + M: "[MmᴹᵐḾ-ṃ℠™ℳⅯⅿ⒨Ⓜⓜ㍷-㍹㎃㎆㎎㎒㎖㎙-㎨㎫㎳㎷㎹㎽㎿㏁㏂㏎㏐㏔-㏖㏘㏙㏞㏟Ｍｍ]", + N: "[NnÑñŃ-ʼnNJ-njǸǹᴺṄ-ṋⁿℕ№⒩Ⓝⓝ㎁㎋㎚㎱㎵㎻㏌㏑Ｎｎ]", + O: "[OoºÒ-Öò-öŌ-őƠơǑǒǪǫȌ-ȏȮȯᴼᵒỌ-ỏₒ℅№ℴ⒪Ⓞⓞ㍵㏇㏒㏖Ｏｏ]", + P: "[PpᴾᵖṔ-ṗℙ⒫Ⓟⓟ㉐㍱㍶㎀㎊㎩-㎬㎰㎴㎺㏋㏗-㏚Ｐｐ]", + Q: "[Qqℚ⒬Ⓠⓠ㏃Ｑｑ]", + R: "[RrŔ-řȐ-ȓʳᴿᵣṘ-ṛṞṟ₨ℛ-ℝ⒭Ⓡⓡ㋍㍴㎭-㎯㏚㏛Ｒｒ]", + S: "[SsŚ-šſȘșˢṠ-ṣ₨℁℠⒮Ⓢⓢ㎧㎨㎮-㎳㏛㏜stＳｓ]", + T: "[TtŢ-ťȚțᵀᵗṪ-ṱẗ℡™⒯Ⓣⓣ㉐㋏㎔㏏ſtstＴｔ]", + U: "[UuÙ-Üù-üŨ-ųƯưǓǔȔ-ȗᵁᵘᵤṲ-ṷỤ-ủ℆⒰Ⓤⓤ㍳㍺Ｕｕ]", + V: "[VvᵛᵥṼ-ṿⅣ-Ⅷⅳ-ⅷ⒱Ⓥⓥⱽ㋎㍵㎴-㎹㏜㏞Ｖｖ]", + W: "[WwŴŵʷᵂẀ-ẉẘ⒲Ⓦⓦ㎺-㎿㏝Ｗｗ]", + X: "[XxˣẊ-ẍₓ℻Ⅸ-Ⅻⅸ-ⅻ⒳Ⓧⓧ㏓Ｘｘ]", + Y: "[YyÝýÿŶ-ŸȲȳʸẎẏẙỲ-ỹ⒴Ⓨⓨ㏉Ｙｙ]", + Z: "[ZzŹ-žDZ-dzᶻẐ-ẕℤℨ⒵Ⓩⓩ㎐-㎔Ｚｚ]" + }; + return function hightlight(o) { + var regex; + o = _.mixin({}, defaults, o); + if (!o.node || !o.pattern) { + return; + } + o.pattern = _.isArray(o.pattern) ? o.pattern : [ o.pattern ]; + regex = getRegex(o.pattern, o.caseSensitive, o.wordsOnly, o.diacriticInsensitive); + traverse(o.node, hightlightTextNode); + function hightlightTextNode(textNode) { + var match, patternNode, wrapperNode; + if (match = regex.exec(textNode.data)) { + wrapperNode = doc.createElement(o.tagName); + o.className && (wrapperNode.className = o.className); + patternNode = textNode.splitText(match.index); + patternNode.splitText(match[0].length); + wrapperNode.appendChild(patternNode.cloneNode(true)); + textNode.parentNode.replaceChild(wrapperNode, patternNode); + } + return !!match; + } + function traverse(el, hightlightTextNode) { + var childNode, TEXT_NODE_TYPE = 3; + for (var i = 0; i < el.childNodes.length; i++) { + childNode = el.childNodes[i]; + if (childNode.nodeType === TEXT_NODE_TYPE) { + i += hightlightTextNode(childNode) ? 1 : 0; + } else { + traverse(childNode, hightlightTextNode); + } + } + } + }; + function accent_replacer(chr) { + return accented[chr.toUpperCase()] || chr; + } + function getRegex(patterns, caseSensitive, wordsOnly, diacriticInsensitive) { + var escapedPatterns = [], regexStr; + for (var i = 0, len = patterns.length; i < len; i++) { + var escapedWord = _.escapeRegExChars(patterns[i]); + if (diacriticInsensitive) { + escapedWord = escapedWord.replace(/\S/g, accent_replacer); + } + escapedPatterns.push(escapedWord); + } + regexStr = wordsOnly ? "\\b(" + escapedPatterns.join("|") + ")\\b" : "(" + escapedPatterns.join("|") + ")"; + return caseSensitive ? new RegExp(regexStr) : new RegExp(regexStr, "i"); + } + }(window.document); + var Input = function() { + "use strict"; + var specialKeyCodeMap; + specialKeyCodeMap = { + 9: "tab", + 27: "esc", + 37: "left", + 39: "right", + 13: "enter", + 38: "up", + 40: "down" + }; + function Input(o, www) { + var id; + o = o || {}; + if (!o.input) { + $.error("input is missing"); + } + www.mixin(this); + this.$hint = $(o.hint); + this.$input = $(o.input); + this.$menu = $(o.menu); + id = this.$input.attr("id") || _.guid(); + this.$menu.attr("id", id + "_listbox"); + this.$hint.attr({ + "aria-hidden": true + }); + this.$input.attr({ + "aria-owns": id + "_listbox", + role: "combobox", + "aria-autocomplete": "list", + "aria-expanded": false + }); + this.query = this.$input.val(); + this.queryWhenFocused = this.hasFocus() ? this.query : null; + this.$overflowHelper = buildOverflowHelper(this.$input); + this._checkLanguageDirection(); + if (this.$hint.length === 0) { + this.setHint = this.getHint = this.clearHint = this.clearHintIfInvalid = _.noop; + } + this.onSync("cursorchange", this._updateDescendent); + } + Input.normalizeQuery = function(str) { + return _.toStr(str).replace(/^\s*/g, "").replace(/\s{2,}/g, " "); + }; + _.mixin(Input.prototype, EventEmitter, { + _onBlur: function onBlur() { + this.resetInputValue(); + this.trigger("blurred"); + }, + _onFocus: function onFocus() { + this.queryWhenFocused = this.query; + this.trigger("focused"); + }, + _onKeydown: function onKeydown($e) { + var keyName = specialKeyCodeMap[$e.which || $e.keyCode]; + this._managePreventDefault(keyName, $e); + if (keyName && this._shouldTrigger(keyName, $e)) { + this.trigger(keyName + "Keyed", $e); + } + }, + _onInput: function onInput() { + this._setQuery(this.getInputValue()); + this.clearHintIfInvalid(); + this._checkLanguageDirection(); + }, + _managePreventDefault: function managePreventDefault(keyName, $e) { + var preventDefault; + switch (keyName) { + case "up": + case "down": + preventDefault = !withModifier($e); + break; + + default: + preventDefault = false; + } + preventDefault && $e.preventDefault(); + }, + _shouldTrigger: function shouldTrigger(keyName, $e) { + var trigger; + switch (keyName) { + case "tab": + trigger = !withModifier($e); + break; + + default: + trigger = true; + } + return trigger; + }, + _checkLanguageDirection: function checkLanguageDirection() { + var dir = (this.$input.css("direction") || "ltr").toLowerCase(); + if (this.dir !== dir) { + this.dir = dir; + this.$hint.attr("dir", dir); + this.trigger("langDirChanged", dir); + } + }, + _setQuery: function setQuery(val, silent) { + var areEquivalent, hasDifferentWhitespace; + areEquivalent = areQueriesEquivalent(val, this.query); + hasDifferentWhitespace = areEquivalent ? this.query.length !== val.length : false; + this.query = val; + if (!silent && !areEquivalent) { + this.trigger("queryChanged", this.query); + } else if (!silent && hasDifferentWhitespace) { + this.trigger("whitespaceChanged", this.query); + } + }, + _updateDescendent: function updateDescendent(event, id) { + this.$input.attr("aria-activedescendant", id); + }, + bind: function() { + var that = this, onBlur, onFocus, onKeydown, onInput; + onBlur = _.bind(this._onBlur, this); + onFocus = _.bind(this._onFocus, this); + onKeydown = _.bind(this._onKeydown, this); + onInput = _.bind(this._onInput, this); + this.$input.on("blur.tt", onBlur).on("focus.tt", onFocus).on("keydown.tt", onKeydown); + if (!_.isMsie() || _.isMsie() > 9) { + this.$input.on("input.tt", onInput); + } else { + this.$input.on("keydown.tt keypress.tt cut.tt paste.tt", function($e) { + if (specialKeyCodeMap[$e.which || $e.keyCode]) { + return; + } + _.defer(_.bind(that._onInput, that, $e)); + }); + } + return this; + }, + focus: function focus() { + this.$input.focus(); + }, + blur: function blur() { + this.$input.blur(); + }, + getLangDir: function getLangDir() { + return this.dir; + }, + getQuery: function getQuery() { + return this.query || ""; + }, + setQuery: function setQuery(val, silent) { + this.setInputValue(val); + this._setQuery(val, silent); + }, + hasQueryChangedSinceLastFocus: function hasQueryChangedSinceLastFocus() { + return this.query !== this.queryWhenFocused; + }, + getInputValue: function getInputValue() { + return this.$input.val(); + }, + setInputValue: function setInputValue(value) { + this.$input.val(value); + this.clearHintIfInvalid(); + this._checkLanguageDirection(); + }, + resetInputValue: function resetInputValue() { + this.setInputValue(this.query); + }, + getHint: function getHint() { + return this.$hint.val(); + }, + setHint: function setHint(value) { + this.$hint.val(value); + }, + clearHint: function clearHint() { + this.setHint(""); + }, + clearHintIfInvalid: function clearHintIfInvalid() { + var val, hint, valIsPrefixOfHint, isValid; + val = this.getInputValue(); + hint = this.getHint(); + valIsPrefixOfHint = val !== hint && hint.indexOf(val) === 0; + isValid = val !== "" && valIsPrefixOfHint && !this.hasOverflow(); + !isValid && this.clearHint(); + }, + hasFocus: function hasFocus() { + return this.$input.is(":focus"); + }, + hasOverflow: function hasOverflow() { + var constraint = this.$input.width() - 2; + this.$overflowHelper.text(this.getInputValue()); + return this.$overflowHelper.width() >= constraint; + }, + isCursorAtEnd: function() { + var valueLength, selectionStart, range; + valueLength = this.$input.val().length; + selectionStart = this.$input[0].selectionStart; + if (_.isNumber(selectionStart)) { + return selectionStart === valueLength; + } else if (document.selection) { + range = document.selection.createRange(); + range.moveStart("character", -valueLength); + return valueLength === range.text.length; + } + return true; + }, + destroy: function destroy() { + this.$hint.off(".tt"); + this.$input.off(".tt"); + this.$overflowHelper.remove(); + this.$hint = this.$input = this.$overflowHelper = $("
"); + }, + setAriaExpanded: function setAriaExpanded(value) { + this.$input.attr("aria-expanded", value); + } + }); + return Input; + function buildOverflowHelper($input) { + return $('').css({ + position: "absolute", + visibility: "hidden", + whiteSpace: "pre", + fontFamily: $input.css("font-family"), + fontSize: $input.css("font-size"), + fontStyle: $input.css("font-style"), + fontVariant: $input.css("font-variant"), + fontWeight: $input.css("font-weight"), + wordSpacing: $input.css("word-spacing"), + letterSpacing: $input.css("letter-spacing"), + textIndent: $input.css("text-indent"), + textRendering: $input.css("text-rendering"), + textTransform: $input.css("text-transform") + }).insertAfter($input); + } + function areQueriesEquivalent(a, b) { + return Input.normalizeQuery(a) === Input.normalizeQuery(b); + } + function withModifier($e) { + return $e.altKey || $e.ctrlKey || $e.metaKey || $e.shiftKey; + } + }(); + var Dataset = function() { + "use strict"; + var keys, nameGenerator; + keys = { + dataset: "tt-selectable-dataset", + val: "tt-selectable-display", + obj: "tt-selectable-object" + }; + nameGenerator = _.getIdGenerator(); + function Dataset(o, www) { + o = o || {}; + o.templates = o.templates || {}; + o.templates.notFound = o.templates.notFound || o.templates.empty; + if (!o.source) { + $.error("missing source"); + } + if (!o.node) { + $.error("missing node"); + } + if (o.name && !isValidName(o.name)) { + $.error("invalid dataset name: " + o.name); + } + www.mixin(this); + this.highlight = !!o.highlight; + this.name = _.toStr(o.name || nameGenerator()); + this.limit = o.limit || 5; + this.displayFn = getDisplayFn(o.display || o.displayKey); + this.templates = getTemplates(o.templates, this.displayFn); + this.source = o.source.__ttAdapter ? o.source.__ttAdapter() : o.source; + this.async = _.isUndefined(o.async) ? this.source.length > 2 : !!o.async; + this._resetLastSuggestion(); + this.$el = $(o.node).attr("role", "presentation").addClass(this.classes.dataset).addClass(this.classes.dataset + "-" + this.name); + } + Dataset.extractData = function extractData(el) { + var $el = $(el); + if ($el.data(keys.obj)) { + return { + dataset: $el.data(keys.dataset) || "", + val: $el.data(keys.val) || "", + obj: $el.data(keys.obj) || null + }; + } + return null; + }; + _.mixin(Dataset.prototype, EventEmitter, { + _overwrite: function overwrite(query, suggestions) { + suggestions = suggestions || []; + if (suggestions.length) { + this._renderSuggestions(query, suggestions); + } else if (this.async && this.templates.pending) { + this._renderPending(query); + } else if (!this.async && this.templates.notFound) { + this._renderNotFound(query); + } else { + this._empty(); + } + this.trigger("rendered", suggestions, false, this.name); + }, + _append: function append(query, suggestions) { + suggestions = suggestions || []; + if (suggestions.length && this.$lastSuggestion.length) { + this._appendSuggestions(query, suggestions); + } else if (suggestions.length) { + this._renderSuggestions(query, suggestions); + } else if (!this.$lastSuggestion.length && this.templates.notFound) { + this._renderNotFound(query); + } + this.trigger("rendered", suggestions, true, this.name); + }, + _renderSuggestions: function renderSuggestions(query, suggestions) { + var $fragment; + $fragment = this._getSuggestionsFragment(query, suggestions); + this.$lastSuggestion = $fragment.children().last(); + this.$el.html($fragment).prepend(this._getHeader(query, suggestions)).append(this._getFooter(query, suggestions)); + }, + _appendSuggestions: function appendSuggestions(query, suggestions) { + var $fragment, $lastSuggestion; + $fragment = this._getSuggestionsFragment(query, suggestions); + $lastSuggestion = $fragment.children().last(); + this.$lastSuggestion.after($fragment); + this.$lastSuggestion = $lastSuggestion; + }, + _renderPending: function renderPending(query) { + var template = this.templates.pending; + this._resetLastSuggestion(); + template && this.$el.html(template({ + query: query, + dataset: this.name + })); + }, + _renderNotFound: function renderNotFound(query) { + var template = this.templates.notFound; + this._resetLastSuggestion(); + template && this.$el.html(template({ + query: query, + dataset: this.name + })); + }, + _empty: function empty() { + this.$el.empty(); + this._resetLastSuggestion(); + }, + _getSuggestionsFragment: function getSuggestionsFragment(query, suggestions) { + var that = this, fragment; + fragment = document.createDocumentFragment(); + _.each(suggestions, function getSuggestionNode(suggestion) { + var $el, context; + context = that._injectQuery(query, suggestion); + $el = $(that.templates.suggestion(context)).data(keys.dataset, that.name).data(keys.obj, suggestion).data(keys.val, that.displayFn(suggestion)).addClass(that.classes.suggestion + " " + that.classes.selectable); + fragment.appendChild($el[0]); + }); + this.highlight && highlight({ + className: this.classes.highlight, + node: fragment, + pattern: query + }); + return $(fragment); + }, + _getFooter: function getFooter(query, suggestions) { + return this.templates.footer ? this.templates.footer({ + query: query, + suggestions: suggestions, + dataset: this.name + }) : null; + }, + _getHeader: function getHeader(query, suggestions) { + return this.templates.header ? this.templates.header({ + query: query, + suggestions: suggestions, + dataset: this.name + }) : null; + }, + _resetLastSuggestion: function resetLastSuggestion() { + this.$lastSuggestion = $(); + }, + _injectQuery: function injectQuery(query, obj) { + return _.isObject(obj) ? _.mixin({ + _query: query + }, obj) : obj; + }, + update: function update(query) { + var that = this, canceled = false, syncCalled = false, rendered = 0; + this.cancel(); + this.cancel = function cancel() { + canceled = true; + that.cancel = $.noop; + that.async && that.trigger("asyncCanceled", query, that.name); + }; + this.source(query, sync, async); + !syncCalled && sync([]); + function sync(suggestions) { + if (syncCalled) { + return; + } + syncCalled = true; + suggestions = (suggestions || []).slice(0, that.limit); + rendered = suggestions.length; + that._overwrite(query, suggestions); + if (rendered < that.limit && that.async) { + that.trigger("asyncRequested", query, that.name); + } + } + function async(suggestions) { + suggestions = suggestions || []; + if (!canceled && rendered < that.limit) { + that.cancel = $.noop; + var idx = Math.abs(rendered - that.limit); + rendered += idx; + that._append(query, suggestions.slice(0, idx)); + that.async && that.trigger("asyncReceived", query, that.name); + } + } + }, + cancel: $.noop, + clear: function clear() { + this._empty(); + this.cancel(); + this.trigger("cleared"); + }, + isEmpty: function isEmpty() { + return this.$el.is(":empty"); + }, + destroy: function destroy() { + this.$el = $("
"); + } + }); + return Dataset; + function getDisplayFn(display) { + display = display || _.stringify; + return _.isFunction(display) ? display : displayFn; + function displayFn(obj) { + return obj[display]; + } + } + function getTemplates(templates, displayFn) { + return { + notFound: templates.notFound && _.templatify(templates.notFound), + pending: templates.pending && _.templatify(templates.pending), + header: templates.header && _.templatify(templates.header), + footer: templates.footer && _.templatify(templates.footer), + suggestion: templates.suggestion ? userSuggestionTemplate : suggestionTemplate + }; + function userSuggestionTemplate(context) { + var template = templates.suggestion; + return $(template(context)).attr("id", _.guid()); + } + function suggestionTemplate(context) { + return $('
').attr("id", _.guid()).text(displayFn(context)); + } + } + function isValidName(str) { + return /^[_a-zA-Z0-9-]+$/.test(str); + } + }(); + var Menu = function() { + "use strict"; + function Menu(o, www) { + var that = this; + o = o || {}; + if (!o.node) { + $.error("node is required"); + } + www.mixin(this); + this.$node = $(o.node); + this.query = null; + this.datasets = _.map(o.datasets, initializeDataset); + function initializeDataset(oDataset) { + var node = that.$node.find(oDataset.node).first(); + oDataset.node = node.length ? node : $("
").appendTo(that.$node); + return new Dataset(oDataset, www); + } + } + _.mixin(Menu.prototype, EventEmitter, { + _onSelectableClick: function onSelectableClick($e) { + this.trigger("selectableClicked", $($e.currentTarget)); + }, + _onRendered: function onRendered(type, dataset, suggestions, async) { + this.$node.toggleClass(this.classes.empty, this._allDatasetsEmpty()); + this.trigger("datasetRendered", dataset, suggestions, async); + }, + _onCleared: function onCleared() { + this.$node.toggleClass(this.classes.empty, this._allDatasetsEmpty()); + this.trigger("datasetCleared"); + }, + _propagate: function propagate() { + this.trigger.apply(this, arguments); + }, + _allDatasetsEmpty: function allDatasetsEmpty() { + return _.every(this.datasets, _.bind(function isDatasetEmpty(dataset) { + var isEmpty = dataset.isEmpty(); + this.$node.attr("aria-expanded", !isEmpty); + return isEmpty; + }, this)); + }, + _getSelectables: function getSelectables() { + return this.$node.find(this.selectors.selectable); + }, + _removeCursor: function _removeCursor() { + var $selectable = this.getActiveSelectable(); + $selectable && $selectable.removeClass(this.classes.cursor); + }, + _ensureVisible: function ensureVisible($el) { + var elTop, elBottom, nodeScrollTop, nodeHeight; + elTop = $el.position().top; + elBottom = elTop + $el.outerHeight(true); + nodeScrollTop = this.$node.scrollTop(); + nodeHeight = this.$node.height() + parseInt(this.$node.css("paddingTop"), 10) + parseInt(this.$node.css("paddingBottom"), 10); + if (elTop < 0) { + this.$node.scrollTop(nodeScrollTop + elTop); + } else if (nodeHeight < elBottom) { + this.$node.scrollTop(nodeScrollTop + (elBottom - nodeHeight)); + } + }, + bind: function() { + var that = this, onSelectableClick; + onSelectableClick = _.bind(this._onSelectableClick, this); + this.$node.on("click.tt", this.selectors.selectable, onSelectableClick); + this.$node.on("mouseover", this.selectors.selectable, function() { + that.setCursor($(this)); + }); + this.$node.on("mouseleave", function() { + that._removeCursor(); + }); + _.each(this.datasets, function(dataset) { + dataset.onSync("asyncRequested", that._propagate, that).onSync("asyncCanceled", that._propagate, that).onSync("asyncReceived", that._propagate, that).onSync("rendered", that._onRendered, that).onSync("cleared", that._onCleared, that); + }); + return this; + }, + isOpen: function isOpen() { + return this.$node.hasClass(this.classes.open); + }, + open: function open() { + this.$node.scrollTop(0); + this.$node.addClass(this.classes.open); + }, + close: function close() { + this.$node.attr("aria-expanded", false); + this.$node.removeClass(this.classes.open); + this._removeCursor(); + }, + setLanguageDirection: function setLanguageDirection(dir) { + this.$node.attr("dir", dir); + }, + selectableRelativeToCursor: function selectableRelativeToCursor(delta) { + var $selectables, $oldCursor, oldIndex, newIndex; + $oldCursor = this.getActiveSelectable(); + $selectables = this._getSelectables(); + oldIndex = $oldCursor ? $selectables.index($oldCursor) : -1; + newIndex = oldIndex + delta; + newIndex = (newIndex + 1) % ($selectables.length + 1) - 1; + newIndex = newIndex < -1 ? $selectables.length - 1 : newIndex; + return newIndex === -1 ? null : $selectables.eq(newIndex); + }, + setCursor: function setCursor($selectable) { + this._removeCursor(); + if ($selectable = $selectable && $selectable.first()) { + $selectable.addClass(this.classes.cursor); + this._ensureVisible($selectable); + } + }, + getSelectableData: function getSelectableData($el) { + return $el && $el.length ? Dataset.extractData($el) : null; + }, + getActiveSelectable: function getActiveSelectable() { + var $selectable = this._getSelectables().filter(this.selectors.cursor).first(); + return $selectable.length ? $selectable : null; + }, + getTopSelectable: function getTopSelectable() { + var $selectable = this._getSelectables().first(); + return $selectable.length ? $selectable : null; + }, + update: function update(query) { + var isValidUpdate = query !== this.query; + if (isValidUpdate) { + this.query = query; + _.each(this.datasets, updateDataset); + } + return isValidUpdate; + function updateDataset(dataset) { + dataset.update(query); + } + }, + empty: function empty() { + _.each(this.datasets, clearDataset); + this.query = null; + this.$node.addClass(this.classes.empty); + function clearDataset(dataset) { + dataset.clear(); + } + }, + destroy: function destroy() { + this.$node.off(".tt"); + this.$node = $("
"); + _.each(this.datasets, destroyDataset); + function destroyDataset(dataset) { + dataset.destroy(); + } + } + }); + return Menu; + }(); + var Status = function() { + "use strict"; + function Status(options) { + this.$el = $("", { + role: "status", + "aria-live": "polite" + }).css({ + position: "absolute", + padding: "0", + border: "0", + height: "1px", + width: "1px", + "margin-bottom": "-1px", + "margin-right": "-1px", + overflow: "hidden", + clip: "rect(0 0 0 0)", + "white-space": "nowrap" + }); + options.$input.after(this.$el); + _.each(options.menu.datasets, _.bind(function(dataset) { + if (dataset.onSync) { + dataset.onSync("rendered", _.bind(this.update, this)); + dataset.onSync("cleared", _.bind(this.cleared, this)); + } + }, this)); + } + _.mixin(Status.prototype, { + update: function update(event, suggestions) { + var length = suggestions.length; + var words; + if (length === 1) { + words = { + result: "result", + is: "is" + }; + } else { + words = { + result: "results", + is: "are" + }; + } + this.$el.text(length + " " + words.result + " " + words.is + " available, use up and down arrow keys to navigate."); + }, + cleared: function() { + this.$el.text(""); + } + }); + return Status; + }(); + var DefaultMenu = function() { + "use strict"; + var s = Menu.prototype; + function DefaultMenu() { + Menu.apply(this, [].slice.call(arguments, 0)); + } + _.mixin(DefaultMenu.prototype, Menu.prototype, { + open: function open() { + !this._allDatasetsEmpty() && this._show(); + return s.open.apply(this, [].slice.call(arguments, 0)); + }, + close: function close() { + this._hide(); + return s.close.apply(this, [].slice.call(arguments, 0)); + }, + _onRendered: function onRendered() { + if (this._allDatasetsEmpty()) { + this._hide(); + } else { + this.isOpen() && this._show(); + } + return s._onRendered.apply(this, [].slice.call(arguments, 0)); + }, + _onCleared: function onCleared() { + if (this._allDatasetsEmpty()) { + this._hide(); + } else { + this.isOpen() && this._show(); + } + return s._onCleared.apply(this, [].slice.call(arguments, 0)); + }, + setLanguageDirection: function setLanguageDirection(dir) { + this.$node.css(dir === "ltr" ? this.css.ltr : this.css.rtl); + return s.setLanguageDirection.apply(this, [].slice.call(arguments, 0)); + }, + _hide: function hide() { + this.$node.hide(); + }, + _show: function show() { + this.$node.css("display", "block"); + } + }); + return DefaultMenu; + }(); + var Typeahead = function() { + "use strict"; + function Typeahead(o, www) { + var onFocused, onBlurred, onEnterKeyed, onTabKeyed, onEscKeyed, onUpKeyed, onDownKeyed, onLeftKeyed, onRightKeyed, onQueryChanged, onWhitespaceChanged; + o = o || {}; + if (!o.input) { + $.error("missing input"); + } + if (!o.menu) { + $.error("missing menu"); + } + if (!o.eventBus) { + $.error("missing event bus"); + } + www.mixin(this); + this.eventBus = o.eventBus; + this.minLength = _.isNumber(o.minLength) ? o.minLength : 1; + this.input = o.input; + this.menu = o.menu; + this.enabled = true; + this.autoselect = !!o.autoselect; + this.active = false; + this.input.hasFocus() && this.activate(); + this.dir = this.input.getLangDir(); + this._hacks(); + this.menu.bind().onSync("selectableClicked", this._onSelectableClicked, this).onSync("asyncRequested", this._onAsyncRequested, this).onSync("asyncCanceled", this._onAsyncCanceled, this).onSync("asyncReceived", this._onAsyncReceived, this).onSync("datasetRendered", this._onDatasetRendered, this).onSync("datasetCleared", this._onDatasetCleared, this); + onFocused = c(this, "activate", "open", "_onFocused"); + onBlurred = c(this, "deactivate", "_onBlurred"); + onEnterKeyed = c(this, "isActive", "isOpen", "_onEnterKeyed"); + onTabKeyed = c(this, "isActive", "isOpen", "_onTabKeyed"); + onEscKeyed = c(this, "isActive", "_onEscKeyed"); + onUpKeyed = c(this, "isActive", "open", "_onUpKeyed"); + onDownKeyed = c(this, "isActive", "open", "_onDownKeyed"); + onLeftKeyed = c(this, "isActive", "isOpen", "_onLeftKeyed"); + onRightKeyed = c(this, "isActive", "isOpen", "_onRightKeyed"); + onQueryChanged = c(this, "_openIfActive", "_onQueryChanged"); + onWhitespaceChanged = c(this, "_openIfActive", "_onWhitespaceChanged"); + this.input.bind().onSync("focused", onFocused, this).onSync("blurred", onBlurred, this).onSync("enterKeyed", onEnterKeyed, this).onSync("tabKeyed", onTabKeyed, this).onSync("escKeyed", onEscKeyed, this).onSync("upKeyed", onUpKeyed, this).onSync("downKeyed", onDownKeyed, this).onSync("leftKeyed", onLeftKeyed, this).onSync("rightKeyed", onRightKeyed, this).onSync("queryChanged", onQueryChanged, this).onSync("whitespaceChanged", onWhitespaceChanged, this).onSync("langDirChanged", this._onLangDirChanged, this); + } + _.mixin(Typeahead.prototype, { + _hacks: function hacks() { + var $input, $menu; + $input = this.input.$input || $("
"); + $menu = this.menu.$node || $("
"); + $input.on("blur.tt", function($e) { + var active, isActive, hasActive; + active = document.activeElement; + isActive = $menu.is(active); + hasActive = $menu.has(active).length > 0; + if (_.isMsie() && (isActive || hasActive)) { + $e.preventDefault(); + $e.stopImmediatePropagation(); + _.defer(function() { + $input.focus(); + }); + } + }); + $menu.on("mousedown.tt", function($e) { + $e.preventDefault(); + }); + }, + _onSelectableClicked: function onSelectableClicked(type, $el) { + this.select($el); + }, + _onDatasetCleared: function onDatasetCleared() { + this._updateHint(); + }, + _onDatasetRendered: function onDatasetRendered(type, suggestions, async, dataset) { + this._updateHint(); + if (this.autoselect) { + var cursorClass = this.selectors.cursor.substr(1); + this.menu.$node.find(this.selectors.suggestion).first().addClass(cursorClass); + } + this.eventBus.trigger("render", suggestions, async, dataset); + }, + _onAsyncRequested: function onAsyncRequested(type, dataset, query) { + this.eventBus.trigger("asyncrequest", query, dataset); + }, + _onAsyncCanceled: function onAsyncCanceled(type, dataset, query) { + this.eventBus.trigger("asynccancel", query, dataset); + }, + _onAsyncReceived: function onAsyncReceived(type, dataset, query) { + this.eventBus.trigger("asyncreceive", query, dataset); + }, + _onFocused: function onFocused() { + this._minLengthMet() && this.menu.update(this.input.getQuery()); + }, + _onBlurred: function onBlurred() { + if (this.input.hasQueryChangedSinceLastFocus()) { + this.eventBus.trigger("change", this.input.getQuery()); + } + }, + _onEnterKeyed: function onEnterKeyed(type, $e) { + var $selectable; + if ($selectable = this.menu.getActiveSelectable()) { + if (this.select($selectable)) { + $e.preventDefault(); + $e.stopPropagation(); + } + } else if (this.autoselect) { + if (this.select(this.menu.getTopSelectable())) { + $e.preventDefault(); + $e.stopPropagation(); + } + } + }, + _onTabKeyed: function onTabKeyed(type, $e) { + var $selectable; + if ($selectable = this.menu.getActiveSelectable()) { + this.select($selectable) && $e.preventDefault(); + } else if (this.autoselect) { + if ($selectable = this.menu.getTopSelectable()) { + this.autocomplete($selectable) && $e.preventDefault(); + } + } + }, + _onEscKeyed: function onEscKeyed() { + this.close(); + }, + _onUpKeyed: function onUpKeyed() { + this.moveCursor(-1); + }, + _onDownKeyed: function onDownKeyed() { + this.moveCursor(+1); + }, + _onLeftKeyed: function onLeftKeyed() { + if (this.dir === "rtl" && this.input.isCursorAtEnd()) { + this.autocomplete(this.menu.getActiveSelectable() || this.menu.getTopSelectable()); + } + }, + _onRightKeyed: function onRightKeyed() { + if (this.dir === "ltr" && this.input.isCursorAtEnd()) { + this.autocomplete(this.menu.getActiveSelectable() || this.menu.getTopSelectable()); + } + }, + _onQueryChanged: function onQueryChanged(e, query) { + this._minLengthMet(query) ? this.menu.update(query) : this.menu.empty(); + }, + _onWhitespaceChanged: function onWhitespaceChanged() { + this._updateHint(); + }, + _onLangDirChanged: function onLangDirChanged(e, dir) { + if (this.dir !== dir) { + this.dir = dir; + this.menu.setLanguageDirection(dir); + } + }, + _openIfActive: function openIfActive() { + this.isActive() && this.open(); + }, + _minLengthMet: function minLengthMet(query) { + query = _.isString(query) ? query : this.input.getQuery() || ""; + return query.length >= this.minLength; + }, + _updateHint: function updateHint() { + var $selectable, data, val, query, escapedQuery, frontMatchRegEx, match; + $selectable = this.menu.getTopSelectable(); + data = this.menu.getSelectableData($selectable); + val = this.input.getInputValue(); + if (data && !_.isBlankString(val) && !this.input.hasOverflow()) { + query = Input.normalizeQuery(val); + escapedQuery = _.escapeRegExChars(query); + frontMatchRegEx = new RegExp("^(?:" + escapedQuery + ")(.+$)", "i"); + match = frontMatchRegEx.exec(data.val); + match && this.input.setHint(val + match[1]); + } else { + this.input.clearHint(); + } + }, + isEnabled: function isEnabled() { + return this.enabled; + }, + enable: function enable() { + this.enabled = true; + }, + disable: function disable() { + this.enabled = false; + }, + isActive: function isActive() { + return this.active; + }, + activate: function activate() { + if (this.isActive()) { + return true; + } else if (!this.isEnabled() || this.eventBus.before("active")) { + return false; + } else { + this.active = true; + this.eventBus.trigger("active"); + return true; + } + }, + deactivate: function deactivate() { + if (!this.isActive()) { + return true; + } else if (this.eventBus.before("idle")) { + return false; + } else { + this.active = false; + this.close(); + this.eventBus.trigger("idle"); + return true; + } + }, + isOpen: function isOpen() { + return this.menu.isOpen(); + }, + open: function open() { + if (!this.isOpen() && !this.eventBus.before("open")) { + this.input.setAriaExpanded(true); + this.menu.open(); + this._updateHint(); + this.eventBus.trigger("open"); + } + return this.isOpen(); + }, + close: function close() { + if (this.isOpen() && !this.eventBus.before("close")) { + this.input.setAriaExpanded(false); + this.menu.close(); + this.input.clearHint(); + this.input.resetInputValue(); + this.eventBus.trigger("close"); + } + return !this.isOpen(); + }, + setVal: function setVal(val) { + this.input.setQuery(_.toStr(val)); + }, + getVal: function getVal() { + return this.input.getQuery(); + }, + select: function select($selectable) { + var data = this.menu.getSelectableData($selectable); + if (data && !this.eventBus.before("select", data.obj, data.dataset)) { + this.input.setQuery(data.val, true); + this.eventBus.trigger("select", data.obj, data.dataset); + this.close(); + return true; + } + return false; + }, + autocomplete: function autocomplete($selectable) { + var query, data, isValid; + query = this.input.getQuery(); + data = this.menu.getSelectableData($selectable); + isValid = data && query !== data.val; + if (isValid && !this.eventBus.before("autocomplete", data.obj, data.dataset)) { + this.input.setQuery(data.val); + this.eventBus.trigger("autocomplete", data.obj, data.dataset); + return true; + } + return false; + }, + moveCursor: function moveCursor(delta) { + var query, $candidate, data, suggestion, datasetName, cancelMove, id; + query = this.input.getQuery(); + $candidate = this.menu.selectableRelativeToCursor(delta); + data = this.menu.getSelectableData($candidate); + suggestion = data ? data.obj : null; + datasetName = data ? data.dataset : null; + id = $candidate ? $candidate.attr("id") : null; + this.input.trigger("cursorchange", id); + cancelMove = this._minLengthMet() && this.menu.update(query); + if (!cancelMove && !this.eventBus.before("cursorchange", suggestion, datasetName)) { + this.menu.setCursor($candidate); + if (data) { + if (typeof data.val === "string") { + this.input.setInputValue(data.val); + } + } else { + this.input.resetInputValue(); + this._updateHint(); + } + this.eventBus.trigger("cursorchange", suggestion, datasetName); + return true; + } + return false; + }, + destroy: function destroy() { + this.input.destroy(); + this.menu.destroy(); + } + }); + return Typeahead; + function c(ctx) { + var methods = [].slice.call(arguments, 1); + return function() { + var args = [].slice.call(arguments); + _.each(methods, function(method) { + return ctx[method].apply(ctx, args); + }); + }; + } + }(); + (function() { + "use strict"; + var old, keys, methods; + old = $.fn.typeahead; + keys = { + www: "tt-www", + attrs: "tt-attrs", + typeahead: "tt-typeahead" + }; + methods = { + initialize: function initialize(o, datasets) { + var www; + datasets = _.isArray(datasets) ? datasets : [].slice.call(arguments, 1); + o = o || {}; + www = WWW(o.classNames); + return this.each(attach); + function attach() { + var $input, $wrapper, $hint, $menu, defaultHint, defaultMenu, eventBus, input, menu, status, typeahead, MenuConstructor; + _.each(datasets, function(d) { + d.highlight = !!o.highlight; + }); + $input = $(this); + $wrapper = $(www.html.wrapper); + $hint = $elOrNull(o.hint); + $menu = $elOrNull(o.menu); + defaultHint = o.hint !== false && !$hint; + defaultMenu = o.menu !== false && !$menu; + defaultHint && ($hint = buildHintFromInput($input, www)); + defaultMenu && ($menu = $(www.html.menu).css(www.css.menu)); + $hint && $hint.val(""); + $input = prepInput($input, www); + if (defaultHint || defaultMenu) { + $wrapper.css(www.css.wrapper); + $input.css(defaultHint ? www.css.input : www.css.inputWithNoHint); + $input.wrap($wrapper).parent().prepend(defaultHint ? $hint : null).append(defaultMenu ? $menu : null); + } + MenuConstructor = defaultMenu ? DefaultMenu : Menu; + eventBus = new EventBus({ + el: $input + }); + input = new Input({ + hint: $hint, + input: $input, + menu: $menu + }, www); + menu = new MenuConstructor({ + node: $menu, + datasets: datasets + }, www); + status = new Status({ + $input: $input, + menu: menu + }); + typeahead = new Typeahead({ + input: input, + menu: menu, + eventBus: eventBus, + minLength: o.minLength, + autoselect: o.autoselect + }, www); + $input.data(keys.www, www); + $input.data(keys.typeahead, typeahead); + } + }, + isEnabled: function isEnabled() { + var enabled; + ttEach(this.first(), function(t) { + enabled = t.isEnabled(); + }); + return enabled; + }, + enable: function enable() { + ttEach(this, function(t) { + t.enable(); + }); + return this; + }, + disable: function disable() { + ttEach(this, function(t) { + t.disable(); + }); + return this; + }, + isActive: function isActive() { + var active; + ttEach(this.first(), function(t) { + active = t.isActive(); + }); + return active; + }, + activate: function activate() { + ttEach(this, function(t) { + t.activate(); + }); + return this; + }, + deactivate: function deactivate() { + ttEach(this, function(t) { + t.deactivate(); + }); + return this; + }, + isOpen: function isOpen() { + var open; + ttEach(this.first(), function(t) { + open = t.isOpen(); + }); + return open; + }, + open: function open() { + ttEach(this, function(t) { + t.open(); + }); + return this; + }, + close: function close() { + ttEach(this, function(t) { + t.close(); + }); + return this; + }, + select: function select(el) { + var success = false, $el = $(el); + ttEach(this.first(), function(t) { + success = t.select($el); + }); + return success; + }, + autocomplete: function autocomplete(el) { + var success = false, $el = $(el); + ttEach(this.first(), function(t) { + success = t.autocomplete($el); + }); + return success; + }, + moveCursor: function moveCursoe(delta) { + var success = false; + ttEach(this.first(), function(t) { + success = t.moveCursor(delta); + }); + return success; + }, + val: function val(newVal) { + var query; + if (!arguments.length) { + ttEach(this.first(), function(t) { + query = t.getVal(); + }); + return query; + } else { + ttEach(this, function(t) { + t.setVal(_.toStr(newVal)); + }); + return this; + } + }, + destroy: function destroy() { + ttEach(this, function(typeahead, $input) { + revert($input); + typeahead.destroy(); + }); + return this; + } + }; + $.fn.typeahead = function(method) { + if (methods[method]) { + return methods[method].apply(this, [].slice.call(arguments, 1)); + } else { + return methods.initialize.apply(this, arguments); + } + }; + $.fn.typeahead.noConflict = function noConflict() { + $.fn.typeahead = old; + return this; + }; + function ttEach($els, fn) { + $els.each(function() { + var $input = $(this), typeahead; + (typeahead = $input.data(keys.typeahead)) && fn(typeahead, $input); + }); + } + function buildHintFromInput($input, www) { + return $input.clone().addClass(www.classes.hint).removeData().css(www.css.hint).css(getBackgroundStyles($input)).prop({ + readonly: true, + required: false + }).removeAttr("id name placeholder").removeClass("required").attr({ + spellcheck: "false", + tabindex: -1 + }); + } + function prepInput($input, www) { + $input.data(keys.attrs, { + dir: $input.attr("dir"), + autocomplete: $input.attr("autocomplete"), + spellcheck: $input.attr("spellcheck"), + style: $input.attr("style") + }); + $input.addClass(www.classes.input).attr({ + spellcheck: false + }); + try { + !$input.attr("dir") && $input.attr("dir", "auto"); + } catch (e) {} + return $input; + } + function getBackgroundStyles($el) { + return { + backgroundAttachment: $el.css("background-attachment"), + backgroundClip: $el.css("background-clip"), + backgroundColor: $el.css("background-color"), + backgroundImage: $el.css("background-image"), + backgroundOrigin: $el.css("background-origin"), + backgroundPosition: $el.css("background-position"), + backgroundRepeat: $el.css("background-repeat"), + backgroundSize: $el.css("background-size") + }; + } + function revert($input) { + var www, $wrapper; + www = $input.data(keys.www); + $wrapper = $input.parent().filter(www.selectors.wrapper); + _.each($input.data(keys.attrs), function(val, key) { + _.isUndefined(val) ? $input.removeAttr(key) : $input.attr(key, val); + }); + $input.removeData(keys.typeahead).removeData(keys.www).removeData(keys.attr).removeClass(www.classes.input); + if ($wrapper.length) { + $input.detach().insertAfter($wrapper); + $wrapper.remove(); + } + } + function $elOrNull(obj) { + var isValid, $el; + isValid = _.isJQuery(obj) || _.isElement(obj); + $el = isValid ? $(obj).first() : []; + return $el.length ? $el : null; + } + })(); +}); \ No newline at end of file diff --git a/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/readme.html b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/readme.html new file mode 100644 index 00000000..613bb94a --- /dev/null +++ b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/readme.html @@ -0,0 +1,1033 @@ + + + + README Reference + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + README Reference +

+ +
+ +
+ +
+
+ +

Hyperwallet iOS Core SDK

+ +

Platforms +Build Status +Coverage Status

+ +

CocoaPods +Carthage compatible

+ +

NOTE: This is a beta product available for use in your mobile app. If you are interested in using this product, please notify your Relationship Manager and / or Project Manager to support you during the integration process.

+ +

Welcome to Hyperwallet’s iOS SDK. This library will help you create transfer methods in your iOS app, such as bank account, PayPal account, etc. See our iOS Integration Guide to get started!

+ +

Note that this SDK is geared towards those who only require backend data, which means you will have to build your own UI.

+ +

We also provide an out-of-the-box Hyperwallet iOS UI SDK for you if you decide not to build your own UI.

+

Prerequisites

+ +
    +
  • A Hyperwallet merchant account
    • +
  • Set Up your server to manage the user’s authentication process on the Hyperwallet platform. See the Authentication section for more information.
    • +
  • iOS 13.0+
    • +
  • Xcode 10.2+
    • +
  • Swift 5.0
    • +
+

Installation

+ +

Use Carthage or CocoaPods to integrate to HyperwalletSDK.

+

Carthage

+ +

Specify it in your Cartfile:

+
github "hyperwallet/hyperwallet-ios-sdk" "1.0.0-beta17"
+
+

CocoaPods

+ +

Specify it in your Podfile:

+
pod 'HyperwalletSDK', '~> 1.0.0-beta17'
+
+

Initialization

+ +

After you’re done installing the SDK, you need to initialize an instance in order to utilize core SDK functions. Also, you need to provide a HyperwalletAuthenticationTokenProvider object to retrieve an authentication token.

+ +

Add in the header:

+
import HyperwalletSDK
+
+ +

Initialize the HyperwalletSDK with a HyperwalletAuthenticationTokenProvider implementation instance:

+
Hyperwallet.setup(authenticationTokenProvider :HyperwalletAuthenticationTokenProvider)
+
+

Authentication

+ +

Your server side should be able to send a POST request to Hyperwallet endpoint /rest/v3/users/{user-token}/authentication-token to retrieve an authentication token. +Then, you need to provide a class (an authentication provider) which implements HyperwalletAuthenticationTokenProvider to retrieve an authentication token from your server.

+ +

An example implementation using the URLRequest from Swift Foundation :

+
import Foundation
+import HyperwalletSDK
+
+public class AuthenticationTokenProvider: HyperwalletAuthenticationTokenProvider {
+    private let url = URL(string: "http://your/server/to/retrieve/authenticationToken")!
+
+    public func retrieveAuthenticationToken(
+        completionHandler: @escaping HyperwalletAuthenticationTokenProvider.CompletionHandler) {
+
+        var request = URLRequest(url: url)
+        request.httpMethod = "POST"
+        request.addValue("application/json", forHTTPHeaderField: "Content-Type")
+
+        let defaultSession = URLSession(configuration: .default)
+        let task = defaultSession.dataTask(with: request) {(data, response, error) in
+            DispatchQueue.main.async {
+                    guard let data = data,
+                        let clientToken = String(data: data, encoding: .utf8),
+                        let response = response as? HTTPURLResponse else {
+                            completionHandler(nil, HyperwalletAuthenticationErrorType.unexpected(error?.localizedDescription ??
+                                "authentication token cannot be retrieved"))
+                            return
+                    }
+
+                    switch response.statusCode {
+                        case 200 ..< 300:
+                            completionHandler(clientToken, nil)
+
+                        default:
+                            completionHandler(nil, HyperwalletAuthenticationErrorType
+                                .unexpected("authentication token cannot be retrieved"))
+                }
+            }
+        }
+        task.resume()
+    }
+}
+
+

Usage

+ +

The functions in the core SDK are available to use once the authentication is done.

+

Get User

+
Hyperwallet.shared.getUser { (user, error) in
+    guard error == nil else {
+        print(error?.getHyperwalletErrors()?.errorList?)
+        return
+    }
+
+    print(user?.firstName)
+    print(user?.lastName)
+}
+
+

Create PayPal Account

+
let payPalAccount = HyperwalletPayPalAccount.Builder(transferMethodCountry: "US", transferMethodCurrency: "USD")
+    .email("test@paypal.com")
+    .build()
+
+Hyperwallet.shared.createPayPalAccount(account: payPalAccount, completion: { (result, error) in
+    // Code to handle successful response or error
+    // On successful creation, response (HyperwalletPayPalAccount in this case) will contain information about the user’s PayPal account
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure of PayPal account creation
+})
+
+

Get PayPal Account

+
Hyperwallet.shared.getPayPalAccount(transferMethodToken: "123123", completion: { (result, error) in
+    // On success, response (HyperwalletPayPalAccount? in this case) will contain information about the user’s PayPal account or nil if not exist.
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure
+})
+
+

Update PayPal Account

+
let payPalAccount = HyperwalletPayPalAccount.Builder(token: "trm-12345")
+    .email("test@paypal.com")
+    .build()
+
+Hyperwallet.shared.updatePayPalAccount(account: payPalAccount, completion: { (result, error) in
+    // Code to handle successful response or error
+    // On successful update, response (HyperwalletPayPalAccount in this case) will contain information about the user’s PayPal account
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure of PayPal account updating
+})
+
+

Deactivate PayPal Account

+
Hyperwallet.shared.deactivatePayPalAccount(transferMethodToken: "trm-12345", notes: "deactivate PayPal account", completion: { (result, error) in
+    // Code to handle successful response or error
+    // On successful deactivation, response (HyperwalletStatusTransition in this case) will contain information about the status transition
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure of PayPal account deactivation
+})
+
+

List PayPal Account

+
let payPalQueryParam = HyperwalletPayPalAccountQueryParam()
+payPalQueryParam.status = HyperwalletPayPalAccountQueryParam.QueryStatus.activated.rawValue
+payPalQueryParam.sortBy = HyperwalletTransferMethodQueryParam.QuerySortable.ascendantCreatedOn.rawValue
+
+Hyperwallet.shared.listPayPalAccounts(queryParam: payPalQueryParam) { (result, error) in
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure
+    guard error == nil else {
+        print(error?.getHyperwalletErrors()?.errorList?)
+        return
+    }
+
+    // On success, response (HyperwalletPageList<HyperwalletPayPalAccount>? in this case) will contain information about or nil if not exist.
+    if let payPalAccounts = result?.data {
+        for payPalAccount in payPalAccounts {
+        print(payPalAccount.getField(fieldName: .token) ?? "")
+        }
+    }
+}
+
+

Create Venmo Account

+
let venmoAccount = HyperwalletVenmoAccount.Builder(transferMethodCountry: "US", transferMethodCurrency: "USD")
+    .accountId("9876543210")
+    .build()
+
+Hyperwallet.shared.createVenmoAccount(account: venmoAccount, completion: { (result, error) in
+    // Code to handle successful response or error
+    // On successful creation, response (HyperwalletVenmoAccount in this case) will contain information about the user’s Venmo account
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure of Venmo account creation
+})
+
+

Get Venmo Account

+
Hyperwallet.shared.getVenmoAccount(transferMethodToken: "123123", completion: { (result, error) in
+    // On success, response (HyperwalletVenmoAccount? in this case) will contain information about the user’s Venmo account or nil if not exist.
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure
+})
+
+

Update Venmo Account

+
let venmoAccount = HyperwalletVenmoAccount.Builder(token: "trm-12345")
+    .accountId("9876543210")
+    .build()
+
+Hyperwallet.shared.updateVenmoAccount(account: venmoAccount, completion: { (result, error) in
+    // Code to handle successful response or error
+    // On successful update, response (HyperwalletVenmoAccount in this case) will contain information about the user’s Venmo account
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure of Venmo account updating
+})
+
+

Deactivate Venmo Account

+
Hyperwallet.shared.deactivateVenmoAccount(transferMethodToken: "trm-12345", notes: "deactivate Venmo account", completion: { (result, error) in
+    // Code to handle successful response or error
+    // On successful deactivation, response (HyperwalletStatusTransition in this case) will contain information about the status transition
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure of Venmo account deactivation
+})
+
+

List Venmo Account

+
let venmoQueryParam = HyperwalletVenmoQueryParam()
+venmoQueryParam.status = HyperwalletVenmoQueryParam.QueryStatus.activated.rawValue
+venmoQueryParam.sortBy = HyperwalletVenmoQueryParam.QuerySortable.ascendantCreatedOn.rawValue
+
+Hyperwallet.shared.listVenmoAccounts(queryParam: venmoQueryParam) { (result, error) in
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure
+    guard error == nil else {
+        print(error?.getHyperwalletErrors()?.errorList?)
+        return
+    }
+
+    // On success, response (HyperwalletPageList<HyperwalletVenmoAccount>? in this case) will contain information about or nil if not exist.
+    if let venmoAccounts = result?.data {
+        for venmoAccount in venmoAccounts {
+           print(venmoAccount.getField(fieldName: .token) ?? "")
+        }
+    }
+}
+
+

Create Bank Account

+
let bankAccount = HyperwalletBankAccount.Builder(transferMethodCountry: "US",   
+                                                 transferMethodCurrency: "USD",
+                                                 transferMethodProfileType: "INDIVIDUAL")
+.bankAccountId("12345")
+.branchId("123456")
+.bankAccountPurpose(.checking)
+.build()
+
+Hyperwallet.shared.createBankAccount(account: bankAccount, completion: { (result, error) in
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure of account creation
+    guard error == nil else {
+        print(error?.getHyperwalletErrors()?.errorList?)
+        return
+    }   
+
+    // On successful creation, response (HyperwalletBankAccount in this case) payload will contain information about the account created
+    print(result)
+})
+
+

Get Bank Account

+
Hyperwallet.shared.getBankAccount(transferMethodToken: "123123", completion: { (result, error) in
+    // On success, response (HyperwalletBankCard? in this case) will contain information about the user’s bank account or nil if not exist.
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure
+})
+
+

Update Bank Account

+
let bankAccount = HyperwalletBankAccount
+.Builder(token: "12345")
+.branchId("026009593")
+.build()
+
+Hyperwallet.shared.updateBankAccount(account: bankAccount, completion: { (response, error) in
+    // Code to handle successful response or error
+    // On successful update, response (HyperwalletBankAccount in this case) payload will contain information about the account updated
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure of account updating
+})
+
+

Deactivate Bank Account

+
Hyperwallet.shared.deactivateBankAccount(transferMethodToken: "trm-12345", notes: "deactivate bank account", completion: { (result, error) in
+    // Code to handle successful response or error
+    // On successful deactivation, response (HyperwalletStatusTransition in this case) will contain information about the status transition
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure of account deactivation
+})
+
+

List Bank Account

+
let bankAccountQueryParam = HyperwalletBankAccountQueryParam()
+bankAccountQueryParam.status = HyperwalletBankAccountQueryParam.QueryStatus.activated.rawValue
+bankAccountQueryParam.sortBy = HyperwalletBankAccountQueryParam.QuerySortable.ascendantCreatedOn.rawValue
+
+Hyperwallet.shared.listBankAccounts(queryParam: bankAccountQueryParam) { (result, error) in
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure
+    guard error == nil else {
+        print(error?.getHyperwalletErrors()?.errorList?)
+        return
+    }
+
+    // On success, response (HyperwalletPageList<HyperwalletBankAccount>? in this case) will contain information about or nil if not exist.
+    if let bankAccounts = result?.data {
+        for bankAccount in bankAccounts {
+            print(bankAccount.token ?? "")
+        }
+    }
+}
+
+

Create Paper Check

+
let paperCheck = HyperwalletPaperCheck.Builder(transferMethodCountry: "US",   
+                                               transferMethodCurrency: "USD",
+                                               transferMethodProfileType: "INDIVIDUAL")
+.shippingMethod("STANDARD")
+.build()
+
+Hyperwallet.shared.createPaperCheck(account: paperCheck, completion: { (result, error) in
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure of account creation
+    guard error == nil else {
+        print(error?.getHyperwalletErrors()?.errorList?)
+        return
+    }   
+
+    // On successful creation, response (HyperwalletPaperCheck in this case) payload will contain information about the paper check created
+    print(result)
+})
+
+

Get Paper Check

+
Hyperwallet.shared.getPaperCheck(transferMethodToken: "123123", completion: { (result, error) in
+    // On success, response (HyperwalletPaperCheck? in this case) will contain information about the user’s paper check or nil if not exist.
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure
+})
+
+

Update Paper Check

+
let paperCheck = HyperwalletPaperCheck
+.Builder(token: "12345")
+.shippingMethod("STANDARD")
+.build()
+
+Hyperwallet.shared.updatePaperCheck(account: paperCheck, completion: { (response, error) in
+    // Code to handle successful response or error
+    // On successful update, response (HyperwalletPaperCheck in this case) payload will contain information about the paper check updated
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure while updating
+})
+
+

Deactivate Paper Check

+
Hyperwallet.shared.deactivatePaperCheck(transferMethodToken: "trm-12345", notes: "deactivate paper check", completion: { (result, error) in
+    // Code to handle successful response or error
+    // On successful deactivation, response (HyperwalletStatusTransition in this case) will contain information about the status transition
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure
+})
+
+

List Paper Check

+
let paperCheckQueryParam = HyperwalletPaperCheckQueryParam()
+paperCheckQueryParam.status = HyperwalletPaperCheckQueryParam.QueryStatus.activated.rawValue
+paperCheckQueryParam.sortBy = HyperwalletPaperCheckQueryParam.QuerySortable.ascendantCreatedOn.rawValue
+
+Hyperwallet.shared.listPaperChecks(queryParam: paperCheckQueryParam) { (result, error) in
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure
+    guard error == nil else {
+        print(error?.getHyperwalletErrors()?.errorList?)
+        return
+    }
+
+    // On success, response (HyperwalletPageList<HyperwalletPaperCheck>? in this case) will contain information about or nil if not exist.
+    if let paperChecks = result?.data {
+        for paperCheck in paperChecks {
+            print(paperCheck.token ?? "")
+        }
+    }
+}
+
+

Create Bank Card

+
let bankCard = HyperwalletBankCard.Builder(transferMethodCountry: "US",
+                                           transferMethodCurrency: "USD",
+                                           transferMethodProfileType: "INDIVIDUAL")
+.cardNumber("1234123412341234")
+.dateOfExpiry("2022-12")
+.cvv("123")
+.build()
+
+Hyperwallet.shared.createBankCard(account: bankCard, completion: { (result, error) in
+    // Code to handle successful response or error
+    // On successful creation, response (HyperwalletBankCard in this case) will contain information about the user’s bank card
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure of bank card creation
+})
+
+

Get Bank Card

+
Hyperwallet.shared.getBankCard(transferMethodToken: "123123", completion: { (result, error) in
+    // On success, response (HyperwalletBankCard? in this case) will contain information about the user’s bank card or nil if not exist.
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure
+})
+
+

Update Bank Card

+
let bankCard = HyperwalletBankCard
+.Builder(token: "trm-12345")
+.dateOfExpiry("2022-12")
+.build()
+
+Hyperwallet.shared.updateBankCard(account: bankCard, completion: { (result, error) in
+    // Code to handle successful response or error
+    // On successful update, response (HyperwalletBankCard in this case) will contain information about the user’s bank card
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure of bank card updating
+})
+
+

Deactivate Bank Card

+
Hyperwallet.shared.deactivateBankCard(transferMethodToken: "trm-12345", notes: "deactivate bank card", completion: { (result, error) in
+    // Code to handle successful response or error
+    // On successful deactivation, response (HyperwalletStatusTransition in this case) will contain information about the status transition
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure of bank card deactivation
+})
+
+

List Bank Card

+
let bankCardQueryParam = HyperwalletBankCardQueryParam()
+bankCardQueryParam.status = HyperwalletBankCardQueryParam.QueryStatus.activated.rawValue
+bankCardQueryParam.sortBy = HyperwalletBankCardQueryParam.QuerySortable.ascendantCreatedOn.rawValue
+
+Hyperwallet.shared.listBankCards(queryParam: bankCardQueryParam) { (result, error) in
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure
+    guard error == nil else {
+        print(error?.getHyperwalletErrors()?.errorList?)
+        return
+    }
+
+    // On success, response (HyperwalletPageList<HyperwalletBankCard>? in this case) will contain information about or nil if not exist.
+    if let bankCards = result?.data {
+        for bankCard in bankCards {
+            print(bankCard.token ?? "")
+        }
+    }
+}
+
+

Get Prepaid Card

+
Hyperwallet.shared.getPrepaidCard(transferMethodToken: "123123", completion: { (result, error) in
+    // On success, response (HyperwalletPrepaidCard? in this case) will contain information about the user’s prepaid card or nil if not exist.
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure
+})
+
+

List Prepaid Cards

+
let prepaidCardQueryParam = HyperwalletPrepaidCardQueryParam()
+prepaidCardQueryParam.status = HyperwalletPrepaidCardQueryParam.QueryStatus.activated.rawValue
+prepaidCardQueryParam.sortBy = HyperwalletPrepaidCardQueryParam.QuerySortable.ascendantCreatedOn.rawValue
+
+Hyperwallet.shared.listPrepaidCards(queryParam: prepaidCardQueryParam) { (result, error) in
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure
+    guard error == nil else {
+        print(error?.getHyperwalletErrors()?.errorList?)
+        return
+    }
+
+    // On success, response (HyperwalletPageList<HyperwalletPrepaidCard>? in this case) will contain information about or nil if not exist.
+    if let prepaidCards = result?.data {
+        for prepaidCard in prepaidCards {
+            print(prepaidCard.token)
+        }
+    }
+}
+
+

List Prepaid Card Receipts

+
let receiptQueryParam = HyperwalletReceiptQueryParam()
+receiptQueryParam.createdAfter = ISO8601DateFormatter.ignoreTimeZone.date(from: "2016-12-01T00:00:00")
+
+Hyperwallet.shared.listPrepaidCardReceipts(prepaidCardToken: prepaidCardToken,
+                                           queryParam: receiptQueryParam,
+                                           completion: { (result, error) in
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure
+    guard error == nil else {
+        print(error?.getHyperwalletErrors()?.errorList?)
+        return
+    }
+
+    // On success, response (HyperwalletPageList<HyperwalletReceipt>? in this case) will contain information about or nil if not exist.
+    if let receipts = result?.data {
+        for receipt in receipts {
+            print(receipt.destinationToken ?? "")
+        }
+    }
+}
+
+

List User Receipts

+
let receiptQueryParam = HyperwalletReceiptQueryParam()
+receiptQueryParam.createdAfter = ISO8601DateFormatter.ignoreTimeZone.date(from: "2018-12-01T00:00:00")
+receiptQueryParam.currency = "USD"
+receiptQueryParam.sortBy = HyperwalletReceiptQueryParam.QuerySortable.descendantAmount.rawValue
+
+Hyperwallet.shared.listUserReceipts(queryParam: receiptQueryParam) { (result, error) in
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure
+    guard error == nil else {
+        print(error?.getHyperwalletErrors()?.errorList?)
+        return
+        }
+
+    // On success, response (HyperwalletPageList<HyperwalletReceipt>? in this case) will contain information about or nil if not exist.
+    if let receipts = result?.data {
+        for receipt in receipts {
+            print(receipt.destinationToken ?? "")
+        }
+    }
+}
+
+

List Transfer Methods

+
let transferMethodQueryParam = HyperwalletTransferMethodQueryParam()
+transferMethodQueryParam.sortBy = HyperwalletTransferMethodQueryParam.QuerySortable.ascendantCreatedOn.rawValue
+
+Hyperwallet.shared.listTransferMethods(queryParam: transferMethodQueryParam) { (result, error) in
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure
+    guard error == nil else {
+        print(error?.getHyperwalletErrors()?.errorList?)
+        return
+    }
+
+    // On success, response (HyperwalletPageList<HyperwalletTransferMethod>? in this case) will contain information about or nil if not exist.
+    if let transferMethods = result?.data {
+        for transferMethod in transferMethods {
+            print(transferMethod.token ?? "")
+        }
+    }
+}
+
+

Create Transfer

+
let transfer = HyperwalletTransfer.Builder(clientTransferId: "6712348070812",
+                                           sourceToken: "source-token",
+                                           destinationToken: "destination-token")
+    .sourceAmount("100")
+    .sourceCurrency("CAD")
+    .destinationAmount("62.29")
+    .destinationCurrency("USD")
+    .memo("TransferClientId56387")
+    .notes("Partial-Balance Transfer")
+    .build()
+
+Hyperwallet.shared.createTransfer(transfer: transfer, completion: { (result, error) in
+    //Code to handle successful response or error
+    //On successfull creation, response (HyperwalletTransfer in this case) will contain information about the transfer
+    //in case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure of transfer creation
+})
+
+

Schedule Transfer

+
Hyperwallet.shared.scheduleTransfer(transferToken: "trf-123456", completion: { (result, error) in
+    //Code to handle successful response or error
+    // On successful scheduling, response (HyperwalletStatusTransition in this case) will contain information about the status transition
+    //in case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure of transfer creation
+})
+
+

Get Transfer

+
Hyperwallet.shared.getTransfer(transferToken: "trf-123456", completion: { (result, error) in
+    // On success, response (HyperwalletTransfer? in this case) will contain information about the transfer or nil if not exist.
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure
+})
+
+

List Transfers

+
Hyperwallet.shared.listTransfers { (result, error) in
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure
+    guard error == nil else {
+        print(error?.getHyperwalletErrors()?.errorList?)
+        return
+    }
+
+    // On success, response (HyperwalletPageList<HyperwalletTransfer>? in this case) will contain information about or nil if not exist.
+    if let transfers = result?.data {
+        for transfer in transfers {
+            print(transfer.token ?? "")
+        }
+    }
+})
+
+

List User Balances

+
let balanceQueryParam = HyperwalletBalanceQueryParam()
+balanceQueryParam.currency = "USD"
+balanceQueryParam.sortBy = HyperwalletBalanceQueryParam.QuerySortable.descendantAmount.rawValue
+
+Hyperwallet.shared.listUserBalances(queryParam: balanceQueryParam) { (result, error) in
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure
+    guard error == nil else {
+    print(error?.getHyperwalletErrors()?.errorList?)
+    return
+    }
+
+    // On success, response (HyperwalletPageList<HyperwalletBalance>? in this case) will contain information about or nil if not exist.
+    if let balances = result?.data {
+        for balance in balances {
+            print(balance.amount ?? "")
+        }
+    }
+}
+
+

List Prepaid Card Balances

+
let prepaidCardBalanceQueryParam = HyperwalletPrepaidCardBalanceQueryParam()
+prepaidCardBalanceQueryParam.sortBy = HyperwalletPrepaidCardBalanceQueryParam.QuerySortable.descendantAmount.rawValue
+
+Hyperwallet.shared.listPrepaidCardBalances(prepaidCardToken: "trm-1234", queryParam: prepaidCardBalanceQueryParam) { (result, error) in
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure
+    guard error == nil else {
+    print(error?.getHyperwalletErrors()?.errorList?)
+    return
+    }
+
+    // On success, response (HyperwalletPageList<HyperwalletBalance>? in this case) will contain information about or nil if not exist.
+    if let balances = result?.data {
+        for balance in balances {
+            print(balance.amount ?? "")
+        }
+    }
+}
+
+

Transfer Method Configurations

+

Get countries, currencies

+
let keysQuery = HyperwalletTransferMethodConfigurationKeysQuery()
+
+Hyperwallet.shared.retrieveTransferMethodConfigurationKeys(request: keysQuery) { (result, error) in
+
+    guard error == nil else {
+        print(error?.getHyperwalletErrors()?.errorList?)
+        return
+    }
+
+    guard let result = result else { return }
+    // Get countries
+    let countries = result.countries()
+
+    // Get currencies based on the first available country code
+    var currencies: [HyperwalletCurrency]?
+    if let countries = result.countries(), !countries.isEmpty {
+        currencies = result.currencies(from: countries.first!.code)
+    }
+
+    print(countries)
+    print(currencies)
+}
+
+

Get transfer method types, fees and processing times for Country and Currency

+
let country = "CA"
+let currency = "CAD"
+let keysQuery = HyperwalletTransferMethodTypesFeesAndProcessingTimesQuery(country: country, currency: currency)
+
+Hyperwallet
+    .shared
+    .retrieveTransferMethodTypesFeesAndProcessingTimes(request: keysQuery) { (result, error) in
+    guard error == nil else {
+        print(error?.getHyperwalletErrors()?.errorList?)
+        return
+    }
+
+    guard let result = result else { return }
+
+    // Get transfer method types based on the first country code and its first currency code
+    transferMethodTypes = result.transferMethodTypes(countryCode: country, currencyCode: currency)
+    print(transferMethodTypes)
+    print(transferMethodTypes?.first?.fees)
+    print(transferMethodTypes?.first?.processingTimes)
+}
+
+

Get fields for a transfer method type

+
let fieldQuery = HyperwalletTransferMethodConfigurationFieldQuery(country: "CA",
+                                                                  currency: "USD",
+                                                                  transferMethodType: "BANK_ACCOUNT",
+                                                                  profile: "INDIVIDUAL")
+
+Hyperwallet.shared.retrieveTransferMethodConfigurationFields(request: fieldQuery) { (result, error) in
+
+    guard error == nil else {
+        print(error?.getHyperwalletErrors()?.errorList?)
+        return
+    }
+
+    guard let result = result else { return }
+
+    print(result.transferMethodType()))
+    print(result.fieldGroups()?.fields))
+}
+
+

Get fields for updating transfer method

+
let fieldQuery = HyperwalletTransferMethodUpdateConfigurationFieldQuery(transferMethodToken: "trm-0000001")
+
+Hyperwallet.shared.retrieveTransferMethodUpdateConfigurationFields(request: fieldQuery) { (result, error) in
+    guard error == nil else {
+        print(error?.getHyperwalletErrors()?.errorList)
+        return
+    }
+
+    guard let result = result else { return }
+
+    print(result.transferMethodUpdateConfiguration()?.fieldGroups?.nodes)
+    print(result.transferMethodUpdateConfiguration()?.transferMethodType)
+}
+
+

License

+ +

The Hyperwallet iOS SDK is open source and available under the MIT license

+ +
+
+ + +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/search.json b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/search.json new file mode 100644 index 00000000..532a155d --- /dev/null +++ b/docsets/HyperwalletSDK.docset/Contents/Resources/Documents/search.json @@ -0,0 +1 @@ +{"Structs/HyperwalletTransfer/Builder.html#/s:14HyperwalletSDK0A8TransferV7BuilderC06clientC2Id11sourceToken011destinationH0AESS_S2Stcfc":{"name":"init(clientTransferId:sourceToken:destinationToken:)","abstract":"\u003cp\u003eCreates a new instance of the \u003ccode\u003eHyperwalletTransfer.Builder\u003c/code\u003e based on the required parameters to create","parent_name":"Builder"},"Structs/HyperwalletTransfer/Builder.html#/s:14HyperwalletSDK0A8TransferV7BuilderC17destinationAmountyAESSSgF":{"name":"destinationAmount(_:)","abstract":"\u003cp\u003eSets the transfer destination amount.\u003c/p\u003e","parent_name":"Builder"},"Structs/HyperwalletTransfer/Builder.html#/s:14HyperwalletSDK0A8TransferV7BuilderC19destinationCurrencyyAESSSgF":{"name":"destinationCurrency(_:)","abstract":"\u003cp\u003eSets the transfer destination currency.\u003c/p\u003e","parent_name":"Builder"},"Structs/HyperwalletTransfer/Builder.html#/s:14HyperwalletSDK0A8TransferV7BuilderC4memoyAESSSgF":{"name":"memo(_:)","abstract":"\u003cp\u003eSets the transfer memo.\u003c/p\u003e","parent_name":"Builder"},"Structs/HyperwalletTransfer/Builder.html#/s:14HyperwalletSDK0A8TransferV7BuilderC5notesyAESSSgF":{"name":"notes(_:)","abstract":"\u003cp\u003eSets the transfer notes.\u003c/p\u003e","parent_name":"Builder"},"Structs/HyperwalletTransfer/Builder.html#/s:14HyperwalletSDK0A8TransferV7BuilderC12sourceAmountyAESSSgF":{"name":"sourceAmount(_:)","abstract":"\u003cp\u003eSets the transfer source amount.\u003c/p\u003e","parent_name":"Builder"},"Structs/HyperwalletTransfer/Builder.html#/s:14HyperwalletSDK0A8TransferV7BuilderC14sourceCurrencyyAESSSgF":{"name":"sourceCurrency(_:)","abstract":"\u003cp\u003eSets the transfer source currency.\u003c/p\u003e","parent_name":"Builder"},"Structs/HyperwalletTransfer/Builder.html#/s:14HyperwalletSDK0A8TransferV7BuilderC5buildACyF":{"name":"build()","parent_name":"Builder"},"Structs/HyperwalletTransfer/HyperwalletTransferStatus.html#/s:14HyperwalletSDK0A8TransferV0aC6StatusO9cancelledyA2EmF":{"name":"cancelled","abstract":"\u003cp\u003eThe transfer status is cancelled\u003c/p\u003e","parent_name":"HyperwalletTransferStatus"},"Structs/HyperwalletTransfer/HyperwalletTransferStatus.html#/s:14HyperwalletSDK0A8TransferV0aC6StatusO9completedyA2EmF":{"name":"completed","abstract":"\u003cp\u003eThe transfer status is completed\u003c/p\u003e","parent_name":"HyperwalletTransferStatus"},"Structs/HyperwalletTransfer/HyperwalletTransferStatus.html#/s:14HyperwalletSDK0A8TransferV0aC6StatusO7expiredyA2EmF":{"name":"expired","abstract":"\u003cp\u003eThe transfer status is expired\u003c/p\u003e","parent_name":"HyperwalletTransferStatus"},"Structs/HyperwalletTransfer/HyperwalletTransferStatus.html#/s:14HyperwalletSDK0A8TransferV0aC6StatusO6failedyA2EmF":{"name":"failed","abstract":"\u003cp\u003eThe transfer status is failed\u003c/p\u003e","parent_name":"HyperwalletTransferStatus"},"Structs/HyperwalletTransfer/HyperwalletTransferStatus.html#/s:14HyperwalletSDK0A8TransferV0aC6StatusO10inProgressyA2EmF":{"name":"inProgress","abstract":"\u003cp\u003eThe transfer status is in Progress\u003c/p\u003e","parent_name":"HyperwalletTransferStatus"},"Structs/HyperwalletTransfer/HyperwalletTransferStatus.html#/s:14HyperwalletSDK0A8TransferV0aC6StatusO6quotedyA2EmF":{"name":"quoted","abstract":"\u003cp\u003eThe transfer status is quoted\u003c/p\u003e","parent_name":"HyperwalletTransferStatus"},"Structs/HyperwalletTransfer/HyperwalletTransferStatus.html#/s:14HyperwalletSDK0A8TransferV0aC6StatusO8returnedyA2EmF":{"name":"returned","abstract":"\u003cp\u003eThe transfer status is returned\u003c/p\u003e","parent_name":"HyperwalletTransferStatus"},"Structs/HyperwalletTransfer/HyperwalletTransferStatus.html#/s:14HyperwalletSDK0A8TransferV0aC6StatusO9scheduledyA2EmF":{"name":"scheduled","abstract":"\u003cp\u003eThe transfer status is scheduled\u003c/p\u003e","parent_name":"HyperwalletTransferStatus"},"Structs/HyperwalletTransfer/HyperwalletTransferStatus.html#/s:14HyperwalletSDK0A8TransferV0aC6StatusO20verificationRequiredyA2EmF":{"name":"verificationRequired","abstract":"\u003cp\u003eThe verification required\u003c/p\u003e","parent_name":"HyperwalletTransferStatus"},"Structs/HyperwalletTransfer.html#/s:14HyperwalletSDK0A8TransferV06clientC2IdSSvp":{"name":"clientTransferId","abstract":"\u003cp\u003eA value that identifies the client transfer id.\u003c/p\u003e","parent_name":"HyperwalletTransfer"},"Structs/HyperwalletTransfer.html#/s:14HyperwalletSDK0A8TransferV9createdOnSSSgvp":{"name":"createdOn","abstract":"\u003cp\u003eThe created date\u003c/p\u003e","parent_name":"HyperwalletTransfer"},"Structs/HyperwalletTransfer.html#/s:14HyperwalletSDK0A8TransferV17destinationAmountSSSgvp":{"name":"destinationAmount","abstract":"\u003cp\u003eThe destination amount\u003c/p\u003e","parent_name":"HyperwalletTransfer"},"Structs/HyperwalletTransfer.html#/s:14HyperwalletSDK0A8TransferV19destinationCurrencySSSgvp":{"name":"destinationCurrency","abstract":"\u003cp\u003eThe destination currency\u003c/p\u003e","parent_name":"HyperwalletTransfer"},"Structs/HyperwalletTransfer.html#/s:14HyperwalletSDK0A8TransferV20destinationFeeAmountSSSgvp":{"name":"destinationFeeAmount","abstract":"\u003cp\u003eThe destination amount\u003c/p\u003e","parent_name":"HyperwalletTransfer"},"Structs/HyperwalletTransfer.html#/s:14HyperwalletSDK0A8TransferV16destinationTokenSSvp":{"name":"destinationToken","abstract":"\u003cp\u003eThe destination token\u003c/p\u003e","parent_name":"HyperwalletTransfer"},"Structs/HyperwalletTransfer.html#/s:14HyperwalletSDK0A8TransferV9expiresOnSSSgvp":{"name":"expiresOn","abstract":"\u003cp\u003eThe expiresOn\u003c/p\u003e","parent_name":"HyperwalletTransfer"},"Structs/HyperwalletTransfer.html#/s:14HyperwalletSDK0A8TransferV16foreignExchangesSayAA0A15ForeignExchangeVGSgvp":{"name":"foreignExchanges","abstract":"\u003cp\u003eThe list of foreignExchanges\u003c/p\u003e","parent_name":"HyperwalletTransfer"},"Structs/HyperwalletTransfer.html#/s:14HyperwalletSDK0A8TransferV4memoSSSgvp":{"name":"memo","abstract":"\u003cp\u003eThe memo\u003c/p\u003e","parent_name":"HyperwalletTransfer"},"Structs/HyperwalletTransfer.html#/s:14HyperwalletSDK0A8TransferV5notesSSSgvp":{"name":"notes","abstract":"\u003cp\u003eThe notes to add\u003c/p\u003e","parent_name":"HyperwalletTransfer"},"Structs/HyperwalletTransfer.html#/s:14HyperwalletSDK0A8TransferV12sourceAmountSSSgvp":{"name":"sourceAmount","abstract":"\u003cp\u003eThe source amount\u003c/p\u003e","parent_name":"HyperwalletTransfer"},"Structs/HyperwalletTransfer.html#/s:14HyperwalletSDK0A8TransferV14sourceCurrencySSSgvp":{"name":"sourceCurrency","abstract":"\u003cp\u003eThe source currency\u003c/p\u003e","parent_name":"HyperwalletTransfer"},"Structs/HyperwalletTransfer.html#/s:14HyperwalletSDK0A8TransferV15sourceFeeAmountSSSgvp":{"name":"sourceFeeAmount","abstract":"\u003cp\u003eThe source fee\u003c/p\u003e","parent_name":"HyperwalletTransfer"},"Structs/HyperwalletTransfer.html#/s:14HyperwalletSDK0A8TransferV11sourceTokenSSvp":{"name":"sourceToken","abstract":"\u003cp\u003eThe source token\u003c/p\u003e","parent_name":"HyperwalletTransfer"},"Structs/HyperwalletTransfer.html#/s:14HyperwalletSDK0A8TransferV6statusAC0aC6StatusOSgvp":{"name":"status","abstract":"\u003cp\u003eThe transfer status\u003c/p\u003e","parent_name":"HyperwalletTransfer"},"Structs/HyperwalletTransfer.html#/s:14HyperwalletSDK0A8TransferV5tokenSSSgvp":{"name":"token","abstract":"\u003cp\u003eThe token\u003c/p\u003e","parent_name":"HyperwalletTransfer"},"Structs/HyperwalletTransfer/HyperwalletTransferStatus.html":{"name":"HyperwalletTransferStatus","abstract":"\u003cp\u003eRepresentation of a \u003ccode\u003eHyperwalletTransferStatus\u003c/code\u003e\u003c/p\u003e","parent_name":"HyperwalletTransfer"},"Structs/HyperwalletTransfer/Builder.html":{"name":"Builder","abstract":"\u003cp\u003eA helper class to build the \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbStructs/HyperwalletTransfer.html\"\u003eHyperwalletTransfer\u003c/a\u003e\u003c/code\u003e instance.\u003c/p\u003e","parent_name":"HyperwalletTransfer"},"Structs/HyperwalletForeignExchange.html#/s:14HyperwalletSDK0A15ForeignExchangeV17destinationAmountSSSgvp":{"name":"destinationAmount","abstract":"\u003cp\u003eThe destination amount\u003c/p\u003e","parent_name":"HyperwalletForeignExchange"},"Structs/HyperwalletForeignExchange.html#/s:14HyperwalletSDK0A15ForeignExchangeV19destinationCurrencySSSgvp":{"name":"destinationCurrency","abstract":"\u003cp\u003eThe destination currency\u003c/p\u003e","parent_name":"HyperwalletForeignExchange"},"Structs/HyperwalletForeignExchange.html#/s:14HyperwalletSDK0A15ForeignExchangeV4rateSSSgvp":{"name":"rate","abstract":"\u003cp\u003eThe rate\u003c/p\u003e","parent_name":"HyperwalletForeignExchange"},"Structs/HyperwalletForeignExchange.html#/s:14HyperwalletSDK0A15ForeignExchangeV12sourceAmountSSSgvp":{"name":"sourceAmount","abstract":"\u003cp\u003eThe source amount\u003c/p\u003e","parent_name":"HyperwalletForeignExchange"},"Structs/HyperwalletForeignExchange.html#/s:14HyperwalletSDK0A15ForeignExchangeV14sourceCurrencySSSgvp":{"name":"sourceCurrency","abstract":"\u003cp\u003eThe source currency\u003c/p\u003e","parent_name":"HyperwalletForeignExchange"},"Structs/HyperwalletStatusTransition/Builder.html#/s:14HyperwalletSDK0A16StatusTransitionV7BuilderC5notes10transitionAESSSg_AC0C0Otcfc":{"name":"init(notes:transition:)","abstract":"\u003cp\u003eInitialization of Builder\u003c/p\u003e","parent_name":"Builder"},"Structs/HyperwalletStatusTransition/Builder.html#/s:14HyperwalletSDK0A16StatusTransitionV7BuilderC5buildACyF":{"name":"build()","parent_name":"Builder"},"Structs/HyperwalletStatusTransition/Status.html#/s:14HyperwalletSDK0A16StatusTransitionV0C0O9activatedyA2EmF":{"name":"activated","abstract":"\u003cp\u003eThe status is activate.\u003c/p\u003e","parent_name":"Status"},"Structs/HyperwalletStatusTransition/Status.html#/s:14HyperwalletSDK0A16StatusTransitionV0C0O9cancelledyA2EmF":{"name":"cancelled","abstract":"\u003cp\u003eThe status is cancel.\u003c/p\u003e","parent_name":"Status"},"Structs/HyperwalletStatusTransition/Status.html#/s:14HyperwalletSDK0A16StatusTransitionV0C0O9completedyA2EmF":{"name":"completed","abstract":"\u003cp\u003eThe status is complete.\u003c/p\u003e","parent_name":"Status"},"Structs/HyperwalletStatusTransition/Status.html#/s:14HyperwalletSDK0A16StatusTransitionV0C0O11deactivatedyA2EmF":{"name":"deactivated","abstract":"\u003cp\u003eThe status is deactivate.\u003c/p\u003e","parent_name":"Status"},"Structs/HyperwalletStatusTransition/Status.html#/s:14HyperwalletSDK0A16StatusTransitionV0C0O7expiredyA2EmF":{"name":"expired","abstract":"\u003cp\u003eThe status is expire.\u003c/p\u003e","parent_name":"Status"},"Structs/HyperwalletStatusTransition/Status.html#/s:14HyperwalletSDK0A16StatusTransitionV0C0O6failedyA2EmF":{"name":"failed","abstract":"\u003cp\u003eThe status is fail.\u003c/p\u003e","parent_name":"Status"},"Structs/HyperwalletStatusTransition/Status.html#/s:14HyperwalletSDK0A16StatusTransitionV0C0O10inProgressyA2EmF":{"name":"inProgress","abstract":"\u003cp\u003eThe status is in progress.\u003c/p\u003e","parent_name":"Status"},"Structs/HyperwalletStatusTransition/Status.html#/s:14HyperwalletSDK0A16StatusTransitionV0C0O7invalidyA2EmF":{"name":"invalid","abstract":"\u003cp\u003eThe status is invalid.\u003c/p\u003e","parent_name":"Status"},"Structs/HyperwalletStatusTransition/Status.html#/s:14HyperwalletSDK0A16StatusTransitionV0C0O12lostOrStolenyA2EmF":{"name":"lostOrStolen","abstract":"\u003cp\u003eThe status is lost or stolen.\u003c/p\u003e","parent_name":"Status"},"Structs/HyperwalletStatusTransition/Status.html#/s:14HyperwalletSDK0A16StatusTransitionV0C0O24pendingAccountActivationyA2EmF":{"name":"pendingAccountActivation","abstract":"\u003cp\u003eThe status is pending account activation.\u003c/p\u003e","parent_name":"Status"},"Structs/HyperwalletStatusTransition/Status.html#/s:14HyperwalletSDK0A16StatusTransitionV0C0O21pendingIdVerificationyA2EmF":{"name":"pendingIdVerification","abstract":"\u003cp\u003eThe status is pending identity verification.\u003c/p\u003e","parent_name":"Status"},"Structs/HyperwalletStatusTransition/Status.html#/s:14HyperwalletSDK0A16StatusTransitionV0C0O22pendingTaxVerificationyA2EmF":{"name":"pendingTaxVerification","abstract":"\u003cp\u003eThe status is pending tax verification.\u003c/p\u003e","parent_name":"Status"},"Structs/HyperwalletStatusTransition/Status.html#/s:14HyperwalletSDK0A16StatusTransitionV0C0O30pendingTransactionVerificationyA2EmF":{"name":"pendingTransactionVerification","abstract":"\u003cp\u003eThe status is pending transaction verification.\u003c/p\u003e","parent_name":"Status"},"Structs/HyperwalletStatusTransition/Status.html#/s:14HyperwalletSDK0A16StatusTransitionV0C0O27pendingTransferMethodActionyA2EmF":{"name":"pendingTransferMethodAction","abstract":"\u003cp\u003eThe status is pending transfer method action.\u003c/p\u003e","parent_name":"Status"},"Structs/HyperwalletStatusTransition/Status.html#/s:14HyperwalletSDK0A16StatusTransitionV0C0O6quotedyA2EmF":{"name":"quoted","abstract":"\u003cp\u003eThe status is quoted\u003c/p\u003e","parent_name":"Status"},"Structs/HyperwalletStatusTransition/Status.html#/s:14HyperwalletSDK0A16StatusTransitionV0C0O8recalledyA2EmF":{"name":"recalled","abstract":"\u003cp\u003eThe status is recall.\u003c/p\u003e","parent_name":"Status"},"Structs/HyperwalletStatusTransition/Status.html#/s:14HyperwalletSDK0A16StatusTransitionV0C0O8returnedyA2EmF":{"name":"returned","abstract":"\u003cp\u003eThe status is return.\u003c/p\u003e","parent_name":"Status"},"Structs/HyperwalletStatusTransition/Status.html#/s:14HyperwalletSDK0A16StatusTransitionV0C0O9scheduledyA2EmF":{"name":"scheduled","abstract":"\u003cp\u003eThe status is schedule.\u003c/p\u003e","parent_name":"Status"},"Structs/HyperwalletStatusTransition/Status.html#/s:14HyperwalletSDK0A16StatusTransitionV0C0O9suspendedyA2EmF":{"name":"suspended","abstract":"\u003cp\u003eThe status is suspend.\u003c/p\u003e","parent_name":"Status"},"Structs/HyperwalletStatusTransition/Status.html#/s:14HyperwalletSDK0A16StatusTransitionV0C0O11unsuspendedyA2EmF":{"name":"unsuspended","abstract":"\u003cp\u003eThe status is not suspended.\u003c/p\u003e","parent_name":"Status"},"Structs/HyperwalletStatusTransition/Status.html#/s:14HyperwalletSDK0A16StatusTransitionV0C0O20verificationRequiredyA2EmF":{"name":"verificationRequired","abstract":"\u003cp\u003eThe status is verification required\u003c/p\u003e","parent_name":"Status"},"Structs/HyperwalletStatusTransition/Status.html#/s:14HyperwalletSDK0A16StatusTransitionV0C0O8verifiedyA2EmF":{"name":"verified","abstract":"\u003cp\u003eThe status is verified.\u003c/p\u003e","parent_name":"Status"},"Structs/HyperwalletStatusTransition.html#/s:14HyperwalletSDK0A16StatusTransitionV9createdOnSSSgvp":{"name":"createdOn","abstract":"\u003cp\u003eThe datetime the status changed in ISO 8601 format (YYYY-MM-DDThh:mm:ss). Note that the timezone used is UTC,","parent_name":"HyperwalletStatusTransition"},"Structs/HyperwalletStatusTransition.html#/s:14HyperwalletSDK0A16StatusTransitionV04fromC0AC0C0OSgvp":{"name":"fromStatus","abstract":"\u003cp\u003eThe status before the transition.\u003c/p\u003e","parent_name":"HyperwalletStatusTransition"},"Structs/HyperwalletStatusTransition.html#/s:14HyperwalletSDK0A16StatusTransitionV5notesSSSgvp":{"name":"notes","abstract":"\u003cp\u003eComments regarding the status change.\u003c/p\u003e","parent_name":"HyperwalletStatusTransition"},"Structs/HyperwalletStatusTransition.html#/s:14HyperwalletSDK0A16StatusTransitionV5tokenSSSgvp":{"name":"token","abstract":"\u003cp\u003eThe unique, auto-generated status transition identifier.\u003c/p\u003e","parent_name":"HyperwalletStatusTransition"},"Structs/HyperwalletStatusTransition.html#/s:14HyperwalletSDK0A16StatusTransitionV02toC0AC0C0OSgvp":{"name":"toStatus","abstract":"\u003cp\u003eThe status after the transition.\u003c/p\u003e","parent_name":"HyperwalletStatusTransition"},"Structs/HyperwalletStatusTransition.html#/s:14HyperwalletSDK0A16StatusTransitionV10transitionAC0C0OSgvp":{"name":"transition","abstract":"\u003cp\u003eThe new status of the resource.\u003c/p\u003e","parent_name":"HyperwalletStatusTransition"},"Structs/HyperwalletStatusTransition/Status.html":{"name":"Status","abstract":"\u003cp\u003eRepresentation of the status.\u003c/p\u003e","parent_name":"HyperwalletStatusTransition"},"Structs/HyperwalletStatusTransition/Builder.html":{"name":"Builder","abstract":"\u003cp\u003eA helper class to build the \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbStructs/HyperwalletStatusTransition.html\"\u003eHyperwalletStatusTransition\u003c/a\u003e\u003c/code\u003e instance.\u003c/p\u003e","parent_name":"HyperwalletStatusTransition"},"Structs/HyperwalletReceipt/HyperwalletEntryType.html#/s:14HyperwalletSDK0A7ReceiptV0A9EntryTypeO6credityA2EmF":{"name":"credit","abstract":"\u003cp\u003eThe credit entry type\u003c/p\u003e","parent_name":"HyperwalletEntryType"},"Structs/HyperwalletReceipt/HyperwalletEntryType.html#/s:14HyperwalletSDK0A7ReceiptV0A9EntryTypeO5debityA2EmF":{"name":"debit","abstract":"\u003cp\u003eThe debit entry type\u003c/p\u003e","parent_name":"HyperwalletEntryType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO9annualFeeyA2EmF":{"name":"annualFee","abstract":"\u003cp\u003eThe annual fee\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO15annualFeeRefundyA2EmF":{"name":"annualFeeRefund","abstract":"\u003cp\u003eThe annual fee refund\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO18customerServiceFeeyA2EmF":{"name":"customerServiceFee","abstract":"\u003cp\u003eThe customer service fee\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO24customerServiceFeeRefundyA2EmF":{"name":"customerServiceFeeRefund","abstract":"\u003cp\u003eThe customer service fee refund\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO20expeditedShippingFeeyA2EmF":{"name":"expeditedShippingFee","abstract":"\u003cp\u003eThe expedited shipping fee\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO16genericFeeRefundyA2EmF":{"name":"genericFeeRefund","abstract":"\u003cp\u003eThe generic fee refund\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO10monthlyFeeyA2EmF":{"name":"monthlyFee","abstract":"\u003cp\u003eThe monthly fee\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO16monthlyFeeRefundyA2EmF":{"name":"monthlyFeeRefund","abstract":"\u003cp\u003eThe monthly fee refund\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO16paymentExpiryFeeyA2EmF":{"name":"paymentExpiryFee","abstract":"\u003cp\u003eThe payment expiry fee\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO10paymentFeeyA2EmF":{"name":"paymentFee","abstract":"\u003cp\u003eThe payment fee\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO13processingFeeyA2EmF":{"name":"processingFee","abstract":"\u003cp\u003eThe processing fee\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO19standardShippingFeeyA2EmF":{"name":"standardShippingFee","abstract":"\u003cp\u003eThe standard shipping fee\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO11transferFeeyA2EmF":{"name":"transferFee","abstract":"\u003cp\u003eThe transfer fee\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO10adjustmentyA2EmF":{"name":"adjustment","abstract":"\u003cp\u003eThe adjustment\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO7deposityA2EmF":{"name":"deposit","abstract":"\u003cp\u003eThe deposit\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO15foreignExchangeyA2EmF":{"name":"foreignExchange","abstract":"\u003cp\u003eThe foreign exchange\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO16manualAdjustmentyA2EmF":{"name":"manualAdjustment","abstract":"\u003cp\u003eThe manual adjustment\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO17paymentExpirationyA2EmF":{"name":"paymentExpiration","abstract":"\u003cp\u003eThe payment expiration\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO22bankAccountTransferFeeyA2EmF":{"name":"bankAccountTransferFee","abstract":"\u003cp\u003eThe bank account transfer fee\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO25bankAccountTransferReturnyA2EmF":{"name":"bankAccountTransferReturn","abstract":"\u003cp\u003eThe bank account transfer return\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO28bankAccountTransferReturnFeeyA2EmF":{"name":"bankAccountTransferReturnFee","abstract":"\u003cp\u003eThe bank account transfer return fee\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO21transferToBankAccountyA2EmF":{"name":"transferToBankAccount","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO17cardActivationFeeyA2EmF":{"name":"cardActivationFee","abstract":"\u003cp\u003eThe card activation fee\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO23cardActivationFeeWaiveryA2EmF":{"name":"cardActivationFeeWaiver","abstract":"\u003cp\u003eThe card activation fee waiver\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO7cardFeeyA2EmF":{"name":"cardFee","abstract":"\u003cp\u003eThe card fee\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO27manualTransferToPrepaidCardyA2EmF":{"name":"manualTransferToPrepaidCard","abstract":"\u003cp\u003eThe manual transfer to prepaid card\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO28prepaidCardBalanceInquiryFeeyA2EmF":{"name":"prepaidCardBalanceInquiryFee","abstract":"\u003cp\u003eThe prepaid card balance inquiry fee\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO22prepaidCardCashAdvanceyA2EmF":{"name":"prepaidCardCashAdvance","abstract":"\u003cp\u003eThe prepaid card cash advance\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO31prepaidCardDisputedChargeRefundyA2EmF":{"name":"prepaidCardDisputedChargeRefund","abstract":"\u003cp\u003eThe prepaid card disputed charge refund\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO25prepaidCardDisputeDeposityA2EmF":{"name":"prepaidCardDisputeDeposit","abstract":"\u003cp\u003eThe prepaid card dispute deposit\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO36prepaidCardDomesticCashWithdrawalFeeyA2EmF":{"name":"prepaidCardDomesticCashWithdrawalFee","abstract":"\u003cp\u003eThe prepaid card domestic cash withdrawal fee\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO33prepaidCardExchangeRateDifferenceyA2EmF":{"name":"prepaidCardExchangeRateDifference","abstract":"\u003cp\u003eThe prepaid card exchange rate difference\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO23prepaidCardManualUnloadyA2EmF":{"name":"prepaidCardManualUnload","abstract":"\u003cp\u003eThe prepaid card manual unload\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO36prepaidCardOverseasCashWithdrawalFeeyA2EmF":{"name":"prepaidCardOverseasCashWithdrawalFee","abstract":"\u003cp\u003eThe prepaid card overseas cash withdrawal fee\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO23prepaidCardPinChangeFeeyA2EmF":{"name":"prepaidCardPinChangeFee","abstract":"\u003cp\u003eThe prepaid card pin change fee\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO17prepaidCardRefundyA2EmF":{"name":"prepaidCardRefund","abstract":"\u003cp\u003eThe prepaid card refund\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO25prepaidCardReplacementFeeyA2EmF":{"name":"prepaidCardReplacementFee","abstract":"\u003cp\u003eThe prepaid card replacement fee\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO23prepaidCardSaleReversalyA2EmF":{"name":"prepaidCardSaleReversal","abstract":"\u003cp\u003eThe prepaid card sale reversal\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO17prepaidCardUnloadyA2EmF":{"name":"prepaidCardUnload","abstract":"\u003cp\u003eThe prepaid card unload\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO19transferToDebitCardyA2EmF":{"name":"transferToDebitCard","abstract":"\u003cp\u003eThe transfer to debit card\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO21transferToPrepaidCardyA2EmF":{"name":"transferToPrepaidCard","abstract":"\u003cp\u003eThe transfer to prepaid card\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO25prepaidCardAccountDeposityA2EmF":{"name":"prepaidCardAccountDeposit","abstract":"\u003cp\u003eThe prepaid card account deposit\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO21prepaidCardAccountFeeyA2EmF":{"name":"prepaidCardAccountFee","abstract":"\u003cp\u003eThe prepaid card account fee\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO28prepaidCardAnnualFeeDiscountyA2EmF":{"name":"prepaidCardAnnualFeeDiscount","abstract":"\u003cp\u003eThe prepaid card annual fee discount\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO25prepaidCardBillReprintFeeyA2EmF":{"name":"prepaidCardBillReprintFee","abstract":"\u003cp\u003eThe prepaid card bill reprint fee\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO30prepaidCardAtmOrCashAdvanceFeeyA2EmF":{"name":"prepaidCardAtmOrCashAdvanceFee","abstract":"\u003cp\u003eThe prepaid card atm or cash advance fee\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO32prepaidCardCashAdvanceChargebackyA2EmF":{"name":"prepaidCardCashAdvanceChargeback","abstract":"\u003cp\u003eThe prepaid card cash advance chargeback\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO40prepaidCardCashAdvanceChargebackReversalyA2EmF":{"name":"prepaidCardCashAdvanceChargebackReversal","abstract":"\u003cp\u003eThe prepaid card cash advance chargeback reversal\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO29prepaidCardCashAdvanceRepressyA2EmF":{"name":"prepaidCardCashAdvanceRepress","abstract":"\u003cp\u003eThe prepaid card cash advance repress\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO37prepaidCardCashAdvanceRepressReversalyA2EmF":{"name":"prepaidCardCashAdvanceRepressReversal","abstract":"\u003cp\u003eThe prepaid card cash advance repress reversal\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO21prepaidCardChargebackyA2EmF":{"name":"prepaidCardChargeback","abstract":"\u003cp\u003eThe prepaid card chargeback\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO27prepaidCardChargebackRefundyA2EmF":{"name":"prepaidCardChargebackRefund","abstract":"\u003cp\u003eThe prepaid card chargeback refund\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO35prepaidCardChargebackRefundReversalyA2EmF":{"name":"prepaidCardChargebackRefundReversal","abstract":"\u003cp\u003eThe prepaid card chargeback refund reversal\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO29prepaidCardChargebackReversalyA2EmF":{"name":"prepaidCardChargebackReversal","abstract":"\u003cp\u003eThe prepaid card chargeback reversal\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO26prepaidCardCommissionOrFeeyA2EmF":{"name":"prepaidCardCommissionOrFee","abstract":"\u003cp\u003eThe prepaid card commission or fee\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO24prepaidCardDebitTransferyA2EmF":{"name":"prepaidCardDebitTransfer","abstract":"\u003cp\u003eThe prepaid card debit transfer\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO29prepaidCardDocumentRequestFeeyA2EmF":{"name":"prepaidCardDocumentRequestFee","abstract":"\u003cp\u003eThe prepaid card document request fee\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO24prepaidCardEmergencyCashyA2EmF":{"name":"prepaidCardEmergencyCash","abstract":"\u003cp\u003eThe prepaid card emergency cash\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO020prepaidCardEmergencyF0yA2EmF":{"name":"prepaidCardEmergencyCard","abstract":"\u003cp\u003eThe prepaid card emergency card\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO17prepaidCardIncomeyA2EmF":{"name":"prepaidCardIncome","abstract":"\u003cp\u003eThe prepaid card income\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO18prepaidCardLoadFeeyA2EmF":{"name":"prepaidCardLoadFee","abstract":"\u003cp\u003eThe prepaid card load fee\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO33prepaidCardOverduePaymentInterestyA2EmF":{"name":"prepaidCardOverduePaymentInterest","abstract":"\u003cp\u003eThe prepaid card overdue payment interest\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO18prepaidCardPaymentyA2EmF":{"name":"prepaidCardPayment","abstract":"\u003cp\u003eThe prepaid card payment\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO24prepaidCardPinReprintFeeyA2EmF":{"name":"prepaidCardPinReprintFee","abstract":"\u003cp\u003eThe prepaid card pin reprint fee\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO26prepaidCardPriorityPassFeeyA2EmF":{"name":"prepaidCardPriorityPassFee","abstract":"\u003cp\u003eThe prepaid card priority pass fee\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO30prepaidCardPriorityPassRenewalyA2EmF":{"name":"prepaidCardPriorityPassRenewal","abstract":"\u003cp\u003eThe prepaid card priority pass renewal\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO28prepaidCardRecurringInterestyA2EmF":{"name":"prepaidCardRecurringInterest","abstract":"\u003cp\u003eThe prepaid card recurring interest\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO24prepaidCardRefundRepressyA2EmF":{"name":"prepaidCardRefundRepress","abstract":"\u003cp\u003eThe prepaid card refund repress\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO32prepaidCardRefundRepressReversalyA2EmF":{"name":"prepaidCardRefundRepressReversal","abstract":"\u003cp\u003eThe prepaid card refund repress reversal\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO23prepaidCardStatementFeeyA2EmF":{"name":"prepaidCardStatementFee","abstract":"\u003cp\u003eThe prepaid card statement fee\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO30prepaidCardTelephoneSupportFeeyA2EmF":{"name":"prepaidCardTelephoneSupportFee","abstract":"\u003cp\u003eThe prepaid card telephone support fee\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO22prepaidCardTransferFeeyA2EmF":{"name":"prepaidCardTransferFee","abstract":"\u003cp\u003eThe prepaid card transfer fee\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO25prepaidCardTransferReturnyA2EmF":{"name":"prepaidCardTransferReturn","abstract":"\u003cp\u003eThe prepaid card transfer return\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO35prepaidCardBankWithdrawalChargebackyA2EmF":{"name":"prepaidCardBankWithdrawalChargeback","abstract":"\u003cp\u003eThe prepaid card bank withdrawal chargeback\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO20prepaidCardRefundfeeyA2EmF":{"name":"prepaidCardRefundfee","abstract":"\u003cp\u003eThe prepaid card refund fee\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO32prepaidCardMonthlyMaintenanceFeeyA2EmF":{"name":"prepaidCardMonthlyMaintenanceFee","abstract":"\u003cp\u003eThe prepaid card monthly maintenance fee\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO25prepaidCardTransactionFeeyA2EmF":{"name":"prepaidCardTransactionFee","abstract":"\u003cp\u003eThe prepaid card transaction fee\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO17prepaidCardSmsFeeyA2EmF":{"name":"prepaidCardSmsFee","abstract":"\u003cp\u003eThe prepaid card sms fee\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO35prepaidCardDeclinedAuthorizationFeeyA2EmF":{"name":"prepaidCardDeclinedAuthorizationFee","abstract":"\u003cp\u003eThe prepaid card declined authorization fee\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO5fispcyA2EmF":{"name":"fispc","abstract":"\u003cp\u003eThe prepaid card purchases\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO8donationyA2EmF":{"name":"donation","abstract":"\u003cp\u003eThe donation\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO11donationFeeyA2EmF":{"name":"donationFee","abstract":"\u003cp\u003eThe donation fee\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO14donationReturnyA2EmF":{"name":"donationReturn","abstract":"\u003cp\u003eThe donation return\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO15merchantPaymentyA2EmF":{"name":"merchantPayment","abstract":"\u003cp\u003eThe merchant payment\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO18merchantPaymentFeeyA2EmF":{"name":"merchantPaymentFee","abstract":"\u003cp\u003eThe merchant payment fee\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO21merchantPaymentRefundyA2EmF":{"name":"merchantPaymentRefund","abstract":"\u003cp\u003eThe merchant payment refund\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO21merchantPaymentReturnyA2EmF":{"name":"merchantPaymentReturn","abstract":"\u003cp\u003eThe merchant payment return\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO23moneygramTransferReturnyA2EmF":{"name":"moneygramTransferReturn","abstract":"\u003cp\u003eThe money gram transfer return\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO19transferToMoneygramyA2EmF":{"name":"transferToMoneygram","abstract":"\u003cp\u003eThe transfer to money gram\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO13paperCheckFeeyA2EmF":{"name":"paperCheckFee","abstract":"\u003cp\u003eThe paper check fee\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO16paperCheckRefundyA2EmF":{"name":"paperCheckRefund","abstract":"\u003cp\u003eThe paper check refund\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO20transferToPaperCheckyA2EmF":{"name":"transferToPaperCheck","abstract":"\u003cp\u003eThe transfer to paper check\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO14accountClosureyA2EmF":{"name":"accountClosure","abstract":"\u003cp\u003eThe account to be closed\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO17accountClosureFeeyA2EmF":{"name":"accountClosureFee","abstract":"\u003cp\u003eThe account closure fee\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO13accountUnloadyA2EmF":{"name":"accountUnload","abstract":"\u003cp\u003eThe account unload\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO14dormantUserFeeyA2EmF":{"name":"dormantUserFee","abstract":"\u003cp\u003eThe dormant user fee\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO20dormantUserFeeRefundyA2EmF":{"name":"dormantUserFeeRefund","abstract":"\u003cp\u003eThe dormant user fee refund\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO7paymentyA2EmF":{"name":"payment","abstract":"\u003cp\u003eThe payment\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO19paymentCancellationyA2EmF":{"name":"paymentCancellation","abstract":"\u003cp\u003eThe payment cancellation\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO15paymentReversalyA2EmF":{"name":"paymentReversal","abstract":"\u003cp\u003eThe payment reversal\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO18paymentReversalFeeyA2EmF":{"name":"paymentReversalFee","abstract":"\u003cp\u003eThe payment reversal fee\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO13paymentReturnyA2EmF":{"name":"paymentReturn","abstract":"\u003cp\u003eThe payment return\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO24transferToProgramAccountyA2EmF":{"name":"transferToProgramAccount","abstract":"\u003cp\u003eThe transfer to program account\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO14transferToUseryA2EmF":{"name":"transferToUser","abstract":"\u003cp\u003eThe transfer to user\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO28virtualIncentiveCancellationyA2EmF":{"name":"virtualIncentiveCancellation","abstract":"\u003cp\u003eThe virtual incentive cancellation\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO24virtualIncentiveIssuanceyA2EmF":{"name":"virtualIncentiveIssuance","abstract":"\u003cp\u003eThe virtual incentive issuance\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO24virtualIncentivePurchaseyA2EmF":{"name":"virtualIncentivePurchase","abstract":"\u003cp\u003eThe virtual incentive purchase\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO22virtualIncentiveRefundyA2EmF":{"name":"virtualIncentiveRefund","abstract":"\u003cp\u003eThe virtual incentive refund\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO22transferToWesternUnionyA2EmF":{"name":"transferToWesternUnion","abstract":"\u003cp\u003eThe transfer to western union\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO18transferToWubsWireyA2EmF":{"name":"transferToWubsWire","abstract":"\u003cp\u003eThe transfer to wubs wire\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO26westernUnionTransferReturnyA2EmF":{"name":"westernUnionTransferReturn","abstract":"\u003cp\u003eThe western union transfer return\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO22wubsWireTransferReturnyA2EmF":{"name":"wubsWireTransferReturn","abstract":"\u003cp\u003eThe wubs wire transfer return\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO14transferToWireyA2EmF":{"name":"transferToWire","abstract":"\u003cp\u003eThe transfer to Wire\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO15wireTransferFeeyA2EmF":{"name":"wireTransferFee","abstract":"\u003cp\u003eThe wire transfer fee\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO18wireTransferReturnyA2EmF":{"name":"wireTransferReturn","abstract":"\u003cp\u003eThe wire transfer return\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO15prepaidCardSaleyA2EmF":{"name":"prepaidCardSale","abstract":"\u003cp\u003eThe prepaid card sale\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO23transferToPayPalAccountyA2EmF":{"name":"transferToPayPalAccount","abstract":"\u003cp\u003eTransfer to PayPal account\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO27paypalAccountTransferReturnyA2EmF":{"name":"paypalAccountTransferReturn","abstract":"\u003cp\u003eReturn to Paypal Account\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO22transferToVenmoAccountyA2EmF":{"name":"transferToVenmoAccount","abstract":"\u003cp\u003eTransfer to Venmo account\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO26venmoAccountTransferReturnyA2EmF":{"name":"venmoAccountTransferReturn","abstract":"\u003cp\u003eReturn to Venmo account\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO18transferToBankCardyA2EmF":{"name":"transferToBankCard","abstract":"\u003cp\u003eTransfer To Bank Card\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO7unknownyA2EmF":{"name":"unknown","abstract":"\u003cp\u003eDefault - unknown transfer type\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO4fromAEs7Decoder_p_tKcfc":{"name":"init(from:)","abstract":"\u003cp\u003eA safe initializer for creating a HyperwalletReceiptType object\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt.html#/s:14HyperwalletSDK0A7ReceiptV6amountSSSgvp":{"name":"amount","abstract":"\u003cp\u003eThe gross amount of the transaction.\u003c/p\u003e","parent_name":"HyperwalletReceipt"},"Structs/HyperwalletReceipt.html#/s:14HyperwalletSDK0A7ReceiptV9createdOnSSSgvp":{"name":"createdOn","abstract":"\u003cp\u003eThe datetime the transaction was created on in ISO 8601 format \u0026lsquo;YYYY-MM-DDThh:mm:ss\u0026rsquo; (UTC timezone)\u003c/p\u003e","parent_name":"HyperwalletReceipt"},"Structs/HyperwalletReceipt.html#/s:14HyperwalletSDK0A7ReceiptV8currencySSSgvp":{"name":"currency","abstract":"\u003cp\u003eThe 3-letter currency code for the transaction.\u003c/p\u003e","parent_name":"HyperwalletReceipt"},"Structs/HyperwalletReceipt.html#/s:14HyperwalletSDK0A7ReceiptV16destinationTokenSSSgvp":{"name":"destinationToken","abstract":"\u003cp\u003eA token identifying where the funds were sent.\u003c/p\u003e","parent_name":"HyperwalletReceipt"},"Structs/HyperwalletReceipt.html#/s:14HyperwalletSDK0A7ReceiptV7detailsAA0aC7DetailsVSgvp":{"name":"details","abstract":"\u003cp\u003eDetails of the transaction.\u003c/p\u003e","parent_name":"HyperwalletReceipt"},"Structs/HyperwalletReceipt.html#/s:14HyperwalletSDK0A7ReceiptV5entryAC0A9EntryTypeOSgvp":{"name":"entry","abstract":"\u003cp\u003eThe type of transaction.\u003c/p\u003e","parent_name":"HyperwalletReceipt"},"Structs/HyperwalletReceipt.html#/s:14HyperwalletSDK0A7ReceiptV3feeSSSgvp":{"name":"fee","abstract":"\u003cp\u003eThe fee amount.\u003c/p\u003e","parent_name":"HyperwalletReceipt"},"Structs/HyperwalletReceipt.html#/s:14HyperwalletSDK0A7ReceiptV23foreignExchangeCurrencySSSgvp":{"name":"foreignExchangeCurrency","abstract":"\u003cp\u003eThe 3-letter currency code for the foreign exchange.\u003c/p\u003e","parent_name":"HyperwalletReceipt"},"Structs/HyperwalletReceipt.html#/s:14HyperwalletSDK0A7ReceiptV19foreignExchangeRateSSSgvp":{"name":"foreignExchangeRate","abstract":"\u003cp\u003eThe foreign exchange rate.\u003c/p\u003e","parent_name":"HyperwalletReceipt"},"Structs/HyperwalletReceipt.html#/s:14HyperwalletSDK0A7ReceiptV9journalIdSSSgvp":{"name":"journalId","abstract":"\u003cp\u003eThe journal entry number for the transaction.\u003c/p\u003e","parent_name":"HyperwalletReceipt"},"Structs/HyperwalletReceipt.html#/s:14HyperwalletSDK0A7ReceiptV11sourceTokenSSSgvp":{"name":"sourceToken","abstract":"\u003cp\u003eA token identifying the source of funds.\u003c/p\u003e","parent_name":"HyperwalletReceipt"},"Structs/HyperwalletReceipt.html#/s:14HyperwalletSDK0A7ReceiptV4typeAC0aC4TypeOSgvp":{"name":"type","abstract":"\u003cp\u003eThe transaction type.\u003c/p\u003e","parent_name":"HyperwalletReceipt"},"Structs/HyperwalletReceipt.html#/s:SQ2eeoiySbx_xtFZ":{"name":"==(_:_:)","parent_name":"HyperwalletReceipt"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html":{"name":"HyperwalletReceiptType","abstract":"\u003cp\u003eThe transaction type.\u003c/p\u003e","parent_name":"HyperwalletReceipt"},"Structs/HyperwalletReceipt/HyperwalletEntryType.html":{"name":"HyperwalletEntryType","abstract":"\u003cp\u003eThe entry type.\u003c/p\u003e","parent_name":"HyperwalletReceipt"},"Structs/HyperwalletReceiptDetails.html#/s:14HyperwalletSDK0A14ReceiptDetailsV13bankAccountIdSSSgvp":{"name":"bankAccountId","abstract":"\u003cp\u003eThe bank account number, IBAN or equivalent\u003c/p\u003e","parent_name":"HyperwalletReceiptDetails"},"Structs/HyperwalletReceiptDetails.html#/s:14HyperwalletSDK0A14ReceiptDetailsV18bankAccountPurposeSSSgvp":{"name":"bankAccountPurpose","abstract":"\u003cp\u003eThe bank account type, e.g. CHECKING or SAVINGS\u003c/p\u003e","parent_name":"HyperwalletReceiptDetails"},"Structs/HyperwalletReceiptDetails.html#/s:14HyperwalletSDK0A14ReceiptDetailsV6bankIdSSSgvp":{"name":"bankId","abstract":"\u003cp\u003eThe bank code, BIC/SWIFT or equivalent\u003c/p\u003e","parent_name":"HyperwalletReceiptDetails"},"Structs/HyperwalletReceiptDetails.html#/s:14HyperwalletSDK0A14ReceiptDetailsV8bankNameSSSgvp":{"name":"bankName","abstract":"\u003cp\u003eThe bank name\u003c/p\u003e","parent_name":"HyperwalletReceiptDetails"},"Structs/HyperwalletReceiptDetails.html#/s:14HyperwalletSDK0A14ReceiptDetailsV18branchAddressLine1SSSgvp":{"name":"branchAddressLine1","abstract":"\u003cp\u003eThe branch address, first line\u003c/p\u003e","parent_name":"HyperwalletReceiptDetails"},"Structs/HyperwalletReceiptDetails.html#/s:14HyperwalletSDK0A14ReceiptDetailsV18branchAddressLine2SSSgvp":{"name":"branchAddressLine2","abstract":"\u003cp\u003eThe branch address, second line\u003c/p\u003e","parent_name":"HyperwalletReceiptDetails"},"Structs/HyperwalletReceiptDetails.html#/s:14HyperwalletSDK0A14ReceiptDetailsV10branchCitySSSgvp":{"name":"branchCity","abstract":"\u003cp\u003eThe branch city\u003c/p\u003e","parent_name":"HyperwalletReceiptDetails"},"Structs/HyperwalletReceiptDetails.html#/s:14HyperwalletSDK0A14ReceiptDetailsV13branchCountrySSSgvp":{"name":"branchCountry","abstract":"\u003cp\u003eThe 2-letter country code of the branch\u003c/p\u003e","parent_name":"HyperwalletReceiptDetails"},"Structs/HyperwalletReceiptDetails.html#/s:14HyperwalletSDK0A14ReceiptDetailsV8branchIdSSSgvp":{"name":"branchId","abstract":"\u003cp\u003eThe branch code or equivalent\u003c/p\u003e","parent_name":"HyperwalletReceiptDetails"},"Structs/HyperwalletReceiptDetails.html#/s:14HyperwalletSDK0A14ReceiptDetailsV10branchNameSSSgvp":{"name":"branchName","abstract":"\u003cp\u003eThe branch name\u003c/p\u003e","parent_name":"HyperwalletReceiptDetails"},"Structs/HyperwalletReceiptDetails.html#/s:14HyperwalletSDK0A14ReceiptDetailsV16branchPostalCodeSSSgvp":{"name":"branchPostalCode","abstract":"\u003cp\u003eThe branch postal code\u003c/p\u003e","parent_name":"HyperwalletReceiptDetails"},"Structs/HyperwalletReceiptDetails.html#/s:14HyperwalletSDK0A14ReceiptDetailsV19branchStateProvinceSSSgvp":{"name":"branchStateProvince","abstract":"\u003cp\u003eThe branch state or province\u003c/p\u003e","parent_name":"HyperwalletReceiptDetails"},"Structs/HyperwalletReceiptDetails.html#/s:14HyperwalletSDK0A14ReceiptDetailsV14cardExpiryDateSSSgvp":{"name":"cardExpiryDate","abstract":"\u003cp\u003eThe card expiry date in YYYY-MM format\u003c/p\u003e","parent_name":"HyperwalletReceiptDetails"},"Structs/HyperwalletReceiptDetails.html#/s:14HyperwalletSDK0A14ReceiptDetailsV14cardHolderNameSSSgvp":{"name":"cardHolderName","abstract":"\u003cp\u003eThe card holder\u0026rsquo;s full name\u003c/p\u003e","parent_name":"HyperwalletReceiptDetails"},"Structs/HyperwalletReceiptDetails.html#/s:14HyperwalletSDK0A14ReceiptDetailsV10cardNumberSSSgvp":{"name":"cardNumber","abstract":"\u003cp\u003eThe card number\u003c/p\u003e","parent_name":"HyperwalletReceiptDetails"},"Structs/HyperwalletReceiptDetails.html#/s:14HyperwalletSDK0A14ReceiptDetailsV11charityNameSSSgvp":{"name":"charityName","abstract":"\u003cp\u003eThe name of the charity that is receiving the donation\u003c/p\u003e","parent_name":"HyperwalletReceiptDetails"},"Structs/HyperwalletReceiptDetails.html#/s:14HyperwalletSDK0A14ReceiptDetailsV11checkNumberSSSgvp":{"name":"checkNumber","abstract":"\u003cp\u003eThe paper check number\u003c/p\u003e","parent_name":"HyperwalletReceiptDetails"},"Structs/HyperwalletReceiptDetails.html#/s:14HyperwalletSDK0A14ReceiptDetailsV15clientPaymentIdSSSgvp":{"name":"clientPaymentId","abstract":"\u003cp\u003eThe client-assigned transaction identifier\u003c/p\u003e","parent_name":"HyperwalletReceiptDetails"},"Structs/HyperwalletReceiptDetails.html#/s:14HyperwalletSDK0A14ReceiptDetailsV4memoSSSgvp":{"name":"memo","abstract":"\u003cp\u003eAn internal note added by a client operator\u003c/p\u003e","parent_name":"HyperwalletReceiptDetails"},"Structs/HyperwalletReceiptDetails.html#/s:14HyperwalletSDK0A14ReceiptDetailsV5notesSSSgvp":{"name":"notes","abstract":"\u003cp\u003eA description for the receipt\u003c/p\u003e","parent_name":"HyperwalletReceiptDetails"},"Structs/HyperwalletReceiptDetails.html#/s:14HyperwalletSDK0A14ReceiptDetailsV17payeeAddressLine1SSSgvp":{"name":"payeeAddressLine1","abstract":"\u003cp\u003eThe payee\u0026rsquo;s address first line\u003c/p\u003e","parent_name":"HyperwalletReceiptDetails"},"Structs/HyperwalletReceiptDetails.html#/s:14HyperwalletSDK0A14ReceiptDetailsV17payeeAddressLine2SSSgvp":{"name":"payeeAddressLine2","abstract":"\u003cp\u003eThe payee\u0026rsquo;s address, second line\u003c/p\u003e","parent_name":"HyperwalletReceiptDetails"},"Structs/HyperwalletReceiptDetails.html#/s:14HyperwalletSDK0A14ReceiptDetailsV9payeeCitySSSgvp":{"name":"payeeCity","abstract":"\u003cp\u003eThe payee\u0026rsquo;s city\u003c/p\u003e","parent_name":"HyperwalletReceiptDetails"},"Structs/HyperwalletReceiptDetails.html#/s:14HyperwalletSDK0A14ReceiptDetailsV12payeeCountrySSSgvp":{"name":"payeeCountry","abstract":"\u003cp\u003eThe payee\u0026rsquo;s 2-letter country code\u003c/p\u003e","parent_name":"HyperwalletReceiptDetails"},"Structs/HyperwalletReceiptDetails.html#/s:14HyperwalletSDK0A14ReceiptDetailsV10payeeEmailSSSgvp":{"name":"payeeEmail","abstract":"\u003cp\u003eThe payee\u0026rsquo;s email address on record\u003c/p\u003e","parent_name":"HyperwalletReceiptDetails"},"Structs/HyperwalletReceiptDetails.html#/s:14HyperwalletSDK0A14ReceiptDetailsV9payeeNameSSSgvp":{"name":"payeeName","abstract":"\u003cp\u003eThe payee\u0026rsquo;s full name\u003c/p\u003e","parent_name":"HyperwalletReceiptDetails"},"Structs/HyperwalletReceiptDetails.html#/s:14HyperwalletSDK0A14ReceiptDetailsV15payeePostalCodeSSSgvp":{"name":"payeePostalCode","abstract":"\u003cp\u003eThe payee\u0026rsquo;s postal code, ZIP code or equivalent\u003c/p\u003e","parent_name":"HyperwalletReceiptDetails"},"Structs/HyperwalletReceiptDetails.html#/s:14HyperwalletSDK0A14ReceiptDetailsV18payeeStateProvinceSSSgvp":{"name":"payeeStateProvince","abstract":"\u003cp\u003eThe payee\u0026rsquo;s state or province\u003c/p\u003e","parent_name":"HyperwalletReceiptDetails"},"Structs/HyperwalletReceiptDetails.html#/s:14HyperwalletSDK0A14ReceiptDetailsV9payerNameSSSgvp":{"name":"payerName","abstract":"\u003cp\u003eThe payer\u0026rsquo;s full name\u003c/p\u003e","parent_name":"HyperwalletReceiptDetails"},"Structs/HyperwalletReceiptDetails.html#/s:14HyperwalletSDK0A14ReceiptDetailsV17paymentExpiryDateSSSgvp":{"name":"paymentExpiryDate","abstract":"\u003cp\u003eThe payment expiry date in YYYY-MM-DD format\u003c/p\u003e","parent_name":"HyperwalletReceiptDetails"},"Structs/HyperwalletReceiptDetails.html#/s:14HyperwalletSDK0A14ReceiptDetailsV20returnOrRecallReasonSSSgvp":{"name":"returnOrRecallReason","abstract":"\u003cp\u003eThe reason for returning or recalling the payment\u003c/p\u003e","parent_name":"HyperwalletReceiptDetails"},"Structs/HyperwalletReceiptDetails.html#/s:14HyperwalletSDK0A14ReceiptDetailsV14securityAnswerSSSgvp":{"name":"securityAnswer","abstract":"\u003cp\u003eThe answer to the securityQuestion\u003c/p\u003e","parent_name":"HyperwalletReceiptDetails"},"Structs/HyperwalletReceiptDetails.html#/s:14HyperwalletSDK0A14ReceiptDetailsV16securityQuestionSSSgvp":{"name":"securityQuestion","abstract":"\u003cp\u003eA security question\u003c/p\u003e","parent_name":"HyperwalletReceiptDetails"},"Structs/HyperwalletReceiptDetails.html#/s:14HyperwalletSDK0A14ReceiptDetailsV7websiteSSSgvp":{"name":"website","abstract":"\u003cp\u003eThe URL of the client website where the virtual incentive was accrued\u003c/p\u003e","parent_name":"HyperwalletReceiptDetails"},"Structs/HyperwalletPageParameter.html#/s:14HyperwalletSDK0A13PageParameterV3relSSSgvp":{"name":"rel","abstract":"\u003cp\u003eThe relationship\u003c/p\u003e","parent_name":"HyperwalletPageParameter"},"Structs/HyperwalletPageLink.html#/s:14HyperwalletSDK0A8PageLinkV4href10Foundation3URLVSgvp":{"name":"href","abstract":"\u003cp\u003eThe URL of the link\u003c/p\u003e","parent_name":"HyperwalletPageLink"},"Structs/HyperwalletPageLink.html#/s:14HyperwalletSDK0A8PageLinkV6paramsAA0aC9ParameterVSgvp":{"name":"params","abstract":"\u003cp\u003eThe \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbStructs/HyperwalletPageParameter.html\"\u003eHyperwalletPageParameter\u003c/a\u003e\u003c/code\u003e\u003c/p\u003e","parent_name":"HyperwalletPageLink"},"Structs/HyperwalletPageList.html#/s:14HyperwalletSDK0A8PageListV5countSiSgvp":{"name":"count","abstract":"\u003cp\u003eThe amount of the dataset\u003c/p\u003e","parent_name":"HyperwalletPageList"},"Structs/HyperwalletPageList.html#/s:14HyperwalletSDK0A8PageListV4dataSayxGSgvp":{"name":"data","abstract":"\u003cp\u003eThe \u003ccode\u003eListType\u003c/code\u003e items\u003c/p\u003e","parent_name":"HyperwalletPageList"},"Structs/HyperwalletPageList.html#/s:14HyperwalletSDK0A8PageListV5limitSiSgvp":{"name":"limit","abstract":"\u003cp\u003eThe maximum number of records that will be returned per page\u003c/p\u003e","parent_name":"HyperwalletPageList"},"Structs/HyperwalletPageList.html#/s:14HyperwalletSDK0A8PageListV5linksSayAA0aC4LinkVGSgvp":{"name":"links","abstract":"\u003cp\u003eThe links\u003c/p\u003e","parent_name":"HyperwalletPageList"},"Structs/HyperwalletPageList.html#/s:14HyperwalletSDK0A8PageListV6offsetSiSgvp":{"name":"offset","abstract":"\u003cp\u003eThe number of records to skip.\u003c/p\u003e","parent_name":"HyperwalletPageList"},"Structs/HyperwalletTransferMethodUpdateConfigurationFieldQuery.html#/s:14HyperwalletSDK0A43TransferMethodUpdateConfigurationFieldQueryV08transferD5TokenACSS_tcfc":{"name":"init(transferMethodToken:)","abstract":"\u003cp\u003eCreate a new \u003ccode\u003eHyperwalletTransferMethodUpdateConfigurationFieldQuery\u003c/code\u003e from the transferMethodToken\u003c/p\u003e","parent_name":"HyperwalletTransferMethodUpdateConfigurationFieldQuery"},"Structs/HyperwalletTransferMethodUpdateConfigurationFieldQuery.html#/s:14HyperwalletSDK12GraphQlQueryP02tocD09userTokenS2S_tF":{"name":"toGraphQl(userToken:)","parent_name":"HyperwalletTransferMethodUpdateConfigurationFieldQuery"},"Structs/HyperwalletTransferMethodUpdateConfigurationFieldQuery.html#/s:SH4hash4intoys6HasherVz_tF":{"name":"hash(into:)","parent_name":"HyperwalletTransferMethodUpdateConfigurationFieldQuery"},"Structs/HyperwalletTransferMethodTypesFeesAndProcessingTimesQuery.html#/s:14HyperwalletSDK12GraphQlQueryP02tocD09userTokenS2S_tF":{"name":"toGraphQl(userToken:)","parent_name":"HyperwalletTransferMethodTypesFeesAndProcessingTimesQuery"},"Structs/HyperwalletTransferMethodTypesFeesAndProcessingTimesQuery.html#/s:SH4hash4intoys6HasherVz_tF":{"name":"hash(into:)","parent_name":"HyperwalletTransferMethodTypesFeesAndProcessingTimesQuery"},"Structs/HyperwalletTransferMethodConfigurationKeysQuery.html#/s:14HyperwalletSDK0A36TransferMethodConfigurationKeysQueryV5limitACSi_tcfc":{"name":"init(limit:)","abstract":"\u003cp\u003e/ Create a new \u003ccode\u003eHyperwalletTransferMethodConfigurationKeysQuery\u003c/code\u003e instance\u003c/p\u003e","parent_name":"HyperwalletTransferMethodConfigurationKeysQuery"},"Structs/HyperwalletTransferMethodConfigurationKeysQuery.html#/s:14HyperwalletSDK12GraphQlQueryP02tocD09userTokenS2S_tF":{"name":"toGraphQl(userToken:)","parent_name":"HyperwalletTransferMethodConfigurationKeysQuery"},"Structs/HyperwalletTransferMethodConfigurationFieldQuery.html#/s:14HyperwalletSDK0A37TransferMethodConfigurationFieldQueryV7country8currency08transferD4Type7profileACSS_S3Stcfc":{"name":"init(country:currency:transferMethodType:profile:)","abstract":"\u003cp\u003eCreate a new \u003ccode\u003eHyperwalletTransferMethodConfigurationQuery\u003c/code\u003e from the country, currency, transferMethodType","parent_name":"HyperwalletTransferMethodConfigurationFieldQuery"},"Structs/HyperwalletTransferMethodConfigurationFieldQuery.html#/s:14HyperwalletSDK12GraphQlQueryP02tocD09userTokenS2S_tF":{"name":"toGraphQl(userToken:)","parent_name":"HyperwalletTransferMethodConfigurationFieldQuery"},"Structs/HyperwalletTransferMethodConfigurationFieldQuery.html#/s:SH4hash4intoys6HasherVz_tF":{"name":"hash(into:)","parent_name":"HyperwalletTransferMethodConfigurationFieldQuery"},"Structs/HyperwalletConditionalPattern.html#/s:14HyperwalletSDK0A18ConditionalPatternV7patternSSvp":{"name":"pattern","abstract":"\u003cp\u003eThe pattern\u003c/p\u003e","parent_name":"HyperwalletConditionalPattern"},"Structs/HyperwalletConditionalPattern.html#/s:14HyperwalletSDK0A18ConditionalPatternV5regexSSvp":{"name":"regex","abstract":"\u003cp\u003eThe regex\u003c/p\u003e","parent_name":"HyperwalletConditionalPattern"},"Structs/HyperwalletMask.html#/s:14HyperwalletSDK0A4MaskV19conditionalPatternsSayAA0A18ConditionalPatternVGSgvp":{"name":"conditionalPatterns","abstract":"\u003cp\u003eThe conditional pattern, or nil if none exists\u003c/p\u003e","parent_name":"HyperwalletMask"},"Structs/HyperwalletMask.html#/s:14HyperwalletSDK0A4MaskV14defaultPatternSSvp":{"name":"defaultPattern","abstract":"\u003cp\u003eThe default pattern\u003c/p\u003e","parent_name":"HyperwalletMask"},"Structs/HyperwalletMask.html#/s:14HyperwalletSDK0A4MaskV10scrubRegexSSSgvp":{"name":"scrubRegex","abstract":"\u003cp\u003eThe scrub regex, or nil if none exists\u003c/p\u003e","parent_name":"HyperwalletMask"},"Structs/HyperwalletTransferMethodConfiguration.html#/s:14HyperwalletSDK0A27TransferMethodConfigurationV7countrySSSgvp":{"name":"country","abstract":"\u003cp\u003eThe country\u003c/p\u003e","parent_name":"HyperwalletTransferMethodConfiguration"},"Structs/HyperwalletTransferMethodConfiguration.html#/s:14HyperwalletSDK0A27TransferMethodConfigurationV8currencySSSgvp":{"name":"currency","abstract":"\u003cp\u003eThe currency\u003c/p\u003e","parent_name":"HyperwalletTransferMethodConfiguration"},"Structs/HyperwalletTransferMethodConfiguration.html#/s:14HyperwalletSDK0A27TransferMethodConfigurationV08transferD4TypeSSSgvp":{"name":"transferMethodType","abstract":"\u003cp\u003eThe transfer method type\u003c/p\u003e","parent_name":"HyperwalletTransferMethodConfiguration"},"Structs/HyperwalletTransferMethodConfiguration.html#/s:14HyperwalletSDK0A27TransferMethodConfigurationV7profileSSSgvp":{"name":"profile","abstract":"\u003cp\u003eThe profile type\u003c/p\u003e","parent_name":"HyperwalletTransferMethodConfiguration"},"Structs/HyperwalletTransferMethodConfiguration.html#/s:14HyperwalletSDK0A27TransferMethodConfigurationV11fieldGroupsAA10ConnectionVyAA0A10FieldGroupVGSgvp":{"name":"fieldGroups","abstract":"\u003cp\u003eThe \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbStructs/HyperwalletFieldGroup.html\"\u003eHyperwalletFieldGroup\u003c/a\u003e\u003c/code\u003e, or nil if none exists\u003c/p\u003e","parent_name":"HyperwalletTransferMethodConfiguration"},"Structs/HyperwalletValidationMessage.html#/s:14HyperwalletSDK0A17ValidationMessageV6lengthSSSgvp":{"name":"length","abstract":"\u003cp\u003eThe validation message length, or nil if none exists\u003c/p\u003e","parent_name":"HyperwalletValidationMessage"},"Structs/HyperwalletValidationMessage.html#/s:14HyperwalletSDK0A17ValidationMessageV7patternSSSgvp":{"name":"pattern","abstract":"\u003cp\u003eThe validation message pattern, or nil if none exists\u003c/p\u003e","parent_name":"HyperwalletValidationMessage"},"Structs/HyperwalletValidationMessage.html#/s:14HyperwalletSDK0A17ValidationMessageV5emptySSSgvp":{"name":"empty","abstract":"\u003cp\u003eThe validation message empty, or nil if none exists\u003c/p\u003e","parent_name":"HyperwalletValidationMessage"},"Structs/HyperwalletTransferMethodType.html#/s:14HyperwalletSDK0A18TransferMethodTypeV4codeSSSgvp":{"name":"code","abstract":"\u003cp\u003eThe country code\u003c/p\u003e","parent_name":"HyperwalletTransferMethodType"},"Structs/HyperwalletTransferMethodType.html#/s:14HyperwalletSDK0A18TransferMethodTypeV4nameSSSgvp":{"name":"name","abstract":"\u003cp\u003eThe country name\u003c/p\u003e","parent_name":"HyperwalletTransferMethodType"},"Structs/HyperwalletTransferMethodType.html#/s:14HyperwalletSDK0A18TransferMethodTypeV4feesAA10ConnectionVyAA0A3FeeVGSgvp":{"name":"fees","abstract":"\u003cp\u003eThe fees for transfer\u003c/p\u003e","parent_name":"HyperwalletTransferMethodType"},"Structs/HyperwalletTransferMethodType.html#/s:14HyperwalletSDK0A18TransferMethodTypeV15processingTimesAA10ConnectionVyAA0A14ProcessingTimeVGSgvp":{"name":"processingTimes","abstract":"\u003cp\u003eThe processing time for transfer\u003c/p\u003e","parent_name":"HyperwalletTransferMethodType"},"Structs/HyperwalletProcessingTime.html#/s:14HyperwalletSDK0A14ProcessingTimeV7countrySSSgvp":{"name":"country","abstract":"\u003cp\u003eThe country to process\u003c/p\u003e","parent_name":"HyperwalletProcessingTime"},"Structs/HyperwalletProcessingTime.html#/s:14HyperwalletSDK0A14ProcessingTimeV8currencySSSgvp":{"name":"currency","abstract":"\u003cp\u003eThe currency to process\u003c/p\u003e","parent_name":"HyperwalletProcessingTime"},"Structs/HyperwalletProcessingTime.html#/s:14HyperwalletSDK0A14ProcessingTimeV18transferMethodTypeSSSgvp":{"name":"transferMethodType","abstract":"\u003cp\u003eThe transfer method type\u003c/p\u003e","parent_name":"HyperwalletProcessingTime"},"Structs/HyperwalletProcessingTime.html#/s:14HyperwalletSDK0A14ProcessingTimeV5valueSSSgvp":{"name":"value","abstract":"\u003cp\u003eThe value to process\u003c/p\u003e","parent_name":"HyperwalletProcessingTime"},"Structs/HyperwalletFieldSelectionOption.html#/s:14HyperwalletSDK0A20FieldSelectionOptionV5labelSSSgvp":{"name":"label","abstract":"\u003cp\u003eThe label\u003c/p\u003e","parent_name":"HyperwalletFieldSelectionOption"},"Structs/HyperwalletFieldSelectionOption.html#/s:14HyperwalletSDK0A20FieldSelectionOptionV5valueSSSgvp":{"name":"value","abstract":"\u003cp\u003eThe value\u003c/p\u003e","parent_name":"HyperwalletFieldSelectionOption"},"Structs/HyperwalletFieldGroup.html#/s:14HyperwalletSDK0A10FieldGroupV5groupSSSgvp":{"name":"group","abstract":"\u003cp\u003eThe group\u003c/p\u003e","parent_name":"HyperwalletFieldGroup"},"Structs/HyperwalletFieldGroup.html#/s:14HyperwalletSDK0A10FieldGroupV6fieldsSayAA0aC0VGSgvp":{"name":"fields","abstract":"\u003cp\u003eThe list of HyperwalletField\u003c/p\u003e","parent_name":"HyperwalletFieldGroup"},"Structs/HyperwalletField.html#/s:14HyperwalletSDK0A5FieldV8dataTypeSSSgvp":{"name":"dataType","abstract":"\u003cp\u003eThe field data type, or nil if none exists\u003c/p\u003e","parent_name":"HyperwalletField"},"Structs/HyperwalletField.html#/s:14HyperwalletSDK0A5FieldV21fieldSelectionOptionsSayAA0acE6OptionVGSgvp":{"name":"fieldSelectionOptions","abstract":"\u003cp\u003eThe list of selection option, or nil if none exists\u003c/p\u003e","parent_name":"HyperwalletField"},"Structs/HyperwalletField.html#/s:14HyperwalletSDK0A5FieldV10isRequiredSbSgvp":{"name":"isRequired","abstract":"\u003cp\u003eIndicate if the field is mandatory, or nil if none exists\u003c/p\u003e","parent_name":"HyperwalletField"},"Structs/HyperwalletField.html#/s:14HyperwalletSDK0A5FieldV10isEditableSbSgvp":{"name":"isEditable","abstract":"\u003cp\u003eIndicate if the field is editable, or nil if none exists\u003c/p\u003e","parent_name":"HyperwalletField"},"Structs/HyperwalletField.html#/s:14HyperwalletSDK0A5FieldV5labelSSSgvp":{"name":"label","abstract":"\u003cp\u003eThe field label\u003c/p\u003e","parent_name":"HyperwalletField"},"Structs/HyperwalletField.html#/s:14HyperwalletSDK0A5FieldV9maxLengthSiSgvp":{"name":"maxLength","abstract":"\u003cp\u003eThe field maximum length, or nil if none exists\u003c/p\u003e","parent_name":"HyperwalletField"},"Structs/HyperwalletField.html#/s:14HyperwalletSDK0A5FieldV9minLengthSiSgvp":{"name":"minLength","abstract":"\u003cp\u003eThe field minimum length, or nil if none exists\u003c/p\u003e","parent_name":"HyperwalletField"},"Structs/HyperwalletField.html#/s:14HyperwalletSDK0A5FieldV4nameSSSgvp":{"name":"name","abstract":"\u003cp\u003eThe field name, or nil if none exists\u003c/p\u003e","parent_name":"HyperwalletField"},"Structs/HyperwalletField.html#/s:14HyperwalletSDK0A5FieldV11placeholderSSSgvp":{"name":"placeholder","abstract":"\u003cp\u003eThe field placeholder, or nil if none exists\u003c/p\u003e","parent_name":"HyperwalletField"},"Structs/HyperwalletField.html#/s:14HyperwalletSDK0A5FieldV17regularExpressionSSSgvp":{"name":"regularExpression","abstract":"\u003cp\u003eThe regular expression to validate the field value, or nil if none exists\u003c/p\u003e","parent_name":"HyperwalletField"},"Structs/HyperwalletField.html#/s:14HyperwalletSDK0A5FieldV17validationMessageAA0a10ValidationE0VSgvp":{"name":"validationMessage","abstract":"\u003cp\u003eThe validation message\u003c/p\u003e","parent_name":"HyperwalletField"},"Structs/HyperwalletField.html#/s:14HyperwalletSDK0A5FieldV5valueSSSgvp":{"name":"value","abstract":"\u003cp\u003eThe field value\u003c/p\u003e","parent_name":"HyperwalletField"},"Structs/HyperwalletField.html#/s:14HyperwalletSDK0A5FieldV4maskAA0A4MaskVSgvp":{"name":"mask","abstract":"\u003cp\u003eThe mask, or nil if none exists\u003c/p\u003e","parent_name":"HyperwalletField"},"Structs/HyperwalletField.html#/s:14HyperwalletSDK0A5FieldV16fieldValueMaskedSbSgvp":{"name":"fieldValueMasked","abstract":"\u003cp\u003eIndicate if the field is masked, or nil if none exists\u003c/p\u003e","parent_name":"HyperwalletField"},"Structs/HyperwalletFee.html#/s:14HyperwalletSDK0A3FeeV11feeRateTypeSSSgvp":{"name":"feeRateType","abstract":"\u003cp\u003eThe fee rate type (FLAT or PERCENT)\u003c/p\u003e","parent_name":"HyperwalletFee"},"Structs/HyperwalletFee.html#/s:14HyperwalletSDK0A3FeeV5valueSSSgvp":{"name":"value","abstract":"\u003cp\u003eThe fee value\u003c/p\u003e","parent_name":"HyperwalletFee"},"Structs/HyperwalletFee.html#/s:14HyperwalletSDK0A3FeeV8currencySSSgvp":{"name":"currency","abstract":"\u003cp\u003eThe fee currency\u003c/p\u003e","parent_name":"HyperwalletFee"},"Structs/HyperwalletFee.html#/s:14HyperwalletSDK0A3FeeV7minimumSSSgvp":{"name":"minimum","abstract":"\u003cp\u003eThe minimum fee, or nil if none exists\u003c/p\u003e","parent_name":"HyperwalletFee"},"Structs/HyperwalletFee.html#/s:14HyperwalletSDK0A3FeeV7maximumSSSgvp":{"name":"maximum","abstract":"\u003cp\u003eThe maximum fee, or nil if none exists\u003c/p\u003e","parent_name":"HyperwalletFee"},"Structs/HyperwalletCurrency.html#/s:14HyperwalletSDK0A8CurrencyV4codeSSSgvp":{"name":"code","abstract":"\u003cp\u003eThe 3 letter ISO 4217-1 currency code\u003c/p\u003e","parent_name":"HyperwalletCurrency"},"Structs/HyperwalletCurrency.html#/s:14HyperwalletSDK0A8CurrencyV4nameSSSgvp":{"name":"name","abstract":"\u003cp\u003eThe currency name\u003c/p\u003e","parent_name":"HyperwalletCurrency"},"Structs/HyperwalletCurrency.html#/s:14HyperwalletSDK0A8CurrencyV19transferMethodTypesAA10ConnectionVyAA0a8TransferE4TypeVGSgvp":{"name":"transferMethodTypes","abstract":"\u003cp\u003eThe \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbStructs/HyperwalletTransferMethodType.html\"\u003eHyperwalletTransferMethodType\u003c/a\u003e\u003c/code\u003e nodes that connect to this currency node\u003c/p\u003e","parent_name":"HyperwalletCurrency"},"Structs/HyperwalletCountry.html#/s:14HyperwalletSDK0A7CountryV4codeSSSgvp":{"name":"code","abstract":"\u003cp\u003eThe 2 letter ISO 3166-1 country code\u003c/p\u003e","parent_name":"HyperwalletCountry"},"Structs/HyperwalletCountry.html#/s:14HyperwalletSDK0A7CountryV4nameSSSgvp":{"name":"name","abstract":"\u003cp\u003eThe country name\u003c/p\u003e","parent_name":"HyperwalletCountry"},"Structs/HyperwalletCountry.html#/s:14HyperwalletSDK0A7CountryV10currenciesAA10ConnectionVyAA0A8CurrencyVGSgvp":{"name":"currencies","abstract":"\u003cp\u003eThe \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbStructs/HyperwalletCurrency.html\"\u003eHyperwalletCurrency\u003c/a\u003e\u003c/code\u003e nodes that connect to this country node\u003c/p\u003e","parent_name":"HyperwalletCountry"},"Structs/Connection.html#/s:14HyperwalletSDK10ConnectionV5nodesSayxGSgvp":{"name":"nodes","abstract":"\u003cp\u003eArray of Connection type\u003c/p\u003e","parent_name":"Connection"},"Structs/HyperwalletBalance.html#/s:14HyperwalletSDK0A7BalanceV8currencySSSgvp":{"name":"currency","abstract":"\u003cp\u003eThe currency of balance\u003c/p\u003e","parent_name":"HyperwalletBalance"},"Structs/HyperwalletBalance.html#/s:14HyperwalletSDK0A7BalanceV6amountSSSgvp":{"name":"amount","abstract":"\u003cp\u003eThe amount of balance\u003c/p\u003e","parent_name":"HyperwalletBalance"},"Structs/HyperwalletError.html#/s:14HyperwalletSDK0A5ErrorV7messageSSvp":{"name":"message","abstract":"\u003cp\u003eThe error message\u003c/p\u003e","parent_name":"HyperwalletError"},"Structs/HyperwalletError.html#/s:14HyperwalletSDK0A5ErrorV4codeSSvp":{"name":"code","abstract":"\u003cp\u003eThe error code\u003c/p\u003e","parent_name":"HyperwalletError"},"Structs/HyperwalletError.html#/s:14HyperwalletSDK0A5ErrorV9fieldNameSSSgvp":{"name":"fieldName","abstract":"\u003cp\u003eThe field name\u003c/p\u003e","parent_name":"HyperwalletError"},"Structs/HyperwalletError.html#/s:14HyperwalletSDK0A5ErrorV16relatedResourcesSaySSGSgvp":{"name":"relatedResources","abstract":"\u003cp\u003eThe list of related resources\u003c/p\u003e","parent_name":"HyperwalletError"},"Structs/HyperwalletError.html#/s:14HyperwalletSDK0A5ErrorV7message4code9fieldName16relatedResourcesACSS_S2SSgSaySSGSgtcfc":{"name":"init(message:code:fieldName:relatedResources:)","abstract":"\u003cp\u003eCreates an instance of HyperwalletError\u003c/p\u003e","parent_name":"HyperwalletError"},"Structs/HyperwalletErrors/CodingKeys.html#/s:14HyperwalletSDK0A6ErrorsV10CodingKeysO9errorListyA2EmF":{"name":"errorList","parent_name":"CodingKeys"},"Structs/HyperwalletErrors.html#/s:14HyperwalletSDK0A6ErrorsV9errorListSayAA0A5ErrorVGSgvp":{"name":"errorList","abstract":"\u003cp\u003eThe error list\u003c/p\u003e","parent_name":"HyperwalletErrors"},"Structs/HyperwalletErrors.html#/s:14HyperwalletSDK0A6ErrorsV13originalErrors0E0_pSgvp":{"name":"originalError","abstract":"\u003cp\u003eThe original error\u003c/p\u003e","parent_name":"HyperwalletErrors"},"Structs/HyperwalletErrors/CodingKeys.html":{"name":"CodingKeys","abstract":"\u003cp\u003eThe CodingKeys for Hyperwallet errors\u003c/p\u003e","parent_name":"HyperwalletErrors"},"Structs/HyperwalletErrors.html#/s:14HyperwalletSDK0A6ErrorsV9errorListACSayAA0A5ErrorVG_tcfc":{"name":"init(errorList:)","abstract":"\u003cp\u003eCreates an instance of HyperwalletErrors\u003c/p\u003e","parent_name":"HyperwalletErrors"},"Structs/HyperwalletErrors.html#/s:14HyperwalletSDK0A6ErrorsV9errorList13originalErrorACSayAA0aG0VG_s0G0_pSgtcfc":{"name":"init(errorList:originalError:)","abstract":"\u003cp\u003eCreates an instance of HyperwalletErrors\u003c/p\u003e","parent_name":"HyperwalletErrors"},"Structs/Configuration.html#/s:14HyperwalletSDK13ConfigurationV11environmentSSSgvp":{"name":"environment","abstract":"\u003cp\u003eThe environment type\u003c/p\u003e","parent_name":"Configuration"},"Structs/Configuration.html#/s:14HyperwalletSDK13ConfigurationV11insightsUrlSSSgvp":{"name":"insightsUrl","abstract":"\u003cp\u003eThe insights Url\u003c/p\u003e","parent_name":"Configuration"},"Structs/Configuration.html#/s:14HyperwalletSDK13ConfigurationV6issuerSSvp":{"name":"issuer","abstract":"\u003cp\u003eThe issuer\u003c/p\u003e","parent_name":"Configuration"},"Structs/Configuration.html#/s:14HyperwalletSDK13ConfigurationV9userTokenSSvp":{"name":"userToken","abstract":"\u003cp\u003eThe user token\u003c/p\u003e","parent_name":"Configuration"},"Structs/Configuration.html#/s:14HyperwalletSDK13ConfigurationV12programModelSSSgvp":{"name":"programModel","abstract":"\u003cp\u003eThe program model\u003c/p\u003e","parent_name":"Configuration"},"Structs/Configuration.html":{"name":"Configuration","abstract":"\u003cp\u003eConfiguration object retrieved on successful authentication\u003c/p\u003e"},"Structs/HyperwalletErrors.html":{"name":"HyperwalletErrors","abstract":"\u003cp\u003eRepresentation of the Hyperwallet error list\u003c/p\u003e"},"Structs/HyperwalletError.html":{"name":"HyperwalletError","abstract":"\u003cp\u003eRepresentation of the Hyperwallet error entity.\u003c/p\u003e"},"Structs/HyperwalletBalance.html":{"name":"HyperwalletBalance","abstract":"\u003cp\u003eDetails of the balance.\u003c/p\u003e"},"Structs/Connection.html":{"name":"Connection","abstract":"\u003cp\u003eRepresentation of the GraphQL\u0026rsquo;s Connection type\u003c/p\u003e"},"Structs/HyperwalletCountry.html":{"name":"HyperwalletCountry","abstract":"\u003cp\u003eRepresentation of a \u003ccode\u003eHyperwalletCountry\u003c/code\u003e node\u003c/p\u003e"},"Structs/HyperwalletCurrency.html":{"name":"HyperwalletCurrency","abstract":"\u003cp\u003eRepresentation of a \u003ccode\u003eHyperwalletCurrency\u003c/code\u003e node\u003c/p\u003e"},"Structs/HyperwalletFee.html":{"name":"HyperwalletFee","abstract":"\u003cp\u003eRepresentation of the fee\u003c/p\u003e"},"Structs/HyperwalletField.html":{"name":"HyperwalletField","abstract":"\u003cp\u003eRepresentation of the transfer method configuration field\u003c/p\u003e"},"Structs/HyperwalletFieldGroup.html":{"name":"HyperwalletFieldGroup","abstract":"\u003cp\u003eRepresentation of list of HyperwalletField and the group to which it belongs\u003c/p\u003e"},"Structs/HyperwalletFieldSelectionOption.html":{"name":"HyperwalletFieldSelectionOption","abstract":"\u003cp\u003eRepresentation of the transfer method configuration field selection option\u003c/p\u003e"},"Structs/HyperwalletProcessingTime.html":{"name":"HyperwalletProcessingTime","abstract":"\u003cp\u003eRepresentation of the transfer method configuration field processing times\u003c/p\u003e"},"Structs/HyperwalletTransferMethodType.html":{"name":"HyperwalletTransferMethodType","abstract":"\u003cp\u003eRepresentation of transfer method type\u003c/p\u003e"},"Structs/HyperwalletValidationMessage.html":{"name":"HyperwalletValidationMessage","abstract":"\u003cp\u003eRepresentation of the transfer method configuration field validation message\u003c/p\u003e"},"Structs/HyperwalletTransferMethodConfiguration.html":{"name":"HyperwalletTransferMethodConfiguration","abstract":"\u003cp\u003eRepresentation of the transfer method configuration\u003c/p\u003e"},"Structs/HyperwalletMask.html":{"name":"HyperwalletMask","abstract":"\u003cp\u003eRepresentation of the transfer method configuration field mask\u003c/p\u003e"},"Structs/HyperwalletConditionalPattern.html":{"name":"HyperwalletConditionalPattern","abstract":"\u003cp\u003eRepresentation of the transfer method configuration field conditionalPatterns\u003c/p\u003e"},"Structs/HyperwalletTransferMethodConfigurationFieldQuery.html":{"name":"HyperwalletTransferMethodConfigurationFieldQuery","abstract":"\u003cp\u003eThe \u003ccode\u003eHyperwalletTransferMethodConfigurationFieldQuery\u003c/code\u003e struct defines and builds a query to retrieve the fields"},"Structs/HyperwalletTransferMethodConfigurationKeysQuery.html":{"name":"HyperwalletTransferMethodConfigurationKeysQuery","abstract":"\u003cp\u003eThe \u0026lsquo;HyperwalletTransferMethodConfigurationKeysQuery\u0026rsquo; struct defines and builds a query to retrieve the key set"},"Structs/HyperwalletTransferMethodTypesFeesAndProcessingTimesQuery.html":{"name":"HyperwalletTransferMethodTypesFeesAndProcessingTimesQuery","abstract":"\u003cp\u003eThe \u0026lsquo;HyperwalletTransferMethodTypesFeesAndProcessingTimesQuery\u0026rsquo; struct defines"},"Structs/HyperwalletTransferMethodUpdateConfigurationFieldQuery.html":{"name":"HyperwalletTransferMethodUpdateConfigurationFieldQuery","abstract":"\u003cp\u003eThe \u003ccode\u003eHyperwalletTransferMethodUpdateConfigurationFieldQuery\u003c/code\u003e"},"Structs/HyperwalletPageList.html":{"name":"HyperwalletPageList","abstract":"\u003cp\u003eRepresentation of subset content from a dataset\u003c/p\u003e"},"Structs/HyperwalletPageLink.html":{"name":"HyperwalletPageLink","abstract":"\u003cp\u003eRepresentation of the page link\u003c/p\u003e"},"Structs/HyperwalletPageParameter.html":{"name":"HyperwalletPageParameter","abstract":"\u003cp\u003eRepresentation of the relationship between the current document and the linked document\u003c/p\u003e"},"Structs/HyperwalletReceiptDetails.html":{"name":"HyperwalletReceiptDetails","abstract":"\u003cp\u003eDetails of the transaction.\u003c/p\u003e"},"Structs/HyperwalletReceipt.html":{"name":"HyperwalletReceipt","abstract":"\u003cp\u003eRepresentation of the Hyperwallet\u0026rsquo;s receipt.\u003c/p\u003e"},"Structs/HyperwalletStatusTransition.html":{"name":"HyperwalletStatusTransition","abstract":"\u003cp\u003eRepresentation of the status transition.\u003c/p\u003e"},"Structs/HyperwalletForeignExchange.html":{"name":"HyperwalletForeignExchange","abstract":"\u003cp\u003eRepresentation of a \u003ccode\u003eHyperwalletForeignExchange\u003c/code\u003e\u003c/p\u003e"},"Structs/HyperwalletTransfer.html":{"name":"HyperwalletTransfer","abstract":"\u003cp\u003eRepresentation of a \u003ccode\u003eHyperwalletTransfer\u003c/code\u003e\u003c/p\u003e"},"Protocols/HyperwalletTransferMethodUpdateConfigurationField.html#/s:14HyperwalletSDK0A38TransferMethodUpdateConfigurationFieldP08transferdeF0AA0acdF0VSgyF":{"name":"transferMethodUpdateConfiguration()","abstract":"\u003cp\u003eReturns \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbStructs/HyperwalletTransferMethodConfiguration.html\"\u003eHyperwalletTransferMethodConfiguration\u003c/a\u003e\u003c/code\u003e\u003c/p\u003e","parent_name":"HyperwalletTransferMethodUpdateConfigurationField"},"Protocols/HyperwalletTransferMethodConfigurationKey.html#/s:14HyperwalletSDK0A30TransferMethodConfigurationKeyP9countriesSayAA0A7CountryVGSgyF":{"name":"countries()","abstract":"\u003cp\u003eReturns the list of countries\u003c/p\u003e","parent_name":"HyperwalletTransferMethodConfigurationKey"},"Protocols/HyperwalletTransferMethodConfigurationKey.html#/s:14HyperwalletSDK0A30TransferMethodConfigurationKeyP10currencies4fromSayAA0A8CurrencyVGSgSS_tF":{"name":"currencies(from:)","abstract":"\u003cp\u003eReturns the list of currencies based on the country\u003c/p\u003e","parent_name":"HyperwalletTransferMethodConfigurationKey"},"Protocols/HyperwalletTransferMethodConfigurationKey.html#/s:14HyperwalletSDK0A30TransferMethodConfigurationKeyP08transferD5Types11countryCode08currencyJ0SayAA0acD4TypeVGSgSS_SStF":{"name":"transferMethodTypes(countryCode:currencyCode:)","abstract":"\u003cp\u003eReturns the list of transfer method types based on the parameters\u003c/p\u003e","parent_name":"HyperwalletTransferMethodConfigurationKey"},"Protocols/HyperwalletTransferMethodConfigurationField.html#/s:14HyperwalletSDK0A32TransferMethodConfigurationFieldP11fieldGroupsSayAA0aF5GroupVGSgyF":{"name":"fieldGroups()","abstract":"\u003cp\u003eReturns a list of \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbStructs/HyperwalletField.html\"\u003eHyperwalletField\u003c/a\u003e\u003c/code\u003e\u003c/p\u003e","parent_name":"HyperwalletTransferMethodConfigurationField"},"Protocols/HyperwalletTransferMethodConfigurationField.html#/s:14HyperwalletSDK0A32TransferMethodConfigurationFieldP08transferD4TypeAA0acdH0VSgyF":{"name":"transferMethodType()","abstract":"\u003cp\u003eReturns the list of transfer method types based on the parameters\u003c/p\u003e","parent_name":"HyperwalletTransferMethodConfigurationField"},"Protocols/HyperwalletAuthenticationTokenProvider.html#/s:14HyperwalletSDK0A27AuthenticationTokenProviderP17CompletionHandlera":{"name":"CompletionHandler","abstract":"\u003cp\u003eA callback interface to handle the submission of an authentication token or an error message in case of failure.\u003c/p\u003e","parent_name":"HyperwalletAuthenticationTokenProvider"},"Protocols/HyperwalletAuthenticationTokenProvider.html#/c:@M@HyperwalletSDK@objc(pl)HyperwalletAuthenticationTokenProvider(im)retrieveAuthenticationTokenWithCompletionHandler:":{"name":"retrieveAuthenticationToken(completionHandler:)","abstract":"\u003cp\u003eInvoked when the Hyperwallet iOS Core SDK requires an authentication token.\u003c/p\u003e","parent_name":"HyperwalletAuthenticationTokenProvider"},"Protocols/HyperwalletAuthenticationTokenProvider.html":{"name":"HyperwalletAuthenticationTokenProvider","abstract":"\u003cp\u003eThe \u003ccode\u003eHyperwalletAuthenticationTokenProvider\u003c/code\u003e protocol provides the Hyperwallet iOS Core SDK with an"},"Protocols/HyperwalletTransferMethodConfigurationField.html":{"name":"HyperwalletTransferMethodConfigurationField","abstract":"\u003cp\u003eThe \u003ccode\u003eHyperwalletTransferMethodConfigurationField\u003c/code\u003e protocol for processing the transfer method"},"Protocols/HyperwalletTransferMethodConfigurationKey.html":{"name":"HyperwalletTransferMethodConfigurationKey","abstract":"\u003cp\u003eThe \u003ccode\u003eHyperwalletTransferMethodConfigurationKey\u003c/code\u003e protocol for processing the transfer method configuration"},"Protocols/HyperwalletTransferMethodUpdateConfigurationField.html":{"name":"HyperwalletTransferMethodUpdateConfigurationField","abstract":"\u003cp\u003eThe \u003ccode\u003eHyperwalletTransferMethodUpdateConfigurationField\u003c/code\u003e protocol for processing the update transfer method"},"Extensions/ISO8601DateFormatter.html#/s:So22NSISO8601DateFormatterC14HyperwalletSDKE14ignoreTimeZoneABvpZ":{"name":"ignoreTimeZone","abstract":"\u003cp\u003eThe thread-safe date formatter to work with ISO8601 date representations.","parent_name":"ISO8601DateFormatter"},"Extensions/ISO8601DateFormatter.html":{"name":"ISO8601DateFormatter","abstract":"\u003cp\u003eDate extension.\u003c/p\u003e"},"Enums/HyperwalletDataType.html#/s:14HyperwalletSDK0A8DataTypeO4textyA2CmF":{"name":"text","abstract":"\u003cp\u003eThe text field type\u003c/p\u003e","parent_name":"HyperwalletDataType"},"Enums/HyperwalletDataType.html#/s:14HyperwalletSDK0A8DataTypeO9selectionyA2CmF":{"name":"selection","abstract":"\u003cp\u003eThe selecion option field type\u003c/p\u003e","parent_name":"HyperwalletDataType"},"Enums/HyperwalletDataType.html#/s:14HyperwalletSDK0A8DataTypeO7booleanyA2CmF":{"name":"boolean","abstract":"\u003cp\u003eThe boolean field type\u003c/p\u003e","parent_name":"HyperwalletDataType"},"Enums/HyperwalletDataType.html#/s:14HyperwalletSDK0A8DataTypeO6numberyA2CmF":{"name":"number","abstract":"\u003cp\u003eThe numeric field type\u003c/p\u003e","parent_name":"HyperwalletDataType"},"Enums/HyperwalletDataType.html#/s:14HyperwalletSDK0A8DataTypeO5rangeyA2CmF":{"name":"range","abstract":"\u003cp\u003eThe range field type\u003c/p\u003e","parent_name":"HyperwalletDataType"},"Enums/HyperwalletDataType.html#/s:14HyperwalletSDK0A8DataTypeO4dateyA2CmF":{"name":"date","abstract":"\u003cp\u003eThe date field type\u003c/p\u003e","parent_name":"HyperwalletDataType"},"Enums/HyperwalletDataType.html#/s:14HyperwalletSDK0A8DataTypeO8datetimeyA2CmF":{"name":"datetime","abstract":"\u003cp\u003eThe datetime field type\u003c/p\u003e","parent_name":"HyperwalletDataType"},"Enums/HyperwalletDataType.html#/s:14HyperwalletSDK0A8DataTypeO10expiryDateyA2CmF":{"name":"expiryDate","abstract":"\u003cp\u003eThe expiry date field type\u003c/p\u003e","parent_name":"HyperwalletDataType"},"Enums/HyperwalletDataType.html#/s:14HyperwalletSDK0A8DataTypeO5phoneyA2CmF":{"name":"phone","abstract":"\u003cp\u003eThe phone field type\u003c/p\u003e","parent_name":"HyperwalletDataType"},"Enums/HyperwalletDataType.html#/s:14HyperwalletSDK0A8DataTypeO5emailyA2CmF":{"name":"email","abstract":"\u003cp\u003eThe email field type\u003c/p\u003e","parent_name":"HyperwalletDataType"},"Enums/HyperwalletDataType.html#/s:14HyperwalletSDK0A8DataTypeO4fileyA2CmF":{"name":"file","abstract":"\u003cp\u003eThe file field type\u003c/p\u003e","parent_name":"HyperwalletDataType"},"Enums/HyperwalletErrorGroup.html#/s:14HyperwalletSDK0A10ErrorGroupO8businessyA2CmF":{"name":"business","abstract":"\u003cp\u003eReturned when a business error is thrown\u003c/p\u003e","parent_name":"HyperwalletErrorGroup"},"Enums/HyperwalletErrorGroup.html#/s:14HyperwalletSDK0A10ErrorGroupO10unexpectedyA2CmF":{"name":"unexpected","abstract":"\u003cp\u003eReturned when an unexpected error is thrown\u003c/p\u003e","parent_name":"HyperwalletErrorGroup"},"Enums/HyperwalletErrorGroup.html#/s:14HyperwalletSDK0A10ErrorGroupO10connectionyA2CmF":{"name":"connection","abstract":"\u003cp\u003eReturned when a connection error is thrown\u003c/p\u003e","parent_name":"HyperwalletErrorGroup"},"Enums/HyperwalletErrorGroup.html#/s:14HyperwalletSDK0A10ErrorGroupO14authenticationyA2CmF":{"name":"authentication","abstract":"\u003cp\u003eReturned when a authentication error is thrown\u003c/p\u003e","parent_name":"HyperwalletErrorGroup"},"Enums/HyperwalletAuthenticationErrorType.html#/s:14HyperwalletSDK0A23AuthenticationErrorTypeO7expiredyACSScACmF":{"name":"expired(_:)","parent_name":"HyperwalletAuthenticationErrorType"},"Enums/HyperwalletAuthenticationErrorType.html#/s:14HyperwalletSDK0A23AuthenticationErrorTypeO10unexpectedyACSScACmF":{"name":"unexpected(_:)","parent_name":"HyperwalletAuthenticationErrorType"},"Enums/HyperwalletAuthenticationErrorType.html#/s:14HyperwalletSDK0A23AuthenticationErrorTypeO7messageSSyF":{"name":"message()","abstract":"\u003cp\u003eGets the AuthenticationErrorType error message\u003c/p\u003e","parent_name":"HyperwalletAuthenticationErrorType"},"Enums/HyperwalletErrorType.html#/s:14HyperwalletSDK0A9ErrorTypeO4httpyAcA0A6ErrorsV_SitcACmF":{"name":"http(_:_:)","abstract":"\u003cp\u003eReturned when an HTTP code is not in the range 2xx.\u003c/p\u003e","parent_name":"HyperwalletErrorType"},"Enums/HyperwalletErrorType.html#/s:14HyperwalletSDK0A9ErrorTypeO05parseC0yAcA0A6ErrorsVcACmF":{"name":"parseError(_:)","abstract":"\u003cp\u003eReturned when a response parser process throws error.\u003c/p\u003e","parent_name":"HyperwalletErrorType"},"Enums/HyperwalletErrorType.html#/s:14HyperwalletSDK0A9ErrorTypeO14notInitializedyAcA0A6ErrorsVcACmF":{"name":"notInitialized(_:)","abstract":"\u003cp\u003eReturned when the SDK was not initialized properly.\u003c/p\u003e","parent_name":"HyperwalletErrorType"},"Enums/HyperwalletErrorType.html#/s:14HyperwalletSDK0A9ErrorTypeO10invalidUrlyAcA0A6ErrorsVcACmF":{"name":"invalidUrl(_:)","abstract":"\u003cp\u003eReturned when a provided URL is not valid\u003c/p\u003e","parent_name":"HyperwalletErrorType"},"Enums/HyperwalletErrorType.html#/s:14HyperwalletSDK0A9ErrorTypeO18transactionAbortedyAcA0A6ErrorsVcACmF":{"name":"transactionAborted(_:)","abstract":"\u003cp\u003eReturned when a transaction is explicitly aborted.\u003c/p\u003e","parent_name":"HyperwalletErrorType"},"Enums/HyperwalletErrorType.html#/s:14HyperwalletSDK0A9ErrorTypeO014authenticationC0yAcA0a14AuthenticationcD0OcACmF":{"name":"authenticationError(_:)","abstract":"\u003cp\u003eReturned on authentication failure\u003c/p\u003e","parent_name":"HyperwalletErrorType"},"Enums/HyperwalletErrorType.html#/s:14HyperwalletSDK0A9ErrorTypeO10unexpectedyAcA0A6ErrorsVcACmF":{"name":"unexpected(_:)","abstract":"\u003cp\u003eReturned when an unexpected behavior happened.\u003c/p\u003e","parent_name":"HyperwalletErrorType"},"Enums/HyperwalletErrorType.html#/s:14HyperwalletSDK0A9ErrorTypeO13graphQlErrorsyAcA0aG0VcACmF":{"name":"graphQlErrors(_:)","abstract":"\u003cp\u003eReturned when a GraphQL parser process throws error.\u003c/p\u003e","parent_name":"HyperwalletErrorType"},"Enums/HyperwalletErrorType.html#/s:14HyperwalletSDK0A9ErrorTypeO14invalidRequestyAcA0A6ErrorsVcACmF":{"name":"invalidRequest(_:)","abstract":"\u003cp\u003eReturned when some step-in builds the request throws error.\u003c/p\u003e","parent_name":"HyperwalletErrorType"},"Enums/HyperwalletErrorType.html#/s:14HyperwalletSDK0A9ErrorTypeO010connectionC0yAcA0A6ErrorsVcACmF":{"name":"connectionError(_:)","abstract":"\u003cp\u003eReturned when during the connection process throws error.\u003c/p\u003e","parent_name":"HyperwalletErrorType"},"Enums/HyperwalletErrorType.html#/s:14HyperwalletSDK0A9ErrorTypeO5groupAA0aC5GroupOvp":{"name":"group","abstract":"\u003cp\u003eThe error type group\u003c/p\u003e","parent_name":"HyperwalletErrorType"},"Enums/HyperwalletErrorType.html#/s:14HyperwalletSDK0A9ErrorTypeO03getA6ErrorsAA0aF0VSgyF":{"name":"getHyperwalletErrors()","abstract":"\u003cp\u003eGets the \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbStructs/HyperwalletErrors.html\"\u003eHyperwalletErrors\u003c/a\u003e\u003c/code\u003e based on the ErrorType\u003c/p\u003e","parent_name":"HyperwalletErrorType"},"Enums/HyperwalletErrorType.html#/s:14HyperwalletSDK0A9ErrorTypeO017getAuthenticationC0AA0afcD0OSgyF":{"name":"getAuthenticationError()","abstract":"\u003cp\u003eGets the \u003ccode\u003eAuthenticationErrorType\u003c/code\u003e on the ErrorType\u003c/p\u003e","parent_name":"HyperwalletErrorType"},"Enums/HyperwalletErrorType.html#/s:14HyperwalletSDK0A9ErrorTypeO11getHttpCodeSiSgyF":{"name":"getHttpCode()","abstract":"\u003cp\u003eGets the HTTP Code based on the ErrorType.http\u003c/p\u003e","parent_name":"HyperwalletErrorType"},"Enums/HyperwalletErrorType.html":{"name":"HyperwalletErrorType","abstract":"\u003cp\u003eThe \u003ccode\u003eHyperwalletErrorType\u003c/code\u003e is the error type returned By Hyperwallet SDK.\u003c/p\u003e"},"Enums/HyperwalletAuthenticationErrorType.html":{"name":"HyperwalletAuthenticationErrorType","abstract":"\u003cp\u003eThe \u003ccode\u003eHyperwalletAuthenticationErrorType\u003c/code\u003e is the authentication error type returned By Hyperwallet SDK.\u003c/p\u003e"},"Enums/HyperwalletErrorGroup.html":{"name":"HyperwalletErrorGroup","abstract":"\u003cp\u003eRepresentation of the error type group\u003c/p\u003e"},"Enums/HyperwalletDataType.html":{"name":"HyperwalletDataType","abstract":"\u003cp\u003eRepresentation of the transfer method configuration field data type\u003c/p\u003e"},"Classes/HyperwalletUser/Builder.html#/s:14HyperwalletSDK0A4UserC7BuilderC12addressLine1yAESSF":{"name":"addressLine1(_:)","abstract":"\u003cp\u003eSets the user\u0026rsquo;s street address.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletUser/Builder.html#/s:14HyperwalletSDK0A4UserC7BuilderC12addressLine2yAESSF":{"name":"addressLine2(_:)","abstract":"\u003cp\u003eSets the user\u0026rsquo;s address, second line.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletUser/Builder.html#/s:14HyperwalletSDK0A4UserC7BuilderC5buildACyF":{"name":"build()","abstract":"\u003cp\u003eBuilds a new instance of the \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/HyperwalletUser.html\"\u003eHyperwalletUser\u003c/a\u003e\u003c/code\u003e.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletUser/Builder.html#/s:14HyperwalletSDK0A4UserC7BuilderC27businessContactAddressLine1yAESSF":{"name":"businessContactAddressLine1(_:)","abstract":"\u003cp\u003eSets the business contact\u0026rsquo;s street address.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletUser/Builder.html#/s:14HyperwalletSDK0A4UserC7BuilderC27businessContactAddressLine2yAESSF":{"name":"businessContactAddressLine2(_:)","abstract":"\u003cp\u003eSets the business contact\u0026rsquo;s address, second line.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletUser/Builder.html#/s:14HyperwalletSDK0A4UserC7BuilderC19businessContactCityyAESSF":{"name":"businessContactCity(_:)","abstract":"\u003cp\u003eSets the business contact\u0026rsquo;s city.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletUser/Builder.html#/s:14HyperwalletSDK0A4UserC7BuilderC22businessContactCountryyAESSF":{"name":"businessContactCountry(_:)","abstract":"\u003cp\u003eSets the business contact\u0026rsquo;s country.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletUser/Builder.html#/s:14HyperwalletSDK0A4UserC7BuilderC25businessContactPostalCodeyAESSF":{"name":"businessContactPostalCode(_:)","abstract":"\u003cp\u003eSets the business contact\u0026rsquo;s postal code.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletUser/Builder.html#/s:14HyperwalletSDK0A4UserC7BuilderC19businessContactRoleyAeC08BusinessfG0OF":{"name":"businessContactRole(_:)","abstract":"\u003cp\u003eSets the user\u0026rsquo;s role in the organization.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletUser/Builder.html#/s:14HyperwalletSDK0A4UserC7BuilderC28businessContactStateProvinceyAESSF":{"name":"businessContactStateProvince(_:)","abstract":"\u003cp\u003eSets the business contact\u0026rsquo;s state, province or region.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletUser/Builder.html#/s:14HyperwalletSDK0A4UserC7BuilderC12businessNameyAESSF":{"name":"businessName(_:)","abstract":"\u003cp\u003eSets the business name.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletUser/Builder.html#/s:14HyperwalletSDK0A4UserC7BuilderC21businessOperatingNameyAESSF":{"name":"businessOperatingName(_:)","abstract":"\u003cp\u003eSets the business\u0026rsquo; operating name.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletUser/Builder.html#/s:14HyperwalletSDK0A4UserC7BuilderC27businessRegistrationCountryyAESSF":{"name":"businessRegistrationCountry(_:)","abstract":"\u003cp\u003eSets the country where the business is registered.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletUser/Builder.html#/s:14HyperwalletSDK0A4UserC7BuilderC22businessRegistrationIdyAESSF":{"name":"businessRegistrationId(_:)","abstract":"\u003cp\u003eSets the business registration number or identifier assigned by a government body.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletUser/Builder.html#/s:14HyperwalletSDK0A4UserC7BuilderC33businessRegistrationStateProvinceyAESSF":{"name":"businessRegistrationStateProvince(_:)","abstract":"\u003cp\u003eSets the state, province or region where the business is registered.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletUser/Builder.html#/s:14HyperwalletSDK0A4UserC7BuilderC12businessTypeyAeC08BusinessF0OF":{"name":"businessType(_:)","abstract":"\u003cp\u003eSets the business type.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletUser/Builder.html#/s:14HyperwalletSDK0A4UserC7BuilderC4cityyAESSF":{"name":"city(_:)","abstract":"\u003cp\u003eSets the user\u0026rsquo;s city.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletUser/Builder.html#/s:14HyperwalletSDK0A4UserC7BuilderC7countryyAESSF":{"name":"country(_:)","abstract":"\u003cp\u003eSets the user\u0026rsquo;s country.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletUser/Builder.html#/s:14HyperwalletSDK0A4UserC7BuilderC14countryOfBirthyAESSF":{"name":"countryOfBirth(_:)","abstract":"\u003cp\u003eSets the user\u0026rsquo;s birth country.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletUser/Builder.html#/s:14HyperwalletSDK0A4UserC7BuilderC20countryOfNationalityyAESSF":{"name":"countryOfNationality(_:)","abstract":"\u003cp\u003eSets the user\u0026rsquo;s country of citizenship or nationality.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletUser/Builder.html#/s:14HyperwalletSDK0A4UserC7BuilderC9createdOnyAESSF":{"name":"createdOn(_:)","abstract":"\u003cp\u003eSets the datetime the user account was created on in ISO 8601 format (YYYY-MM-DDThh:mm:ss). Note that the","parent_name":"Builder"},"Classes/HyperwalletUser/Builder.html#/s:14HyperwalletSDK0A4UserC7BuilderC11dateOfBirthyAESSF":{"name":"dateOfBirth(_:)","abstract":"\u003cp\u003eSets the user\u0026rsquo;s date of birth (All users must be at least 13 years old).\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletUser/Builder.html#/s:14HyperwalletSDK0A4UserC7BuilderC16driversLicenseIdyAESSF":{"name":"driversLicenseId(_:)","abstract":"\u003cp\u003eSets the user\u0026rsquo;s driver\u0026rsquo;s license number.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletUser/Builder.html#/s:14HyperwalletSDK0A4UserC7BuilderC5emailyAESSF":{"name":"email(_:)","abstract":"\u003cp\u003eSets the contact email address for the user account. This must be unique for your program, so you cannot","parent_name":"Builder"},"Classes/HyperwalletUser/Builder.html#/s:14HyperwalletSDK0A4UserC7BuilderC10employerIdyAESSF":{"name":"employerId(_:)","abstract":"\u003cp\u003eSets the user\u0026rsquo;s employer identifier, generally used for tax purposes.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletUser/Builder.html#/s:14HyperwalletSDK0A4UserC7BuilderC9firstNameyAESSF":{"name":"firstName(_:)","abstract":"\u003cp\u003eSets the user\u0026rsquo;s first name.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletUser/Builder.html#/s:14HyperwalletSDK0A4UserC7BuilderC6genderyAeC6GenderOF":{"name":"gender(_:)","abstract":"\u003cp\u003eSets the user\u0026rsquo;s gender.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletUser/Builder.html#/s:14HyperwalletSDK0A4UserC7BuilderC12governmentIdyAESSF":{"name":"governmentId(_:)","abstract":"\u003cp\u003eSets the user\u0026rsquo;s government ID number, such as a Social Security Number.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletUser/Builder.html#/s:14HyperwalletSDK0A4UserC7BuilderC16governmentIdTypeyAESSF":{"name":"governmentIdType(_:)","abstract":"\u003cp\u003eSets the user\u0026rsquo;s government ID type.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletUser/Builder.html#/s:14HyperwalletSDK0A4UserC7BuilderC8languageyAESSF":{"name":"language(_:)","abstract":"\u003cp\u003eSets the preferred language for the user\u0026rsquo;s account. Defaults to English if not provided.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletUser/Builder.html#/s:14HyperwalletSDK0A4UserC7BuilderC8lastNameyAESSF":{"name":"lastName(_:)","abstract":"\u003cp\u003eSets the user\u0026rsquo;s last name.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletUser/Builder.html#/s:14HyperwalletSDK0A4UserC7BuilderC10middleNameyAESSF":{"name":"middleName(_:)","abstract":"\u003cp\u003eSets the user\u0026rsquo;s middle name.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletUser/Builder.html#/s:14HyperwalletSDK0A4UserC7BuilderC12mobileNumberyAESSF":{"name":"mobileNumber(_:)","abstract":"\u003cp\u003eSets the user\u0026rsquo;s cell phone number.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletUser/Builder.html#/s:14HyperwalletSDK0A4UserC7BuilderC10passportIdyAESSF":{"name":"passportId(_:)","abstract":"\u003cp\u003eSets the user\u0026rsquo;s passport number.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletUser/Builder.html#/s:14HyperwalletSDK0A4UserC7BuilderC11phoneNumberyAESSF":{"name":"phoneNumber(_:)","abstract":"\u003cp\u003eSets the user\u0026rsquo;s phone number.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletUser/Builder.html#/s:14HyperwalletSDK0A4UserC7BuilderC10postalCodeyAESSF":{"name":"postalCode(_:)","abstract":"\u003cp\u003eSets the user\u0026rsquo;s postal code.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletUser/Builder.html#/s:14HyperwalletSDK0A4UserC7BuilderC11profileTypeyAeC07ProfileF0OF":{"name":"profileType(_:)","abstract":"\u003cp\u003eSets the user\u0026rsquo;s profile type.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletUser/Builder.html#/s:14HyperwalletSDK0A4UserC7BuilderC12programTokenyAESSF":{"name":"programToken(_:)","abstract":"\u003cp\u003eSets the unique identifier for the program to which the user will belong.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletUser/Builder.html#/s:14HyperwalletSDK0A4UserC7BuilderC8setField3key5valueAeC0cF0O_SStF":{"name":"setField(key:value:)","abstract":"\u003cp\u003eSets the field value based on the \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/HyperwalletUser/UserField.html\"\u003eUserField\u003c/a\u003e\u003c/code\u003e\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletUser/Builder.html#/s:14HyperwalletSDK0A4UserC7BuilderC8setField3key5valueAESS_SStF":{"name":"setField(key:value:)","abstract":"\u003cp\u003eSets the field value based on the \u003ccode\u003eUserField.RawValue\u003c/code\u003e\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletUser/Builder.html#/s:14HyperwalletSDK0A4UserC7BuilderC13stateProvinceyAESSF":{"name":"stateProvince(_:)","abstract":"\u003cp\u003eSets the user\u0026rsquo;s state, province or region.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletUser/Builder.html#/s:14HyperwalletSDK0A4UserC7BuilderC6statusyAeC6StatusOF":{"name":"status(_:)","abstract":"\u003cp\u003eSets the user account status.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletUser/Builder.html#/s:14HyperwalletSDK0A4UserC7BuilderC8timeZoneyAESSF":{"name":"timeZone(_:)","abstract":"\u003cp\u003eSets the local time of a region or a country. e.g. GMT, PST, \u0026hellip;\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletUser/Builder.html#/s:14HyperwalletSDK0A4UserC7BuilderC5tokenyAESSF":{"name":"token(_:)","abstract":"\u003cp\u003eSets the unique, auto-generated user identifier. Max 64 characters, prefixed with \u0026ldquo;usr-\u0026rdquo;.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletUser/Builder.html#/s:14HyperwalletSDK0A4UserC7BuilderC18verificationStatusyAeC012VerificationF0OF":{"name":"verificationStatus(_:)","abstract":"\u003cp\u003eSets the the user\u0026rsquo;s verification status. A user may be required to verify their identity after a certain","parent_name":"Builder"},"Classes/HyperwalletUser/VerificationStatus.html#/s:14HyperwalletSDK0A4UserC18VerificationStatusO6failedyA2EmF":{"name":"failed","abstract":"\u003cp\u003eThe user\u0026rsquo;s verification status is fail. Temporary status before changing to REQUIRED.\u003c/p\u003e","parent_name":"VerificationStatus"},"Classes/HyperwalletUser/VerificationStatus.html#/s:14HyperwalletSDK0A4UserC18VerificationStatusO11notRequiredyA2EmF":{"name":"notRequired","abstract":"\u003cp\u003eThe user\u0026rsquo;s verification status is not require.\u003c/p\u003e","parent_name":"VerificationStatus"},"Classes/HyperwalletUser/VerificationStatus.html#/s:14HyperwalletSDK0A4UserC18VerificationStatusO8requiredyA2EmF":{"name":"required","abstract":"\u003cp\u003eThe user\u0026rsquo;s verification status is require.\u003c/p\u003e","parent_name":"VerificationStatus"},"Classes/HyperwalletUser/VerificationStatus.html#/s:14HyperwalletSDK0A4UserC18VerificationStatusO11underReviewyA2EmF":{"name":"underReview","abstract":"\u003cp\u003eThe user\u0026rsquo;s verification status is under review.\u003c/p\u003e","parent_name":"VerificationStatus"},"Classes/HyperwalletUser/VerificationStatus.html#/s:14HyperwalletSDK0A4UserC18VerificationStatusO8verifiedyA2EmF":{"name":"verified","abstract":"\u003cp\u003eThe user\u0026rsquo;s verification status is verified.\u003c/p\u003e","parent_name":"VerificationStatus"},"Classes/HyperwalletUser/Status.html#/s:14HyperwalletSDK0A4UserC6StatusO9activatedyA2EmF":{"name":"activated","abstract":"\u003cp\u003eThe user account is activated.\u003c/p\u003e","parent_name":"Status"},"Classes/HyperwalletUser/Status.html#/s:14HyperwalletSDK0A4UserC6StatusO11deactivatedyA2EmF":{"name":"deactivated","abstract":"\u003cp\u003eThe user account is deactivated.\u003c/p\u003e","parent_name":"Status"},"Classes/HyperwalletUser/Status.html#/s:14HyperwalletSDK0A4UserC6StatusO6frozenyA2EmF":{"name":"frozen","abstract":"\u003cp\u003eThe user account is frozen.\u003c/p\u003e","parent_name":"Status"},"Classes/HyperwalletUser/Status.html#/s:14HyperwalletSDK0A4UserC6StatusO6lockedyA2EmF":{"name":"locked","abstract":"\u003cp\u003eThe user account is locked.\u003c/p\u003e","parent_name":"Status"},"Classes/HyperwalletUser/Status.html#/s:14HyperwalletSDK0A4UserC6StatusO12preActivatedyA2EmF":{"name":"preActivated","abstract":"\u003cp\u003eThe user account is pre activated.\u003c/p\u003e","parent_name":"Status"},"Classes/HyperwalletUser/ProfileType.html#/s:14HyperwalletSDK0A4UserC11ProfileTypeO8businessyA2EmF":{"name":"business","abstract":"\u003cp\u003eThe business profile type.\u003c/p\u003e","parent_name":"ProfileType"},"Classes/HyperwalletUser/ProfileType.html#/s:14HyperwalletSDK0A4UserC11ProfileTypeO10individualyA2EmF":{"name":"individual","abstract":"\u003cp\u003eThe individual profile type.\u003c/p\u003e","parent_name":"ProfileType"},"Classes/HyperwalletUser/Gender.html#/s:14HyperwalletSDK0A4UserC6GenderO6femaleyA2EmF":{"name":"female","abstract":"\u003cp\u003eThe female gender\u003c/p\u003e","parent_name":"Gender"},"Classes/HyperwalletUser/Gender.html#/s:14HyperwalletSDK0A4UserC6GenderO4maleyA2EmF":{"name":"male","abstract":"\u003cp\u003eThe male gender\u003c/p\u003e","parent_name":"Gender"},"Classes/HyperwalletUser/BusinessContactRole.html#/s:14HyperwalletSDK0A4UserC19BusinessContactRoleO8directoryA2EmF":{"name":"director","abstract":"\u003cp\u003eThe director role\u003c/p\u003e","parent_name":"BusinessContactRole"},"Classes/HyperwalletUser/BusinessContactRole.html#/s:14HyperwalletSDK0A4UserC19BusinessContactRoleO5otheryA2EmF":{"name":"other","abstract":"\u003cp\u003eThe other role\u003c/p\u003e","parent_name":"BusinessContactRole"},"Classes/HyperwalletUser/BusinessContactRole.html#/s:14HyperwalletSDK0A4UserC19BusinessContactRoleO5owneryA2EmF":{"name":"owner","abstract":"\u003cp\u003eThe owner role\u003c/p\u003e","parent_name":"BusinessContactRole"},"Classes/HyperwalletUser/BusinessType.html#/s:14HyperwalletSDK0A4UserC12BusinessTypeO11corporationyA2EmF":{"name":"corporation","abstract":"\u003cp\u003eThe corporation business type\u003c/p\u003e","parent_name":"BusinessType"},"Classes/HyperwalletUser/BusinessType.html#/s:14HyperwalletSDK0A4UserC12BusinessTypeO11partnershipyA2EmF":{"name":"partnership","abstract":"\u003cp\u003eThe partnership business type\u003c/p\u003e","parent_name":"BusinessType"},"Classes/HyperwalletUser/UserField.html#/s:14HyperwalletSDK0A4UserC0C5FieldO12addressLine1yA2EmF":{"name":"addressLine1","abstract":"\u003cp\u003eThe user\u0026rsquo;s street address.\u003c/p\u003e","parent_name":"UserField"},"Classes/HyperwalletUser/UserField.html#/s:14HyperwalletSDK0A4UserC0C5FieldO12addressLine2yA2EmF":{"name":"addressLine2","abstract":"\u003cp\u003eThe user\u0026rsquo;s address, second line.\u003c/p\u003e","parent_name":"UserField"},"Classes/HyperwalletUser/UserField.html#/s:14HyperwalletSDK0A4UserC0C5FieldO27businessContactAddressLine1yA2EmF":{"name":"businessContactAddressLine1","abstract":"\u003cp\u003eThe business contact\u0026rsquo;s street address.\u003c/p\u003e","parent_name":"UserField"},"Classes/HyperwalletUser/UserField.html#/s:14HyperwalletSDK0A4UserC0C5FieldO27businessContactAddressLine2yA2EmF":{"name":"businessContactAddressLine2","abstract":"\u003cp\u003eThe business contact\u0026rsquo;s address, second line.\u003c/p\u003e","parent_name":"UserField"},"Classes/HyperwalletUser/UserField.html#/s:14HyperwalletSDK0A4UserC0C5FieldO19businessContactCityyA2EmF":{"name":"businessContactCity","abstract":"\u003cp\u003eThe business contact\u0026rsquo;s city.\u003c/p\u003e","parent_name":"UserField"},"Classes/HyperwalletUser/UserField.html#/s:14HyperwalletSDK0A4UserC0C5FieldO22businessContactCountryyA2EmF":{"name":"businessContactCountry","abstract":"\u003cp\u003eThe business contact\u0026rsquo;s country.\u003c/p\u003e","parent_name":"UserField"},"Classes/HyperwalletUser/UserField.html#/s:14HyperwalletSDK0A4UserC0C5FieldO25businessContactPostalCodeyA2EmF":{"name":"businessContactPostalCode","abstract":"\u003cp\u003eThe business contact\u0026rsquo;s postal code.\u003c/p\u003e","parent_name":"UserField"},"Classes/HyperwalletUser/UserField.html#/s:14HyperwalletSDK0A4UserC0C5FieldO19businessContactRoleyA2EmF":{"name":"businessContactRole","abstract":"\u003cp\u003eThe user\u0026rsquo;s role in the organization.\u003c/p\u003e","parent_name":"UserField"},"Classes/HyperwalletUser/UserField.html#/s:14HyperwalletSDK0A4UserC0C5FieldO28businessContactStateProvinceyA2EmF":{"name":"businessContactStateProvince","abstract":"\u003cp\u003eThe business contact\u0026rsquo;s state, province or region.\u003c/p\u003e","parent_name":"UserField"},"Classes/HyperwalletUser/UserField.html#/s:14HyperwalletSDK0A4UserC0C5FieldO12businessNameyA2EmF":{"name":"businessName","abstract":"\u003cp\u003eThe business name.\u003c/p\u003e","parent_name":"UserField"},"Classes/HyperwalletUser/UserField.html#/s:14HyperwalletSDK0A4UserC0C5FieldO21businessOperatingNameyA2EmF":{"name":"businessOperatingName","abstract":"\u003cp\u003eThe business\u0026rsquo; operating name.\u003c/p\u003e","parent_name":"UserField"},"Classes/HyperwalletUser/UserField.html#/s:14HyperwalletSDK0A4UserC0C5FieldO27businessRegistrationCountryyA2EmF":{"name":"businessRegistrationCountry","abstract":"\u003cp\u003eThe country where the business is registered.\u003c/p\u003e","parent_name":"UserField"},"Classes/HyperwalletUser/UserField.html#/s:14HyperwalletSDK0A4UserC0C5FieldO22businessRegistrationIdyA2EmF":{"name":"businessRegistrationId","abstract":"\u003cp\u003eThe business registration number or identifier assigned by a government body.\u003c/p\u003e","parent_name":"UserField"},"Classes/HyperwalletUser/UserField.html#/s:14HyperwalletSDK0A4UserC0C5FieldO33businessRegistrationStateProvinceyA2EmF":{"name":"businessRegistrationStateProvince","abstract":"\u003cp\u003eThe state, province or region where the business is registered.\u003c/p\u003e","parent_name":"UserField"},"Classes/HyperwalletUser/UserField.html#/s:14HyperwalletSDK0A4UserC0C5FieldO12businessTypeyA2EmF":{"name":"businessType","abstract":"\u003cp\u003eThe business type.\u003c/p\u003e","parent_name":"UserField"},"Classes/HyperwalletUser/UserField.html#/s:14HyperwalletSDK0A4UserC0C5FieldO4cityyA2EmF":{"name":"city","abstract":"\u003cp\u003eThe user\u0026rsquo;s city.\u003c/p\u003e","parent_name":"UserField"},"Classes/HyperwalletUser/UserField.html#/s:14HyperwalletSDK0A4UserC0C5FieldO06clientC2IdyA2EmF":{"name":"clientUserId","abstract":"\u003cp\u003eA client-defined identifier for the user. This is the unique ID assigned to the user","parent_name":"UserField"},"Classes/HyperwalletUser/UserField.html#/s:14HyperwalletSDK0A4UserC0C5FieldO7countryyA2EmF":{"name":"country","abstract":"\u003cp\u003eThe user\u0026rsquo;s country.\u003c/p\u003e","parent_name":"UserField"},"Classes/HyperwalletUser/UserField.html#/s:14HyperwalletSDK0A4UserC0C5FieldO14countryOfBirthyA2EmF":{"name":"countryOfBirth","abstract":"\u003cp\u003eThe user\u0026rsquo;s birth country.\u003c/p\u003e","parent_name":"UserField"},"Classes/HyperwalletUser/UserField.html#/s:14HyperwalletSDK0A4UserC0C5FieldO20countryOfNationalityyA2EmF":{"name":"countryOfNationality","abstract":"\u003cp\u003eThe user\u0026rsquo;s country of citizenship or nationality.\u003c/p\u003e","parent_name":"UserField"},"Classes/HyperwalletUser/UserField.html#/s:14HyperwalletSDK0A4UserC0C5FieldO9createdOnyA2EmF":{"name":"createdOn","abstract":"\u003cp\u003eThe datetime the user account was created on in ISO 8601 format (YYYY-MM-DDThh:mm:ss).","parent_name":"UserField"},"Classes/HyperwalletUser/UserField.html#/s:14HyperwalletSDK0A4UserC0C5FieldO11dateOfBirthyA2EmF":{"name":"dateOfBirth","abstract":"\u003cp\u003eThe user\u0026rsquo;s date of birth (All users must be at least 13 years old).\u003c/p\u003e","parent_name":"UserField"},"Classes/HyperwalletUser/UserField.html#/s:14HyperwalletSDK0A4UserC0C5FieldO16driversLicenseIdyA2EmF":{"name":"driversLicenseId","abstract":"\u003cp\u003eThe user\u0026rsquo;s driver\u0026rsquo;s license number.\u003c/p\u003e","parent_name":"UserField"},"Classes/HyperwalletUser/UserField.html#/s:14HyperwalletSDK0A4UserC0C5FieldO5emailyA2EmF":{"name":"email","abstract":"\u003cp\u003eThe contact email address for the user account. This must be unique for your program,","parent_name":"UserField"},"Classes/HyperwalletUser/UserField.html#/s:14HyperwalletSDK0A4UserC0C5FieldO10employerIdyA2EmF":{"name":"employerId","abstract":"\u003cp\u003eThe user\u0026rsquo;s employer identifier, generally used for tax purposes.\u003c/p\u003e","parent_name":"UserField"},"Classes/HyperwalletUser/UserField.html#/s:14HyperwalletSDK0A4UserC0C5FieldO9firstNameyA2EmF":{"name":"firstName","abstract":"\u003cp\u003eThe user\u0026rsquo;s first name.\u003c/p\u003e","parent_name":"UserField"},"Classes/HyperwalletUser/UserField.html#/s:14HyperwalletSDK0A4UserC0C5FieldO6genderyA2EmF":{"name":"gender","abstract":"\u003cp\u003eThe user\u0026rsquo;s gender.\u003c/p\u003e","parent_name":"UserField"},"Classes/HyperwalletUser/UserField.html#/s:14HyperwalletSDK0A4UserC0C5FieldO12governmentIdyA2EmF":{"name":"governmentId","abstract":"\u003cp\u003eThe user\u0026rsquo;s government ID number, such as a Social Security Number.\u003c/p\u003e","parent_name":"UserField"},"Classes/HyperwalletUser/UserField.html#/s:14HyperwalletSDK0A4UserC0C5FieldO16governmentIdTypeyA2EmF":{"name":"governmentIdType","abstract":"\u003cp\u003eThe user\u0026rsquo;s government ID type.\u003c/p\u003e","parent_name":"UserField"},"Classes/HyperwalletUser/UserField.html#/s:14HyperwalletSDK0A4UserC0C5FieldO8languageyA2EmF":{"name":"language","abstract":"\u003cp\u003eThe preferred language for the user\u0026rsquo;s account. Defaults to English if not provided.\u003c/p\u003e","parent_name":"UserField"},"Classes/HyperwalletUser/UserField.html#/s:14HyperwalletSDK0A4UserC0C5FieldO8lastNameyA2EmF":{"name":"lastName","abstract":"\u003cp\u003eThe user\u0026rsquo;s last name.\u003c/p\u003e","parent_name":"UserField"},"Classes/HyperwalletUser/UserField.html#/s:14HyperwalletSDK0A4UserC0C5FieldO10middleNameyA2EmF":{"name":"middleName","abstract":"\u003cp\u003eThe user\u0026rsquo;s middle name.\u003c/p\u003e","parent_name":"UserField"},"Classes/HyperwalletUser/UserField.html#/s:14HyperwalletSDK0A4UserC0C5FieldO12mobileNumberyA2EmF":{"name":"mobileNumber","abstract":"\u003cp\u003eThe user\u0026rsquo;s cell phone number.\u003c/p\u003e","parent_name":"UserField"},"Classes/HyperwalletUser/UserField.html#/s:14HyperwalletSDK0A4UserC0C5FieldO10passportIdyA2EmF":{"name":"passportId","abstract":"\u003cp\u003eThe user\u0026rsquo;s passport number.\u003c/p\u003e","parent_name":"UserField"},"Classes/HyperwalletUser/UserField.html#/s:14HyperwalletSDK0A4UserC0C5FieldO11phoneNumberyA2EmF":{"name":"phoneNumber","abstract":"\u003cp\u003eThe user\u0026rsquo;s phone number.\u003c/p\u003e","parent_name":"UserField"},"Classes/HyperwalletUser/UserField.html#/s:14HyperwalletSDK0A4UserC0C5FieldO10postalCodeyA2EmF":{"name":"postalCode","abstract":"\u003cp\u003eThe user\u0026rsquo;s postal code.\u003c/p\u003e","parent_name":"UserField"},"Classes/HyperwalletUser/UserField.html#/s:14HyperwalletSDK0A4UserC0C5FieldO11profileTypeyA2EmF":{"name":"profileType","abstract":"\u003cp\u003eThe user\u0026rsquo;s postal code.\u003c/p\u003e","parent_name":"UserField"},"Classes/HyperwalletUser/UserField.html#/s:14HyperwalletSDK0A4UserC0C5FieldO12programTokenyA2EmF":{"name":"programToken","abstract":"\u003cp\u003eThe unique identifier for the program to which the user will belong.\u003c/p\u003e","parent_name":"UserField"},"Classes/HyperwalletUser/UserField.html#/s:14HyperwalletSDK0A4UserC0C5FieldO13stateProvinceyA2EmF":{"name":"stateProvince","abstract":"\u003cp\u003eThe user\u0026rsquo;s state, province or region.\u003c/p\u003e","parent_name":"UserField"},"Classes/HyperwalletUser/UserField.html#/s:14HyperwalletSDK0A4UserC0C5FieldO6statusyA2EmF":{"name":"status","abstract":"\u003cp\u003eThe user account status.\u003c/p\u003e","parent_name":"UserField"},"Classes/HyperwalletUser/UserField.html#/s:14HyperwalletSDK0A4UserC0C5FieldO8timeZoneyA2EmF":{"name":"timeZone","abstract":"\u003cp\u003eThe local time of a region or a country. e.g. GMT, PST, \u0026hellip;\u003c/p\u003e","parent_name":"UserField"},"Classes/HyperwalletUser/UserField.html#/s:14HyperwalletSDK0A4UserC0C5FieldO5tokenyA2EmF":{"name":"token","abstract":"\u003cp\u003eThe unique, auto-generated user identifier. Max 64 characters, prefixed with \u0026ldquo;usr-\u0026rdquo;.\u003c/p\u003e","parent_name":"UserField"},"Classes/HyperwalletUser/UserField.html#/s:14HyperwalletSDK0A4UserC0C5FieldO18verificationStatusyA2EmF":{"name":"verificationStatus","abstract":"\u003cp\u003eThe user\u0026rsquo;s verification status. A user may be required to verify their identity after","parent_name":"UserField"},"Classes/HyperwalletUser/UserField.html":{"name":"UserField","abstract":"\u003cp\u003eRepresentation of the user field type.\u003c/p\u003e","parent_name":"HyperwalletUser"},"Classes/HyperwalletUser/BusinessType.html":{"name":"BusinessType","abstract":"\u003cp\u003eThe business type.\u003c/p\u003e","parent_name":"HyperwalletUser"},"Classes/HyperwalletUser/BusinessContactRole.html":{"name":"BusinessContactRole","abstract":"\u003cp\u003eThe user\u0026rsquo;s role in the organization.\u003c/p\u003e","parent_name":"HyperwalletUser"},"Classes/HyperwalletUser/Gender.html":{"name":"Gender","abstract":"\u003cp\u003eRepresentation of the gender.\u003c/p\u003e","parent_name":"HyperwalletUser"},"Classes/HyperwalletUser/ProfileType.html":{"name":"ProfileType","abstract":"\u003cp\u003eRepresentation of the user\u0026rsquo;s profile type.\u003c/p\u003e","parent_name":"HyperwalletUser"},"Classes/HyperwalletUser/Status.html":{"name":"Status","abstract":"\u003cp\u003eRepresentation of the user account status type.\u003c/p\u003e","parent_name":"HyperwalletUser"},"Classes/HyperwalletUser/VerificationStatus.html":{"name":"VerificationStatus","abstract":"\u003cp\u003eRepresentation of the user\u0026rsquo;s verification status type.\u003c/p\u003e","parent_name":"HyperwalletUser"},"Classes/HyperwalletUser.html#/s:Se4fromxs7Decoder_p_tKcfc":{"name":"init(from:)","parent_name":"HyperwalletUser"},"Classes/HyperwalletUser.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletUser(py)addressLine1":{"name":"addressLine1","abstract":"\u003cp\u003eThe user\u0026rsquo;s street address.\u003c/p\u003e","parent_name":"HyperwalletUser"},"Classes/HyperwalletUser.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletUser(py)addressLine2":{"name":"addressLine2","abstract":"\u003cp\u003eThe user\u0026rsquo;s address, second line.\u003c/p\u003e","parent_name":"HyperwalletUser"},"Classes/HyperwalletUser.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletUser(py)businessContactAddressLine1":{"name":"businessContactAddressLine1","abstract":"\u003cp\u003eThe business contact\u0026rsquo;s street address.\u003c/p\u003e","parent_name":"HyperwalletUser"},"Classes/HyperwalletUser.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletUser(py)businessContactAddressLine2":{"name":"businessContactAddressLine2","abstract":"\u003cp\u003eThe business contact\u0026rsquo;s address, second line.\u003c/p\u003e","parent_name":"HyperwalletUser"},"Classes/HyperwalletUser.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletUser(py)businessContactCity":{"name":"businessContactCity","abstract":"\u003cp\u003eThe business contact\u0026rsquo;s city.\u003c/p\u003e","parent_name":"HyperwalletUser"},"Classes/HyperwalletUser.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletUser(py)businessContactCountry":{"name":"businessContactCountry","abstract":"\u003cp\u003eThe business contact\u0026rsquo;s country,\u003c/p\u003e","parent_name":"HyperwalletUser"},"Classes/HyperwalletUser.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletUser(py)businessContactPostalCode":{"name":"businessContactPostalCode","abstract":"\u003cp\u003eThe business contact\u0026rsquo;s postal code.\u003c/p\u003e","parent_name":"HyperwalletUser"},"Classes/HyperwalletUser.html#/s:14HyperwalletSDK0A4UserC19businessContactRoleAC08BusinesseF0OSgvp":{"name":"businessContactRole","abstract":"\u003cp\u003eThe user\u0026rsquo;s role in the organization\u003c/p\u003e","parent_name":"HyperwalletUser"},"Classes/HyperwalletUser.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletUser(py)businessContactStateProvince":{"name":"businessContactStateProvince","abstract":"\u003cp\u003eThe business contact\u0026rsquo;s state, province or region.\u003c/p\u003e","parent_name":"HyperwalletUser"},"Classes/HyperwalletUser.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletUser(py)businessName":{"name":"businessName","abstract":"\u003cp\u003eThe business name.\u003c/p\u003e","parent_name":"HyperwalletUser"},"Classes/HyperwalletUser.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletUser(py)businessOperatingName":{"name":"businessOperatingName","abstract":"\u003cp\u003eThe business\u0026rsquo; operating name.\u003c/p\u003e","parent_name":"HyperwalletUser"},"Classes/HyperwalletUser.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletUser(py)businessRegistrationCountry":{"name":"businessRegistrationCountry","abstract":"\u003cp\u003eThe country where the business is registered.\u003c/p\u003e","parent_name":"HyperwalletUser"},"Classes/HyperwalletUser.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletUser(py)businessRegistrationId":{"name":"businessRegistrationId","abstract":"\u003cp\u003eThe business registration number or identifier assigned by a government body.\u003c/p\u003e","parent_name":"HyperwalletUser"},"Classes/HyperwalletUser.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletUser(py)businessRegistrationStateProvince":{"name":"businessRegistrationStateProvince","abstract":"\u003cp\u003eThe state, province or region where the business is registered.\u003c/p\u003e","parent_name":"HyperwalletUser"},"Classes/HyperwalletUser.html#/s:14HyperwalletSDK0A4UserC12businessTypeAC08BusinessE0OSgvp":{"name":"businessType","abstract":"\u003cp\u003eThe business type\u003c/p\u003e","parent_name":"HyperwalletUser"},"Classes/HyperwalletUser.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletUser(py)city":{"name":"city","abstract":"\u003cp\u003eThe user\u0026rsquo;s city.\u003c/p\u003e","parent_name":"HyperwalletUser"},"Classes/HyperwalletUser.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletUser(py)clientUserId":{"name":"clientUserId","abstract":"\u003cp\u003eA client-defined identifier for the user. This is the unique ID assigned to the user on your system.\u003c/p\u003e","parent_name":"HyperwalletUser"},"Classes/HyperwalletUser.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletUser(py)country":{"name":"country","abstract":"\u003cp\u003eThe user\u0026rsquo;s country.\u003c/p\u003e","parent_name":"HyperwalletUser"},"Classes/HyperwalletUser.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletUser(py)countryOfBirth":{"name":"countryOfBirth","abstract":"\u003cp\u003eThe user\u0026rsquo;s birth country.\u003c/p\u003e","parent_name":"HyperwalletUser"},"Classes/HyperwalletUser.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletUser(py)countryOfNationality":{"name":"countryOfNationality","abstract":"\u003cp\u003eThe user\u0026rsquo;s country of citizenship or nationality.\u003c/p\u003e","parent_name":"HyperwalletUser"},"Classes/HyperwalletUser.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletUser(py)createdOn":{"name":"createdOn","abstract":"\u003cp\u003eThe datetime the user account was created on in ISO 8601 format (YYYY-MM-DDThh:mm:ss). Note that the timezone","parent_name":"HyperwalletUser"},"Classes/HyperwalletUser.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletUser(py)dateOfBirth":{"name":"dateOfBirth","abstract":"\u003cp\u003eThe user\u0026rsquo;s date of birth (All users must be at least 13 years old).\u003c/p\u003e","parent_name":"HyperwalletUser"},"Classes/HyperwalletUser.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletUser(py)driversLicenseId":{"name":"driversLicenseId","abstract":"\u003cp\u003eThe user\u0026rsquo;s driver\u0026rsquo;s license number.\u003c/p\u003e","parent_name":"HyperwalletUser"},"Classes/HyperwalletUser.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletUser(py)email":{"name":"email","abstract":"\u003cp\u003eThe contact email address for the user account. This must be unique for your program, so you cannot have two","parent_name":"HyperwalletUser"},"Classes/HyperwalletUser.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletUser(py)employerId":{"name":"employerId","abstract":"\u003cp\u003eThe user\u0026rsquo;s employer identifier, generally used for tax purposes.\u003c/p\u003e","parent_name":"HyperwalletUser"},"Classes/HyperwalletUser.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletUser(py)firstName":{"name":"firstName","abstract":"\u003cp\u003eThe user\u0026rsquo;s first name.\u003c/p\u003e","parent_name":"HyperwalletUser"},"Classes/HyperwalletUser.html#/s:14HyperwalletSDK0A4UserC6genderAC6GenderOSgvp":{"name":"gender","abstract":"\u003cp\u003eThe user\u0026rsquo;s gender.\u003c/p\u003e","parent_name":"HyperwalletUser"},"Classes/HyperwalletUser.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletUser(py)governmentId":{"name":"governmentId","abstract":"\u003cp\u003eThe user\u0026rsquo;s government ID number, such as a Social Security Number.\u003c/p\u003e","parent_name":"HyperwalletUser"},"Classes/HyperwalletUser.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletUser(py)governmentIdType":{"name":"governmentIdType","abstract":"\u003cp\u003eThe user\u0026rsquo;s government ID type.\u003c/p\u003e","parent_name":"HyperwalletUser"},"Classes/HyperwalletUser.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletUser(py)language":{"name":"language","abstract":"\u003cp\u003eThe preferred language for the user\u0026rsquo;s account. Defaults to English if not provided.\u003c/p\u003e","parent_name":"HyperwalletUser"},"Classes/HyperwalletUser.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletUser(py)lastName":{"name":"lastName","abstract":"\u003cp\u003eThe user\u0026rsquo;s last name.\u003c/p\u003e","parent_name":"HyperwalletUser"},"Classes/HyperwalletUser.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletUser(py)middleName":{"name":"middleName","abstract":"\u003cp\u003eThe user\u0026rsquo;s middle name.\u003c/p\u003e","parent_name":"HyperwalletUser"},"Classes/HyperwalletUser.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletUser(py)mobileNumber":{"name":"mobileNumber","abstract":"\u003cp\u003eThe user\u0026rsquo;s cell phone number.\u003c/p\u003e","parent_name":"HyperwalletUser"},"Classes/HyperwalletUser.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletUser(py)passportId":{"name":"passportId","abstract":"\u003cp\u003eThe user\u0026rsquo;s passport number.\u003c/p\u003e","parent_name":"HyperwalletUser"},"Classes/HyperwalletUser.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletUser(py)phoneNumber":{"name":"phoneNumber","abstract":"\u003cp\u003eThe user\u0026rsquo;s phone number.\u003c/p\u003e","parent_name":"HyperwalletUser"},"Classes/HyperwalletUser.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletUser(py)postalCode":{"name":"postalCode","abstract":"\u003cp\u003eThe user\u0026rsquo;s postal code.\u003c/p\u003e","parent_name":"HyperwalletUser"},"Classes/HyperwalletUser.html#/s:14HyperwalletSDK0A4UserC11profileTypeAC07ProfileE0OSgvp":{"name":"profileType","abstract":"\u003cp\u003eThe user\u0026rsquo;s profile type. See \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/HyperwalletUser/ProfileType.html\"\u003eProfileType\u003c/a\u003e\u003c/code\u003e\u003c/p\u003e","parent_name":"HyperwalletUser"},"Classes/HyperwalletUser.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletUser(py)programToken":{"name":"programToken","abstract":"\u003cp\u003eThe unique identifier for the program to which the user will belong.\u003c/p\u003e","parent_name":"HyperwalletUser"},"Classes/HyperwalletUser.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletUser(py)stateProvince":{"name":"stateProvince","abstract":"\u003cp\u003eThe user\u0026rsquo;s state, province or region.\u003c/p\u003e","parent_name":"HyperwalletUser"},"Classes/HyperwalletUser.html#/s:14HyperwalletSDK0A4UserC6statusAC6StatusOSgvp":{"name":"status","abstract":"\u003cp\u003eThe user account status.\u003c/p\u003e","parent_name":"HyperwalletUser"},"Classes/HyperwalletUser.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletUser(py)timeZone":{"name":"timeZone","abstract":"\u003cp\u003eThe local time of a region or a country. e.g. GMT, PST, \u0026hellip;\u003c/p\u003e","parent_name":"HyperwalletUser"},"Classes/HyperwalletUser.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletUser(py)token":{"name":"token","abstract":"\u003cp\u003eThe unique, auto-generated user identifier. Max 64 characters, prefixed with \u0026ldquo;usr-\u0026rdquo;.\u003c/p\u003e","parent_name":"HyperwalletUser"},"Classes/HyperwalletUser.html#/s:14HyperwalletSDK0A4UserC18verificationStatusAC012VerificationE0OSgvp":{"name":"verificationStatus","abstract":"\u003cp\u003eThe user\u0026rsquo;s verification status. A user may be required to verify their identity after a certain","parent_name":"HyperwalletUser"},"Classes/HyperwalletUser.html#/s:SE6encode2toys7Encoder_p_tKF":{"name":"encode(to:)","parent_name":"HyperwalletUser"},"Classes/HyperwalletUser.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletUser(im)getField:":{"name":"getField(_:)","abstract":"\u003cp\u003eGets the field value\u003c/p\u003e","parent_name":"HyperwalletUser"},"Classes/HyperwalletUser/Builder.html":{"name":"Builder","abstract":"\u003cp\u003eA helper class to build the \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/HyperwalletUser.html\"\u003eHyperwalletUser\u003c/a\u003e\u003c/code\u003e instance.\u003c/p\u003e","parent_name":"HyperwalletUser"},"Classes/HyperwalletVenmoQueryParam.html#/s:14HyperwalletSDK0A15VenmoQueryParamC02toD0SDyS2SGyF":{"name":"toQuery()","parent_name":"HyperwalletVenmoQueryParam"},"Classes/HyperwalletVenmoAccount/Builder.html#/s:14HyperwalletSDK0A12VenmoAccountC7BuilderC5tokenAESS_tcfc":{"name":"init(token:)","abstract":"\u003cp\u003eCreates a new instance of the \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/HyperwalletVenmoAccount.html\"\u003eHyperwalletVenmoAccount\u003c/a\u003e\u003c/code\u003e based on the required parameter to update","parent_name":"Builder"},"Classes/HyperwalletVenmoAccount/Builder.html#/s:14HyperwalletSDK0A12VenmoAccountC7BuilderC21transferMethodCountry0fG8Currency0fG11ProfileTypeAESS_S2Stcfc":{"name":"init(transferMethodCountry:transferMethodCurrency:transferMethodProfileType:)","abstract":"\u003cp\u003eCreates a new instance of the \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/HyperwalletVenmoAccount.html\"\u003eHyperwalletVenmoAccount\u003c/a\u003e\u003c/code\u003e based on the required parameters to create","parent_name":"Builder"},"Classes/HyperwalletVenmoAccount/Builder.html#/s:14HyperwalletSDK0A12VenmoAccountC7BuilderC9accountIdyAESSF":{"name":"accountId(_:)","abstract":"\u003cp\u003eSets the accountId address\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletVenmoAccount/Builder.html#/s:14HyperwalletSDK0A12VenmoAccountC7BuilderC11profileTypeyAESSF":{"name":"profileType(_:)","abstract":"\u003cp\u003eSets the bank account holder\u0026rsquo;s profile type.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletVenmoAccount/Builder.html#/s:14HyperwalletSDK0A12VenmoAccountC7BuilderC5buildACyF":{"name":"build()","abstract":"\u003cp\u003eBuilds a new instance of the \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/HyperwalletVenmoAccount.html\"\u003eHyperwalletVenmoAccount\u003c/a\u003e\u003c/code\u003e.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletVenmoAccount.html#/s:14HyperwalletSDK0A12VenmoAccountC4fromACs7Decoder_p_tKcfc":{"name":"init(from:)","abstract":"\u003cp\u003eThe required initializer\u003c/p\u003e","parent_name":"HyperwalletVenmoAccount"},"Classes/HyperwalletVenmoAccount.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletVenmoAccount(py)accountId":{"name":"accountId","abstract":"\u003cp\u003eThe accountId as phone number.\u003c/p\u003e","parent_name":"HyperwalletVenmoAccount"},"Classes/HyperwalletVenmoAccount/Builder.html":{"name":"Builder","abstract":"\u003cp\u003eA helper class to build the \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/HyperwalletVenmoAccount.html\"\u003eHyperwalletVenmoAccount\u003c/a\u003e\u003c/code\u003e instance.\u003c/p\u003e","parent_name":"HyperwalletVenmoAccount"},"Classes/HyperwalletTransferMethodQueryParam/QueryType.html#/s:14HyperwalletSDK0A24TransferMethodQueryParamC0E4TypeO11bankAccountyA2EmF":{"name":"bankAccount","abstract":"\u003cp\u003eWhen the transfer method is Bank Account\u003c/p\u003e","parent_name":"QueryType"},"Classes/HyperwalletTransferMethodQueryParam/QueryType.html#/s:14HyperwalletSDK0A24TransferMethodQueryParamC0E4TypeO8bankCardyA2EmF":{"name":"bankCard","abstract":"\u003cp\u003eWhen the transfer method is Bank Card\u003c/p\u003e","parent_name":"QueryType"},"Classes/HyperwalletTransferMethodQueryParam/QueryType.html#/s:14HyperwalletSDK0A24TransferMethodQueryParamC0E4TypeO13payPalAccountyA2EmF":{"name":"payPalAccount","abstract":"\u003cp\u003eWhen the transfer method is PayPal Account\u003c/p\u003e","parent_name":"QueryType"},"Classes/HyperwalletTransferMethodQueryParam/QueryType.html#/s:14HyperwalletSDK0A24TransferMethodQueryParamC0E4TypeO11wireAccountyA2EmF":{"name":"wireAccount","abstract":"\u003cp\u003eWhen the transfer method is Wire Account\u003c/p\u003e","parent_name":"QueryType"},"Classes/HyperwalletTransferMethodQueryParam/QueryType.html#/s:14HyperwalletSDK0A24TransferMethodQueryParamC0E4TypeO11prepaidCardyA2EmF":{"name":"prepaidCard","abstract":"\u003cp\u003eWhen the transfer method is Prepaid Card\u003c/p\u003e","parent_name":"QueryType"},"Classes/HyperwalletTransferMethodQueryParam/QueryType.html#/s:14HyperwalletSDK0A24TransferMethodQueryParamC0E4TypeO12venmoAccountyA2EmF":{"name":"venmoAccount","abstract":"\u003cp\u003eWhen the transfer method is Venmo Account\u003c/p\u003e","parent_name":"QueryType"},"Classes/HyperwalletTransferMethodQueryParam/QueryType.html#/s:14HyperwalletSDK0A24TransferMethodQueryParamC0E4TypeO10paperCheckyA2EmF":{"name":"paperCheck","abstract":"\u003cp\u003eWhen the transfer method is Paper Check\u003c/p\u003e","parent_name":"QueryType"},"Classes/HyperwalletTransferMethodQueryParam/QuerySortable.html#/s:14HyperwalletSDK0A24TransferMethodQueryParamC0E8SortableO18ascendantCreatedOnyA2EmF":{"name":"ascendantCreatedOn","abstract":"\u003cp\u003eSort the result by ascendant created on\u003c/p\u003e","parent_name":"QuerySortable"},"Classes/HyperwalletTransferMethodQueryParam/QuerySortable.html#/s:14HyperwalletSDK0A24TransferMethodQueryParamC0E8SortableO15ascendantStatusyA2EmF":{"name":"ascendantStatus","abstract":"\u003cp\u003eSort the result by ascendant status\u003c/p\u003e","parent_name":"QuerySortable"},"Classes/HyperwalletTransferMethodQueryParam/QuerySortable.html#/s:14HyperwalletSDK0A24TransferMethodQueryParamC0E8SortableO19descendantCreatedOnyA2EmF":{"name":"descendantCreatedOn","abstract":"\u003cp\u003eSort the result by descendant created on\u003c/p\u003e","parent_name":"QuerySortable"},"Classes/HyperwalletTransferMethodQueryParam/QuerySortable.html#/s:14HyperwalletSDK0A24TransferMethodQueryParamC0E8SortableO16descendantStatusyA2EmF":{"name":"descendantStatus","abstract":"\u003cp\u003eSort the result by descendant status\u003c/p\u003e","parent_name":"QuerySortable"},"Classes/HyperwalletTransferMethodQueryParam/QueryStatus.html#/s:14HyperwalletSDK0A24TransferMethodQueryParamC0E6StatusO9activatedyA2EmF":{"name":"activated","abstract":"\u003cp\u003eFilter by activated transfer methods\u003c/p\u003e","parent_name":"QueryStatus"},"Classes/HyperwalletTransferMethodQueryParam/QueryStatus.html#/s:14HyperwalletSDK0A24TransferMethodQueryParamC0E6StatusO11deActivatedyA2EmF":{"name":"deActivated","abstract":"\u003cp\u003eFilter by deActivated transfer methods\u003c/p\u003e","parent_name":"QueryStatus"},"Classes/HyperwalletTransferMethodQueryParam/QueryStatus.html#/s:14HyperwalletSDK0A24TransferMethodQueryParamC0E6StatusO7invalidyA2EmF":{"name":"invalid","abstract":"\u003cp\u003eFilter only invalid transfer methods\u003c/p\u003e","parent_name":"QueryStatus"},"Classes/HyperwalletTransferMethodQueryParam/QueryStatus.html#/s:14HyperwalletSDK0A24TransferMethodQueryParamC0E6StatusO12lostOrStolenyA2EmF":{"name":"lostOrStolen","abstract":"\u003cp\u003eFilter only lost or stolen prepaid cards\u003c/p\u003e","parent_name":"QueryStatus"},"Classes/HyperwalletTransferMethodQueryParam/QueryStatus.html#/s:14HyperwalletSDK0A24TransferMethodQueryParamC0E6StatusO12preActivatedyA2EmF":{"name":"preActivated","abstract":"\u003cp\u003eFilter by preActivated prepaid cards\u003c/p\u003e","parent_name":"QueryStatus"},"Classes/HyperwalletTransferMethodQueryParam/QueryStatus.html#/s:14HyperwalletSDK0A24TransferMethodQueryParamC0E6StatusO9suspendedyA2EmF":{"name":"suspended","abstract":"\u003cp\u003eFilter only suspended prepaid cards\u003c/p\u003e","parent_name":"QueryStatus"},"Classes/HyperwalletTransferMethodQueryParam/QueryStatus.html#/s:14HyperwalletSDK0A24TransferMethodQueryParamC0E6StatusO8verifiedyA2EmF":{"name":"verified","abstract":"\u003cp\u003eFilter only verified transfer methods\u003c/p\u003e","parent_name":"QueryStatus"},"Classes/HyperwalletTransferMethodQueryParam.html#/s:14HyperwalletSDK0A24TransferMethodQueryParamC6statusSSSgvp":{"name":"status","abstract":"\u003cp\u003eReturns transfer method with this status.\u003c/p\u003e","parent_name":"HyperwalletTransferMethodQueryParam"},"Classes/HyperwalletTransferMethodQueryParam.html#/s:14HyperwalletSDK0A24TransferMethodQueryParamC4typeSSSgvp":{"name":"type","abstract":"\u003cp\u003eReturns transfer method of that type\u003c/p\u003e","parent_name":"HyperwalletTransferMethodQueryParam"},"Classes/HyperwalletTransferMethodQueryParam/QueryStatus.html":{"name":"QueryStatus","abstract":"\u003cp\u003eRepresentation of the transfer method status\u003c/p\u003e","parent_name":"HyperwalletTransferMethodQueryParam"},"Classes/HyperwalletTransferMethodQueryParam/QuerySortable.html":{"name":"QuerySortable","abstract":"\u003cp\u003eRepresentation of the field\u0026rsquo;s sortable\u003c/p\u003e","parent_name":"HyperwalletTransferMethodQueryParam"},"Classes/HyperwalletTransferMethodQueryParam/QueryType.html":{"name":"QueryType","abstract":"\u003cp\u003eRepresentation of the transfer method\u0026rsquo;s type\u003c/p\u003e","parent_name":"HyperwalletTransferMethodQueryParam"},"Classes/HyperwalletTransferMethodQueryParam.html#/s:14HyperwalletSDK0A24TransferMethodQueryParamC02toE0SDyS2SGyF":{"name":"toQuery()","parent_name":"HyperwalletTransferMethodQueryParam"},"Classes/HyperwalletTransferMethod/TransferMethodType.html#/s:14HyperwalletSDK0A14TransferMethodC0cD4TypeO11bankAccountyA2EmF":{"name":"bankAccount","abstract":"\u003cp\u003eWhen the transfer method is Bank Account\u003c/p\u003e","parent_name":"TransferMethodType"},"Classes/HyperwalletTransferMethod/TransferMethodType.html#/s:14HyperwalletSDK0A14TransferMethodC0cD4TypeO8bankCardyA2EmF":{"name":"bankCard","abstract":"\u003cp\u003eWhen the transfer method is Bank Card\u003c/p\u003e","parent_name":"TransferMethodType"},"Classes/HyperwalletTransferMethod/TransferMethodType.html#/s:14HyperwalletSDK0A14TransferMethodC0cD4TypeO13payPalAccountyA2EmF":{"name":"payPalAccount","abstract":"\u003cp\u003eWhen the transfer method is PayPal Account\u003c/p\u003e","parent_name":"TransferMethodType"},"Classes/HyperwalletTransferMethod/TransferMethodType.html#/s:14HyperwalletSDK0A14TransferMethodC0cD4TypeO11wireAccountyA2EmF":{"name":"wireAccount","abstract":"\u003cp\u003eWhen the transfer method is Wire Account\u003c/p\u003e","parent_name":"TransferMethodType"},"Classes/HyperwalletTransferMethod/TransferMethodType.html#/s:14HyperwalletSDK0A14TransferMethodC0cD4TypeO11prepaidCardyA2EmF":{"name":"prepaidCard","abstract":"\u003cp\u003eWhen the transfer method is Prepaid Card\u003c/p\u003e","parent_name":"TransferMethodType"},"Classes/HyperwalletTransferMethod/TransferMethodType.html#/s:14HyperwalletSDK0A14TransferMethodC0cD4TypeO12venmoAccountyA2EmF":{"name":"venmoAccount","abstract":"\u003cp\u003eWhen the transfer method is Venmo Account\u003c/p\u003e","parent_name":"TransferMethodType"},"Classes/HyperwalletTransferMethod/TransferMethodType.html#/s:14HyperwalletSDK0A14TransferMethodC0cD4TypeO10paperCheckyA2EmF":{"name":"paperCheck","abstract":"\u003cp\u003ewhen transfer method is paper check\u003c/p\u003e","parent_name":"TransferMethodType"},"Classes/HyperwalletTransferMethod/TransferMethodField.html#/s:14HyperwalletSDK0A14TransferMethodC0cD5FieldO9createdOnyA2EmF":{"name":"createdOn","abstract":"\u003cp\u003eThe datetime when the transfer method was created on.\u003c/p\u003e","parent_name":"TransferMethodField"},"Classes/HyperwalletTransferMethod/TransferMethodField.html#/s:14HyperwalletSDK0A14TransferMethodC0cD5FieldO6statusyA2EmF":{"name":"status","abstract":"\u003cp\u003eThe transfer method status transition.\u003c/p\u003e","parent_name":"TransferMethodField"},"Classes/HyperwalletTransferMethod/TransferMethodField.html#/s:14HyperwalletSDK0A14TransferMethodC0cD5FieldO5tokenyA2EmF":{"name":"token","abstract":"\u003cp\u003eThe transfer method identifier.\u003c/p\u003e","parent_name":"TransferMethodField"},"Classes/HyperwalletTransferMethod/TransferMethodField.html#/s:14HyperwalletSDK0A14TransferMethodC0cD5FieldO08transferD7CountryyA2EmF":{"name":"transferMethodCountry","abstract":"\u003cp\u003eThe transfer method country.\u003c/p\u003e","parent_name":"TransferMethodField"},"Classes/HyperwalletTransferMethod/TransferMethodField.html#/s:14HyperwalletSDK0A14TransferMethodC0cD5FieldO08transferD8CurrencyyA2EmF":{"name":"transferMethodCurrency","abstract":"\u003cp\u003eThe transfer method currency.\u003c/p\u003e","parent_name":"TransferMethodField"},"Classes/HyperwalletTransferMethod/TransferMethodField.html#/s:14HyperwalletSDK0A14TransferMethodC0cD5FieldO4typeyA2EmF":{"name":"type","abstract":"\u003cp\u003eThe transfer method type.\u003c/p\u003e","parent_name":"TransferMethodField"},"Classes/HyperwalletTransferMethod/TransferMethodField.html#/s:14HyperwalletSDK0A14TransferMethodC0cD5FieldO12addressLine1yA2EmF":{"name":"addressLine1","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s street address.\u003c/p\u003e","parent_name":"TransferMethodField"},"Classes/HyperwalletTransferMethod/TransferMethodField.html#/s:14HyperwalletSDK0A14TransferMethodC0cD5FieldO12addressLine2yA2EmF":{"name":"addressLine2","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s address, second line.\u003c/p\u003e","parent_name":"TransferMethodField"},"Classes/HyperwalletTransferMethod/TransferMethodField.html#/s:14HyperwalletSDK0A14TransferMethodC0cD5FieldO13bankAccountIdyA2EmF":{"name":"bankAccountId","abstract":"\u003cp\u003eThe bank account number, IBAN or equivalent. If you are providing an IBAN,","parent_name":"TransferMethodField"},"Classes/HyperwalletTransferMethod/TransferMethodField.html#/s:14HyperwalletSDK0A14TransferMethodC0cD5FieldO18bankAccountPurposeyA2EmF":{"name":"bankAccountPurpose","abstract":"\u003cp\u003eThe purpose of the bank account (e.g. checking, savings, etc).\u003c/p\u003e","parent_name":"TransferMethodField"},"Classes/HyperwalletTransferMethod/TransferMethodField.html#/s:14HyperwalletSDK0A14TransferMethodC0cD5FieldO23bankAccountRelationshipyA2EmF":{"name":"bankAccountRelationship","abstract":"\u003cp\u003eThe user\u0026rsquo;s relationship with the bank account holder.\u003c/p\u003e","parent_name":"TransferMethodField"},"Classes/HyperwalletTransferMethod/TransferMethodField.html#/s:14HyperwalletSDK0A14TransferMethodC0cD5FieldO6bankIdyA2EmF":{"name":"bankId","abstract":"\u003cp\u003eThe bank code or equivalent (e.g. BIC/SWIFT code).\u003c/p\u003e","parent_name":"TransferMethodField"},"Classes/HyperwalletTransferMethod/TransferMethodField.html#/s:14HyperwalletSDK0A14TransferMethodC0cD5FieldO8bankNameyA2EmF":{"name":"bankName","abstract":"\u003cp\u003eThe bank name.\u003c/p\u003e","parent_name":"TransferMethodField"},"Classes/HyperwalletTransferMethod/TransferMethodField.html#/s:14HyperwalletSDK0A14TransferMethodC0cD5FieldO8branchIdyA2EmF":{"name":"branchId","abstract":"\u003cp\u003eThe branch code, transit number, routing number or equivalent.\u003c/p\u003e","parent_name":"TransferMethodField"},"Classes/HyperwalletTransferMethod/TransferMethodField.html#/s:14HyperwalletSDK0A14TransferMethodC0cD5FieldO10branchNameyA2EmF":{"name":"branchName","abstract":"\u003cp\u003eThe branch name\u003c/p\u003e","parent_name":"TransferMethodField"},"Classes/HyperwalletTransferMethod/TransferMethodField.html#/s:14HyperwalletSDK0A14TransferMethodC0cD5FieldO19businessContactRoleyA2EmF":{"name":"businessContactRole","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s role in the organization.\u003c/p\u003e","parent_name":"TransferMethodField"},"Classes/HyperwalletTransferMethod/TransferMethodField.html#/s:14HyperwalletSDK0A14TransferMethodC0cD5FieldO12businessNameyA2EmF":{"name":"businessName","abstract":"\u003cp\u003eThe name of the transfer method holder\u0026rsquo;s business\u003c/p\u003e","parent_name":"TransferMethodField"},"Classes/HyperwalletTransferMethod/TransferMethodField.html#/s:14HyperwalletSDK0A14TransferMethodC0cD5FieldO27businessRegistrationCountryyA2EmF":{"name":"businessRegistrationCountry","abstract":"\u003cp\u003eThe country where the transfer method holder\u0026rsquo;s business is registered\u003c/p\u003e","parent_name":"TransferMethodField"},"Classes/HyperwalletTransferMethod/TransferMethodField.html#/s:14HyperwalletSDK0A14TransferMethodC0cD5FieldO22businessRegistrationIdyA2EmF":{"name":"businessRegistrationId","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s business registration number or identifier, as","parent_name":"TransferMethodField"},"Classes/HyperwalletTransferMethod/TransferMethodField.html#/s:14HyperwalletSDK0A14TransferMethodC0cD5FieldO33businessRegistrationStateProvinceyA2EmF":{"name":"businessRegistrationStateProvince","abstract":"\u003cp\u003eThe state, province or region where the bank account holder\u0026rsquo;s business","parent_name":"TransferMethodField"},"Classes/HyperwalletTransferMethod/TransferMethodField.html#/s:14HyperwalletSDK0A14TransferMethodC0cD5FieldO12businessTypeyA2EmF":{"name":"businessType","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s business type.\u003c/p\u003e","parent_name":"TransferMethodField"},"Classes/HyperwalletTransferMethod/TransferMethodField.html#/s:14HyperwalletSDK0A14TransferMethodC0cD5FieldO4cityyA2EmF":{"name":"city","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s city.\u003c/p\u003e","parent_name":"TransferMethodField"},"Classes/HyperwalletTransferMethod/TransferMethodField.html#/s:14HyperwalletSDK0A14TransferMethodC0cD5FieldO7countryyA2EmF":{"name":"country","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s country.\u003c/p\u003e","parent_name":"TransferMethodField"},"Classes/HyperwalletTransferMethod/TransferMethodField.html#/s:14HyperwalletSDK0A14TransferMethodC0cD5FieldO14countryOfBirthyA2EmF":{"name":"countryOfBirth","abstract":"\u003cp\u003eThe country where bank account holder born\u003c/p\u003e","parent_name":"TransferMethodField"},"Classes/HyperwalletTransferMethod/TransferMethodField.html#/s:14HyperwalletSDK0A14TransferMethodC0cD5FieldO20countryOfNationalityyA2EmF":{"name":"countryOfNationality","abstract":"\u003cp\u003eThe Nationality of the bank account holder\u003c/p\u003e","parent_name":"TransferMethodField"},"Classes/HyperwalletTransferMethod/TransferMethodField.html#/s:14HyperwalletSDK0A14TransferMethodC0cD5FieldO11dateOfBirthyA2EmF":{"name":"dateOfBirth","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s date of birth.\u003c/p\u003e","parent_name":"TransferMethodField"},"Classes/HyperwalletTransferMethod/TransferMethodField.html#/s:14HyperwalletSDK0A14TransferMethodC0cD5FieldO16driversLicenseIdyA2EmF":{"name":"driversLicenseId","abstract":"\u003cp\u003eThe LicenseId of the bank account holder\u003c/p\u003e","parent_name":"TransferMethodField"},"Classes/HyperwalletTransferMethod/TransferMethodField.html#/s:14HyperwalletSDK0A14TransferMethodC0cD5FieldO10employerIdyA2EmF":{"name":"employerId","abstract":"\u003cp\u003eThe employer Id of the bank account holder\u003c/p\u003e","parent_name":"TransferMethodField"},"Classes/HyperwalletTransferMethod/TransferMethodField.html#/s:14HyperwalletSDK0A14TransferMethodC0cD5FieldO9firstNameyA2EmF":{"name":"firstName","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s first name.\u003c/p\u003e","parent_name":"TransferMethodField"},"Classes/HyperwalletTransferMethod/TransferMethodField.html#/s:14HyperwalletSDK0A14TransferMethodC0cD5FieldO6genderyA2EmF":{"name":"gender","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s gender\u003c/p\u003e","parent_name":"TransferMethodField"},"Classes/HyperwalletTransferMethod/TransferMethodField.html#/s:14HyperwalletSDK0A14TransferMethodC0cD5FieldO12governmentIdyA2EmF":{"name":"governmentId","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s government ID number, such as a Social Security Number.\u003c/p\u003e","parent_name":"TransferMethodField"},"Classes/HyperwalletTransferMethod/TransferMethodField.html#/s:14HyperwalletSDK0A14TransferMethodC0cD5FieldO16governmentIdTypeyA2EmF":{"name":"governmentIdType","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s government IdType\u003c/p\u003e","parent_name":"TransferMethodField"},"Classes/HyperwalletTransferMethod/TransferMethodField.html#/s:14HyperwalletSDK0A14TransferMethodC0cD5FieldO25intermediaryBankAccountIdyA2EmF":{"name":"intermediaryBankAccountId","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s Intermediary Bank AccountId\u003c/p\u003e","parent_name":"TransferMethodField"},"Classes/HyperwalletTransferMethod/TransferMethodField.html#/s:14HyperwalletSDK0A14TransferMethodC0cD5FieldO28intermediaryBankAddressLine1yA2EmF":{"name":"intermediaryBankAddressLine1","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s Intermediary Bank AddressLine1\u003c/p\u003e","parent_name":"TransferMethodField"},"Classes/HyperwalletTransferMethod/TransferMethodField.html#/s:14HyperwalletSDK0A14TransferMethodC0cD5FieldO28intermediaryBankAddressLine2yA2EmF":{"name":"intermediaryBankAddressLine2","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s Intermediary Bank AddressLine2\u003c/p\u003e","parent_name":"TransferMethodField"},"Classes/HyperwalletTransferMethod/TransferMethodField.html#/s:14HyperwalletSDK0A14TransferMethodC0cD5FieldO20intermediaryBankCityyA2EmF":{"name":"intermediaryBankCity","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s Intermediary Bank\u0026rsquo;s City\u003c/p\u003e","parent_name":"TransferMethodField"},"Classes/HyperwalletTransferMethod/TransferMethodField.html#/s:14HyperwalletSDK0A14TransferMethodC0cD5FieldO23intermediaryBankCountryyA2EmF":{"name":"intermediaryBankCountry","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s Intermediary Bank\u0026rsquo;s Country\u003c/p\u003e","parent_name":"TransferMethodField"},"Classes/HyperwalletTransferMethod/TransferMethodField.html#/s:14HyperwalletSDK0A14TransferMethodC0cD5FieldO18intermediaryBankIdyA2EmF":{"name":"intermediaryBankId","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s Intermediary Bank Id\u003c/p\u003e","parent_name":"TransferMethodField"},"Classes/HyperwalletTransferMethod/TransferMethodField.html#/s:14HyperwalletSDK0A14TransferMethodC0cD5FieldO20intermediaryBankNameyA2EmF":{"name":"intermediaryBankName","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s Intermediary Bank Name\u003c/p\u003e","parent_name":"TransferMethodField"},"Classes/HyperwalletTransferMethod/TransferMethodField.html#/s:14HyperwalletSDK0A14TransferMethodC0cD5FieldO26intermediaryBankPostalCodeyA2EmF":{"name":"intermediaryBankPostalCode","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s Intermediary PostalCode:\u003c/p\u003e","parent_name":"TransferMethodField"},"Classes/HyperwalletTransferMethod/TransferMethodField.html#/s:14HyperwalletSDK0A14TransferMethodC0cD5FieldO29intermediaryBankStateProvinceyA2EmF":{"name":"intermediaryBankStateProvince","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s Intermediary Bank\u0026rsquo;s State and Province\u003c/p\u003e","parent_name":"TransferMethodField"},"Classes/HyperwalletTransferMethod/TransferMethodField.html#/s:14HyperwalletSDK0A14TransferMethodC0cD5FieldO8lastNameyA2EmF":{"name":"lastName","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s last name.\u003c/p\u003e","parent_name":"TransferMethodField"},"Classes/HyperwalletTransferMethod/TransferMethodField.html#/s:14HyperwalletSDK0A14TransferMethodC0cD5FieldO10middleNameyA2EmF":{"name":"middleName","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s middle name.\u003c/p\u003e","parent_name":"TransferMethodField"},"Classes/HyperwalletTransferMethod/TransferMethodField.html#/s:14HyperwalletSDK0A14TransferMethodC0cD5FieldO12mobileNumberyA2EmF":{"name":"mobileNumber","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s mobile number\u003c/p\u003e","parent_name":"TransferMethodField"},"Classes/HyperwalletTransferMethod/TransferMethodField.html#/s:14HyperwalletSDK0A14TransferMethodC0cD5FieldO10passportIdyA2EmF":{"name":"passportId","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s passport Id\u003c/p\u003e","parent_name":"TransferMethodField"},"Classes/HyperwalletTransferMethod/TransferMethodField.html#/s:14HyperwalletSDK0A14TransferMethodC0cD5FieldO11phoneNumberyA2EmF":{"name":"phoneNumber","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s phone number.\u003c/p\u003e","parent_name":"TransferMethodField"},"Classes/HyperwalletTransferMethod/TransferMethodField.html#/s:14HyperwalletSDK0A14TransferMethodC0cD5FieldO10postalCodeyA2EmF":{"name":"postalCode","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s postal code.\u003c/p\u003e","parent_name":"TransferMethodField"},"Classes/HyperwalletTransferMethod/TransferMethodField.html#/s:14HyperwalletSDK0A14TransferMethodC0cD5FieldO11profileTypeyA2EmF":{"name":"profileType","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s profile type.\u003c/p\u003e","parent_name":"TransferMethodField"},"Classes/HyperwalletTransferMethod/TransferMethodField.html#/s:14HyperwalletSDK0A14TransferMethodC0cD5FieldO13stateProvinceyA2EmF":{"name":"stateProvince","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s state, province or region.\u003c/p\u003e","parent_name":"TransferMethodField"},"Classes/HyperwalletTransferMethod/TransferMethodField.html#/s:14HyperwalletSDK0A14TransferMethodC0cD5FieldO16wireInstructionsyA2EmF":{"name":"wireInstructions","abstract":"\u003cp\u003eThe wire transfer instructions\u003c/p\u003e","parent_name":"TransferMethodField"},"Classes/HyperwalletTransferMethod/TransferMethodField.html#/s:14HyperwalletSDK0A14TransferMethodC0cD5FieldO9cardBrandyA2EmF":{"name":"cardBrand","abstract":"\u003cp\u003eThe card brand.\u003c/p\u003e","parent_name":"TransferMethodField"},"Classes/HyperwalletTransferMethod/TransferMethodField.html#/s:14HyperwalletSDK0A14TransferMethodC0cD5FieldO10cardNumberyA2EmF":{"name":"cardNumber","abstract":"\u003cp\u003eThe 16-digit card number.\u003c/p\u003e","parent_name":"TransferMethodField"},"Classes/HyperwalletTransferMethod/TransferMethodField.html#/s:14HyperwalletSDK0A14TransferMethodC0cD5FieldO8cardTypeyA2EmF":{"name":"cardType","abstract":"\u003cp\u003eThe bank card type.\u003c/p\u003e","parent_name":"TransferMethodField"},"Classes/HyperwalletTransferMethod/TransferMethodField.html#/s:14HyperwalletSDK0A14TransferMethodC0cD5FieldO3cvvyA2EmF":{"name":"cvv","abstract":"\u003cp\u003eThe card security code which is embossed or printed on the card.\u003c/p\u003e","parent_name":"TransferMethodField"},"Classes/HyperwalletTransferMethod/TransferMethodField.html#/s:14HyperwalletSDK0A14TransferMethodC0cD5FieldO12dateOfExpiryyA2EmF":{"name":"dateOfExpiry","abstract":"\u003cp\u003eThe expiration date for the card (YYYY-MM).\u003c/p\u003e","parent_name":"TransferMethodField"},"Classes/HyperwalletTransferMethod/TransferMethodField.html#/s:14HyperwalletSDK0A14TransferMethodC0cD5FieldO16primaryCardTokenyA2EmF":{"name":"primaryCardToken","abstract":"\u003cp\u003eThe primary card token\u003c/p\u003e","parent_name":"TransferMethodField"},"Classes/HyperwalletTransferMethod/TransferMethodField.html#/s:14HyperwalletSDK0A14TransferMethodC0cD5FieldO5emailyA2EmF":{"name":"email","abstract":"\u003cp\u003eThe email address associated with the PayPal account.\u003c/p\u003e","parent_name":"TransferMethodField"},"Classes/HyperwalletTransferMethod/TransferMethodField.html#/s:14HyperwalletSDK0A14TransferMethodC0cD5FieldO9accountIdyA2EmF":{"name":"accountId","abstract":"\u003cp\u003eThe mobile number associated with the Venmo account.\u003c/p\u003e","parent_name":"TransferMethodField"},"Classes/HyperwalletTransferMethod/TransferMethodField.html#/s:14HyperwalletSDK0A14TransferMethodC0cD5FieldO11cardPackageyA2EmF":{"name":"cardPackage","abstract":"\u003cp\u003eThe card\u0026rsquo;s package\u003c/p\u003e","parent_name":"TransferMethodField"},"Classes/HyperwalletTransferMethod/TransferMethodField.html#/s:14HyperwalletSDK0A14TransferMethodC0cD5FieldO9userTokenyA2EmF":{"name":"userToken","abstract":"\u003cp\u003eThe user token\u003c/p\u003e","parent_name":"TransferMethodField"},"Classes/HyperwalletTransferMethod/TransferMethodField.html#/s:14HyperwalletSDK0A14TransferMethodC0cD5FieldO08shippingD0yA2EmF":{"name":"shippingMethod","abstract":"\u003cp\u003eThe shipping method\u003c/p\u003e","parent_name":"TransferMethodField"},"Classes/HyperwalletTransferMethod/TransferMethodField.html":{"name":"TransferMethodField","abstract":"\u003cp\u003eRepresentation of the transfer method\u0026rsquo;s field type\u003c/p\u003e","parent_name":"HyperwalletTransferMethod"},"Classes/HyperwalletTransferMethod/TransferMethodType.html":{"name":"TransferMethodType","abstract":"\u003cp\u003eRepresentation of the transfer method\u0026rsquo;s type\u003c/p\u003e","parent_name":"HyperwalletTransferMethod"},"Classes/HyperwalletTransferMethod.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletTransferMethod(im)init":{"name":"init()","abstract":"\u003cp\u003eCreates a new instance of the \u003ccode\u003eHyperwalletTransferMethod\u003c/code\u003e\u003c/p\u003e","parent_name":"HyperwalletTransferMethod"},"Classes/HyperwalletTransferMethod.html#/s:Se4fromxs7Decoder_p_tKcfc":{"name":"init(from:)","parent_name":"HyperwalletTransferMethod"},"Classes/HyperwalletTransferMethod.html#/s:SE6encode2toys7Encoder_p_tKF":{"name":"encode(to:)","parent_name":"HyperwalletTransferMethod"},"Classes/HyperwalletTransferMethod.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletTransferMethod(im)getField:":{"name":"getField(_:)","abstract":"\u003cp\u003eGets the field value\u003c/p\u003e","parent_name":"HyperwalletTransferMethod"},"Classes/HyperwalletTransferMethod.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletTransferMethod(im)setFieldWithKey:value:":{"name":"setField(key:value:)","abstract":"\u003cp\u003eSets the field value based on the key\u003c/p\u003e","parent_name":"HyperwalletTransferMethod"},"Classes/HyperwalletTransferMethod.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletTransferMethod(py)createdOn":{"name":"createdOn","abstract":"\u003cp\u003eThe transfer method\u0026rsquo;s created time\u003c/p\u003e","parent_name":"HyperwalletTransferMethod"},"Classes/HyperwalletTransferMethod.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletTransferMethod(py)profileType":{"name":"profileType","abstract":"\u003cp\u003eThe transfer method holder\u0026rsquo;s profile type, e.g. INDIVIDUAL or BUSINESS.\u003c/p\u003e","parent_name":"HyperwalletTransferMethod"},"Classes/HyperwalletTransferMethod.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletTransferMethod(py)status":{"name":"status","abstract":"\u003cp\u003eThe transfer method\u0026rsquo;s status\u003c/p\u003e","parent_name":"HyperwalletTransferMethod"},"Classes/HyperwalletTransferMethod.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletTransferMethod(py)token":{"name":"token","abstract":"\u003cp\u003eThe transfer method\u0026rsquo;s token\u003c/p\u003e","parent_name":"HyperwalletTransferMethod"},"Classes/HyperwalletTransferMethod.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletTransferMethod(py)transferMethodCountry":{"name":"transferMethodCountry","abstract":"\u003cp\u003eThe transfer method\u0026rsquo;s country\u003c/p\u003e","parent_name":"HyperwalletTransferMethod"},"Classes/HyperwalletTransferMethod.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletTransferMethod(py)transferMethodCurrency":{"name":"transferMethodCurrency","abstract":"\u003cp\u003eThe transfer method\u0026rsquo;s currency\u003c/p\u003e","parent_name":"HyperwalletTransferMethod"},"Classes/HyperwalletTransferMethod.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletTransferMethod(py)type":{"name":"type","abstract":"\u003cp\u003eThe transfer method\u0026rsquo;s type\u003c/p\u003e","parent_name":"HyperwalletTransferMethod"},"Classes/HyperwalletPrepaidCardQueryParam.html#/s:14HyperwalletSDK0A21PrepaidCardQueryParamC02toE0SDyS2SGyF":{"name":"toQuery()","parent_name":"HyperwalletPrepaidCardQueryParam"},"Classes/HyperwalletPrepaidCard/Builder.html#/s:14HyperwalletSDK0A11PrepaidCardC7BuilderC5tokenAESS_tcfc":{"name":"init(token:)","abstract":"\u003cp\u003eCreates a new instance of the \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/HyperwalletPayPalAccount.html\"\u003eHyperwalletPayPalAccount\u003c/a\u003e\u003c/code\u003e based on the required parameter to update","parent_name":"Builder"},"Classes/HyperwalletPrepaidCard/Builder.html#/s:14HyperwalletSDK0A11PrepaidCardC7BuilderC25transferMethodProfileTypeAESS_tcfc":{"name":"init(transferMethodProfileType:)","abstract":"\u003cp\u003eCreates a new instance of the \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/HyperwalletPrepaidCard.html\"\u003eHyperwalletPrepaidCard\u003c/a\u003e\u003c/code\u003e based on the required parameters to create","parent_name":"Builder"},"Classes/HyperwalletPrepaidCard/Builder.html#/s:14HyperwalletSDK0A11PrepaidCardC7BuilderC11cardPackageyAESSF":{"name":"cardPackage(_:)","abstract":"\u003cp\u003eSets the card package\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletPrepaidCard/Builder.html#/s:14HyperwalletSDK0A11PrepaidCardC7BuilderC9userTokenyAESSF":{"name":"userToken(_:)","abstract":"\u003cp\u003eSets userToken for an instant issue card\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletPrepaidCard/Builder.html#/s:14HyperwalletSDK0A11PrepaidCardC7BuilderC5buildACyF":{"name":"build()","abstract":"\u003cp\u003eBuilds a new instance of the \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/HyperwalletPrepaidCard.html\"\u003eHyperwalletPrepaidCard\u003c/a\u003e\u003c/code\u003e.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletPrepaidCard.html#/s:14HyperwalletSDK0A11PrepaidCardC4fromACs7Decoder_p_tKcfc":{"name":"init(from:)","abstract":"\u003cp\u003eThe required initializer\u003c/p\u003e","parent_name":"HyperwalletPrepaidCard"},"Classes/HyperwalletPrepaidCard.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletPrepaidCard(py)cardType":{"name":"cardType","abstract":"\u003cp\u003eThe prepaid card\u0026rsquo;s type\u003c/p\u003e","parent_name":"HyperwalletPrepaidCard"},"Classes/HyperwalletPrepaidCard.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletPrepaidCard(py)cardPackage":{"name":"cardPackage","abstract":"\u003cp\u003eThe prepaid card\u0026rsquo;s package\u003c/p\u003e","parent_name":"HyperwalletPrepaidCard"},"Classes/HyperwalletPrepaidCard.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletPrepaidCard(py)cardNumber":{"name":"cardNumber","abstract":"\u003cp\u003eThe prepaid card\u0026rsquo;s number\u003c/p\u003e","parent_name":"HyperwalletPrepaidCard"},"Classes/HyperwalletPrepaidCard.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletPrepaidCard(py)cardBrand":{"name":"cardBrand","abstract":"\u003cp\u003eThe prepaid card\u0026rsquo;s brand\u003c/p\u003e","parent_name":"HyperwalletPrepaidCard"},"Classes/HyperwalletPrepaidCard.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletPrepaidCard(py)dateOfExpiry":{"name":"dateOfExpiry","abstract":"\u003cp\u003eThe prepaid card\u0026rsquo;s expiry date\u003c/p\u003e","parent_name":"HyperwalletPrepaidCard"},"Classes/HyperwalletPrepaidCard.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletPrepaidCard(py)primaryCardToken":{"name":"primaryCardToken","abstract":"\u003cp\u003eThe primary prepaid card\u0026rsquo;s token\u003c/p\u003e","parent_name":"HyperwalletPrepaidCard"},"Classes/HyperwalletPrepaidCard.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletPrepaidCard(py)userToken":{"name":"userToken","abstract":"\u003cp\u003eThe prepaid card\u0026rsquo;s user token (instant issue cards only)\u003c/p\u003e","parent_name":"HyperwalletPrepaidCard"},"Classes/HyperwalletPrepaidCard/Builder.html":{"name":"Builder","abstract":"\u003cp\u003eA helper class to build the \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/HyperwalletPrepaidCard.html\"\u003eHyperwalletPrepaidCard\u003c/a\u003e\u003c/code\u003e instance.\u003c/p\u003e","parent_name":"HyperwalletPrepaidCard"},"Classes/HyperwalletPayPalAccountQueryParam.html#/s:14HyperwalletSDK0A23PayPalAccountQueryParamC02toF0SDyS2SGyF":{"name":"toQuery()","parent_name":"HyperwalletPayPalAccountQueryParam"},"Classes/HyperwalletPayPalAccount/Builder.html#/s:14HyperwalletSDK0A13PayPalAccountC7BuilderC5tokenAESS_tcfc":{"name":"init(token:)","abstract":"\u003cp\u003eCreates a new instance of the \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/HyperwalletPayPalAccount.html\"\u003eHyperwalletPayPalAccount\u003c/a\u003e\u003c/code\u003e based on the required parameter to update","parent_name":"Builder"},"Classes/HyperwalletPayPalAccount/Builder.html#/s:14HyperwalletSDK0A13PayPalAccountC7BuilderC21transferMethodCountry0gH8Currency0gH11ProfileTypeAESS_S2Stcfc":{"name":"init(transferMethodCountry:transferMethodCurrency:transferMethodProfileType:)","abstract":"\u003cp\u003eCreates a new instance of the \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/HyperwalletPayPalAccount.html\"\u003eHyperwalletPayPalAccount\u003c/a\u003e\u003c/code\u003e based on the required parameters to create","parent_name":"Builder"},"Classes/HyperwalletPayPalAccount/Builder.html#/s:14HyperwalletSDK0A13PayPalAccountC7BuilderC5emailyAESSF":{"name":"email(_:)","abstract":"\u003cp\u003eSets the email address\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletPayPalAccount/Builder.html#/s:14HyperwalletSDK0A13PayPalAccountC7BuilderC11profileTypeyAESSF":{"name":"profileType(_:)","abstract":"\u003cp\u003eSets the bank account holder\u0026rsquo;s profile type.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletPayPalAccount/Builder.html#/s:14HyperwalletSDK0A13PayPalAccountC7BuilderC5buildACyF":{"name":"build()","abstract":"\u003cp\u003eBuilds a new instance of the \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/HyperwalletPayPalAccount.html\"\u003eHyperwalletPayPalAccount\u003c/a\u003e\u003c/code\u003e.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletPayPalAccount.html#/s:14HyperwalletSDK0A13PayPalAccountC4fromACs7Decoder_p_tKcfc":{"name":"init(from:)","abstract":"\u003cp\u003eThe required initializer\u003c/p\u003e","parent_name":"HyperwalletPayPalAccount"},"Classes/HyperwalletPayPalAccount.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletPayPalAccount(py)email":{"name":"email","abstract":"\u003cp\u003eThe email address.\u003c/p\u003e","parent_name":"HyperwalletPayPalAccount"},"Classes/HyperwalletPayPalAccount/Builder.html":{"name":"Builder","abstract":"\u003cp\u003eA helper class to build the \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/HyperwalletPayPalAccount.html\"\u003eHyperwalletPayPalAccount\u003c/a\u003e\u003c/code\u003e instance.\u003c/p\u003e","parent_name":"HyperwalletPayPalAccount"},"Classes/HyperwalletPaperCheckQueryParam.html#/s:14HyperwalletSDK0A20PaperCheckQueryParamC02toE0SDyS2SGyF":{"name":"toQuery()","parent_name":"HyperwalletPaperCheckQueryParam"},"Classes/HyperwalletPaperCheck/Builder.html#/s:14HyperwalletSDK0A10PaperCheckC7BuilderC5tokenAESS_tcfc":{"name":"init(token:)","abstract":"\u003cp\u003eCreates a new instance of the \u003ccode\u003eHyperwalletPaperCheck.Builder\u003c/code\u003e","parent_name":"Builder"},"Classes/HyperwalletPaperCheck/Builder.html#/s:14HyperwalletSDK0A10PaperCheckC7BuilderC21transferMethodCountry0fG8Currency0fG11ProfileType0fgK0AESS_S3Stcfc":{"name":"init(transferMethodCountry:transferMethodCurrency:transferMethodProfileType:transferMethodType:)","abstract":"\u003cp\u003eCreates a new instance of the \u003ccode\u003eHyperwalletPaperCheck.Builder\u003c/code\u003e","parent_name":"Builder"},"Classes/HyperwalletPaperCheck/Builder.html#/s:14HyperwalletSDK0A10PaperCheckC7BuilderC12addressLine1yAESSF":{"name":"addressLine1(_:)","abstract":"\u003cp\u003eSets the bank account holder\u0026rsquo;s street address.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletPaperCheck/Builder.html#/s:14HyperwalletSDK0A10PaperCheckC7BuilderC12addressLine2yAESSF":{"name":"addressLine2(_:)","abstract":"\u003cp\u003eSets the bank account holder\u0026rsquo;s address, second line.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletPaperCheck/Builder.html#/s:14HyperwalletSDK0A10PaperCheckC7BuilderC23bankAccountRelationshipyAESSF":{"name":"bankAccountRelationship(_:)","abstract":"\u003cp\u003eSets the user\u0026rsquo;s relationship with the bank account holder.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletPaperCheck/Builder.html#/s:14HyperwalletSDK0A10PaperCheckC7BuilderC4cityyAESSF":{"name":"city(_:)","abstract":"\u003cp\u003eSets the bank account holder\u0026rsquo;s city.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletPaperCheck/Builder.html#/s:14HyperwalletSDK0A10PaperCheckC7BuilderC7countryyAESSF":{"name":"country(_:)","abstract":"\u003cp\u003eSets the bank account holder\u0026rsquo;s country.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletPaperCheck/Builder.html#/s:14HyperwalletSDK0A10PaperCheckC7BuilderC10postalCodeyAESSF":{"name":"postalCode(_:)","abstract":"\u003cp\u003eSets the bank account holder\u0026rsquo;s postal code.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletPaperCheck/Builder.html#/s:14HyperwalletSDK0A10PaperCheckC7BuilderC14shippingMethodyAESSF":{"name":"shippingMethod(_:)","abstract":"\u003cp\u003eSets the shipping method for paper check.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletPaperCheck/Builder.html#/s:14HyperwalletSDK0A10PaperCheckC7BuilderC13stateProvinceyAESSF":{"name":"stateProvince(_:)","abstract":"\u003cp\u003eSets the bank account holder\u0026rsquo;s state, province or region.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletPaperCheck/Builder.html#/s:14HyperwalletSDK0A10PaperCheckC7BuilderC11profileTypeyAESSF":{"name":"profileType(_:)","parent_name":"Builder"},"Classes/HyperwalletPaperCheck/Builder.html#/s:14HyperwalletSDK0A10PaperCheckC7BuilderC8lastNameyAESSF":{"name":"lastName(_:)","abstract":"\u003cp\u003eSets the bank account holder\u0026rsquo;s last name.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletPaperCheck/Builder.html#/s:14HyperwalletSDK0A10PaperCheckC7BuilderC10middleNameyAESSF":{"name":"middleName(_:)","abstract":"\u003cp\u003eSets the bank account holder\u0026rsquo;s middle name.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletPaperCheck/Builder.html#/s:14HyperwalletSDK0A10PaperCheckC7BuilderC12mobileNumberyAESSF":{"name":"mobileNumber(_:)","abstract":"\u003cp\u003eSets the bank account holder\u0026rsquo;s cell phone number.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletPaperCheck/Builder.html#/s:14HyperwalletSDK0A10PaperCheckC7BuilderC10passportIdyAESSF":{"name":"passportId(_:)","abstract":"\u003cp\u003eSets the bank account holder\u0026rsquo;s passport number.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletPaperCheck/Builder.html#/s:14HyperwalletSDK0A10PaperCheckC7BuilderC11phoneNumberyAESSF":{"name":"phoneNumber(_:)","abstract":"\u003cp\u003eSets the bank account holder\u0026rsquo;s phone number.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletPaperCheck/Builder.html#/s:14HyperwalletSDK0A10PaperCheckC7BuilderC14countryOfBirthyAESSF":{"name":"countryOfBirth(_:)","abstract":"\u003cp\u003eSets the bank account holder\u0026rsquo;s birth country.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletPaperCheck/Builder.html#/s:14HyperwalletSDK0A10PaperCheckC7BuilderC20countryOfNationalityyAESSF":{"name":"countryOfNationality(_:)","parent_name":"Builder"},"Classes/HyperwalletPaperCheck/Builder.html#/s:14HyperwalletSDK0A10PaperCheckC7BuilderC11dateOfBirthyAESSF":{"name":"dateOfBirth(_:)","abstract":"\u003cp\u003eSets the bank account holder\u0026rsquo;s date of birth (All users must be at least 13 years old).\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletPaperCheck/Builder.html#/s:14HyperwalletSDK0A10PaperCheckC7BuilderC16driversLicenseIdyAESSF":{"name":"driversLicenseId(_:)","abstract":"\u003cp\u003eSets the bank account holder\u0026rsquo;s driver\u0026rsquo;s license number.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletPaperCheck/Builder.html#/s:14HyperwalletSDK0A10PaperCheckC7BuilderC10employerIdyAESSF":{"name":"employerId(_:)","abstract":"\u003cp\u003eSets the bank account holder\u0026rsquo;s employer identifier, generally used for tax purposes.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletPaperCheck/Builder.html#/s:14HyperwalletSDK0A10PaperCheckC7BuilderC9firstNameyAESSF":{"name":"firstName(_:)","abstract":"\u003cp\u003eSets the bank account holder\u0026rsquo;s first name.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletPaperCheck/Builder.html#/s:14HyperwalletSDK0A10PaperCheckC7BuilderC6genderyAESSF":{"name":"gender(_:)","abstract":"\u003cp\u003eSets the bank account holder\u0026rsquo;s gender.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletPaperCheck/Builder.html#/s:14HyperwalletSDK0A10PaperCheckC7BuilderC12governmentIdyAESSF":{"name":"governmentId(_:)","abstract":"\u003cp\u003eSets the bank account holder\u0026rsquo;s government ID number, such as a Social Security Number.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletPaperCheck/Builder.html#/s:14HyperwalletSDK0A10PaperCheckC7BuilderC16governmentIdTypeyAESSF":{"name":"governmentIdType(_:)","abstract":"\u003cp\u003eSets the bank account holder\u0026rsquo;s government ID type.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletPaperCheck/Builder.html#/s:14HyperwalletSDK0A10PaperCheckC7BuilderC19businessContactRoleyAESSF":{"name":"businessContactRole(_:)","abstract":"\u003cp\u003eSets the bank account holder\u0026rsquo;s role in the organization.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletPaperCheck/Builder.html#/s:14HyperwalletSDK0A10PaperCheckC7BuilderC12businessNameyAESSF":{"name":"businessName(_:)","abstract":"\u003cp\u003eSets the name of the bank account holder\u0026rsquo;s business.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletPaperCheck/Builder.html#/s:14HyperwalletSDK0A10PaperCheckC7BuilderC27businessRegistrationCountryyAESSF":{"name":"businessRegistrationCountry(_:)","abstract":"\u003cp\u003eSets the country where the bank account holder\u0026rsquo;s business is registered.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletPaperCheck/Builder.html#/s:14HyperwalletSDK0A10PaperCheckC7BuilderC22businessRegistrationIdyAESSF":{"name":"businessRegistrationId(_:)","abstract":"\u003cp\u003eSets the bank account holder\u0026rsquo;s business registration number or identifier,","parent_name":"Builder"},"Classes/HyperwalletPaperCheck/Builder.html#/s:14HyperwalletSDK0A10PaperCheckC7BuilderC33businessRegistrationStateProvinceyAESSF":{"name":"businessRegistrationStateProvince(_:)","abstract":"\u003cp\u003eSets the state, province or region where the bank account holder\u0026rsquo;s business is registered.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletPaperCheck/Builder.html#/s:14HyperwalletSDK0A10PaperCheckC7BuilderC12businessTypeyAESSF":{"name":"businessType(_:)","abstract":"\u003cp\u003eSets the bank account holder\u0026rsquo;s business type.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletPaperCheck/Builder.html#/s:14HyperwalletSDK0A10PaperCheckC7BuilderC5buildACyF":{"name":"build()","abstract":"\u003cp\u003eBuilds a new instance of the \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/HyperwalletPaperCheck.html\"\u003eHyperwalletPaperCheck\u003c/a\u003e\u003c/code\u003e.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletPaperCheck.html#/s:14HyperwalletSDK0A10PaperCheckC4fromACs7Decoder_p_tKcfc":{"name":"init(from:)","abstract":"\u003cp\u003eThe required initializer\u003c/p\u003e","parent_name":"HyperwalletPaperCheck"},"Classes/HyperwalletPaperCheck.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletPaperCheck(py)bankAccountRelationship":{"name":"bankAccountRelationship","abstract":"\u003cp\u003eThe user\u0026rsquo;s relationship with the bank account holder.\u003c/p\u003e","parent_name":"HyperwalletPaperCheck"},"Classes/HyperwalletPaperCheck.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletPaperCheck(py)addressLine1":{"name":"addressLine1","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s street address.\u003c/p\u003e","parent_name":"HyperwalletPaperCheck"},"Classes/HyperwalletPaperCheck.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletPaperCheck(py)addressLine2":{"name":"addressLine2","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s address, second line.\u003c/p\u003e","parent_name":"HyperwalletPaperCheck"},"Classes/HyperwalletPaperCheck.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletPaperCheck(py)city":{"name":"city","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s city.\u003c/p\u003e","parent_name":"HyperwalletPaperCheck"},"Classes/HyperwalletPaperCheck.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletPaperCheck(py)country":{"name":"country","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s country.\u003c/p\u003e","parent_name":"HyperwalletPaperCheck"},"Classes/HyperwalletPaperCheck.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletPaperCheck(py)postalCode":{"name":"postalCode","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s postal code.\u003c/p\u003e","parent_name":"HyperwalletPaperCheck"},"Classes/HyperwalletPaperCheck.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletPaperCheck(py)stateProvince":{"name":"stateProvince","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s state, province or region.\u003c/p\u003e","parent_name":"HyperwalletPaperCheck"},"Classes/HyperwalletPaperCheck.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletPaperCheck(py)shippingMethod":{"name":"shippingMethod","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s state, province or region.\u003c/p\u003e","parent_name":"HyperwalletPaperCheck"},"Classes/HyperwalletPaperCheck.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletPaperCheck(py)businessName":{"name":"businessName","abstract":"\u003cp\u003eThe name of the bank account holder\u0026rsquo;s business.\u003c/p\u003e","parent_name":"HyperwalletPaperCheck"},"Classes/HyperwalletPaperCheck.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletPaperCheck(py)businessRegistrationCountry":{"name":"businessRegistrationCountry","abstract":"\u003cp\u003eThe country where the bank account holder\u0026rsquo;s business is registered.\u003c/p\u003e","parent_name":"HyperwalletPaperCheck"},"Classes/HyperwalletPaperCheck.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletPaperCheck(py)businessRegistrationId":{"name":"businessRegistrationId","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s business registration number or identifier,","parent_name":"HyperwalletPaperCheck"},"Classes/HyperwalletPaperCheck.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletPaperCheck(py)businessRegistrationStateProvince":{"name":"businessRegistrationStateProvince","abstract":"\u003cp\u003eThe state, province or region where the bank account holder\u0026rsquo;s business is registered.\u003c/p\u003e","parent_name":"HyperwalletPaperCheck"},"Classes/HyperwalletPaperCheck.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletPaperCheck(py)businessType":{"name":"businessType","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s business type.\u003c/p\u003e","parent_name":"HyperwalletPaperCheck"},"Classes/HyperwalletPaperCheck.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletPaperCheck(py)countryOfBirth":{"name":"countryOfBirth","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s birth country.\u003c/p\u003e","parent_name":"HyperwalletPaperCheck"},"Classes/HyperwalletPaperCheck.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletPaperCheck(py)countryOfNationality":{"name":"countryOfNationality","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s nationality country.\u003c/p\u003e","parent_name":"HyperwalletPaperCheck"},"Classes/HyperwalletPaperCheck.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletPaperCheck(py)dateOfBirth":{"name":"dateOfBirth","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s date of birth (All users must be at least 13 years old).\u003c/p\u003e","parent_name":"HyperwalletPaperCheck"},"Classes/HyperwalletPaperCheck.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletPaperCheck(py)driversLicenseId":{"name":"driversLicenseId","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s driver\u0026rsquo;s license number.\u003c/p\u003e","parent_name":"HyperwalletPaperCheck"},"Classes/HyperwalletPaperCheck.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletPaperCheck(py)employerId":{"name":"employerId","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s employer identifier, generally used for tax purposes.\u003c/p\u003e","parent_name":"HyperwalletPaperCheck"},"Classes/HyperwalletPaperCheck.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletPaperCheck(py)firstName":{"name":"firstName","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s first name.\u003c/p\u003e","parent_name":"HyperwalletPaperCheck"},"Classes/HyperwalletPaperCheck.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletPaperCheck(py)gender":{"name":"gender","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s gender.\u003c/p\u003e","parent_name":"HyperwalletPaperCheck"},"Classes/HyperwalletPaperCheck.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletPaperCheck(py)governmentId":{"name":"governmentId","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s government ID number, such as a Social Security Number.\u003c/p\u003e","parent_name":"HyperwalletPaperCheck"},"Classes/HyperwalletPaperCheck.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletPaperCheck(py)governmentIdType":{"name":"governmentIdType","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s government ID type.\u003c/p\u003e","parent_name":"HyperwalletPaperCheck"},"Classes/HyperwalletPaperCheck.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletPaperCheck(py)phoneNumber":{"name":"phoneNumber","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s phone number.\u003c/p\u003e","parent_name":"HyperwalletPaperCheck"},"Classes/HyperwalletPaperCheck.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletPaperCheck(py)mobileNumber":{"name":"mobileNumber","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s cell phone number.\u003c/p\u003e","parent_name":"HyperwalletPaperCheck"},"Classes/HyperwalletPaperCheck.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletPaperCheck(py)lastName":{"name":"lastName","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s last name.\u003c/p\u003e","parent_name":"HyperwalletPaperCheck"},"Classes/HyperwalletPaperCheck.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletPaperCheck(py)middleName":{"name":"middleName","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s middle name.\u003c/p\u003e","parent_name":"HyperwalletPaperCheck"},"Classes/HyperwalletPaperCheck.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletPaperCheck(py)passportId":{"name":"passportId","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s passport number.\u003c/p\u003e","parent_name":"HyperwalletPaperCheck"},"Classes/HyperwalletPaperCheck/Builder.html":{"name":"Builder","abstract":"\u003cp\u003eA helper class to build the \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/HyperwalletPaperCheck.html\"\u003eHyperwalletPaperCheck\u003c/a\u003e\u003c/code\u003e instance.\u003c/p\u003e","parent_name":"HyperwalletPaperCheck"},"Classes/HyperwalletBankCardQueryParam.html#/s:14HyperwalletSDK0A18BankCardQueryParamC02toE0SDyS2SGyF":{"name":"toQuery()","parent_name":"HyperwalletBankCardQueryParam"},"Classes/HyperwalletBankCard/Builder.html#/s:14HyperwalletSDK0A8BankCardC7BuilderC5tokenAESS_tcfc":{"name":"init(token:)","abstract":"\u003cp\u003eCreates a new instance of the \u003ccode\u003eHyperwalletBankCard.Builder\u003c/code\u003e based on the required parameter to update","parent_name":"Builder"},"Classes/HyperwalletBankCard/Builder.html#/s:14HyperwalletSDK0A8BankCardC7BuilderC21transferMethodCountry0fG8Currency0fG11ProfileTypeAESS_S2Stcfc":{"name":"init(transferMethodCountry:transferMethodCurrency:transferMethodProfileType:)","abstract":"\u003cp\u003eCreates a new instance of the \u003ccode\u003eHyperwalletBankCard.Builder\u003c/code\u003e based on the required parameters to create","parent_name":"Builder"},"Classes/HyperwalletBankCard/Builder.html#/s:14HyperwalletSDK0A8BankCardC7BuilderC5buildACyF":{"name":"build()","abstract":"\u003cp\u003eBuilds a new instance of the \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/HyperwalletBankCard.html\"\u003eHyperwalletBankCard\u003c/a\u003e\u003c/code\u003e.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletBankCard/Builder.html#/s:14HyperwalletSDK0A8BankCardC7BuilderC10cardNumberyAESSF":{"name":"cardNumber(_:)","abstract":"\u003cp\u003eSets the card number\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletBankCard/Builder.html#/s:14HyperwalletSDK0A8BankCardC7BuilderC3cvvyAESSF":{"name":"cvv(_:)","abstract":"\u003cp\u003eSets the card security code which is embossed or printed on the card.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletBankCard/Builder.html#/s:14HyperwalletSDK0A8BankCardC7BuilderC12dateOfExpiryyAESSF":{"name":"dateOfExpiry(_:)","abstract":"\u003cp\u003eSets the expiration date.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletBankCard.html#/s:14HyperwalletSDK0A8BankCardC4fromACs7Decoder_p_tKcfc":{"name":"init(from:)","abstract":"\u003cp\u003eThe required initializer\u003c/p\u003e","parent_name":"HyperwalletBankCard"},"Classes/HyperwalletBankCard.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletBankCard(py)cardBrand":{"name":"cardBrand","abstract":"\u003cp\u003eThe card brand\u003c/p\u003e","parent_name":"HyperwalletBankCard"},"Classes/HyperwalletBankCard.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletBankCard(py)cardNumber":{"name":"cardNumber","abstract":"\u003cp\u003eThe card number\u003c/p\u003e","parent_name":"HyperwalletBankCard"},"Classes/HyperwalletBankCard.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletBankCard(py)cardType":{"name":"cardType","abstract":"\u003cp\u003eThe card type\u003c/p\u003e","parent_name":"HyperwalletBankCard"},"Classes/HyperwalletBankCard.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletBankCard(py)dateOfExpiry":{"name":"dateOfExpiry","abstract":"\u003cp\u003eThe expiration date.\u003c/p\u003e","parent_name":"HyperwalletBankCard"},"Classes/HyperwalletBankCard/Builder.html":{"name":"Builder","abstract":"\u003cp\u003eA helper class to build the \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/HyperwalletBankCard.html\"\u003eHyperwalletBankCard\u003c/a\u003e\u003c/code\u003e instance.\u003c/p\u003e","parent_name":"HyperwalletBankCard"},"Classes/HyperwalletBankAccountQueryParam.html#/s:14HyperwalletSDK0A21BankAccountQueryParamC02toE0SDyS2SGyF":{"name":"toQuery()","parent_name":"HyperwalletBankAccountQueryParam"},"Classes/HyperwalletBankAccount/Builder.html#/s:14HyperwalletSDK0A11BankAccountC7BuilderC5tokenAESS_tcfc":{"name":"init(token:)","abstract":"\u003cp\u003eCreates a new instance of the \u003ccode\u003eHyperwalletBankAccount.Builder\u003c/code\u003e based on the required parameter to update","parent_name":"Builder"},"Classes/HyperwalletBankAccount/Builder.html#/s:14HyperwalletSDK0A11BankAccountC7BuilderC21transferMethodCountry0fG8Currency0fG11ProfileType0fgK0AESS_S3Stcfc":{"name":"init(transferMethodCountry:transferMethodCurrency:transferMethodProfileType:transferMethodType:)","abstract":"\u003cp\u003eCreates a new instance of the \u003ccode\u003eHyperwalletBankAccount.Builder\u003c/code\u003e based on the required parameters to create","parent_name":"Builder"},"Classes/HyperwalletBankAccount/Builder.html#/s:14HyperwalletSDK0A11BankAccountC7BuilderC12addressLine1yAESSF":{"name":"addressLine1(_:)","abstract":"\u003cp\u003eSets the bank account holder\u0026rsquo;s street address.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletBankAccount/Builder.html#/s:14HyperwalletSDK0A11BankAccountC7BuilderC12addressLine2yAESSF":{"name":"addressLine2(_:)","abstract":"\u003cp\u003eSets the bank account holder\u0026rsquo;s address, second line.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletBankAccount/Builder.html#/s:14HyperwalletSDK0A11BankAccountC7BuilderC04bankD2IdyAESSF":{"name":"bankAccountId(_:)","abstract":"\u003cp\u003eSets the bank account number, IBAN or equivalent. If you are providing an IBAN, the first two","parent_name":"Builder"},"Classes/HyperwalletBankAccount/Builder.html#/s:14HyperwalletSDK0A11BankAccountC7BuilderC04bankD7PurposeyAESSF":{"name":"bankAccountPurpose(_:)","abstract":"\u003cp\u003eSets the purpose of the bank account (e.g. checking, savings, etc).\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletBankAccount/Builder.html#/s:14HyperwalletSDK0A11BankAccountC7BuilderC04bankD12RelationshipyAESSF":{"name":"bankAccountRelationship(_:)","abstract":"\u003cp\u003eSets the user\u0026rsquo;s relationship with the bank account holder.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletBankAccount/Builder.html#/s:14HyperwalletSDK0A11BankAccountC7BuilderC6bankIdyAESSF":{"name":"bankId(_:)","abstract":"\u003cp\u003eSets the bank code or equivalent (e.g. BIC/SWIFT code).\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletBankAccount/Builder.html#/s:14HyperwalletSDK0A11BankAccountC7BuilderC8bankNameyAESSF":{"name":"bankName(_:)","abstract":"\u003cp\u003eSets the bank name.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletBankAccount/Builder.html#/s:14HyperwalletSDK0A11BankAccountC7BuilderC8branchIdyAESSF":{"name":"branchId(_:)","abstract":"\u003cp\u003eSets the branch code, transit number, routing number or equivalent.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletBankAccount/Builder.html#/s:14HyperwalletSDK0A11BankAccountC7BuilderC10branchNameyAESSF":{"name":"branchName(_:)","abstract":"\u003cp\u003eSets the branch name.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletBankAccount/Builder.html#/s:14HyperwalletSDK0A11BankAccountC7BuilderC19businessContactRoleyAESSF":{"name":"businessContactRole(_:)","abstract":"\u003cp\u003eSets the bank account holder\u0026rsquo;s role in the organization.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletBankAccount/Builder.html#/s:14HyperwalletSDK0A11BankAccountC7BuilderC12businessNameyAESSF":{"name":"businessName(_:)","abstract":"\u003cp\u003eSets the name of the bank account holder\u0026rsquo;s business.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletBankAccount/Builder.html#/s:14HyperwalletSDK0A11BankAccountC7BuilderC27businessRegistrationCountryyAESSF":{"name":"businessRegistrationCountry(_:)","abstract":"\u003cp\u003eSets the country where the bank account holder\u0026rsquo;s business is registered.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletBankAccount/Builder.html#/s:14HyperwalletSDK0A11BankAccountC7BuilderC22businessRegistrationIdyAESSF":{"name":"businessRegistrationId(_:)","abstract":"\u003cp\u003eSets the bank account holder\u0026rsquo;s business registration number or identifier,","parent_name":"Builder"},"Classes/HyperwalletBankAccount/Builder.html#/s:14HyperwalletSDK0A11BankAccountC7BuilderC33businessRegistrationStateProvinceyAESSF":{"name":"businessRegistrationStateProvince(_:)","abstract":"\u003cp\u003eSets the state, province or region where the bank account holder\u0026rsquo;s business is registered.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletBankAccount/Builder.html#/s:14HyperwalletSDK0A11BankAccountC7BuilderC12businessTypeyAESSF":{"name":"businessType(_:)","abstract":"\u003cp\u003eSets the bank account holder\u0026rsquo;s business type.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletBankAccount/Builder.html#/s:14HyperwalletSDK0A11BankAccountC7BuilderC4cityyAESSF":{"name":"city(_:)","abstract":"\u003cp\u003eSets the bank account holder\u0026rsquo;s city.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletBankAccount/Builder.html#/s:14HyperwalletSDK0A11BankAccountC7BuilderC7countryyAESSF":{"name":"country(_:)","abstract":"\u003cp\u003eSets the bank account holder\u0026rsquo;s country.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletBankAccount/Builder.html#/s:14HyperwalletSDK0A11BankAccountC7BuilderC14countryOfBirthyAESSF":{"name":"countryOfBirth(_:)","abstract":"\u003cp\u003eSets the bank account holder\u0026rsquo;s birth country.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletBankAccount/Builder.html#/s:14HyperwalletSDK0A11BankAccountC7BuilderC20countryOfNationalityyAESSF":{"name":"countryOfNationality(_:)","parent_name":"Builder"},"Classes/HyperwalletBankAccount/Builder.html#/s:14HyperwalletSDK0A11BankAccountC7BuilderC11dateOfBirthyAESSF":{"name":"dateOfBirth(_:)","abstract":"\u003cp\u003eSets the bank account holder\u0026rsquo;s date of birth (All users must be at least 13 years old).\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletBankAccount/Builder.html#/s:14HyperwalletSDK0A11BankAccountC7BuilderC16driversLicenseIdyAESSF":{"name":"driversLicenseId(_:)","abstract":"\u003cp\u003eSets the bank account holder\u0026rsquo;s driver\u0026rsquo;s license number.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletBankAccount/Builder.html#/s:14HyperwalletSDK0A11BankAccountC7BuilderC10employerIdyAESSF":{"name":"employerId(_:)","abstract":"\u003cp\u003eSets the bank account holder\u0026rsquo;s employer identifier, generally used for tax purposes.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletBankAccount/Builder.html#/s:14HyperwalletSDK0A11BankAccountC7BuilderC9firstNameyAESSF":{"name":"firstName(_:)","abstract":"\u003cp\u003eSets the bank account holder\u0026rsquo;s first name.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletBankAccount/Builder.html#/s:14HyperwalletSDK0A11BankAccountC7BuilderC6genderyAESSF":{"name":"gender(_:)","abstract":"\u003cp\u003eSets the bank account holder\u0026rsquo;s gender.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletBankAccount/Builder.html#/s:14HyperwalletSDK0A11BankAccountC7BuilderC12governmentIdyAESSF":{"name":"governmentId(_:)","abstract":"\u003cp\u003eSets the bank account holder\u0026rsquo;s government ID number, such as a Social Security Number.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletBankAccount/Builder.html#/s:14HyperwalletSDK0A11BankAccountC7BuilderC16governmentIdTypeyAESSF":{"name":"governmentIdType(_:)","abstract":"\u003cp\u003eSets the bank account holder\u0026rsquo;s government ID type.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletBankAccount/Builder.html#/s:14HyperwalletSDK0A11BankAccountC7BuilderC012intermediarycD2IdyAESSF":{"name":"intermediaryBankAccountId(_:)","abstract":"\u003cp\u003eSets the account number at the intermediary bank.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletBankAccount/Builder.html#/s:14HyperwalletSDK0A11BankAccountC7BuilderC012intermediaryC12AddressLine1yAESSF":{"name":"intermediaryBankAddressLine1(_:)","abstract":"\u003cp\u003eSets the intermediary bank street address.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletBankAccount/Builder.html#/s:14HyperwalletSDK0A11BankAccountC7BuilderC012intermediaryC12AddressLine2yAESSF":{"name":"intermediaryBankAddressLine2(_:)","abstract":"\u003cp\u003eSets the intermediary bank street address, second line.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletBankAccount/Builder.html#/s:14HyperwalletSDK0A11BankAccountC7BuilderC012intermediaryC4CityyAESSF":{"name":"intermediaryBankCity(_:)","abstract":"\u003cp\u003eSets the intermediary bank city.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletBankAccount/Builder.html#/s:14HyperwalletSDK0A11BankAccountC7BuilderC012intermediaryC7CountryyAESSF":{"name":"intermediaryBankCountry(_:)","abstract":"\u003cp\u003eSets the intermediary bank country.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletBankAccount/Builder.html#/s:14HyperwalletSDK0A11BankAccountC7BuilderC012intermediaryC2IdyAESSF":{"name":"intermediaryBankId(_:)","abstract":"\u003cp\u003eSets the intermediary bank\u0026rsquo;s 11-character SWIFT code.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletBankAccount/Builder.html#/s:14HyperwalletSDK0A11BankAccountC7BuilderC012intermediaryC4NameyAESSF":{"name":"intermediaryBankName(_:)","abstract":"\u003cp\u003eSets the intermediary bank name.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletBankAccount/Builder.html#/s:14HyperwalletSDK0A11BankAccountC7BuilderC012intermediaryC10PostalCodeyAESSF":{"name":"intermediaryBankPostalCode(_:)","abstract":"\u003cp\u003eSets the intermediary bank postal code.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletBankAccount/Builder.html#/s:14HyperwalletSDK0A11BankAccountC7BuilderC012intermediaryC13StateProvinceyAESSF":{"name":"intermediaryBankStateProvince(_:)","abstract":"\u003cp\u003eSets the intermediary bank state, province or region.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletBankAccount/Builder.html#/s:14HyperwalletSDK0A11BankAccountC7BuilderC8lastNameyAESSF":{"name":"lastName(_:)","abstract":"\u003cp\u003eSets the bank account holder\u0026rsquo;s last name.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletBankAccount/Builder.html#/s:14HyperwalletSDK0A11BankAccountC7BuilderC10middleNameyAESSF":{"name":"middleName(_:)","abstract":"\u003cp\u003eSets the bank account holder\u0026rsquo;s middle name.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletBankAccount/Builder.html#/s:14HyperwalletSDK0A11BankAccountC7BuilderC12mobileNumberyAESSF":{"name":"mobileNumber(_:)","abstract":"\u003cp\u003eSets the bank account holder\u0026rsquo;s cell phone number.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletBankAccount/Builder.html#/s:14HyperwalletSDK0A11BankAccountC7BuilderC10passportIdyAESSF":{"name":"passportId(_:)","abstract":"\u003cp\u003eSets the bank account holder\u0026rsquo;s passport number.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletBankAccount/Builder.html#/s:14HyperwalletSDK0A11BankAccountC7BuilderC11phoneNumberyAESSF":{"name":"phoneNumber(_:)","abstract":"\u003cp\u003eSets the bank account holder\u0026rsquo;s phone number.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletBankAccount/Builder.html#/s:14HyperwalletSDK0A11BankAccountC7BuilderC10postalCodeyAESSF":{"name":"postalCode(_:)","abstract":"\u003cp\u003eSets the bank account holder\u0026rsquo;s postal code.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletBankAccount/Builder.html#/s:14HyperwalletSDK0A11BankAccountC7BuilderC11profileTypeyAESSF":{"name":"profileType(_:)","abstract":"\u003cp\u003eSets the bank account holder\u0026rsquo;s profile type.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletBankAccount/Builder.html#/s:14HyperwalletSDK0A11BankAccountC7BuilderC13stateProvinceyAESSF":{"name":"stateProvince(_:)","abstract":"\u003cp\u003eSets the bank account holder\u0026rsquo;s state, province or region.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletBankAccount/Builder.html#/s:14HyperwalletSDK0A11BankAccountC7BuilderC4typeyAESSF":{"name":"type(_:)","abstract":"\u003cp\u003eSets the type of transfer method, e.g. BANK_ACCOUNT or WIRE_ACCOUNT.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletBankAccount/Builder.html#/s:14HyperwalletSDK0A11BankAccountC7BuilderC16wireInstructionsyAESSF":{"name":"wireInstructions(_:)","abstract":"\u003cp\u003eSets wire transfer instructions.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletBankAccount/Builder.html#/s:14HyperwalletSDK0A11BankAccountC7BuilderC5buildACyF":{"name":"build()","abstract":"\u003cp\u003eBuilds a new instance of the \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/HyperwalletBankAccount.html\"\u003eHyperwalletBankAccount\u003c/a\u003e\u003c/code\u003e.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletBankAccount.html#/s:14HyperwalletSDK0A11BankAccountC4fromACs7Decoder_p_tKcfc":{"name":"init(from:)","abstract":"\u003cp\u003eThe required initializer\u003c/p\u003e","parent_name":"HyperwalletBankAccount"},"Classes/HyperwalletBankAccount.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletBankAccount(py)addressLine1":{"name":"addressLine1","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s street address.\u003c/p\u003e","parent_name":"HyperwalletBankAccount"},"Classes/HyperwalletBankAccount.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletBankAccount(py)addressLine2":{"name":"addressLine2","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s address, second line.\u003c/p\u003e","parent_name":"HyperwalletBankAccount"},"Classes/HyperwalletBankAccount.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletBankAccount(py)bankAccountId":{"name":"bankAccountId","abstract":"\u003cp\u003eThe bank account number, IBAN or equivalent. If you are providing an IBAN, the first two","parent_name":"HyperwalletBankAccount"},"Classes/HyperwalletBankAccount.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletBankAccount(py)bankAccountPurpose":{"name":"bankAccountPurpose","abstract":"\u003cp\u003eThe purpose of the bank account (e.g. checking, savings, etc).\u003c/p\u003e","parent_name":"HyperwalletBankAccount"},"Classes/HyperwalletBankAccount.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletBankAccount(py)bankAccountRelationship":{"name":"bankAccountRelationship","abstract":"\u003cp\u003eThe user\u0026rsquo;s relationship with the bank account holder.\u003c/p\u003e","parent_name":"HyperwalletBankAccount"},"Classes/HyperwalletBankAccount.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletBankAccount(py)bankId":{"name":"bankId","abstract":"\u003cp\u003eThe bank code or equivalent (e.g. BIC/SWIFT code).\u003c/p\u003e","parent_name":"HyperwalletBankAccount"},"Classes/HyperwalletBankAccount.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletBankAccount(py)bankName":{"name":"bankName","abstract":"\u003cp\u003eThe bank name.\u003c/p\u003e","parent_name":"HyperwalletBankAccount"},"Classes/HyperwalletBankAccount.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletBankAccount(py)branchId":{"name":"branchId","abstract":"\u003cp\u003eThe branch code, transit number, routing number or equivalent.\u003c/p\u003e","parent_name":"HyperwalletBankAccount"},"Classes/HyperwalletBankAccount.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletBankAccount(py)branchName":{"name":"branchName","abstract":"\u003cp\u003eThe branch name.\u003c/p\u003e","parent_name":"HyperwalletBankAccount"},"Classes/HyperwalletBankAccount.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletBankAccount(py)businessContactRole":{"name":"businessContactRole","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s role in the organization.\u003c/p\u003e","parent_name":"HyperwalletBankAccount"},"Classes/HyperwalletBankAccount.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletBankAccount(py)businessName":{"name":"businessName","abstract":"\u003cp\u003eThe name of the bank account holder\u0026rsquo;s business.\u003c/p\u003e","parent_name":"HyperwalletBankAccount"},"Classes/HyperwalletBankAccount.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletBankAccount(py)businessRegistrationCountry":{"name":"businessRegistrationCountry","abstract":"\u003cp\u003eThe country where the bank account holder\u0026rsquo;s business is registered.\u003c/p\u003e","parent_name":"HyperwalletBankAccount"},"Classes/HyperwalletBankAccount.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletBankAccount(py)businessRegistrationId":{"name":"businessRegistrationId","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s business registration number or identifier,","parent_name":"HyperwalletBankAccount"},"Classes/HyperwalletBankAccount.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletBankAccount(py)businessRegistrationStateProvince":{"name":"businessRegistrationStateProvince","abstract":"\u003cp\u003eThe state, province or region where the bank account holder\u0026rsquo;s business is registered.\u003c/p\u003e","parent_name":"HyperwalletBankAccount"},"Classes/HyperwalletBankAccount.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletBankAccount(py)businessType":{"name":"businessType","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s business type.\u003c/p\u003e","parent_name":"HyperwalletBankAccount"},"Classes/HyperwalletBankAccount.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletBankAccount(py)city":{"name":"city","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s city.\u003c/p\u003e","parent_name":"HyperwalletBankAccount"},"Classes/HyperwalletBankAccount.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletBankAccount(py)country":{"name":"country","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s country.\u003c/p\u003e","parent_name":"HyperwalletBankAccount"},"Classes/HyperwalletBankAccount.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletBankAccount(py)countryOfBirth":{"name":"countryOfBirth","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s birth country.\u003c/p\u003e","parent_name":"HyperwalletBankAccount"},"Classes/HyperwalletBankAccount.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletBankAccount(py)countryOfNationality":{"name":"countryOfNationality","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s nationality country.\u003c/p\u003e","parent_name":"HyperwalletBankAccount"},"Classes/HyperwalletBankAccount.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletBankAccount(py)dateOfBirth":{"name":"dateOfBirth","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s date of birth (All users must be at least 13 years old).\u003c/p\u003e","parent_name":"HyperwalletBankAccount"},"Classes/HyperwalletBankAccount.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletBankAccount(py)driversLicenseId":{"name":"driversLicenseId","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s driver\u0026rsquo;s license number.\u003c/p\u003e","parent_name":"HyperwalletBankAccount"},"Classes/HyperwalletBankAccount.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletBankAccount(py)employerId":{"name":"employerId","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s employer identifier, generally used for tax purposes.\u003c/p\u003e","parent_name":"HyperwalletBankAccount"},"Classes/HyperwalletBankAccount.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletBankAccount(py)firstName":{"name":"firstName","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s first name.\u003c/p\u003e","parent_name":"HyperwalletBankAccount"},"Classes/HyperwalletBankAccount.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletBankAccount(py)gender":{"name":"gender","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s gender.\u003c/p\u003e","parent_name":"HyperwalletBankAccount"},"Classes/HyperwalletBankAccount.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletBankAccount(py)governmentId":{"name":"governmentId","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s government ID number, such as a Social Security Number.\u003c/p\u003e","parent_name":"HyperwalletBankAccount"},"Classes/HyperwalletBankAccount.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletBankAccount(py)governmentIdType":{"name":"governmentIdType","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s government ID type.\u003c/p\u003e","parent_name":"HyperwalletBankAccount"},"Classes/HyperwalletBankAccount.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletBankAccount(py)intermediaryBankAccountId":{"name":"intermediaryBankAccountId","abstract":"\u003cp\u003eThe account number at the intermediary bank.\u003c/p\u003e","parent_name":"HyperwalletBankAccount"},"Classes/HyperwalletBankAccount.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletBankAccount(py)intermediaryBankAddressLine1":{"name":"intermediaryBankAddressLine1","abstract":"\u003cp\u003eThe intermediary bank street address.\u003c/p\u003e","parent_name":"HyperwalletBankAccount"},"Classes/HyperwalletBankAccount.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletBankAccount(py)intermediaryBankAddressLine2":{"name":"intermediaryBankAddressLine2","abstract":"\u003cp\u003eThe intermediary bank street address, second line.\u003c/p\u003e","parent_name":"HyperwalletBankAccount"},"Classes/HyperwalletBankAccount.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletBankAccount(py)intermediaryBankCity":{"name":"intermediaryBankCity","abstract":"\u003cp\u003eThe intermediary bank city.\u003c/p\u003e","parent_name":"HyperwalletBankAccount"},"Classes/HyperwalletBankAccount.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletBankAccount(py)intermediaryBankCountry":{"name":"intermediaryBankCountry","abstract":"\u003cp\u003eThe intermediary bank country.\u003c/p\u003e","parent_name":"HyperwalletBankAccount"},"Classes/HyperwalletBankAccount.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletBankAccount(py)intermediaryBankId":{"name":"intermediaryBankId","abstract":"\u003cp\u003eThe intermediary bank\u0026rsquo;s 11-character SWIFT code.\u003c/p\u003e","parent_name":"HyperwalletBankAccount"},"Classes/HyperwalletBankAccount.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletBankAccount(py)intermediaryBankName":{"name":"intermediaryBankName","abstract":"\u003cp\u003eThe intermediary bank name.\u003c/p\u003e","parent_name":"HyperwalletBankAccount"},"Classes/HyperwalletBankAccount.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletBankAccount(py)intermediaryBankPostalCode":{"name":"intermediaryBankPostalCode","abstract":"\u003cp\u003eThe intermediary bank postal code.\u003c/p\u003e","parent_name":"HyperwalletBankAccount"},"Classes/HyperwalletBankAccount.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletBankAccount(py)intermediaryBankStateProvince":{"name":"intermediaryBankStateProvince","abstract":"\u003cp\u003eThe intermediary bank state, province or region.\u003c/p\u003e","parent_name":"HyperwalletBankAccount"},"Classes/HyperwalletBankAccount.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletBankAccount(py)lastName":{"name":"lastName","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s last name.\u003c/p\u003e","parent_name":"HyperwalletBankAccount"},"Classes/HyperwalletBankAccount.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletBankAccount(py)middleName":{"name":"middleName","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s middle name.\u003c/p\u003e","parent_name":"HyperwalletBankAccount"},"Classes/HyperwalletBankAccount.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletBankAccount(py)mobileNumber":{"name":"mobileNumber","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s cell phone number.\u003c/p\u003e","parent_name":"HyperwalletBankAccount"},"Classes/HyperwalletBankAccount.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletBankAccount(py)passportId":{"name":"passportId","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s passport number.\u003c/p\u003e","parent_name":"HyperwalletBankAccount"},"Classes/HyperwalletBankAccount.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletBankAccount(py)phoneNumber":{"name":"phoneNumber","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s phone number.\u003c/p\u003e","parent_name":"HyperwalletBankAccount"},"Classes/HyperwalletBankAccount.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletBankAccount(py)postalCode":{"name":"postalCode","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s postal code.\u003c/p\u003e","parent_name":"HyperwalletBankAccount"},"Classes/HyperwalletBankAccount.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletBankAccount(py)stateProvince":{"name":"stateProvince","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s state, province or region.\u003c/p\u003e","parent_name":"HyperwalletBankAccount"},"Classes/HyperwalletBankAccount.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletBankAccount(py)wireInstructions":{"name":"wireInstructions","abstract":"\u003cp\u003eThe wire transfer instructions\u003c/p\u003e","parent_name":"HyperwalletBankAccount"},"Classes/HyperwalletBankAccount/Builder.html":{"name":"Builder","abstract":"\u003cp\u003eA helper class to build the \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/HyperwalletBankAccount.html\"\u003eHyperwalletBankAccount\u003c/a\u003e\u003c/code\u003e instance.\u003c/p\u003e","parent_name":"HyperwalletBankAccount"},"Classes/HyperwalletTransferQueryParam.html#/s:14HyperwalletSDK0A18TransferQueryParamC06clientC2IdSSSgvp":{"name":"clientTransferId","abstract":"\u003cp\u003eA value that identifies the client transfer id.\u003c/p\u003e","parent_name":"HyperwalletTransferQueryParam"},"Classes/HyperwalletTransferQueryParam.html#/s:14HyperwalletSDK0A18TransferQueryParamC16destinationTokenSSSgvp":{"name":"destinationToken","abstract":"\u003cp\u003eA value that identifies the destination token.\u003c/p\u003e","parent_name":"HyperwalletTransferQueryParam"},"Classes/HyperwalletTransferQueryParam.html#/s:14HyperwalletSDK0A18TransferQueryParamC11sourceTokenSSSgvp":{"name":"sourceToken","abstract":"\u003cp\u003eA value that identifies the source token.\u003c/p\u003e","parent_name":"HyperwalletTransferQueryParam"},"Classes/HyperwalletReceiptQueryParam/QuerySortable.html#/s:14HyperwalletSDK0A17ReceiptQueryParamC0D8SortableO15ascendantAmountyA2EmF":{"name":"ascendantAmount","abstract":"\u003cp\u003eSort the result by ascendant amount\u003c/p\u003e","parent_name":"QuerySortable"},"Classes/HyperwalletReceiptQueryParam/QuerySortable.html#/s:14HyperwalletSDK0A17ReceiptQueryParamC0D8SortableO18ascendantCreatedOnyA2EmF":{"name":"ascendantCreatedOn","abstract":"\u003cp\u003eSort the result by ascendant created on\u003c/p\u003e","parent_name":"QuerySortable"},"Classes/HyperwalletReceiptQueryParam/QuerySortable.html#/s:14HyperwalletSDK0A17ReceiptQueryParamC0D8SortableO17ascendantCurrencyyA2EmF":{"name":"ascendantCurrency","abstract":"\u003cp\u003eSort the result by ascendant currency\u003c/p\u003e","parent_name":"QuerySortable"},"Classes/HyperwalletReceiptQueryParam/QuerySortable.html#/s:14HyperwalletSDK0A17ReceiptQueryParamC0D8SortableO13ascendantTypeyA2EmF":{"name":"ascendantType","abstract":"\u003cp\u003eSort the result by ascendant type\u003c/p\u003e","parent_name":"QuerySortable"},"Classes/HyperwalletReceiptQueryParam/QuerySortable.html#/s:14HyperwalletSDK0A17ReceiptQueryParamC0D8SortableO16descendantAmountyA2EmF":{"name":"descendantAmount","abstract":"\u003cp\u003eSort the result by descendant amount\u003c/p\u003e","parent_name":"QuerySortable"},"Classes/HyperwalletReceiptQueryParam/QuerySortable.html#/s:14HyperwalletSDK0A17ReceiptQueryParamC0D8SortableO19descendantCreatedOnyA2EmF":{"name":"descendantCreatedOn","abstract":"\u003cp\u003eSort the result by descendant created on\u003c/p\u003e","parent_name":"QuerySortable"},"Classes/HyperwalletReceiptQueryParam/QuerySortable.html#/s:14HyperwalletSDK0A17ReceiptQueryParamC0D8SortableO18descendantCurrencyyA2EmF":{"name":"descendantCurrency","abstract":"\u003cp\u003eSort the result by descendant currency\u003c/p\u003e","parent_name":"QuerySortable"},"Classes/HyperwalletReceiptQueryParam/QuerySortable.html#/s:14HyperwalletSDK0A17ReceiptQueryParamC0D8SortableO14descendantTypeyA2EmF":{"name":"descendantType","abstract":"\u003cp\u003eSort the result by descendant type\u003c/p\u003e","parent_name":"QuerySortable"},"Classes/HyperwalletReceiptQueryParam.html#/s:14HyperwalletSDK0A17ReceiptQueryParamC8currencySSSgvp":{"name":"currency","abstract":"\u003cp\u003eA value that identifies the user receipts currency.\u003c/p\u003e","parent_name":"HyperwalletReceiptQueryParam"},"Classes/HyperwalletReceiptQueryParam/QuerySortable.html":{"name":"QuerySortable","abstract":"\u003cp\u003eRepresentation of the field\u0026rsquo;s sortable\u003c/p\u003e","parent_name":"HyperwalletReceiptQueryParam"},"Classes/QueryParam.html#/s:14HyperwalletSDK10QueryParamC12createdAfter10Foundation4DateVSgvp":{"name":"createdAfter","abstract":"\u003cp\u003eReturns user receipts created after this datetime.\u003c/p\u003e","parent_name":"QueryParam"},"Classes/QueryParam.html#/s:14HyperwalletSDK10QueryParamC13createdBefore10Foundation4DateVSgvp":{"name":"createdBefore","abstract":"\u003cp\u003eReturns user receipts created before this datetime.\u003c/p\u003e","parent_name":"QueryParam"},"Classes/QueryParam.html#/s:14HyperwalletSDK10QueryParamC5limitSiSgvp":{"name":"limit","abstract":"\u003cp\u003eThe maximum number of records that will be returned per page\u003c/p\u003e","parent_name":"QueryParam"},"Classes/QueryParam.html#/s:14HyperwalletSDK10QueryParamC6offsetSiSgvp":{"name":"offset","abstract":"\u003cp\u003eThe number of records to skip. If no filters are applied, records will be skipped from the beginning","parent_name":"QueryParam"},"Classes/QueryParam.html#/s:14HyperwalletSDK10QueryParamC6sortBySSSgvp":{"name":"sortBy","abstract":"\u003cp\u003eThe user receipts attribute to sort the result set by.\u003c/p\u003e","parent_name":"QueryParam"},"Classes/QueryParam.html#/s:14HyperwalletSDK10QueryParamCACycfc":{"name":"init()","abstract":"\u003cp\u003eCreates a new instance of \u003ccode\u003eQueryParam\u003c/code\u003e]\u003c/p\u003e","parent_name":"QueryParam"},"Classes/HyperwalletPrepaidCardBalanceQueryParam/QuerySortable.html#/s:14HyperwalletSDK0A28PrepaidCardBalanceQueryParamC0F8SortableO15ascendantAmountyA2EmF":{"name":"ascendantAmount","abstract":"\u003cp\u003eSort the result by ascendant amount\u003c/p\u003e","parent_name":"QuerySortable"},"Classes/HyperwalletPrepaidCardBalanceQueryParam/QuerySortable.html#/s:14HyperwalletSDK0A28PrepaidCardBalanceQueryParamC0F8SortableO17ascendantCurrencyyA2EmF":{"name":"ascendantCurrency","abstract":"\u003cp\u003eSort the result by ascendant currency\u003c/p\u003e","parent_name":"QuerySortable"},"Classes/HyperwalletPrepaidCardBalanceQueryParam/QuerySortable.html#/s:14HyperwalletSDK0A28PrepaidCardBalanceQueryParamC0F8SortableO16descendantAmountyA2EmF":{"name":"descendantAmount","abstract":"\u003cp\u003eSort the result by descendant amount\u003c/p\u003e","parent_name":"QuerySortable"},"Classes/HyperwalletPrepaidCardBalanceQueryParam/QuerySortable.html#/s:14HyperwalletSDK0A28PrepaidCardBalanceQueryParamC0F8SortableO18descendantCurrencyyA2EmF":{"name":"descendantCurrency","abstract":"\u003cp\u003eSort the result by descendant currency\u003c/p\u003e","parent_name":"QuerySortable"},"Classes/HyperwalletPrepaidCardBalanceQueryParam/QuerySortable.html":{"name":"QuerySortable","abstract":"\u003cp\u003eRepresentation of the sortable fields\u003c/p\u003e","parent_name":"HyperwalletPrepaidCardBalanceQueryParam"},"Classes/HyperwalletBalanceQueryParam/QuerySortable.html#/s:14HyperwalletSDK0A17BalanceQueryParamC0D8SortableO15ascendantAmountyA2EmF":{"name":"ascendantAmount","abstract":"\u003cp\u003eSort the result by ascendant amount\u003c/p\u003e","parent_name":"QuerySortable"},"Classes/HyperwalletBalanceQueryParam/QuerySortable.html#/s:14HyperwalletSDK0A17BalanceQueryParamC0D8SortableO17ascendantCurrencyyA2EmF":{"name":"ascendantCurrency","abstract":"\u003cp\u003eSort the result by ascendant currency\u003c/p\u003e","parent_name":"QuerySortable"},"Classes/HyperwalletBalanceQueryParam/QuerySortable.html#/s:14HyperwalletSDK0A17BalanceQueryParamC0D8SortableO16descendantAmountyA2EmF":{"name":"descendantAmount","abstract":"\u003cp\u003eSort the result by descendant amount\u003c/p\u003e","parent_name":"QuerySortable"},"Classes/HyperwalletBalanceQueryParam/QuerySortable.html#/s:14HyperwalletSDK0A17BalanceQueryParamC0D8SortableO18descendantCurrencyyA2EmF":{"name":"descendantCurrency","abstract":"\u003cp\u003eSort the result by descendant currency\u003c/p\u003e","parent_name":"QuerySortable"},"Classes/HyperwalletBalanceQueryParam.html#/s:14HyperwalletSDK0A17BalanceQueryParamC8currencySSSgvp":{"name":"currency","abstract":"\u003cp\u003eA value that identifies the currency of balance\u003c/p\u003e","parent_name":"HyperwalletBalanceQueryParam"},"Classes/HyperwalletBalanceQueryParam/QuerySortable.html":{"name":"QuerySortable","abstract":"\u003cp\u003eRepresentation of the sortable fields\u003c/p\u003e","parent_name":"HyperwalletBalanceQueryParam"},"Classes/Hyperwallet.html#/c:@M@HyperwalletSDK@objc(cs)Hyperwallet(cpy)shared":{"name":"shared","abstract":"\u003cp\u003eReturns the previously initialized instance of the Hyperwallet Core SDK interface object\u003c/p\u003e","parent_name":"Hyperwallet"},"Classes/Hyperwallet.html#/c:@M@HyperwalletSDK@objc(cs)Hyperwallet(cm)clearInstance":{"name":"clearInstance()","abstract":"\u003cp\u003eClears Hyperwallet instance.\u003c/p\u003e","parent_name":"Hyperwallet"},"Classes/Hyperwallet.html#/c:@M@HyperwalletSDK@objc(cs)Hyperwallet(cm)setup:":{"name":"setup(_:)","abstract":"\u003cp\u003eCreates a new instance of the Hyperwallet Core SDK interface object. If a previously created instance exists,","parent_name":"Hyperwallet"},"Classes/Hyperwallet.html#/s:14HyperwalletSDK0A0C16getConfiguration10completionyyAA0D0VSg_AA0A9ErrorTypeOSgtc_tF":{"name":"getConfiguration(completion:)","abstract":"\u003cp\u003eRetrieves a configuration if one exists - else using the authentication token from the provider,","parent_name":"Hyperwallet"},"Classes/Hyperwallet.html#/s:14HyperwalletSDK0A0C7getUser10completionyyAA0aD0CSg_AA0A9ErrorTypeOSgtc_tF":{"name":"getUser(completion:)","abstract":"\u003cp\u003eReturns the \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/HyperwalletUser.html\"\u003eHyperwalletUser\u003c/a\u003e\u003c/code\u003e for the User associated with the authentication token returned from","parent_name":"Hyperwallet"},"Classes/Hyperwallet.html#/s:14HyperwalletSDK0A0C17createBankAccount7account10completionyAA0adE0C_yAHSg_AA0A9ErrorTypeOSgtctF":{"name":"createBankAccount(account:completion:)","abstract":"\u003cp\u003eCreates a \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/HyperwalletBankAccount.html\"\u003eHyperwalletBankAccount\u003c/a\u003e\u003c/code\u003e for the User associated with the authentication token returned from","parent_name":"Hyperwallet"},"Classes/Hyperwallet.html#/s:14HyperwalletSDK0A0C16createPaperCheck7account10completionyAA0adE0C_yAHSg_AA0A9ErrorTypeOSgtctF":{"name":"createPaperCheck(account:completion:)","abstract":"\u003cp\u003eCreates a \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/HyperwalletPaperCheck.html\"\u003eHyperwalletPaperCheck\u003c/a\u003e\u003c/code\u003e for the User associated with the authentication token returned from","parent_name":"Hyperwallet"},"Classes/Hyperwallet.html#/s:14HyperwalletSDK0A0C14createBankCard7account10completionyAA0adE0C_yAHSg_AA0A9ErrorTypeOSgtctF":{"name":"createBankCard(account:completion:)","abstract":"\u003cp\u003eCreates a \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/HyperwalletBankCard.html\"\u003eHyperwalletBankCard\u003c/a\u003e\u003c/code\u003e for the User associated with the authentication token returned from","parent_name":"Hyperwallet"},"Classes/Hyperwallet.html#/s:14HyperwalletSDK0A0C19createPayPalAccount7account10completionyAA0adeF0C_yAHSg_AA0A9ErrorTypeOSgtctF":{"name":"createPayPalAccount(account:completion:)","abstract":"\u003cp\u003eCreates a \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/HyperwalletPayPalAccount.html\"\u003eHyperwalletPayPalAccount\u003c/a\u003e\u003c/code\u003e for the User associated with the authentication token returned from","parent_name":"Hyperwallet"},"Classes/Hyperwallet.html#/s:14HyperwalletSDK0A0C14createTransfer8transfer10completionyAA0aD0V_yAHSg_AA0A9ErrorTypeOSgtctF":{"name":"createTransfer(transfer:completion:)","abstract":"\u003cp\u003eCreates a \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbStructs/HyperwalletTransfer.html\"\u003eHyperwalletTransfer\u003c/a\u003e\u003c/code\u003e for the User associated with the authentication token returned from","parent_name":"Hyperwallet"},"Classes/Hyperwallet.html#/s:14HyperwalletSDK0A0C18createVenmoAccount7account10completionyAA0adE0C_yAHSg_AA0A9ErrorTypeOSgtctF":{"name":"createVenmoAccount(account:completion:)","abstract":"\u003cp\u003eCreates a \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/HyperwalletVenmoAccount.html\"\u003eHyperwalletVenmoAccount\u003c/a\u003e\u003c/code\u003e for the User associated with the authentication token returned from","parent_name":"Hyperwallet"},"Classes/Hyperwallet.html#/s:14HyperwalletSDK0A0C21deactivateBankAccount19transferMethodToken5notes10completionySS_SSSgyAA0A16StatusTransitionVSg_AA0A9ErrorTypeOSgtctF":{"name":"deactivateBankAccount(transferMethodToken:notes:completion:)","abstract":"\u003cp\u003eDeactivates the \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/HyperwalletBankAccount.html\"\u003eHyperwalletBankAccount\u003c/a\u003e\u003c/code\u003e linked to the transfer method token specified. The","parent_name":"Hyperwallet"},"Classes/Hyperwallet.html#/s:14HyperwalletSDK0A0C20deactivatePaperCheck19transferMethodToken5notes10completionySS_SSSgyAA0A16StatusTransitionVSg_AA0A9ErrorTypeOSgtctF":{"name":"deactivatePaperCheck(transferMethodToken:notes:completion:)","abstract":"\u003cp\u003eDeactivates the \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/HyperwalletPaperCheck.html\"\u003eHyperwalletPaperCheck\u003c/a\u003e\u003c/code\u003e linked to the transfer method token specified. The","parent_name":"Hyperwallet"},"Classes/Hyperwallet.html#/s:14HyperwalletSDK0A0C18deactivateBankCard19transferMethodToken5notes10completionySS_SSSgyAA0A16StatusTransitionVSg_AA0A9ErrorTypeOSgtctF":{"name":"deactivateBankCard(transferMethodToken:notes:completion:)","abstract":"\u003cp\u003eDeactivates the \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/HyperwalletBankCard.html\"\u003eHyperwalletBankCard\u003c/a\u003e\u003c/code\u003e linked to the transfer method token specified. The","parent_name":"Hyperwallet"},"Classes/Hyperwallet.html#/s:14HyperwalletSDK0A0C23deactivatePayPalAccount19transferMethodToken5notes10completionySS_SSSgyAA0A16StatusTransitionVSg_AA0A9ErrorTypeOSgtctF":{"name":"deactivatePayPalAccount(transferMethodToken:notes:completion:)","abstract":"\u003cp\u003eDeactivates the \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/HyperwalletPayPalAccount.html\"\u003eHyperwalletPayPalAccount\u003c/a\u003e\u003c/code\u003e linked to the transfer method token specified. The","parent_name":"Hyperwallet"},"Classes/Hyperwallet.html#/s:14HyperwalletSDK0A0C22deactivateVenmoAccount19transferMethodToken5notes10completionySS_SSSgyAA0A16StatusTransitionVSg_AA0A9ErrorTypeOSgtctF":{"name":"deactivateVenmoAccount(transferMethodToken:notes:completion:)","abstract":"\u003cp\u003eDeactivates the \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/HyperwalletVenmoAccount.html\"\u003eHyperwalletVenmoAccount\u003c/a\u003e\u003c/code\u003e linked to the transfer method token specified. The","parent_name":"Hyperwallet"},"Classes/Hyperwallet.html#/s:14HyperwalletSDK0A0C16scheduleTransfer13transferToken5notes10completionySS_SSSgyAA0A16StatusTransitionVSg_AA0A9ErrorTypeOSgtctF":{"name":"scheduleTransfer(transferToken:notes:completion:)","abstract":"\u003cp\u003eSchedules the \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbStructs/HyperwalletTransfer.html\"\u003eHyperwalletTransfer\u003c/a\u003e\u003c/code\u003e linked to the transfer method token specified.\u003c/p\u003e","parent_name":"Hyperwallet"},"Classes/Hyperwallet.html#/s:14HyperwalletSDK0A0C14getBankAccount19transferMethodToken10completionySS_yAA0adE0CSg_AA0A9ErrorTypeOSgtctF":{"name":"getBankAccount(transferMethodToken:completion:)","abstract":"\u003cp\u003eReturns the \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/HyperwalletBankAccount.html\"\u003eHyperwalletBankAccount\u003c/a\u003e\u003c/code\u003e linked to the transfer method token specified, or nil if none exists.\u003c/p\u003e","parent_name":"Hyperwallet"},"Classes/Hyperwallet.html#/s:14HyperwalletSDK0A0C13getPaperCheck19transferMethodToken10completionySS_yAA0adE0CSg_AA0A9ErrorTypeOSgtctF":{"name":"getPaperCheck(transferMethodToken:completion:)","abstract":"\u003cp\u003eReturns the \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/HyperwalletPaperCheck.html\"\u003eHyperwalletPaperCheck\u003c/a\u003e\u003c/code\u003e linked to the transfer method token specified, or nil if none exists.\u003c/p\u003e","parent_name":"Hyperwallet"},"Classes/Hyperwallet.html#/s:14HyperwalletSDK0A0C11getBankCard19transferMethodToken10completionySS_yAA0adE0CSg_AA0A9ErrorTypeOSgtctF":{"name":"getBankCard(transferMethodToken:completion:)","abstract":"\u003cp\u003eReturns the \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/HyperwalletBankCard.html\"\u003eHyperwalletBankCard\u003c/a\u003e\u003c/code\u003e linked to the transfer method token specified, or nil if none exists.\u003c/p\u003e","parent_name":"Hyperwallet"},"Classes/Hyperwallet.html#/s:14HyperwalletSDK0A0C16getPayPalAccount19transferMethodToken10completionySS_yAA0adeF0CSg_AA0A9ErrorTypeOSgtctF":{"name":"getPayPalAccount(transferMethodToken:completion:)","abstract":"\u003cp\u003eReturns the \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/HyperwalletPayPalAccount.html\"\u003eHyperwalletPayPalAccount\u003c/a\u003e\u003c/code\u003e linked to the transfer method token specified, or nil if none exists.\u003c/p\u003e","parent_name":"Hyperwallet"},"Classes/Hyperwallet.html#/s:14HyperwalletSDK0A0C14getPrepaidCard19transferMethodToken10completionySS_yAA0adE0CSg_AA0A9ErrorTypeOSgtctF":{"name":"getPrepaidCard(transferMethodToken:completion:)","abstract":"\u003cp\u003eReturns the \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/HyperwalletPrepaidCard.html\"\u003eHyperwalletPrepaidCard\u003c/a\u003e\u003c/code\u003e linked to the transfer method token specified, or nil if none exists.\u003c/p\u003e","parent_name":"Hyperwallet"},"Classes/Hyperwallet.html#/s:14HyperwalletSDK0A0C11getTransfer13transferToken10completionySS_yAA0aD0VSg_AA0A9ErrorTypeOSgtctF":{"name":"getTransfer(transferToken:completion:)","abstract":"\u003cp\u003eReturns the \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbStructs/HyperwalletTransfer.html\"\u003eHyperwalletTransfer\u003c/a\u003e\u003c/code\u003e linked to the transfer method token specified, or nil if none exists.\u003c/p\u003e","parent_name":"Hyperwallet"},"Classes/Hyperwallet.html#/s:14HyperwalletSDK0A0C15getVenmoAccount19transferMethodToken10completionySS_yAA0adE0CSg_AA0A9ErrorTypeOSgtctF":{"name":"getVenmoAccount(transferMethodToken:completion:)","abstract":"\u003cp\u003eReturns the \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/HyperwalletVenmoAccount.html\"\u003eHyperwalletVenmoAccount\u003c/a\u003e\u003c/code\u003e linked to the transfer method token specified, or nil if none exists.\u003c/p\u003e","parent_name":"Hyperwallet"},"Classes/Hyperwallet.html#/s:14HyperwalletSDK0A0C16listBankAccounts10queryParam10completionyAA0ad12AccountQueryG0CSg_yAA0A8PageListVyAA0adI0CGSg_AA0A9ErrorTypeOSgtctF":{"name":"listBankAccounts(queryParam:completion:)","abstract":"\u003cp\u003eReturns the list of \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/HyperwalletBankAccount.html\"\u003eHyperwalletBankAccount\u003c/a\u003e\u003c/code\u003es for the User associated with the authentication token","parent_name":"Hyperwallet"},"Classes/Hyperwallet.html#/s:14HyperwalletSDK0A0C15listPaperChecks10queryParam10completionyAA0ad10CheckQueryG0CSg_yAA0A8PageListVyAA0adI0CGSg_AA0A9ErrorTypeOSgtctF":{"name":"listPaperChecks(queryParam:completion:)","abstract":"\u003cp\u003eReturns the list of \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/HyperwalletPaperCheck.html\"\u003eHyperwalletPaperCheck\u003c/a\u003e\u003c/code\u003es for the User associated with the authentication token","parent_name":"Hyperwallet"},"Classes/Hyperwallet.html#/s:14HyperwalletSDK0A0C13listBankCards10queryParam10completionyAA0ad9CardQueryG0CSg_yAA0A8PageListVyAA0adI0CGSg_AA0A9ErrorTypeOSgtctF":{"name":"listBankCards(queryParam:completion:)","abstract":"\u003cp\u003eReturns the \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/HyperwalletBankCard.html\"\u003eHyperwalletBankCard\u003c/a\u003e\u003c/code\u003e for the User associated with the authentication token returned from","parent_name":"Hyperwallet"},"Classes/Hyperwallet.html#/s:14HyperwalletSDK0A0C18listPayPalAccounts10queryParam10completionyAA0ade12AccountQueryH0CSg_yAA0A8PageListVyAA0adeJ0CGSg_AA0A9ErrorTypeOSgtctF":{"name":"listPayPalAccounts(queryParam:completion:)","abstract":"\u003cp\u003eReturns the \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/HyperwalletPayPalAccount.html\"\u003eHyperwalletPayPalAccount\u003c/a\u003e\u003c/code\u003e for the User associated with the authentication token returned from","parent_name":"Hyperwallet"},"Classes/Hyperwallet.html#/s:14HyperwalletSDK0A0C19listTransferMethods10queryParam10completionyAA0ad11MethodQueryG0CSg_yAA0A8PageListVyAA0adI0CGSg_AA0A9ErrorTypeOSgtctF":{"name":"listTransferMethods(queryParam:completion:)","abstract":"\u003cp\u003eReturns the \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/HyperwalletTransferMethod.html\"\u003eHyperwalletTransferMethod\u003c/a\u003e\u003c/code\u003e (Bank Account, Bank Card, PayPay Account, Prepaid Card, Paper Checks)","parent_name":"Hyperwallet"},"Classes/Hyperwallet.html#/s:14HyperwalletSDK0A0C16listPrepaidCards10queryParam10completionyAA0ad9CardQueryG0CSg_yAA0A8PageListVyAA0adI0CGSg_AA0A9ErrorTypeOSgtctF":{"name":"listPrepaidCards(queryParam:completion:)","abstract":"\u003cp\u003eReturns the \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/HyperwalletPrepaidCard.html\"\u003eHyperwalletPrepaidCard\u003c/a\u003e\u003c/code\u003e","parent_name":"Hyperwallet"},"Classes/Hyperwallet.html#/s:14HyperwalletSDK0A0C17listVenmoAccounts10queryParam10completionyAA0ad5QueryG0CSg_yAA0A8PageListVyAA0aD7AccountCGSg_AA0A9ErrorTypeOSgtctF":{"name":"listVenmoAccounts(queryParam:completion:)","abstract":"\u003cp\u003eReturns the \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/HyperwalletVenmoAccount.html\"\u003eHyperwalletVenmoAccount\u003c/a\u003e\u003c/code\u003e for the User associated with the authentication token returned from","parent_name":"Hyperwallet"},"Classes/Hyperwallet.html#/s:14HyperwalletSDK0A0C16listUserReceipts10queryParam10completionyAA0a12ReceiptQueryG0CSg_yAA0A8PageListVyAA0aI0VGSg_AA0A9ErrorTypeOSgtctF":{"name":"listUserReceipts(queryParam:completion:)","abstract":"\u003cp\u003eReturns the list of receipts for the User associated with the authentication token.\u003c/p\u003e","parent_name":"Hyperwallet"},"Classes/Hyperwallet.html#/s:14HyperwalletSDK0A0C23listPrepaidCardReceipts07prepaidE5Token10queryParam10completionySS_AA0a12ReceiptQueryJ0CSgyAA0A8PageListVyAA0aL0VGSg_AA0A9ErrorTypeOSgtctF":{"name":"listPrepaidCardReceipts(prepaidCardToken:queryParam:completion:)","abstract":"\u003cp\u003eThe filtering of \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbStructs/HyperwalletReceipt.html\"\u003eHyperwalletReceipt\u003c/a\u003e\u003c/code\u003e will be based on the criteria specified within the","parent_name":"Hyperwallet"},"Classes/Hyperwallet.html#/s:14HyperwalletSDK0A0C13listTransfers10queryParam10completionyAA0a13TransferQueryF0CSg_yAA0A8PageListVyAA0aH0VGSg_AA0A9ErrorTypeOSgtctF":{"name":"listTransfers(queryParam:completion:)","abstract":"\u003cp\u003eReturns the list of transfers for the User associated with the authentication token.\u003c/p\u003e","parent_name":"Hyperwallet"},"Classes/Hyperwallet.html#/s:14HyperwalletSDK0A0C41retrieveTransferMethodConfigurationFields7request10completionyAA0adeF10FieldQueryV_yAA0adefJ0_pSg_AA0A9ErrorTypeOSgtctF":{"name":"retrieveTransferMethodConfigurationFields(request:completion:)","abstract":"\u003cp\u003eReturns the transfer method configuration field set for the User that is associated with the authentication","parent_name":"Hyperwallet"},"Classes/Hyperwallet.html#/s:14HyperwalletSDK0A0C47retrieveTransferMethodUpdateConfigurationFields7request10completionyAA0adefG10FieldQueryV_yAA0adefgK0_pSg_AA0A9ErrorTypeOSgtctF":{"name":"retrieveTransferMethodUpdateConfigurationFields(request:completion:)","abstract":"\u003cp\u003eReturns the transfer method update configuration fields set for the User that is associated with","parent_name":"Hyperwallet"},"Classes/Hyperwallet.html#/s:14HyperwalletSDK0A0C39retrieveTransferMethodConfigurationKeys7request10completionyAA0adefG5QueryV_yAA0adeF3Key_pSg_AA0A9ErrorTypeOSgtctF":{"name":"retrieveTransferMethodConfigurationKeys(request:completion:)","abstract":"\u003cp\u003eReturns the transfer method configuration key set for the User that is associated","parent_name":"Hyperwallet"},"Classes/Hyperwallet.html#/s:14HyperwalletSDK0A0C49retrieveTransferMethodTypesFeesAndProcessingTimes7request10completionyAA0adefghiJ5QueryV_yAA0adE16ConfigurationKey_pSg_AA0A9ErrorTypeOSgtctF":{"name":"retrieveTransferMethodTypesFeesAndProcessingTimes(request:completion:)","abstract":"\u003cp\u003eReturns the transfer method types, processing times, and fees for the User that is associated","parent_name":"Hyperwallet"},"Classes/Hyperwallet.html#/s:14HyperwalletSDK0A0C17updateBankAccount7account10completionyAA0adE0C_yAHSg_AA0A9ErrorTypeOSgtctF":{"name":"updateBankAccount(account:completion:)","abstract":"\u003cp\u003eUpdates the \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/HyperwalletBankAccount.html\"\u003eHyperwalletBankAccount\u003c/a\u003e\u003c/code\u003e for the User associated with the authentication token returned from","parent_name":"Hyperwallet"},"Classes/Hyperwallet.html#/s:14HyperwalletSDK0A0C16updatePaperCheck7account10completionyAA0adE0C_yAHSg_AA0A9ErrorTypeOSgtctF":{"name":"updatePaperCheck(account:completion:)","abstract":"\u003cp\u003eUpdates the \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/HyperwalletPaperCheck.html\"\u003eHyperwalletPaperCheck\u003c/a\u003e\u003c/code\u003e for the User associated with the authentication token returned from","parent_name":"Hyperwallet"},"Classes/Hyperwallet.html#/s:14HyperwalletSDK0A0C14updateBankCard7account10completionyAA0adE0C_yAHSg_AA0A9ErrorTypeOSgtctF":{"name":"updateBankCard(account:completion:)","abstract":"\u003cp\u003eUpdates the \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/HyperwalletBankCard.html\"\u003eHyperwalletBankCard\u003c/a\u003e\u003c/code\u003e for the User associated with the authentication token returned from","parent_name":"Hyperwallet"},"Classes/Hyperwallet.html#/s:14HyperwalletSDK0A0C19updatePayPalAccount7account10completionyAA0adeF0C_yAHSg_AA0A9ErrorTypeOSgtctF":{"name":"updatePayPalAccount(account:completion:)","abstract":"\u003cp\u003eUpdates the \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/HyperwalletPayPalAccount.html\"\u003eHyperwalletPayPalAccount\u003c/a\u003e\u003c/code\u003e for the User associated with the authentication token returned from","parent_name":"Hyperwallet"},"Classes/Hyperwallet.html#/s:14HyperwalletSDK0A0C18updateVenmoAccount7account10completionyAA0adE0C_yAHSg_AA0A9ErrorTypeOSgtctF":{"name":"updateVenmoAccount(account:completion:)","abstract":"\u003cp\u003eUpdates the \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/HyperwalletVenmoAccount.html\"\u003eHyperwalletVenmoAccount\u003c/a\u003e\u003c/code\u003e for the User associated with the authentication token returned from","parent_name":"Hyperwallet"},"Classes/Hyperwallet.html#/s:14HyperwalletSDK0A0C16listUserBalances10queryParam10completionyAA0a12BalanceQueryG0CSg_yAA0A8PageListVyAA0aI0VGSg_AA0A9ErrorTypeOSgtctF":{"name":"listUserBalances(queryParam:completion:)","abstract":"\u003cp\u003eReturns the list of balances for the User associated with the authentication token.\u003c/p\u003e","parent_name":"Hyperwallet"},"Classes/Hyperwallet.html#/s:14HyperwalletSDK0A0C23listPrepaidCardBalances07prepaidE5Token10queryParam10completionySS_AA0ade12BalanceQueryJ0CSgyAA0A8PageListVyAA0aL0VGSg_AA0A9ErrorTypeOSgtctF":{"name":"listPrepaidCardBalances(prepaidCardToken:queryParam:completion:)","abstract":"\u003cp\u003eReturns the list of prepaid card balances for the User associated with the authentication token.\u003c/p\u003e","parent_name":"Hyperwallet"},"Classes/Hyperwallet.html":{"name":"Hyperwallet","abstract":"\u003cp\u003eThe \u003ccode\u003eHyperwallet\u003c/code\u003e class is an iOS specific implementation of the"},"Classes/HyperwalletBalanceQueryParam.html":{"name":"HyperwalletBalanceQueryParam","abstract":"\u003cp\u003eRepresentation of the balance QueryParam fields.\u003c/p\u003e"},"Classes/HyperwalletPrepaidCardBalanceQueryParam.html":{"name":"HyperwalletPrepaidCardBalanceQueryParam","abstract":"\u003cp\u003eRepresentation of the prepaid card balance QueryParam fields.\u003c/p\u003e"},"Classes/QueryParam.html":{"name":"QueryParam","abstract":"\u003cp\u003eRepresentation of the common query parameters.\u003c/p\u003e"},"Classes/HyperwalletReceiptQueryParam.html":{"name":"HyperwalletReceiptQueryParam","abstract":"\u003cp\u003eRepresentation of the user receipts QueryParam fields.\u003c/p\u003e"},"Classes/HyperwalletTransferQueryParam.html":{"name":"HyperwalletTransferQueryParam","abstract":"\u003cp\u003eRepresentation of the user transfers QueryParams fields.\u003c/p\u003e"},"Classes/HyperwalletBankAccount.html":{"name":"HyperwalletBankAccount","abstract":"\u003cp\u003eRepresentation of the user\u0026rsquo;s bank account\u003c/p\u003e"},"Classes/HyperwalletBankAccountQueryParam.html":{"name":"HyperwalletBankAccountQueryParam","abstract":"\u003cp\u003eRepresentation of the bank account query parameters.\u003c/p\u003e"},"Classes/HyperwalletBankCard.html":{"name":"HyperwalletBankCard","abstract":"\u003cp\u003eRepresentation of the user\u0026rsquo;s bank card\u003c/p\u003e"},"Classes/HyperwalletBankCardQueryParam.html":{"name":"HyperwalletBankCardQueryParam","abstract":"\u003cp\u003eRepresentation of the bank card query parameters.\u003c/p\u003e"},"Classes/HyperwalletPaperCheck.html":{"name":"HyperwalletPaperCheck","abstract":"\u003cp\u003eRepresentation of the user\u0026rsquo;s paper check\u003c/p\u003e"},"Classes/HyperwalletPaperCheckQueryParam.html":{"name":"HyperwalletPaperCheckQueryParam","abstract":"\u003cp\u003eRepresentation of the paper check query parameters.\u003c/p\u003e"},"Classes/HyperwalletPayPalAccount.html":{"name":"HyperwalletPayPalAccount","abstract":"\u003cp\u003eRepresentation of the user\u0026rsquo;s PayPal account\u003c/p\u003e"},"Classes/HyperwalletPayPalAccountQueryParam.html":{"name":"HyperwalletPayPalAccountQueryParam","abstract":"\u003cp\u003eRepresentation of the PayPal account query parameters.\u003c/p\u003e"},"Classes/HyperwalletPrepaidCard.html":{"name":"HyperwalletPrepaidCard","abstract":"\u003cp\u003eRepresentation of the user\u0026rsquo;s Prepaid card account\u003c/p\u003e"},"Classes/HyperwalletPrepaidCardQueryParam.html":{"name":"HyperwalletPrepaidCardQueryParam","abstract":"\u003cp\u003eRepresentation of the prepaid card query parameters.\u003c/p\u003e"},"Classes/HyperwalletTransferMethod.html":{"name":"HyperwalletTransferMethod","abstract":"\u003cp\u003eRepresentation of the transfer method (bank account, bank card, PayPal account, prepaid card, paper check).\u003c/p\u003e"},"Classes/HyperwalletTransferMethodQueryParam.html":{"name":"HyperwalletTransferMethodQueryParam","abstract":"\u003cp\u003eRepresentation of the common transfer method\u0026rsquo;s query parameters.\u003c/p\u003e"},"Classes/HyperwalletVenmoAccount.html":{"name":"HyperwalletVenmoAccount","abstract":"\u003cp\u003eRepresentation of the user\u0026rsquo;s Venmo account\u003c/p\u003e"},"Classes/HyperwalletVenmoQueryParam.html":{"name":"HyperwalletVenmoQueryParam","abstract":"\u003cp\u003eRepresentation of the common Venmo\u0026rsquo;s query parameters.\u003c/p\u003e"},"Classes/HyperwalletUser.html":{"name":"HyperwalletUser","abstract":"\u003cp\u003eRepresentation of the Hyperwallet\u0026rsquo;s user.\u003c/p\u003e"},"changelog.html":{"name":"CHANGELOG"},"readme.html":{"name":"README"},"Guides.html":{"name":"Guides","abstract":"\u003cp\u003eThe following guides are available globally.\u003c/p\u003e"},"Classes.html":{"name":"Classes","abstract":"\u003cp\u003eThe following classes are available globally.\u003c/p\u003e"},"Enums.html":{"name":"Enumerations","abstract":"\u003cp\u003eThe following enumerations are available globally.\u003c/p\u003e"},"Extensions.html":{"name":"Extensions","abstract":"\u003cp\u003eThe following extensions are available globally.\u003c/p\u003e"},"Protocols.html":{"name":"Protocols","abstract":"\u003cp\u003eThe following protocols are available globally.\u003c/p\u003e"},"Structs.html":{"name":"Structures","abstract":"\u003cp\u003eThe following structures are available globally.\u003c/p\u003e"}} \ No newline at end of file diff --git a/docsets/HyperwalletSDK.docset/Contents/Resources/docSet.dsidx b/docsets/HyperwalletSDK.docset/Contents/Resources/docSet.dsidx new file mode 100644 index 00000000..3ea5a339 Binary files /dev/null and b/docsets/HyperwalletSDK.docset/Contents/Resources/docSet.dsidx differ diff --git a/docsets/HyperwalletSDK.tgz b/docsets/HyperwalletSDK.tgz new file mode 100644 index 00000000..344c0a90 Binary files /dev/null and b/docsets/HyperwalletSDK.tgz differ diff --git a/img/carat.png b/img/carat.png new file mode 100755 index 00000000..29d2f7fd Binary files /dev/null and b/img/carat.png differ diff --git a/img/dash.png b/img/dash.png new file mode 100755 index 00000000..6f694c7a Binary files /dev/null and b/img/dash.png differ diff --git a/img/gh.png b/img/gh.png new file mode 100755 index 00000000..628da97c Binary files /dev/null and b/img/gh.png differ diff --git a/img/spinner.gif b/img/spinner.gif new file mode 100644 index 00000000..e3038d0a Binary files /dev/null and b/img/spinner.gif differ diff --git a/index.html b/index.html new file mode 100644 index 00000000..875b1ab4 --- /dev/null +++ b/index.html @@ -0,0 +1,1033 @@ + + + + HyperwalletSDK Reference + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + HyperwalletSDK Reference +

+ +
+ +
+ +
+
+ +

Hyperwallet iOS Core SDK

+ +

Platforms +Build Status +Coverage Status

+ +

CocoaPods +Carthage compatible

+ +

NOTE: This is a beta product available for use in your mobile app. If you are interested in using this product, please notify your Relationship Manager and / or Project Manager to support you during the integration process.

+ +

Welcome to Hyperwallet’s iOS SDK. This library will help you create transfer methods in your iOS app, such as bank account, PayPal account, etc. See our iOS Integration Guide to get started!

+ +

Note that this SDK is geared towards those who only require backend data, which means you will have to build your own UI.

+ +

We also provide an out-of-the-box Hyperwallet iOS UI SDK for you if you decide not to build your own UI.

+

Prerequisites

+ +
    +
  • A Hyperwallet merchant account
    • +
  • Set Up your server to manage the user’s authentication process on the Hyperwallet platform. See the Authentication section for more information.
    • +
  • iOS 13.0+
    • +
  • Xcode 10.2+
    • +
  • Swift 5.0
    • +
+

Installation

+ +

Use Carthage or CocoaPods to integrate to HyperwalletSDK.

+

Carthage

+ +

Specify it in your Cartfile:

+
github "hyperwallet/hyperwallet-ios-sdk" "1.0.0-beta17"
+
+

CocoaPods

+ +

Specify it in your Podfile:

+
pod 'HyperwalletSDK', '~> 1.0.0-beta17'
+
+

Initialization

+ +

After you’re done installing the SDK, you need to initialize an instance in order to utilize core SDK functions. Also, you need to provide a HyperwalletAuthenticationTokenProvider object to retrieve an authentication token.

+ +

Add in the header:

+
import HyperwalletSDK
+
+ +

Initialize the HyperwalletSDK with a HyperwalletAuthenticationTokenProvider implementation instance:

+
Hyperwallet.setup(authenticationTokenProvider :HyperwalletAuthenticationTokenProvider)
+
+

Authentication

+ +

Your server side should be able to send a POST request to Hyperwallet endpoint /rest/v3/users/{user-token}/authentication-token to retrieve an authentication token. +Then, you need to provide a class (an authentication provider) which implements HyperwalletAuthenticationTokenProvider to retrieve an authentication token from your server.

+ +

An example implementation using the URLRequest from Swift Foundation :

+
import Foundation
+import HyperwalletSDK
+
+public class AuthenticationTokenProvider: HyperwalletAuthenticationTokenProvider {
+    private let url = URL(string: "http://your/server/to/retrieve/authenticationToken")!
+
+    public func retrieveAuthenticationToken(
+        completionHandler: @escaping HyperwalletAuthenticationTokenProvider.CompletionHandler) {
+
+        var request = URLRequest(url: url)
+        request.httpMethod = "POST"
+        request.addValue("application/json", forHTTPHeaderField: "Content-Type")
+
+        let defaultSession = URLSession(configuration: .default)
+        let task = defaultSession.dataTask(with: request) {(data, response, error) in
+            DispatchQueue.main.async {
+                    guard let data = data,
+                        let clientToken = String(data: data, encoding: .utf8),
+                        let response = response as? HTTPURLResponse else {
+                            completionHandler(nil, HyperwalletAuthenticationErrorType.unexpected(error?.localizedDescription ??
+                                "authentication token cannot be retrieved"))
+                            return
+                    }
+
+                    switch response.statusCode {
+                        case 200 ..< 300:
+                            completionHandler(clientToken, nil)
+
+                        default:
+                            completionHandler(nil, HyperwalletAuthenticationErrorType
+                                .unexpected("authentication token cannot be retrieved"))
+                }
+            }
+        }
+        task.resume()
+    }
+}
+
+

Usage

+ +

The functions in the core SDK are available to use once the authentication is done.

+

Get User

+
Hyperwallet.shared.getUser { (user, error) in
+    guard error == nil else {
+        print(error?.getHyperwalletErrors()?.errorList?)
+        return
+    }
+
+    print(user?.firstName)
+    print(user?.lastName)
+}
+
+

Create PayPal Account

+
let payPalAccount = HyperwalletPayPalAccount.Builder(transferMethodCountry: "US", transferMethodCurrency: "USD")
+    .email("test@paypal.com")
+    .build()
+
+Hyperwallet.shared.createPayPalAccount(account: payPalAccount, completion: { (result, error) in
+    // Code to handle successful response or error
+    // On successful creation, response (HyperwalletPayPalAccount in this case) will contain information about the user’s PayPal account
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure of PayPal account creation
+})
+
+

Get PayPal Account

+
Hyperwallet.shared.getPayPalAccount(transferMethodToken: "123123", completion: { (result, error) in
+    // On success, response (HyperwalletPayPalAccount? in this case) will contain information about the user’s PayPal account or nil if not exist.
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure
+})
+
+

Update PayPal Account

+
let payPalAccount = HyperwalletPayPalAccount.Builder(token: "trm-12345")
+    .email("test@paypal.com")
+    .build()
+
+Hyperwallet.shared.updatePayPalAccount(account: payPalAccount, completion: { (result, error) in
+    // Code to handle successful response or error
+    // On successful update, response (HyperwalletPayPalAccount in this case) will contain information about the user’s PayPal account
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure of PayPal account updating
+})
+
+

Deactivate PayPal Account

+
Hyperwallet.shared.deactivatePayPalAccount(transferMethodToken: "trm-12345", notes: "deactivate PayPal account", completion: { (result, error) in
+    // Code to handle successful response or error
+    // On successful deactivation, response (HyperwalletStatusTransition in this case) will contain information about the status transition
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure of PayPal account deactivation
+})
+
+

List PayPal Account

+
let payPalQueryParam = HyperwalletPayPalAccountQueryParam()
+payPalQueryParam.status = HyperwalletPayPalAccountQueryParam.QueryStatus.activated.rawValue
+payPalQueryParam.sortBy = HyperwalletTransferMethodQueryParam.QuerySortable.ascendantCreatedOn.rawValue
+
+Hyperwallet.shared.listPayPalAccounts(queryParam: payPalQueryParam) { (result, error) in
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure
+    guard error == nil else {
+        print(error?.getHyperwalletErrors()?.errorList?)
+        return
+    }
+
+    // On success, response (HyperwalletPageList<HyperwalletPayPalAccount>? in this case) will contain information about or nil if not exist.
+    if let payPalAccounts = result?.data {
+        for payPalAccount in payPalAccounts {
+        print(payPalAccount.getField(fieldName: .token) ?? "")
+        }
+    }
+}
+
+

Create Venmo Account

+
let venmoAccount = HyperwalletVenmoAccount.Builder(transferMethodCountry: "US", transferMethodCurrency: "USD")
+    .accountId("9876543210")
+    .build()
+
+Hyperwallet.shared.createVenmoAccount(account: venmoAccount, completion: { (result, error) in
+    // Code to handle successful response or error
+    // On successful creation, response (HyperwalletVenmoAccount in this case) will contain information about the user’s Venmo account
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure of Venmo account creation
+})
+
+

Get Venmo Account

+
Hyperwallet.shared.getVenmoAccount(transferMethodToken: "123123", completion: { (result, error) in
+    // On success, response (HyperwalletVenmoAccount? in this case) will contain information about the user’s Venmo account or nil if not exist.
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure
+})
+
+

Update Venmo Account

+
let venmoAccount = HyperwalletVenmoAccount.Builder(token: "trm-12345")
+    .accountId("9876543210")
+    .build()
+
+Hyperwallet.shared.updateVenmoAccount(account: venmoAccount, completion: { (result, error) in
+    // Code to handle successful response or error
+    // On successful update, response (HyperwalletVenmoAccount in this case) will contain information about the user’s Venmo account
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure of Venmo account updating
+})
+
+

Deactivate Venmo Account

+
Hyperwallet.shared.deactivateVenmoAccount(transferMethodToken: "trm-12345", notes: "deactivate Venmo account", completion: { (result, error) in
+    // Code to handle successful response or error
+    // On successful deactivation, response (HyperwalletStatusTransition in this case) will contain information about the status transition
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure of Venmo account deactivation
+})
+
+

List Venmo Account

+
let venmoQueryParam = HyperwalletVenmoQueryParam()
+venmoQueryParam.status = HyperwalletVenmoQueryParam.QueryStatus.activated.rawValue
+venmoQueryParam.sortBy = HyperwalletVenmoQueryParam.QuerySortable.ascendantCreatedOn.rawValue
+
+Hyperwallet.shared.listVenmoAccounts(queryParam: venmoQueryParam) { (result, error) in
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure
+    guard error == nil else {
+        print(error?.getHyperwalletErrors()?.errorList?)
+        return
+    }
+
+    // On success, response (HyperwalletPageList<HyperwalletVenmoAccount>? in this case) will contain information about or nil if not exist.
+    if let venmoAccounts = result?.data {
+        for venmoAccount in venmoAccounts {
+           print(venmoAccount.getField(fieldName: .token) ?? "")
+        }
+    }
+}
+
+

Create Bank Account

+
let bankAccount = HyperwalletBankAccount.Builder(transferMethodCountry: "US",   
+                                                 transferMethodCurrency: "USD",
+                                                 transferMethodProfileType: "INDIVIDUAL")
+.bankAccountId("12345")
+.branchId("123456")
+.bankAccountPurpose(.checking)
+.build()
+
+Hyperwallet.shared.createBankAccount(account: bankAccount, completion: { (result, error) in
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure of account creation
+    guard error == nil else {
+        print(error?.getHyperwalletErrors()?.errorList?)
+        return
+    }   
+
+    // On successful creation, response (HyperwalletBankAccount in this case) payload will contain information about the account created
+    print(result)
+})
+
+

Get Bank Account

+
Hyperwallet.shared.getBankAccount(transferMethodToken: "123123", completion: { (result, error) in
+    // On success, response (HyperwalletBankCard? in this case) will contain information about the user’s bank account or nil if not exist.
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure
+})
+
+

Update Bank Account

+
let bankAccount = HyperwalletBankAccount
+.Builder(token: "12345")
+.branchId("026009593")
+.build()
+
+Hyperwallet.shared.updateBankAccount(account: bankAccount, completion: { (response, error) in
+    // Code to handle successful response or error
+    // On successful update, response (HyperwalletBankAccount in this case) payload will contain information about the account updated
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure of account updating
+})
+
+

Deactivate Bank Account

+
Hyperwallet.shared.deactivateBankAccount(transferMethodToken: "trm-12345", notes: "deactivate bank account", completion: { (result, error) in
+    // Code to handle successful response or error
+    // On successful deactivation, response (HyperwalletStatusTransition in this case) will contain information about the status transition
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure of account deactivation
+})
+
+

List Bank Account

+
let bankAccountQueryParam = HyperwalletBankAccountQueryParam()
+bankAccountQueryParam.status = HyperwalletBankAccountQueryParam.QueryStatus.activated.rawValue
+bankAccountQueryParam.sortBy = HyperwalletBankAccountQueryParam.QuerySortable.ascendantCreatedOn.rawValue
+
+Hyperwallet.shared.listBankAccounts(queryParam: bankAccountQueryParam) { (result, error) in
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure
+    guard error == nil else {
+        print(error?.getHyperwalletErrors()?.errorList?)
+        return
+    }
+
+    // On success, response (HyperwalletPageList<HyperwalletBankAccount>? in this case) will contain information about or nil if not exist.
+    if let bankAccounts = result?.data {
+        for bankAccount in bankAccounts {
+            print(bankAccount.token ?? "")
+        }
+    }
+}
+
+

Create Paper Check

+
let paperCheck = HyperwalletPaperCheck.Builder(transferMethodCountry: "US",   
+                                               transferMethodCurrency: "USD",
+                                               transferMethodProfileType: "INDIVIDUAL")
+.shippingMethod("STANDARD")
+.build()
+
+Hyperwallet.shared.createPaperCheck(account: paperCheck, completion: { (result, error) in
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure of account creation
+    guard error == nil else {
+        print(error?.getHyperwalletErrors()?.errorList?)
+        return
+    }   
+
+    // On successful creation, response (HyperwalletPaperCheck in this case) payload will contain information about the paper check created
+    print(result)
+})
+
+

Get Paper Check

+
Hyperwallet.shared.getPaperCheck(transferMethodToken: "123123", completion: { (result, error) in
+    // On success, response (HyperwalletPaperCheck? in this case) will contain information about the user’s paper check or nil if not exist.
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure
+})
+
+

Update Paper Check

+
let paperCheck = HyperwalletPaperCheck
+.Builder(token: "12345")
+.shippingMethod("STANDARD")
+.build()
+
+Hyperwallet.shared.updatePaperCheck(account: paperCheck, completion: { (response, error) in
+    // Code to handle successful response or error
+    // On successful update, response (HyperwalletPaperCheck in this case) payload will contain information about the paper check updated
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure while updating
+})
+
+

Deactivate Paper Check

+
Hyperwallet.shared.deactivatePaperCheck(transferMethodToken: "trm-12345", notes: "deactivate paper check", completion: { (result, error) in
+    // Code to handle successful response or error
+    // On successful deactivation, response (HyperwalletStatusTransition in this case) will contain information about the status transition
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure
+})
+
+

List Paper Check

+
let paperCheckQueryParam = HyperwalletPaperCheckQueryParam()
+paperCheckQueryParam.status = HyperwalletPaperCheckQueryParam.QueryStatus.activated.rawValue
+paperCheckQueryParam.sortBy = HyperwalletPaperCheckQueryParam.QuerySortable.ascendantCreatedOn.rawValue
+
+Hyperwallet.shared.listPaperChecks(queryParam: paperCheckQueryParam) { (result, error) in
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure
+    guard error == nil else {
+        print(error?.getHyperwalletErrors()?.errorList?)
+        return
+    }
+
+    // On success, response (HyperwalletPageList<HyperwalletPaperCheck>? in this case) will contain information about or nil if not exist.
+    if let paperChecks = result?.data {
+        for paperCheck in paperChecks {
+            print(paperCheck.token ?? "")
+        }
+    }
+}
+
+

Create Bank Card

+
let bankCard = HyperwalletBankCard.Builder(transferMethodCountry: "US",
+                                           transferMethodCurrency: "USD",
+                                           transferMethodProfileType: "INDIVIDUAL")
+.cardNumber("1234123412341234")
+.dateOfExpiry("2022-12")
+.cvv("123")
+.build()
+
+Hyperwallet.shared.createBankCard(account: bankCard, completion: { (result, error) in
+    // Code to handle successful response or error
+    // On successful creation, response (HyperwalletBankCard in this case) will contain information about the user’s bank card
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure of bank card creation
+})
+
+

Get Bank Card

+
Hyperwallet.shared.getBankCard(transferMethodToken: "123123", completion: { (result, error) in
+    // On success, response (HyperwalletBankCard? in this case) will contain information about the user’s bank card or nil if not exist.
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure
+})
+
+

Update Bank Card

+
let bankCard = HyperwalletBankCard
+.Builder(token: "trm-12345")
+.dateOfExpiry("2022-12")
+.build()
+
+Hyperwallet.shared.updateBankCard(account: bankCard, completion: { (result, error) in
+    // Code to handle successful response or error
+    // On successful update, response (HyperwalletBankCard in this case) will contain information about the user’s bank card
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure of bank card updating
+})
+
+

Deactivate Bank Card

+
Hyperwallet.shared.deactivateBankCard(transferMethodToken: "trm-12345", notes: "deactivate bank card", completion: { (result, error) in
+    // Code to handle successful response or error
+    // On successful deactivation, response (HyperwalletStatusTransition in this case) will contain information about the status transition
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure of bank card deactivation
+})
+
+

List Bank Card

+
let bankCardQueryParam = HyperwalletBankCardQueryParam()
+bankCardQueryParam.status = HyperwalletBankCardQueryParam.QueryStatus.activated.rawValue
+bankCardQueryParam.sortBy = HyperwalletBankCardQueryParam.QuerySortable.ascendantCreatedOn.rawValue
+
+Hyperwallet.shared.listBankCards(queryParam: bankCardQueryParam) { (result, error) in
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure
+    guard error == nil else {
+        print(error?.getHyperwalletErrors()?.errorList?)
+        return
+    }
+
+    // On success, response (HyperwalletPageList<HyperwalletBankCard>? in this case) will contain information about or nil if not exist.
+    if let bankCards = result?.data {
+        for bankCard in bankCards {
+            print(bankCard.token ?? "")
+        }
+    }
+}
+
+

Get Prepaid Card

+
Hyperwallet.shared.getPrepaidCard(transferMethodToken: "123123", completion: { (result, error) in
+    // On success, response (HyperwalletPrepaidCard? in this case) will contain information about the user’s prepaid card or nil if not exist.
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure
+})
+
+

List Prepaid Cards

+
let prepaidCardQueryParam = HyperwalletPrepaidCardQueryParam()
+prepaidCardQueryParam.status = HyperwalletPrepaidCardQueryParam.QueryStatus.activated.rawValue
+prepaidCardQueryParam.sortBy = HyperwalletPrepaidCardQueryParam.QuerySortable.ascendantCreatedOn.rawValue
+
+Hyperwallet.shared.listPrepaidCards(queryParam: prepaidCardQueryParam) { (result, error) in
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure
+    guard error == nil else {
+        print(error?.getHyperwalletErrors()?.errorList?)
+        return
+    }
+
+    // On success, response (HyperwalletPageList<HyperwalletPrepaidCard>? in this case) will contain information about or nil if not exist.
+    if let prepaidCards = result?.data {
+        for prepaidCard in prepaidCards {
+            print(prepaidCard.token)
+        }
+    }
+}
+
+

List Prepaid Card Receipts

+
let receiptQueryParam = HyperwalletReceiptQueryParam()
+receiptQueryParam.createdAfter = ISO8601DateFormatter.ignoreTimeZone.date(from: "2016-12-01T00:00:00")
+
+Hyperwallet.shared.listPrepaidCardReceipts(prepaidCardToken: prepaidCardToken,
+                                           queryParam: receiptQueryParam,
+                                           completion: { (result, error) in
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure
+    guard error == nil else {
+        print(error?.getHyperwalletErrors()?.errorList?)
+        return
+    }
+
+    // On success, response (HyperwalletPageList<HyperwalletReceipt>? in this case) will contain information about or nil if not exist.
+    if let receipts = result?.data {
+        for receipt in receipts {
+            print(receipt.destinationToken ?? "")
+        }
+    }
+}
+
+

List User Receipts

+
let receiptQueryParam = HyperwalletReceiptQueryParam()
+receiptQueryParam.createdAfter = ISO8601DateFormatter.ignoreTimeZone.date(from: "2018-12-01T00:00:00")
+receiptQueryParam.currency = "USD"
+receiptQueryParam.sortBy = HyperwalletReceiptQueryParam.QuerySortable.descendantAmount.rawValue
+
+Hyperwallet.shared.listUserReceipts(queryParam: receiptQueryParam) { (result, error) in
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure
+    guard error == nil else {
+        print(error?.getHyperwalletErrors()?.errorList?)
+        return
+        }
+
+    // On success, response (HyperwalletPageList<HyperwalletReceipt>? in this case) will contain information about or nil if not exist.
+    if let receipts = result?.data {
+        for receipt in receipts {
+            print(receipt.destinationToken ?? "")
+        }
+    }
+}
+
+

List Transfer Methods

+
let transferMethodQueryParam = HyperwalletTransferMethodQueryParam()
+transferMethodQueryParam.sortBy = HyperwalletTransferMethodQueryParam.QuerySortable.ascendantCreatedOn.rawValue
+
+Hyperwallet.shared.listTransferMethods(queryParam: transferMethodQueryParam) { (result, error) in
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure
+    guard error == nil else {
+        print(error?.getHyperwalletErrors()?.errorList?)
+        return
+    }
+
+    // On success, response (HyperwalletPageList<HyperwalletTransferMethod>? in this case) will contain information about or nil if not exist.
+    if let transferMethods = result?.data {
+        for transferMethod in transferMethods {
+            print(transferMethod.token ?? "")
+        }
+    }
+}
+
+

Create Transfer

+
let transfer = HyperwalletTransfer.Builder(clientTransferId: "6712348070812",
+                                           sourceToken: "source-token",
+                                           destinationToken: "destination-token")
+    .sourceAmount("100")
+    .sourceCurrency("CAD")
+    .destinationAmount("62.29")
+    .destinationCurrency("USD")
+    .memo("TransferClientId56387")
+    .notes("Partial-Balance Transfer")
+    .build()
+
+Hyperwallet.shared.createTransfer(transfer: transfer, completion: { (result, error) in
+    //Code to handle successful response or error
+    //On successfull creation, response (HyperwalletTransfer in this case) will contain information about the transfer
+    //in case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure of transfer creation
+})
+
+

Schedule Transfer

+
Hyperwallet.shared.scheduleTransfer(transferToken: "trf-123456", completion: { (result, error) in
+    //Code to handle successful response or error
+    // On successful scheduling, response (HyperwalletStatusTransition in this case) will contain information about the status transition
+    //in case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure of transfer creation
+})
+
+

Get Transfer

+
Hyperwallet.shared.getTransfer(transferToken: "trf-123456", completion: { (result, error) in
+    // On success, response (HyperwalletTransfer? in this case) will contain information about the transfer or nil if not exist.
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure
+})
+
+

List Transfers

+
Hyperwallet.shared.listTransfers { (result, error) in
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure
+    guard error == nil else {
+        print(error?.getHyperwalletErrors()?.errorList?)
+        return
+    }
+
+    // On success, response (HyperwalletPageList<HyperwalletTransfer>? in this case) will contain information about or nil if not exist.
+    if let transfers = result?.data {
+        for transfer in transfers {
+            print(transfer.token ?? "")
+        }
+    }
+})
+
+

List User Balances

+
let balanceQueryParam = HyperwalletBalanceQueryParam()
+balanceQueryParam.currency = "USD"
+balanceQueryParam.sortBy = HyperwalletBalanceQueryParam.QuerySortable.descendantAmount.rawValue
+
+Hyperwallet.shared.listUserBalances(queryParam: balanceQueryParam) { (result, error) in
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure
+    guard error == nil else {
+    print(error?.getHyperwalletErrors()?.errorList?)
+    return
+    }
+
+    // On success, response (HyperwalletPageList<HyperwalletBalance>? in this case) will contain information about or nil if not exist.
+    if let balances = result?.data {
+        for balance in balances {
+            print(balance.amount ?? "")
+        }
+    }
+}
+
+

List Prepaid Card Balances

+
let prepaidCardBalanceQueryParam = HyperwalletPrepaidCardBalanceQueryParam()
+prepaidCardBalanceQueryParam.sortBy = HyperwalletPrepaidCardBalanceQueryParam.QuerySortable.descendantAmount.rawValue
+
+Hyperwallet.shared.listPrepaidCardBalances(prepaidCardToken: "trm-1234", queryParam: prepaidCardBalanceQueryParam) { (result, error) in
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure
+    guard error == nil else {
+    print(error?.getHyperwalletErrors()?.errorList?)
+    return
+    }
+
+    // On success, response (HyperwalletPageList<HyperwalletBalance>? in this case) will contain information about or nil if not exist.
+    if let balances = result?.data {
+        for balance in balances {
+            print(balance.amount ?? "")
+        }
+    }
+}
+
+

Transfer Method Configurations

+

Get countries, currencies

+
let keysQuery = HyperwalletTransferMethodConfigurationKeysQuery()
+
+Hyperwallet.shared.retrieveTransferMethodConfigurationKeys(request: keysQuery) { (result, error) in
+
+    guard error == nil else {
+        print(error?.getHyperwalletErrors()?.errorList?)
+        return
+    }
+
+    guard let result = result else { return }
+    // Get countries
+    let countries = result.countries()
+
+    // Get currencies based on the first available country code
+    var currencies: [HyperwalletCurrency]?
+    if let countries = result.countries(), !countries.isEmpty {
+        currencies = result.currencies(from: countries.first!.code)
+    }
+
+    print(countries)
+    print(currencies)
+}
+
+

Get transfer method types, fees and processing times for Country and Currency

+
let country = "CA"
+let currency = "CAD"
+let keysQuery = HyperwalletTransferMethodTypesFeesAndProcessingTimesQuery(country: country, currency: currency)
+
+Hyperwallet
+    .shared
+    .retrieveTransferMethodTypesFeesAndProcessingTimes(request: keysQuery) { (result, error) in
+    guard error == nil else {
+        print(error?.getHyperwalletErrors()?.errorList?)
+        return
+    }
+
+    guard let result = result else { return }
+
+    // Get transfer method types based on the first country code and its first currency code
+    transferMethodTypes = result.transferMethodTypes(countryCode: country, currencyCode: currency)
+    print(transferMethodTypes)
+    print(transferMethodTypes?.first?.fees)
+    print(transferMethodTypes?.first?.processingTimes)
+}
+
+

Get fields for a transfer method type

+
let fieldQuery = HyperwalletTransferMethodConfigurationFieldQuery(country: "CA",
+                                                                  currency: "USD",
+                                                                  transferMethodType: "BANK_ACCOUNT",
+                                                                  profile: "INDIVIDUAL")
+
+Hyperwallet.shared.retrieveTransferMethodConfigurationFields(request: fieldQuery) { (result, error) in
+
+    guard error == nil else {
+        print(error?.getHyperwalletErrors()?.errorList?)
+        return
+    }
+
+    guard let result = result else { return }
+
+    print(result.transferMethodType()))
+    print(result.fieldGroups()?.fields))
+}
+
+

Get fields for updating transfer method

+
let fieldQuery = HyperwalletTransferMethodUpdateConfigurationFieldQuery(transferMethodToken: "trm-0000001")
+
+Hyperwallet.shared.retrieveTransferMethodUpdateConfigurationFields(request: fieldQuery) { (result, error) in
+    guard error == nil else {
+        print(error?.getHyperwalletErrors()?.errorList)
+        return
+    }
+
+    guard let result = result else { return }
+
+    print(result.transferMethodUpdateConfiguration()?.fieldGroups?.nodes)
+    print(result.transferMethodUpdateConfiguration()?.transferMethodType)
+}
+
+

License

+ +

The Hyperwallet iOS SDK is open source and available under the MIT license

+ +
+
+ + +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/js/jazzy.js b/js/jazzy.js new file mode 100755 index 00000000..19844166 --- /dev/null +++ b/js/jazzy.js @@ -0,0 +1,74 @@ +// Jazzy - https://github.com/realm/jazzy +// Copyright Realm Inc. +// SPDX-License-Identifier: MIT + +window.jazzy = {'docset': false} +if (typeof window.dash != 'undefined') { + document.documentElement.className += ' dash' + window.jazzy.docset = true +} +if (navigator.userAgent.match(/xcode/i)) { + document.documentElement.className += ' xcode' + window.jazzy.docset = true +} + +function toggleItem($link, $content) { + var animationDuration = 300; + $link.toggleClass('token-open'); + $content.slideToggle(animationDuration); +} + +function itemLinkToContent($link) { + return $link.parent().parent().next(); +} + +// On doc load + hash-change, open any targetted item +function openCurrentItemIfClosed() { + if (window.jazzy.docset) { + return; + } + var $link = $(`a[name="${location.hash.substring(1)}"]`).nextAll('.token'); + $content = itemLinkToContent($link); + if ($content.is(':hidden')) { + toggleItem($link, $content); + } +} + +$(openCurrentItemIfClosed); +$(window).on('hashchange', openCurrentItemIfClosed); + +// On item link ('token') click, toggle its discussion +$('.token').on('click', function(event) { + if (window.jazzy.docset) { + return; + } + var $link = $(this); + toggleItem($link, itemLinkToContent($link)); + + // Keeps the document from jumping to the hash. + var href = $link.attr('href'); + if (history.pushState) { + history.pushState({}, '', href); + } else { + location.hash = href; + } + event.preventDefault(); +}); + +// Clicks on links to the current, closed, item need to open the item +$("a:not('.token')").on('click', function() { + if (location == this.href) { + openCurrentItemIfClosed(); + } +}); + +// KaTeX rendering +if ("katex" in window) { + $($('.math').each( (_, element) => { + katex.render(element.textContent, element, { + displayMode: $(element).hasClass('m-block'), + throwOnError: false, + trust: true + }); + })) +} diff --git a/js/jazzy.search.js b/js/jazzy.search.js new file mode 100644 index 00000000..359cdbb8 --- /dev/null +++ b/js/jazzy.search.js @@ -0,0 +1,74 @@ +// Jazzy - https://github.com/realm/jazzy +// Copyright Realm Inc. +// SPDX-License-Identifier: MIT + +$(function(){ + var $typeahead = $('[data-typeahead]'); + var $form = $typeahead.parents('form'); + var searchURL = $form.attr('action'); + + function displayTemplate(result) { + return result.name; + } + + function suggestionTemplate(result) { + var t = '
'; + t += '' + result.name + ''; + if (result.parent_name) { + t += '' + result.parent_name + ''; + } + t += '
'; + return t; + } + + $typeahead.one('focus', function() { + $form.addClass('loading'); + + $.getJSON(searchURL).then(function(searchData) { + const searchIndex = lunr(function() { + this.ref('url'); + this.field('name'); + this.field('abstract'); + for (const [url, doc] of Object.entries(searchData)) { + this.add({url: url, name: doc.name, abstract: doc.abstract}); + } + }); + + $typeahead.typeahead( + { + highlight: true, + minLength: 3, + autoselect: true + }, + { + limit: 10, + display: displayTemplate, + templates: { suggestion: suggestionTemplate }, + source: function(query, sync) { + const lcSearch = query.toLowerCase(); + const results = searchIndex.query(function(q) { + q.term(lcSearch, { boost: 100 }); + q.term(lcSearch, { + boost: 10, + wildcard: lunr.Query.wildcard.TRAILING + }); + }).map(function(result) { + var doc = searchData[result.ref]; + doc.url = result.ref; + return doc; + }); + sync(results); + } + } + ); + $form.removeClass('loading'); + $typeahead.trigger('focus'); + }); + }); + + var baseURL = searchURL.slice(0, -"search.json".length); + + $typeahead.on('typeahead:select', function(e, result) { + window.location = baseURL + result.url; + }); +}); diff --git a/js/jquery.min.js b/js/jquery.min.js new file mode 100644 index 00000000..7f37b5d9 --- /dev/null +++ b/js/jquery.min.js @@ -0,0 +1,2 @@ +/*! jQuery v3.7.1 | (c) OpenJS Foundation and other contributors | jquery.org/license */ +!function(e,t){"use strict";"object"==typeof module&&"object"==typeof module.exports?module.exports=e.document?t(e,!0):function(e){if(!e.document)throw new Error("jQuery requires a window with a document");return t(e)}:t(e)}("undefined"!=typeof window?window:this,function(ie,e){"use strict";var oe=[],r=Object.getPrototypeOf,ae=oe.slice,g=oe.flat?function(e){return oe.flat.call(e)}:function(e){return oe.concat.apply([],e)},s=oe.push,se=oe.indexOf,n={},i=n.toString,ue=n.hasOwnProperty,o=ue.toString,a=o.call(Object),le={},v=function(e){return"function"==typeof e&&"number"!=typeof e.nodeType&&"function"!=typeof e.item},y=function(e){return null!=e&&e===e.window},C=ie.document,u={type:!0,src:!0,nonce:!0,noModule:!0};function m(e,t,n){var r,i,o=(n=n||C).createElement("script");if(o.text=e,t)for(r in u)(i=t[r]||t.getAttribute&&t.getAttribute(r))&&o.setAttribute(r,i);n.head.appendChild(o).parentNode.removeChild(o)}function x(e){return null==e?e+"":"object"==typeof e||"function"==typeof e?n[i.call(e)]||"object":typeof e}var t="3.7.1",l=/HTML$/i,ce=function(e,t){return new ce.fn.init(e,t)};function c(e){var t=!!e&&"length"in e&&e.length,n=x(e);return!v(e)&&!y(e)&&("array"===n||0===t||"number"==typeof t&&0+~]|"+ge+")"+ge+"*"),x=new RegExp(ge+"|>"),j=new RegExp(g),A=new RegExp("^"+t+"$"),D={ID:new RegExp("^#("+t+")"),CLASS:new RegExp("^\\.("+t+")"),TAG:new RegExp("^("+t+"|[*])"),ATTR:new RegExp("^"+p),PSEUDO:new RegExp("^"+g),CHILD:new RegExp("^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\("+ge+"*(even|odd|(([+-]|)(\\d*)n|)"+ge+"*(?:([+-]|)"+ge+"*(\\d+)|))"+ge+"*\\)|)","i"),bool:new RegExp("^(?:"+f+")$","i"),needsContext:new RegExp("^"+ge+"*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\("+ge+"*((?:-\\d)?\\d*)"+ge+"*\\)|)(?=[^-]|$)","i")},N=/^(?:input|select|textarea|button)$/i,q=/^h\d$/i,L=/^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/,H=/[+~]/,O=new RegExp("\\\\[\\da-fA-F]{1,6}"+ge+"?|\\\\([^\\r\\n\\f])","g"),P=function(e,t){var n="0x"+e.slice(1)-65536;return t||(n<0?String.fromCharCode(n+65536):String.fromCharCode(n>>10|55296,1023&n|56320))},M=function(){V()},R=J(function(e){return!0===e.disabled&&fe(e,"fieldset")},{dir:"parentNode",next:"legend"});try{k.apply(oe=ae.call(ye.childNodes),ye.childNodes),oe[ye.childNodes.length].nodeType}catch(e){k={apply:function(e,t){me.apply(e,ae.call(t))},call:function(e){me.apply(e,ae.call(arguments,1))}}}function I(t,e,n,r){var i,o,a,s,u,l,c,f=e&&e.ownerDocument,p=e?e.nodeType:9;if(n=n||[],"string"!=typeof t||!t||1!==p&&9!==p&&11!==p)return n;if(!r&&(V(e),e=e||T,C)){if(11!==p&&(u=L.exec(t)))if(i=u[1]){if(9===p){if(!(a=e.getElementById(i)))return n;if(a.id===i)return k.call(n,a),n}else if(f&&(a=f.getElementById(i))&&I.contains(e,a)&&a.id===i)return k.call(n,a),n}else{if(u[2])return k.apply(n,e.getElementsByTagName(t)),n;if((i=u[3])&&e.getElementsByClassName)return k.apply(n,e.getElementsByClassName(i)),n}if(!(h[t+" "]||d&&d.test(t))){if(c=t,f=e,1===p&&(x.test(t)||m.test(t))){(f=H.test(t)&&U(e.parentNode)||e)==e&&le.scope||((s=e.getAttribute("id"))?s=ce.escapeSelector(s):e.setAttribute("id",s=S)),o=(l=Y(t)).length;while(o--)l[o]=(s?"#"+s:":scope")+" "+Q(l[o]);c=l.join(",")}try{return k.apply(n,f.querySelectorAll(c)),n}catch(e){h(t,!0)}finally{s===S&&e.removeAttribute("id")}}}return re(t.replace(ve,"$1"),e,n,r)}function W(){var r=[];return function e(t,n){return r.push(t+" ")>b.cacheLength&&delete e[r.shift()],e[t+" "]=n}}function F(e){return e[S]=!0,e}function $(e){var t=T.createElement("fieldset");try{return!!e(t)}catch(e){return!1}finally{t.parentNode&&t.parentNode.removeChild(t),t=null}}function B(t){return function(e){return fe(e,"input")&&e.type===t}}function _(t){return function(e){return(fe(e,"input")||fe(e,"button"))&&e.type===t}}function z(t){return function(e){return"form"in e?e.parentNode&&!1===e.disabled?"label"in e?"label"in e.parentNode?e.parentNode.disabled===t:e.disabled===t:e.isDisabled===t||e.isDisabled!==!t&&R(e)===t:e.disabled===t:"label"in e&&e.disabled===t}}function X(a){return F(function(o){return o=+o,F(function(e,t){var n,r=a([],e.length,o),i=r.length;while(i--)e[n=r[i]]&&(e[n]=!(t[n]=e[n]))})})}function U(e){return e&&"undefined"!=typeof e.getElementsByTagName&&e}function V(e){var t,n=e?e.ownerDocument||e:ye;return n!=T&&9===n.nodeType&&n.documentElement&&(r=(T=n).documentElement,C=!ce.isXMLDoc(T),i=r.matches||r.webkitMatchesSelector||r.msMatchesSelector,r.msMatchesSelector&&ye!=T&&(t=T.defaultView)&&t.top!==t&&t.addEventListener("unload",M),le.getById=$(function(e){return r.appendChild(e).id=ce.expando,!T.getElementsByName||!T.getElementsByName(ce.expando).length}),le.disconnectedMatch=$(function(e){return i.call(e,"*")}),le.scope=$(function(){return T.querySelectorAll(":scope")}),le.cssHas=$(function(){try{return T.querySelector(":has(*,:jqfake)"),!1}catch(e){return!0}}),le.getById?(b.filter.ID=function(e){var t=e.replace(O,P);return function(e){return e.getAttribute("id")===t}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&C){var n=t.getElementById(e);return n?[n]:[]}}):(b.filter.ID=function(e){var n=e.replace(O,P);return function(e){var t="undefined"!=typeof e.getAttributeNode&&e.getAttributeNode("id");return t&&t.value===n}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&C){var n,r,i,o=t.getElementById(e);if(o){if((n=o.getAttributeNode("id"))&&n.value===e)return[o];i=t.getElementsByName(e),r=0;while(o=i[r++])if((n=o.getAttributeNode("id"))&&n.value===e)return[o]}return[]}}),b.find.TAG=function(e,t){return"undefined"!=typeof t.getElementsByTagName?t.getElementsByTagName(e):t.querySelectorAll(e)},b.find.CLASS=function(e,t){if("undefined"!=typeof t.getElementsByClassName&&C)return t.getElementsByClassName(e)},d=[],$(function(e){var t;r.appendChild(e).innerHTML="",e.querySelectorAll("[selected]").length||d.push("\\["+ge+"*(?:value|"+f+")"),e.querySelectorAll("[id~="+S+"-]").length||d.push("~="),e.querySelectorAll("a#"+S+"+*").length||d.push(".#.+[+~]"),e.querySelectorAll(":checked").length||d.push(":checked"),(t=T.createElement("input")).setAttribute("type","hidden"),e.appendChild(t).setAttribute("name","D"),r.appendChild(e).disabled=!0,2!==e.querySelectorAll(":disabled").length&&d.push(":enabled",":disabled"),(t=T.createElement("input")).setAttribute("name",""),e.appendChild(t),e.querySelectorAll("[name='']").length||d.push("\\["+ge+"*name"+ge+"*="+ge+"*(?:''|\"\")")}),le.cssHas||d.push(":has"),d=d.length&&new RegExp(d.join("|")),l=function(e,t){if(e===t)return a=!0,0;var n=!e.compareDocumentPosition-!t.compareDocumentPosition;return n||(1&(n=(e.ownerDocument||e)==(t.ownerDocument||t)?e.compareDocumentPosition(t):1)||!le.sortDetached&&t.compareDocumentPosition(e)===n?e===T||e.ownerDocument==ye&&I.contains(ye,e)?-1:t===T||t.ownerDocument==ye&&I.contains(ye,t)?1:o?se.call(o,e)-se.call(o,t):0:4&n?-1:1)}),T}for(e in I.matches=function(e,t){return I(e,null,null,t)},I.matchesSelector=function(e,t){if(V(e),C&&!h[t+" "]&&(!d||!d.test(t)))try{var n=i.call(e,t);if(n||le.disconnectedMatch||e.document&&11!==e.document.nodeType)return n}catch(e){h(t,!0)}return 0":{dir:"parentNode",first:!0}," ":{dir:"parentNode"},"+":{dir:"previousSibling",first:!0},"~":{dir:"previousSibling"}},preFilter:{ATTR:function(e){return e[1]=e[1].replace(O,P),e[3]=(e[3]||e[4]||e[5]||"").replace(O,P),"~="===e[2]&&(e[3]=" "+e[3]+" "),e.slice(0,4)},CHILD:function(e){return e[1]=e[1].toLowerCase(),"nth"===e[1].slice(0,3)?(e[3]||I.error(e[0]),e[4]=+(e[4]?e[5]+(e[6]||1):2*("even"===e[3]||"odd"===e[3])),e[5]=+(e[7]+e[8]||"odd"===e[3])):e[3]&&I.error(e[0]),e},PSEUDO:function(e){var t,n=!e[6]&&e[2];return D.CHILD.test(e[0])?null:(e[3]?e[2]=e[4]||e[5]||"":n&&j.test(n)&&(t=Y(n,!0))&&(t=n.indexOf(")",n.length-t)-n.length)&&(e[0]=e[0].slice(0,t),e[2]=n.slice(0,t)),e.slice(0,3))}},filter:{TAG:function(e){var t=e.replace(O,P).toLowerCase();return"*"===e?function(){return!0}:function(e){return fe(e,t)}},CLASS:function(e){var t=s[e+" "];return t||(t=new RegExp("(^|"+ge+")"+e+"("+ge+"|$)"))&&s(e,function(e){return t.test("string"==typeof e.className&&e.className||"undefined"!=typeof e.getAttribute&&e.getAttribute("class")||"")})},ATTR:function(n,r,i){return function(e){var t=I.attr(e,n);return null==t?"!="===r:!r||(t+="","="===r?t===i:"!="===r?t!==i:"^="===r?i&&0===t.indexOf(i):"*="===r?i&&-1:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i;function T(e,n,r){return v(n)?ce.grep(e,function(e,t){return!!n.call(e,t,e)!==r}):n.nodeType?ce.grep(e,function(e){return e===n!==r}):"string"!=typeof n?ce.grep(e,function(e){return-1)[^>]*|#([\w-]+))$/;(ce.fn.init=function(e,t,n){var r,i;if(!e)return this;if(n=n||k,"string"==typeof e){if(!(r="<"===e[0]&&">"===e[e.length-1]&&3<=e.length?[null,e,null]:S.exec(e))||!r[1]&&t)return!t||t.jquery?(t||n).find(e):this.constructor(t).find(e);if(r[1]){if(t=t instanceof ce?t[0]:t,ce.merge(this,ce.parseHTML(r[1],t&&t.nodeType?t.ownerDocument||t:C,!0)),w.test(r[1])&&ce.isPlainObject(t))for(r in t)v(this[r])?this[r](t[r]):this.attr(r,t[r]);return this}return(i=C.getElementById(r[2]))&&(this[0]=i,this.length=1),this}return e.nodeType?(this[0]=e,this.length=1,this):v(e)?void 0!==n.ready?n.ready(e):e(ce):ce.makeArray(e,this)}).prototype=ce.fn,k=ce(C);var E=/^(?:parents|prev(?:Until|All))/,j={children:!0,contents:!0,next:!0,prev:!0};function A(e,t){while((e=e[t])&&1!==e.nodeType);return e}ce.fn.extend({has:function(e){var t=ce(e,this),n=t.length;return this.filter(function(){for(var e=0;e\x20\t\r\n\f]*)/i,Ce=/^$|^module$|\/(?:java|ecma)script/i;xe=C.createDocumentFragment().appendChild(C.createElement("div")),(be=C.createElement("input")).setAttribute("type","radio"),be.setAttribute("checked","checked"),be.setAttribute("name","t"),xe.appendChild(be),le.checkClone=xe.cloneNode(!0).cloneNode(!0).lastChild.checked,xe.innerHTML="",le.noCloneChecked=!!xe.cloneNode(!0).lastChild.defaultValue,xe.innerHTML="",le.option=!!xe.lastChild;var ke={thead:[1,"","
"],col:[2,"","
"],tr:[2,"","
"],td:[3,"","
"],_default:[0,"",""]};function Se(e,t){var n;return n="undefined"!=typeof e.getElementsByTagName?e.getElementsByTagName(t||"*"):"undefined"!=typeof e.querySelectorAll?e.querySelectorAll(t||"*"):[],void 0===t||t&&fe(e,t)?ce.merge([e],n):n}function Ee(e,t){for(var n=0,r=e.length;n",""]);var je=/<|&#?\w+;/;function Ae(e,t,n,r,i){for(var o,a,s,u,l,c,f=t.createDocumentFragment(),p=[],d=0,h=e.length;d\s*$/g;function Re(e,t){return fe(e,"table")&&fe(11!==t.nodeType?t:t.firstChild,"tr")&&ce(e).children("tbody")[0]||e}function Ie(e){return e.type=(null!==e.getAttribute("type"))+"/"+e.type,e}function We(e){return"true/"===(e.type||"").slice(0,5)?e.type=e.type.slice(5):e.removeAttribute("type"),e}function Fe(e,t){var n,r,i,o,a,s;if(1===t.nodeType){if(_.hasData(e)&&(s=_.get(e).events))for(i in _.remove(t,"handle events"),s)for(n=0,r=s[i].length;n").attr(n.scriptAttrs||{}).prop({charset:n.scriptCharset,src:n.url}).on("load error",i=function(e){r.remove(),i=null,e&&t("error"===e.type?404:200,e.type)}),C.head.appendChild(r[0])},abort:function(){i&&i()}}});var Jt,Kt=[],Zt=/(=)\?(?=&|$)|\?\?/;ce.ajaxSetup({jsonp:"callback",jsonpCallback:function(){var e=Kt.pop()||ce.expando+"_"+jt.guid++;return this[e]=!0,e}}),ce.ajaxPrefilter("json jsonp",function(e,t,n){var r,i,o,a=!1!==e.jsonp&&(Zt.test(e.url)?"url":"string"==typeof e.data&&0===(e.contentType||"").indexOf("application/x-www-form-urlencoded")&&Zt.test(e.data)&&"data");if(a||"jsonp"===e.dataTypes[0])return r=e.jsonpCallback=v(e.jsonpCallback)?e.jsonpCallback():e.jsonpCallback,a?e[a]=e[a].replace(Zt,"$1"+r):!1!==e.jsonp&&(e.url+=(At.test(e.url)?"&":"?")+e.jsonp+"="+r),e.converters["script json"]=function(){return o||ce.error(r+" was not called"),o[0]},e.dataTypes[0]="json",i=ie[r],ie[r]=function(){o=arguments},n.always(function(){void 0===i?ce(ie).removeProp(r):ie[r]=i,e[r]&&(e.jsonpCallback=t.jsonpCallback,Kt.push(r)),o&&v(i)&&i(o[0]),o=i=void 0}),"script"}),le.createHTMLDocument=((Jt=C.implementation.createHTMLDocument("").body).innerHTML="
",2===Jt.childNodes.length),ce.parseHTML=function(e,t,n){return"string"!=typeof e?[]:("boolean"==typeof t&&(n=t,t=!1),t||(le.createHTMLDocument?((r=(t=C.implementation.createHTMLDocument("")).createElement("base")).href=C.location.href,t.head.appendChild(r)):t=C),o=!n&&[],(i=w.exec(e))?[t.createElement(i[1])]:(i=Ae([e],t,o),o&&o.length&&ce(o).remove(),ce.merge([],i.childNodes)));var r,i,o},ce.fn.load=function(e,t,n){var r,i,o,a=this,s=e.indexOf(" ");return-1").append(ce.parseHTML(e)).find(r):e)}).always(n&&function(e,t){a.each(function(){n.apply(this,o||[e.responseText,t,e])})}),this},ce.expr.pseudos.animated=function(t){return ce.grep(ce.timers,function(e){return t===e.elem}).length},ce.offset={setOffset:function(e,t,n){var r,i,o,a,s,u,l=ce.css(e,"position"),c=ce(e),f={};"static"===l&&(e.style.position="relative"),s=c.offset(),o=ce.css(e,"top"),u=ce.css(e,"left"),("absolute"===l||"fixed"===l)&&-1<(o+u).indexOf("auto")?(a=(r=c.position()).top,i=r.left):(a=parseFloat(o)||0,i=parseFloat(u)||0),v(t)&&(t=t.call(e,n,ce.extend({},s))),null!=t.top&&(f.top=t.top-s.top+a),null!=t.left&&(f.left=t.left-s.left+i),"using"in t?t.using.call(e,f):c.css(f)}},ce.fn.extend({offset:function(t){if(arguments.length)return void 0===t?this:this.each(function(e){ce.offset.setOffset(this,t,e)});var e,n,r=this[0];return r?r.getClientRects().length?(e=r.getBoundingClientRect(),n=r.ownerDocument.defaultView,{top:e.top+n.pageYOffset,left:e.left+n.pageXOffset}):{top:0,left:0}:void 0},position:function(){if(this[0]){var e,t,n,r=this[0],i={top:0,left:0};if("fixed"===ce.css(r,"position"))t=r.getBoundingClientRect();else{t=this.offset(),n=r.ownerDocument,e=r.offsetParent||n.documentElement;while(e&&(e===n.body||e===n.documentElement)&&"static"===ce.css(e,"position"))e=e.parentNode;e&&e!==r&&1===e.nodeType&&((i=ce(e).offset()).top+=ce.css(e,"borderTopWidth",!0),i.left+=ce.css(e,"borderLeftWidth",!0))}return{top:t.top-i.top-ce.css(r,"marginTop",!0),left:t.left-i.left-ce.css(r,"marginLeft",!0)}}},offsetParent:function(){return this.map(function(){var e=this.offsetParent;while(e&&"static"===ce.css(e,"position"))e=e.offsetParent;return e||J})}}),ce.each({scrollLeft:"pageXOffset",scrollTop:"pageYOffset"},function(t,i){var o="pageYOffset"===i;ce.fn[t]=function(e){return M(this,function(e,t,n){var r;if(y(e)?r=e:9===e.nodeType&&(r=e.defaultView),void 0===n)return r?r[i]:e[t];r?r.scrollTo(o?r.pageXOffset:n,o?n:r.pageYOffset):e[t]=n},t,e,arguments.length)}}),ce.each(["top","left"],function(e,n){ce.cssHooks[n]=Ye(le.pixelPosition,function(e,t){if(t)return t=Ge(e,n),_e.test(t)?ce(e).position()[n]+"px":t})}),ce.each({Height:"height",Width:"width"},function(a,s){ce.each({padding:"inner"+a,content:s,"":"outer"+a},function(r,o){ce.fn[o]=function(e,t){var n=arguments.length&&(r||"boolean"!=typeof e),i=r||(!0===e||!0===t?"margin":"border");return M(this,function(e,t,n){var r;return y(e)?0===o.indexOf("outer")?e["inner"+a]:e.document.documentElement["client"+a]:9===e.nodeType?(r=e.documentElement,Math.max(e.body["scroll"+a],r["scroll"+a],e.body["offset"+a],r["offset"+a],r["client"+a])):void 0===n?ce.css(e,t,i):ce.style(e,t,n,i)},s,n?e:void 0,n)}})}),ce.each(["ajaxStart","ajaxStop","ajaxComplete","ajaxError","ajaxSuccess","ajaxSend"],function(e,t){ce.fn[t]=function(e){return this.on(t,e)}}),ce.fn.extend({bind:function(e,t,n){return this.on(e,null,t,n)},unbind:function(e,t){return this.off(e,null,t)},delegate:function(e,t,n,r){return this.on(t,e,n,r)},undelegate:function(e,t,n){return 1===arguments.length?this.off(e,"**"):this.off(t,e||"**",n)},hover:function(e,t){return this.on("mouseenter",e).on("mouseleave",t||e)}}),ce.each("blur focus focusin focusout resize scroll click dblclick mousedown mouseup mousemove mouseover mouseout mouseenter mouseleave change select submit keydown keypress keyup contextmenu".split(" "),function(e,n){ce.fn[n]=function(e,t){return 00){var c=e.utils.clone(r)||{};c.position=[a,l],c.index=s.length,s.push(new e.Token(i.slice(a,o),c))}a=o+1}}return s},e.tokenizer.separator=/[\s\-]+/,e.Pipeline=function(){this._stack=[]},e.Pipeline.registeredFunctions=Object.create(null),e.Pipeline.registerFunction=function(t,r){r in this.registeredFunctions&&e.utils.warn("Overwriting existing registered function: "+r),t.label=r,e.Pipeline.registeredFunctions[t.label]=t},e.Pipeline.warnIfFunctionNotRegistered=function(t){var r=t.label&&t.label in this.registeredFunctions;r||e.utils.warn("Function is not registered with pipeline. This may cause problems when serialising the index.\n",t)},e.Pipeline.load=function(t){var r=new e.Pipeline;return t.forEach(function(t){var i=e.Pipeline.registeredFunctions[t];if(!i)throw new Error("Cannot load unregistered function: "+t);r.add(i)}),r},e.Pipeline.prototype.add=function(){var t=Array.prototype.slice.call(arguments);t.forEach(function(t){e.Pipeline.warnIfFunctionNotRegistered(t),this._stack.push(t)},this)},e.Pipeline.prototype.after=function(t,r){e.Pipeline.warnIfFunctionNotRegistered(r);var i=this._stack.indexOf(t);if(i==-1)throw new Error("Cannot find existingFn");i+=1,this._stack.splice(i,0,r)},e.Pipeline.prototype.before=function(t,r){e.Pipeline.warnIfFunctionNotRegistered(r);var i=this._stack.indexOf(t);if(i==-1)throw new Error("Cannot find existingFn");this._stack.splice(i,0,r)},e.Pipeline.prototype.remove=function(e){var t=this._stack.indexOf(e);t!=-1&&this._stack.splice(t,1)},e.Pipeline.prototype.run=function(e){for(var t=this._stack.length,r=0;r1&&(se&&(r=n),s!=e);)i=r-t,n=t+Math.floor(i/2),s=this.elements[2*n];return s==e?2*n:s>e?2*n:sa?l+=2:o==a&&(t+=r[u+1]*i[l+1],u+=2,l+=2);return t},e.Vector.prototype.similarity=function(e){return this.dot(e)/this.magnitude()||0},e.Vector.prototype.toArray=function(){for(var e=new Array(this.elements.length/2),t=1,r=0;t0){var o,a=s.str.charAt(0);a in s.node.edges?o=s.node.edges[a]:(o=new e.TokenSet,s.node.edges[a]=o),1==s.str.length&&(o["final"]=!0),n.push({node:o,editsRemaining:s.editsRemaining,str:s.str.slice(1)})}if(0!=s.editsRemaining){if("*"in s.node.edges)var u=s.node.edges["*"];else{var u=new e.TokenSet;s.node.edges["*"]=u}if(0==s.str.length&&(u["final"]=!0),n.push({node:u,editsRemaining:s.editsRemaining-1,str:s.str}),s.str.length>1&&n.push({node:s.node,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)}),1==s.str.length&&(s.node["final"]=!0),s.str.length>=1){if("*"in s.node.edges)var l=s.node.edges["*"];else{var l=new e.TokenSet;s.node.edges["*"]=l}1==s.str.length&&(l["final"]=!0),n.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var c,h=s.str.charAt(0),d=s.str.charAt(1);d in s.node.edges?c=s.node.edges[d]:(c=new e.TokenSet,s.node.edges[d]=c),1==s.str.length&&(c["final"]=!0),n.push({node:c,editsRemaining:s.editsRemaining-1,str:h+s.str.slice(2)})}}}return i},e.TokenSet.fromString=function(t){for(var r=new e.TokenSet,i=r,n=0,s=t.length;n=e;t--){var r=this.uncheckedNodes[t],i=r.child.toString();i in this.minimizedNodes?r.parent.edges[r["char"]]=this.minimizedNodes[i]:(r.child._str=i,this.minimizedNodes[i]=r.child),this.uncheckedNodes.pop()}},e.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},e.Index.prototype.search=function(t){return this.query(function(r){var i=new e.QueryParser(t,r);i.parse()})},e.Index.prototype.query=function(t){for(var r=new e.Query(this.fields),i=Object.create(null),n=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),u=0;u1?this._b=1:this._b=e},e.Builder.prototype.k1=function(e){this._k1=e},e.Builder.prototype.add=function(t,r){var i=t[this._ref],n=Object.keys(this._fields);this._documents[i]=r||{},this.documentCount+=1;for(var s=0;s=this.length)return e.QueryLexer.EOS;var t=this.str.charAt(this.pos);return this.pos+=1,t},e.QueryLexer.prototype.width=function(){return this.pos-this.start},e.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},e.QueryLexer.prototype.backup=function(){this.pos-=1},e.QueryLexer.prototype.acceptDigitRun=function(){var t,r;do t=this.next(),r=t.charCodeAt(0);while(r>47&&r<58);t!=e.QueryLexer.EOS&&this.backup()},e.QueryLexer.prototype.more=function(){return this.pos1&&(t.backup(),t.emit(e.QueryLexer.TERM)),t.ignore(),t.more())return e.QueryLexer.lexText},e.QueryLexer.lexEditDistance=function(t){return t.ignore(),t.acceptDigitRun(),t.emit(e.QueryLexer.EDIT_DISTANCE),e.QueryLexer.lexText},e.QueryLexer.lexBoost=function(t){return t.ignore(),t.acceptDigitRun(),t.emit(e.QueryLexer.BOOST),e.QueryLexer.lexText},e.QueryLexer.lexEOS=function(t){t.width()>0&&t.emit(e.QueryLexer.TERM)},e.QueryLexer.termSeparator=e.tokenizer.separator,e.QueryLexer.lexText=function(t){for(;;){var r=t.next();if(r==e.QueryLexer.EOS)return e.QueryLexer.lexEOS;if(92!=r.charCodeAt(0)){if(":"==r)return e.QueryLexer.lexField;if("~"==r)return t.backup(),t.width()>0&&t.emit(e.QueryLexer.TERM),e.QueryLexer.lexEditDistance;if("^"==r)return t.backup(),t.width()>0&&t.emit(e.QueryLexer.TERM),e.QueryLexer.lexBoost;if("+"==r&&1===t.width())return t.emit(e.QueryLexer.PRESENCE),e.QueryLexer.lexText;if("-"==r&&1===t.width())return t.emit(e.QueryLexer.PRESENCE),e.QueryLexer.lexText;if(r.match(e.QueryLexer.termSeparator))return e.QueryLexer.lexTerm}else t.escapeCharacter()}},e.QueryParser=function(t,r){this.lexer=new e.QueryLexer(t),this.query=r,this.currentClause={},this.lexemeIdx=0},e.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var t=e.QueryParser.parseClause;t;)t=t(this);return this.query},e.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},e.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},e.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},e.QueryParser.parseClause=function(t){var r=t.peekLexeme();if(void 0!=r)switch(r.type){case e.QueryLexer.PRESENCE:return e.QueryParser.parsePresence;case e.QueryLexer.FIELD:return e.QueryParser.parseField;case e.QueryLexer.TERM:return e.QueryParser.parseTerm;default:var i="expected either a field or a term, found "+r.type;throw r.str.length>=1&&(i+=" with value '"+r.str+"'"),new e.QueryParseError(i,r.start,r.end)}},e.QueryParser.parsePresence=function(t){var r=t.consumeLexeme();if(void 0!=r){switch(r.str){case"-":t.currentClause.presence=e.Query.presence.PROHIBITED;break;case"+":t.currentClause.presence=e.Query.presence.REQUIRED;break;default:var i="unrecognised presence operator'"+r.str+"'";throw new e.QueryParseError(i,r.start,r.end)}var n=t.peekLexeme();if(void 0==n){var i="expecting term or field, found nothing";throw new e.QueryParseError(i,r.start,r.end)}switch(n.type){case e.QueryLexer.FIELD:return e.QueryParser.parseField;case e.QueryLexer.TERM:return e.QueryParser.parseTerm;default:var i="expecting term or field, found '"+n.type+"'";throw new e.QueryParseError(i,n.start,n.end)}}},e.QueryParser.parseField=function(t){var r=t.consumeLexeme();if(void 0!=r){if(t.query.allFields.indexOf(r.str)==-1){var i=t.query.allFields.map(function(e){return"'"+e+"'"}).join(", "),n="unrecognised field '"+r.str+"', possible fields: "+i;throw new e.QueryParseError(n,r.start,r.end)}t.currentClause.fields=[r.str];var s=t.peekLexeme();if(void 0==s){var n="expecting term, found nothing";throw new e.QueryParseError(n,r.start,r.end)}switch(s.type){case e.QueryLexer.TERM:return e.QueryParser.parseTerm;default:var n="expecting term, found '"+s.type+"'";throw new e.QueryParseError(n,s.start,s.end)}}},e.QueryParser.parseTerm=function(t){var r=t.consumeLexeme();if(void 0!=r){t.currentClause.term=r.str.toLowerCase(),r.str.indexOf("*")!=-1&&(t.currentClause.usePipeline=!1);var i=t.peekLexeme();if(void 0==i)return void t.nextClause();switch(i.type){case e.QueryLexer.TERM:return t.nextClause(),e.QueryParser.parseTerm;case e.QueryLexer.FIELD:return t.nextClause(),e.QueryParser.parseField;case e.QueryLexer.EDIT_DISTANCE:return e.QueryParser.parseEditDistance;case e.QueryLexer.BOOST:return e.QueryParser.parseBoost;case e.QueryLexer.PRESENCE:return t.nextClause(),e.QueryParser.parsePresence;default:var n="Unexpected lexeme type '"+i.type+"'";throw new e.QueryParseError(n,i.start,i.end)}}},e.QueryParser.parseEditDistance=function(t){var r=t.consumeLexeme();if(void 0!=r){var i=parseInt(r.str,10);if(isNaN(i)){var n="edit distance must be numeric";throw new e.QueryParseError(n,r.start,r.end)}t.currentClause.editDistance=i;var s=t.peekLexeme();if(void 0==s)return void t.nextClause();switch(s.type){case e.QueryLexer.TERM:return t.nextClause(),e.QueryParser.parseTerm;case e.QueryLexer.FIELD:return t.nextClause(),e.QueryParser.parseField;case e.QueryLexer.EDIT_DISTANCE:return e.QueryParser.parseEditDistance;case e.QueryLexer.BOOST:return e.QueryParser.parseBoost;case e.QueryLexer.PRESENCE:return t.nextClause(),e.QueryParser.parsePresence;default:var n="Unexpected lexeme type '"+s.type+"'";throw new e.QueryParseError(n,s.start,s.end)}}},e.QueryParser.parseBoost=function(t){var r=t.consumeLexeme();if(void 0!=r){var i=parseInt(r.str,10);if(isNaN(i)){var n="boost must be numeric";throw new e.QueryParseError(n,r.start,r.end)}t.currentClause.boost=i;var s=t.peekLexeme();if(void 0==s)return void t.nextClause();switch(s.type){case e.QueryLexer.TERM:return t.nextClause(),e.QueryParser.parseTerm;case e.QueryLexer.FIELD:return t.nextClause(),e.QueryParser.parseField;case e.QueryLexer.EDIT_DISTANCE:return e.QueryParser.parseEditDistance;case e.QueryLexer.BOOST:return e.QueryParser.parseBoost;case e.QueryLexer.PRESENCE:return t.nextClause(),e.QueryParser.parsePresence;default:var n="Unexpected lexeme type '"+s.type+"'";throw new e.QueryParseError(n,s.start,s.end)}}},function(e,t){"function"==typeof define&&define.amd?define(t):"object"==typeof exports?module.exports=t():e.lunr=t()}(this,function(){return e})}(); diff --git a/js/typeahead.jquery.js b/js/typeahead.jquery.js new file mode 100644 index 00000000..3a2d2ab0 --- /dev/null +++ b/js/typeahead.jquery.js @@ -0,0 +1,1694 @@ +/*! + * typeahead.js 1.3.1 + * https://github.com/corejavascript/typeahead.js + * Copyright 2013-2020 Twitter, Inc. and other contributors; Licensed MIT + */ + + +(function(root, factory) { + if (typeof define === "function" && define.amd) { + define([ "jquery" ], function(a0) { + return factory(a0); + }); + } else if (typeof module === "object" && module.exports) { + module.exports = factory(require("jquery")); + } else { + factory(root["jQuery"]); + } +})(this, function($) { + var _ = function() { + "use strict"; + return { + isMsie: function() { + return /(msie|trident)/i.test(navigator.userAgent) ? navigator.userAgent.match(/(msie |rv:)(\d+(.\d+)?)/i)[2] : false; + }, + isBlankString: function(str) { + return !str || /^\s*$/.test(str); + }, + escapeRegExChars: function(str) { + return str.replace(/[\-\[\]\/\{\}\(\)\*\+\?\.\\\^\$\|]/g, "\\$&"); + }, + isString: function(obj) { + return typeof obj === "string"; + }, + isNumber: function(obj) { + return typeof obj === "number"; + }, + isArray: $.isArray, + isFunction: $.isFunction, + isObject: $.isPlainObject, + isUndefined: function(obj) { + return typeof obj === "undefined"; + }, + isElement: function(obj) { + return !!(obj && obj.nodeType === 1); + }, + isJQuery: function(obj) { + return obj instanceof $; + }, + toStr: function toStr(s) { + return _.isUndefined(s) || s === null ? "" : s + ""; + }, + bind: $.proxy, + each: function(collection, cb) { + $.each(collection, reverseArgs); + function reverseArgs(index, value) { + return cb(value, index); + } + }, + map: $.map, + filter: $.grep, + every: function(obj, test) { + var result = true; + if (!obj) { + return result; + } + $.each(obj, function(key, val) { + if (!(result = test.call(null, val, key, obj))) { + return false; + } + }); + return !!result; + }, + some: function(obj, test) { + var result = false; + if (!obj) { + return result; + } + $.each(obj, function(key, val) { + if (result = test.call(null, val, key, obj)) { + return false; + } + }); + return !!result; + }, + mixin: $.extend, + identity: function(x) { + return x; + }, + clone: function(obj) { + return $.extend(true, {}, obj); + }, + getIdGenerator: function() { + var counter = 0; + return function() { + return counter++; + }; + }, + templatify: function templatify(obj) { + return $.isFunction(obj) ? obj : template; + function template() { + return String(obj); + } + }, + defer: function(fn) { + setTimeout(fn, 0); + }, + debounce: function(func, wait, immediate) { + var timeout, result; + return function() { + var context = this, args = arguments, later, callNow; + later = function() { + timeout = null; + if (!immediate) { + result = func.apply(context, args); + } + }; + callNow = immediate && !timeout; + clearTimeout(timeout); + timeout = setTimeout(later, wait); + if (callNow) { + result = func.apply(context, args); + } + return result; + }; + }, + throttle: function(func, wait) { + var context, args, timeout, result, previous, later; + previous = 0; + later = function() { + previous = new Date(); + timeout = null; + result = func.apply(context, args); + }; + return function() { + var now = new Date(), remaining = wait - (now - previous); + context = this; + args = arguments; + if (remaining <= 0) { + clearTimeout(timeout); + timeout = null; + previous = now; + result = func.apply(context, args); + } else if (!timeout) { + timeout = setTimeout(later, remaining); + } + return result; + }; + }, + stringify: function(val) { + return _.isString(val) ? val : JSON.stringify(val); + }, + guid: function() { + function _p8(s) { + var p = (Math.random().toString(16) + "000000000").substr(2, 8); + return s ? "-" + p.substr(0, 4) + "-" + p.substr(4, 4) : p; + } + return "tt-" + _p8() + _p8(true) + _p8(true) + _p8(); + }, + noop: function() {} + }; + }(); + var WWW = function() { + "use strict"; + var defaultClassNames = { + wrapper: "twitter-typeahead", + input: "tt-input", + hint: "tt-hint", + menu: "tt-menu", + dataset: "tt-dataset", + suggestion: "tt-suggestion", + selectable: "tt-selectable", + empty: "tt-empty", + open: "tt-open", + cursor: "tt-cursor", + highlight: "tt-highlight" + }; + return build; + function build(o) { + var www, classes; + classes = _.mixin({}, defaultClassNames, o); + www = { + css: buildCss(), + classes: classes, + html: buildHtml(classes), + selectors: buildSelectors(classes) + }; + return { + css: www.css, + html: www.html, + classes: www.classes, + selectors: www.selectors, + mixin: function(o) { + _.mixin(o, www); + } + }; + } + function buildHtml(c) { + return { + wrapper: '', + menu: '
' + }; + } + function buildSelectors(classes) { + var selectors = {}; + _.each(classes, function(v, k) { + selectors[k] = "." + v; + }); + return selectors; + } + function buildCss() { + var css = { + wrapper: { + position: "relative", + display: "inline-block" + }, + hint: { + position: "absolute", + top: "0", + left: "0", + borderColor: "transparent", + boxShadow: "none", + opacity: "1" + }, + input: { + position: "relative", + verticalAlign: "top", + backgroundColor: "transparent" + }, + inputWithNoHint: { + position: "relative", + verticalAlign: "top" + }, + menu: { + position: "absolute", + top: "100%", + left: "0", + zIndex: "100", + display: "none" + }, + ltr: { + left: "0", + right: "auto" + }, + rtl: { + left: "auto", + right: " 0" + } + }; + if (_.isMsie()) { + _.mixin(css.input, { + backgroundImage: "url(data:image/gif;base64,R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7)" + }); + } + return css; + } + }(); + var EventBus = function() { + "use strict"; + var namespace, deprecationMap; + namespace = "typeahead:"; + deprecationMap = { + render: "rendered", + cursorchange: "cursorchanged", + select: "selected", + autocomplete: "autocompleted" + }; + function EventBus(o) { + if (!o || !o.el) { + $.error("EventBus initialized without el"); + } + this.$el = $(o.el); + } + _.mixin(EventBus.prototype, { + _trigger: function(type, args) { + var $e = $.Event(namespace + type); + this.$el.trigger.call(this.$el, $e, args || []); + return $e; + }, + before: function(type) { + var args, $e; + args = [].slice.call(arguments, 1); + $e = this._trigger("before" + type, args); + return $e.isDefaultPrevented(); + }, + trigger: function(type) { + var deprecatedType; + this._trigger(type, [].slice.call(arguments, 1)); + if (deprecatedType = deprecationMap[type]) { + this._trigger(deprecatedType, [].slice.call(arguments, 1)); + } + } + }); + return EventBus; + }(); + var EventEmitter = function() { + "use strict"; + var splitter = /\s+/, nextTick = getNextTick(); + return { + onSync: onSync, + onAsync: onAsync, + off: off, + trigger: trigger + }; + function on(method, types, cb, context) { + var type; + if (!cb) { + return this; + } + types = types.split(splitter); + cb = context ? bindContext(cb, context) : cb; + this._callbacks = this._callbacks || {}; + while (type = types.shift()) { + this._callbacks[type] = this._callbacks[type] || { + sync: [], + async: [] + }; + this._callbacks[type][method].push(cb); + } + return this; + } + function onAsync(types, cb, context) { + return on.call(this, "async", types, cb, context); + } + function onSync(types, cb, context) { + return on.call(this, "sync", types, cb, context); + } + function off(types) { + var type; + if (!this._callbacks) { + return this; + } + types = types.split(splitter); + while (type = types.shift()) { + delete this._callbacks[type]; + } + return this; + } + function trigger(types) { + var type, callbacks, args, syncFlush, asyncFlush; + if (!this._callbacks) { + return this; + } + types = types.split(splitter); + args = [].slice.call(arguments, 1); + while ((type = types.shift()) && (callbacks = this._callbacks[type])) { + syncFlush = getFlush(callbacks.sync, this, [ type ].concat(args)); + asyncFlush = getFlush(callbacks.async, this, [ type ].concat(args)); + syncFlush() && nextTick(asyncFlush); + } + return this; + } + function getFlush(callbacks, context, args) { + return flush; + function flush() { + var cancelled; + for (var i = 0, len = callbacks.length; !cancelled && i < len; i += 1) { + cancelled = callbacks[i].apply(context, args) === false; + } + return !cancelled; + } + } + function getNextTick() { + var nextTickFn; + if (window.setImmediate) { + nextTickFn = function nextTickSetImmediate(fn) { + setImmediate(function() { + fn(); + }); + }; + } else { + nextTickFn = function nextTickSetTimeout(fn) { + setTimeout(function() { + fn(); + }, 0); + }; + } + return nextTickFn; + } + function bindContext(fn, context) { + return fn.bind ? fn.bind(context) : function() { + fn.apply(context, [].slice.call(arguments, 0)); + }; + } + }(); + var highlight = function(doc) { + "use strict"; + var defaults = { + node: null, + pattern: null, + tagName: "strong", + className: null, + wordsOnly: false, + caseSensitive: false, + diacriticInsensitive: false + }; + var accented = { + A: "[AaªÀ-Åà-åĀ-ąǍǎȀ-ȃȦȧᴬᵃḀḁẚẠ-ảₐ℀℁℻⒜Ⓐⓐ㍱-㍴㎀-㎄㎈㎉㎩-㎯㏂㏊㏟㏿Ａａ]", + B: "[BbᴮᵇḂ-ḇℬ⒝Ⓑⓑ㍴㎅-㎇㏃㏈㏔㏝Ｂｂ]", + C: "[CcÇçĆ-čᶜ℀ℂ℃℅℆ℭⅭⅽ⒞Ⓒⓒ㍶㎈㎉㎝㎠㎤㏄-㏇Ｃｃ]", + D: "[DdĎďDŽ-džDZ-dzᴰᵈḊ-ḓⅅⅆⅮⅾ⒟Ⓓⓓ㋏㍲㍷-㍹㎗㎭-㎯㏅㏈Ｄｄ]", + E: "[EeÈ-Ëè-ëĒ-ěȄ-ȇȨȩᴱᵉḘ-ḛẸ-ẽₑ℡ℯℰⅇ⒠Ⓔⓔ㉐㋍㋎Ｅｅ]", + F: "[FfᶠḞḟ℉ℱ℻⒡Ⓕⓕ㎊-㎌㎙ff-fflＦｆ]", + G: "[GgĜ-ģǦǧǴǵᴳᵍḠḡℊ⒢Ⓖⓖ㋌㋍㎇㎍-㎏㎓㎬㏆㏉㏒㏿Ｇｇ]", + H: "[HhĤĥȞȟʰᴴḢ-ḫẖℋ-ℎ⒣Ⓗⓗ㋌㍱㎐-㎔㏊㏋㏗Ｈｈ]", + I: "[IiÌ-Ïì-ïĨ-İIJijǏǐȈ-ȋᴵᵢḬḭỈ-ịⁱℐℑℹⅈⅠ-ⅣⅥ-ⅨⅪⅫⅰ-ⅳⅵ-ⅸⅺⅻ⒤Ⓘⓘ㍺㏌㏕fiffiＩｉ]", + J: "[JjIJ-ĵLJ-njǰʲᴶⅉ⒥ⒿⓙⱼＪｊ]", + K: "[KkĶķǨǩᴷᵏḰ-ḵK⒦Ⓚⓚ㎄㎅㎉㎏㎑㎘㎞㎢㎦㎪㎸㎾㏀㏆㏍-㏏Ｋｋ]", + L: "[LlĹ-ŀLJ-ljˡᴸḶḷḺ-ḽℒℓ℡Ⅼⅼ⒧Ⓛⓛ㋏㎈㎉㏐-㏓㏕㏖㏿flfflＬｌ]", + M: "[MmᴹᵐḾ-ṃ℠™ℳⅯⅿ⒨Ⓜⓜ㍷-㍹㎃㎆㎎㎒㎖㎙-㎨㎫㎳㎷㎹㎽㎿㏁㏂㏎㏐㏔-㏖㏘㏙㏞㏟Ｍｍ]", + N: "[NnÑñŃ-ʼnNJ-njǸǹᴺṄ-ṋⁿℕ№⒩Ⓝⓝ㎁㎋㎚㎱㎵㎻㏌㏑Ｎｎ]", + O: "[OoºÒ-Öò-öŌ-őƠơǑǒǪǫȌ-ȏȮȯᴼᵒỌ-ỏₒ℅№ℴ⒪Ⓞⓞ㍵㏇㏒㏖Ｏｏ]", + P: "[PpᴾᵖṔ-ṗℙ⒫Ⓟⓟ㉐㍱㍶㎀㎊㎩-㎬㎰㎴㎺㏋㏗-㏚Ｐｐ]", + Q: "[Qqℚ⒬Ⓠⓠ㏃Ｑｑ]", + R: "[RrŔ-řȐ-ȓʳᴿᵣṘ-ṛṞṟ₨ℛ-ℝ⒭Ⓡⓡ㋍㍴㎭-㎯㏚㏛Ｒｒ]", + S: "[SsŚ-šſȘșˢṠ-ṣ₨℁℠⒮Ⓢⓢ㎧㎨㎮-㎳㏛㏜stＳｓ]", + T: "[TtŢ-ťȚțᵀᵗṪ-ṱẗ℡™⒯Ⓣⓣ㉐㋏㎔㏏ſtstＴｔ]", + U: "[UuÙ-Üù-üŨ-ųƯưǓǔȔ-ȗᵁᵘᵤṲ-ṷỤ-ủ℆⒰Ⓤⓤ㍳㍺Ｕｕ]", + V: "[VvᵛᵥṼ-ṿⅣ-Ⅷⅳ-ⅷ⒱Ⓥⓥⱽ㋎㍵㎴-㎹㏜㏞Ｖｖ]", + W: "[WwŴŵʷᵂẀ-ẉẘ⒲Ⓦⓦ㎺-㎿㏝Ｗｗ]", + X: "[XxˣẊ-ẍₓ℻Ⅸ-Ⅻⅸ-ⅻ⒳Ⓧⓧ㏓Ｘｘ]", + Y: "[YyÝýÿŶ-ŸȲȳʸẎẏẙỲ-ỹ⒴Ⓨⓨ㏉Ｙｙ]", + Z: "[ZzŹ-žDZ-dzᶻẐ-ẕℤℨ⒵Ⓩⓩ㎐-㎔Ｚｚ]" + }; + return function hightlight(o) { + var regex; + o = _.mixin({}, defaults, o); + if (!o.node || !o.pattern) { + return; + } + o.pattern = _.isArray(o.pattern) ? o.pattern : [ o.pattern ]; + regex = getRegex(o.pattern, o.caseSensitive, o.wordsOnly, o.diacriticInsensitive); + traverse(o.node, hightlightTextNode); + function hightlightTextNode(textNode) { + var match, patternNode, wrapperNode; + if (match = regex.exec(textNode.data)) { + wrapperNode = doc.createElement(o.tagName); + o.className && (wrapperNode.className = o.className); + patternNode = textNode.splitText(match.index); + patternNode.splitText(match[0].length); + wrapperNode.appendChild(patternNode.cloneNode(true)); + textNode.parentNode.replaceChild(wrapperNode, patternNode); + } + return !!match; + } + function traverse(el, hightlightTextNode) { + var childNode, TEXT_NODE_TYPE = 3; + for (var i = 0; i < el.childNodes.length; i++) { + childNode = el.childNodes[i]; + if (childNode.nodeType === TEXT_NODE_TYPE) { + i += hightlightTextNode(childNode) ? 1 : 0; + } else { + traverse(childNode, hightlightTextNode); + } + } + } + }; + function accent_replacer(chr) { + return accented[chr.toUpperCase()] || chr; + } + function getRegex(patterns, caseSensitive, wordsOnly, diacriticInsensitive) { + var escapedPatterns = [], regexStr; + for (var i = 0, len = patterns.length; i < len; i++) { + var escapedWord = _.escapeRegExChars(patterns[i]); + if (diacriticInsensitive) { + escapedWord = escapedWord.replace(/\S/g, accent_replacer); + } + escapedPatterns.push(escapedWord); + } + regexStr = wordsOnly ? "\\b(" + escapedPatterns.join("|") + ")\\b" : "(" + escapedPatterns.join("|") + ")"; + return caseSensitive ? new RegExp(regexStr) : new RegExp(regexStr, "i"); + } + }(window.document); + var Input = function() { + "use strict"; + var specialKeyCodeMap; + specialKeyCodeMap = { + 9: "tab", + 27: "esc", + 37: "left", + 39: "right", + 13: "enter", + 38: "up", + 40: "down" + }; + function Input(o, www) { + var id; + o = o || {}; + if (!o.input) { + $.error("input is missing"); + } + www.mixin(this); + this.$hint = $(o.hint); + this.$input = $(o.input); + this.$menu = $(o.menu); + id = this.$input.attr("id") || _.guid(); + this.$menu.attr("id", id + "_listbox"); + this.$hint.attr({ + "aria-hidden": true + }); + this.$input.attr({ + "aria-owns": id + "_listbox", + role: "combobox", + "aria-autocomplete": "list", + "aria-expanded": false + }); + this.query = this.$input.val(); + this.queryWhenFocused = this.hasFocus() ? this.query : null; + this.$overflowHelper = buildOverflowHelper(this.$input); + this._checkLanguageDirection(); + if (this.$hint.length === 0) { + this.setHint = this.getHint = this.clearHint = this.clearHintIfInvalid = _.noop; + } + this.onSync("cursorchange", this._updateDescendent); + } + Input.normalizeQuery = function(str) { + return _.toStr(str).replace(/^\s*/g, "").replace(/\s{2,}/g, " "); + }; + _.mixin(Input.prototype, EventEmitter, { + _onBlur: function onBlur() { + this.resetInputValue(); + this.trigger("blurred"); + }, + _onFocus: function onFocus() { + this.queryWhenFocused = this.query; + this.trigger("focused"); + }, + _onKeydown: function onKeydown($e) { + var keyName = specialKeyCodeMap[$e.which || $e.keyCode]; + this._managePreventDefault(keyName, $e); + if (keyName && this._shouldTrigger(keyName, $e)) { + this.trigger(keyName + "Keyed", $e); + } + }, + _onInput: function onInput() { + this._setQuery(this.getInputValue()); + this.clearHintIfInvalid(); + this._checkLanguageDirection(); + }, + _managePreventDefault: function managePreventDefault(keyName, $e) { + var preventDefault; + switch (keyName) { + case "up": + case "down": + preventDefault = !withModifier($e); + break; + + default: + preventDefault = false; + } + preventDefault && $e.preventDefault(); + }, + _shouldTrigger: function shouldTrigger(keyName, $e) { + var trigger; + switch (keyName) { + case "tab": + trigger = !withModifier($e); + break; + + default: + trigger = true; + } + return trigger; + }, + _checkLanguageDirection: function checkLanguageDirection() { + var dir = (this.$input.css("direction") || "ltr").toLowerCase(); + if (this.dir !== dir) { + this.dir = dir; + this.$hint.attr("dir", dir); + this.trigger("langDirChanged", dir); + } + }, + _setQuery: function setQuery(val, silent) { + var areEquivalent, hasDifferentWhitespace; + areEquivalent = areQueriesEquivalent(val, this.query); + hasDifferentWhitespace = areEquivalent ? this.query.length !== val.length : false; + this.query = val; + if (!silent && !areEquivalent) { + this.trigger("queryChanged", this.query); + } else if (!silent && hasDifferentWhitespace) { + this.trigger("whitespaceChanged", this.query); + } + }, + _updateDescendent: function updateDescendent(event, id) { + this.$input.attr("aria-activedescendant", id); + }, + bind: function() { + var that = this, onBlur, onFocus, onKeydown, onInput; + onBlur = _.bind(this._onBlur, this); + onFocus = _.bind(this._onFocus, this); + onKeydown = _.bind(this._onKeydown, this); + onInput = _.bind(this._onInput, this); + this.$input.on("blur.tt", onBlur).on("focus.tt", onFocus).on("keydown.tt", onKeydown); + if (!_.isMsie() || _.isMsie() > 9) { + this.$input.on("input.tt", onInput); + } else { + this.$input.on("keydown.tt keypress.tt cut.tt paste.tt", function($e) { + if (specialKeyCodeMap[$e.which || $e.keyCode]) { + return; + } + _.defer(_.bind(that._onInput, that, $e)); + }); + } + return this; + }, + focus: function focus() { + this.$input.focus(); + }, + blur: function blur() { + this.$input.blur(); + }, + getLangDir: function getLangDir() { + return this.dir; + }, + getQuery: function getQuery() { + return this.query || ""; + }, + setQuery: function setQuery(val, silent) { + this.setInputValue(val); + this._setQuery(val, silent); + }, + hasQueryChangedSinceLastFocus: function hasQueryChangedSinceLastFocus() { + return this.query !== this.queryWhenFocused; + }, + getInputValue: function getInputValue() { + return this.$input.val(); + }, + setInputValue: function setInputValue(value) { + this.$input.val(value); + this.clearHintIfInvalid(); + this._checkLanguageDirection(); + }, + resetInputValue: function resetInputValue() { + this.setInputValue(this.query); + }, + getHint: function getHint() { + return this.$hint.val(); + }, + setHint: function setHint(value) { + this.$hint.val(value); + }, + clearHint: function clearHint() { + this.setHint(""); + }, + clearHintIfInvalid: function clearHintIfInvalid() { + var val, hint, valIsPrefixOfHint, isValid; + val = this.getInputValue(); + hint = this.getHint(); + valIsPrefixOfHint = val !== hint && hint.indexOf(val) === 0; + isValid = val !== "" && valIsPrefixOfHint && !this.hasOverflow(); + !isValid && this.clearHint(); + }, + hasFocus: function hasFocus() { + return this.$input.is(":focus"); + }, + hasOverflow: function hasOverflow() { + var constraint = this.$input.width() - 2; + this.$overflowHelper.text(this.getInputValue()); + return this.$overflowHelper.width() >= constraint; + }, + isCursorAtEnd: function() { + var valueLength, selectionStart, range; + valueLength = this.$input.val().length; + selectionStart = this.$input[0].selectionStart; + if (_.isNumber(selectionStart)) { + return selectionStart === valueLength; + } else if (document.selection) { + range = document.selection.createRange(); + range.moveStart("character", -valueLength); + return valueLength === range.text.length; + } + return true; + }, + destroy: function destroy() { + this.$hint.off(".tt"); + this.$input.off(".tt"); + this.$overflowHelper.remove(); + this.$hint = this.$input = this.$overflowHelper = $("
"); + }, + setAriaExpanded: function setAriaExpanded(value) { + this.$input.attr("aria-expanded", value); + } + }); + return Input; + function buildOverflowHelper($input) { + return $('').css({ + position: "absolute", + visibility: "hidden", + whiteSpace: "pre", + fontFamily: $input.css("font-family"), + fontSize: $input.css("font-size"), + fontStyle: $input.css("font-style"), + fontVariant: $input.css("font-variant"), + fontWeight: $input.css("font-weight"), + wordSpacing: $input.css("word-spacing"), + letterSpacing: $input.css("letter-spacing"), + textIndent: $input.css("text-indent"), + textRendering: $input.css("text-rendering"), + textTransform: $input.css("text-transform") + }).insertAfter($input); + } + function areQueriesEquivalent(a, b) { + return Input.normalizeQuery(a) === Input.normalizeQuery(b); + } + function withModifier($e) { + return $e.altKey || $e.ctrlKey || $e.metaKey || $e.shiftKey; + } + }(); + var Dataset = function() { + "use strict"; + var keys, nameGenerator; + keys = { + dataset: "tt-selectable-dataset", + val: "tt-selectable-display", + obj: "tt-selectable-object" + }; + nameGenerator = _.getIdGenerator(); + function Dataset(o, www) { + o = o || {}; + o.templates = o.templates || {}; + o.templates.notFound = o.templates.notFound || o.templates.empty; + if (!o.source) { + $.error("missing source"); + } + if (!o.node) { + $.error("missing node"); + } + if (o.name && !isValidName(o.name)) { + $.error("invalid dataset name: " + o.name); + } + www.mixin(this); + this.highlight = !!o.highlight; + this.name = _.toStr(o.name || nameGenerator()); + this.limit = o.limit || 5; + this.displayFn = getDisplayFn(o.display || o.displayKey); + this.templates = getTemplates(o.templates, this.displayFn); + this.source = o.source.__ttAdapter ? o.source.__ttAdapter() : o.source; + this.async = _.isUndefined(o.async) ? this.source.length > 2 : !!o.async; + this._resetLastSuggestion(); + this.$el = $(o.node).attr("role", "presentation").addClass(this.classes.dataset).addClass(this.classes.dataset + "-" + this.name); + } + Dataset.extractData = function extractData(el) { + var $el = $(el); + if ($el.data(keys.obj)) { + return { + dataset: $el.data(keys.dataset) || "", + val: $el.data(keys.val) || "", + obj: $el.data(keys.obj) || null + }; + } + return null; + }; + _.mixin(Dataset.prototype, EventEmitter, { + _overwrite: function overwrite(query, suggestions) { + suggestions = suggestions || []; + if (suggestions.length) { + this._renderSuggestions(query, suggestions); + } else if (this.async && this.templates.pending) { + this._renderPending(query); + } else if (!this.async && this.templates.notFound) { + this._renderNotFound(query); + } else { + this._empty(); + } + this.trigger("rendered", suggestions, false, this.name); + }, + _append: function append(query, suggestions) { + suggestions = suggestions || []; + if (suggestions.length && this.$lastSuggestion.length) { + this._appendSuggestions(query, suggestions); + } else if (suggestions.length) { + this._renderSuggestions(query, suggestions); + } else if (!this.$lastSuggestion.length && this.templates.notFound) { + this._renderNotFound(query); + } + this.trigger("rendered", suggestions, true, this.name); + }, + _renderSuggestions: function renderSuggestions(query, suggestions) { + var $fragment; + $fragment = this._getSuggestionsFragment(query, suggestions); + this.$lastSuggestion = $fragment.children().last(); + this.$el.html($fragment).prepend(this._getHeader(query, suggestions)).append(this._getFooter(query, suggestions)); + }, + _appendSuggestions: function appendSuggestions(query, suggestions) { + var $fragment, $lastSuggestion; + $fragment = this._getSuggestionsFragment(query, suggestions); + $lastSuggestion = $fragment.children().last(); + this.$lastSuggestion.after($fragment); + this.$lastSuggestion = $lastSuggestion; + }, + _renderPending: function renderPending(query) { + var template = this.templates.pending; + this._resetLastSuggestion(); + template && this.$el.html(template({ + query: query, + dataset: this.name + })); + }, + _renderNotFound: function renderNotFound(query) { + var template = this.templates.notFound; + this._resetLastSuggestion(); + template && this.$el.html(template({ + query: query, + dataset: this.name + })); + }, + _empty: function empty() { + this.$el.empty(); + this._resetLastSuggestion(); + }, + _getSuggestionsFragment: function getSuggestionsFragment(query, suggestions) { + var that = this, fragment; + fragment = document.createDocumentFragment(); + _.each(suggestions, function getSuggestionNode(suggestion) { + var $el, context; + context = that._injectQuery(query, suggestion); + $el = $(that.templates.suggestion(context)).data(keys.dataset, that.name).data(keys.obj, suggestion).data(keys.val, that.displayFn(suggestion)).addClass(that.classes.suggestion + " " + that.classes.selectable); + fragment.appendChild($el[0]); + }); + this.highlight && highlight({ + className: this.classes.highlight, + node: fragment, + pattern: query + }); + return $(fragment); + }, + _getFooter: function getFooter(query, suggestions) { + return this.templates.footer ? this.templates.footer({ + query: query, + suggestions: suggestions, + dataset: this.name + }) : null; + }, + _getHeader: function getHeader(query, suggestions) { + return this.templates.header ? this.templates.header({ + query: query, + suggestions: suggestions, + dataset: this.name + }) : null; + }, + _resetLastSuggestion: function resetLastSuggestion() { + this.$lastSuggestion = $(); + }, + _injectQuery: function injectQuery(query, obj) { + return _.isObject(obj) ? _.mixin({ + _query: query + }, obj) : obj; + }, + update: function update(query) { + var that = this, canceled = false, syncCalled = false, rendered = 0; + this.cancel(); + this.cancel = function cancel() { + canceled = true; + that.cancel = $.noop; + that.async && that.trigger("asyncCanceled", query, that.name); + }; + this.source(query, sync, async); + !syncCalled && sync([]); + function sync(suggestions) { + if (syncCalled) { + return; + } + syncCalled = true; + suggestions = (suggestions || []).slice(0, that.limit); + rendered = suggestions.length; + that._overwrite(query, suggestions); + if (rendered < that.limit && that.async) { + that.trigger("asyncRequested", query, that.name); + } + } + function async(suggestions) { + suggestions = suggestions || []; + if (!canceled && rendered < that.limit) { + that.cancel = $.noop; + var idx = Math.abs(rendered - that.limit); + rendered += idx; + that._append(query, suggestions.slice(0, idx)); + that.async && that.trigger("asyncReceived", query, that.name); + } + } + }, + cancel: $.noop, + clear: function clear() { + this._empty(); + this.cancel(); + this.trigger("cleared"); + }, + isEmpty: function isEmpty() { + return this.$el.is(":empty"); + }, + destroy: function destroy() { + this.$el = $("
"); + } + }); + return Dataset; + function getDisplayFn(display) { + display = display || _.stringify; + return _.isFunction(display) ? display : displayFn; + function displayFn(obj) { + return obj[display]; + } + } + function getTemplates(templates, displayFn) { + return { + notFound: templates.notFound && _.templatify(templates.notFound), + pending: templates.pending && _.templatify(templates.pending), + header: templates.header && _.templatify(templates.header), + footer: templates.footer && _.templatify(templates.footer), + suggestion: templates.suggestion ? userSuggestionTemplate : suggestionTemplate + }; + function userSuggestionTemplate(context) { + var template = templates.suggestion; + return $(template(context)).attr("id", _.guid()); + } + function suggestionTemplate(context) { + return $('
').attr("id", _.guid()).text(displayFn(context)); + } + } + function isValidName(str) { + return /^[_a-zA-Z0-9-]+$/.test(str); + } + }(); + var Menu = function() { + "use strict"; + function Menu(o, www) { + var that = this; + o = o || {}; + if (!o.node) { + $.error("node is required"); + } + www.mixin(this); + this.$node = $(o.node); + this.query = null; + this.datasets = _.map(o.datasets, initializeDataset); + function initializeDataset(oDataset) { + var node = that.$node.find(oDataset.node).first(); + oDataset.node = node.length ? node : $("
").appendTo(that.$node); + return new Dataset(oDataset, www); + } + } + _.mixin(Menu.prototype, EventEmitter, { + _onSelectableClick: function onSelectableClick($e) { + this.trigger("selectableClicked", $($e.currentTarget)); + }, + _onRendered: function onRendered(type, dataset, suggestions, async) { + this.$node.toggleClass(this.classes.empty, this._allDatasetsEmpty()); + this.trigger("datasetRendered", dataset, suggestions, async); + }, + _onCleared: function onCleared() { + this.$node.toggleClass(this.classes.empty, this._allDatasetsEmpty()); + this.trigger("datasetCleared"); + }, + _propagate: function propagate() { + this.trigger.apply(this, arguments); + }, + _allDatasetsEmpty: function allDatasetsEmpty() { + return _.every(this.datasets, _.bind(function isDatasetEmpty(dataset) { + var isEmpty = dataset.isEmpty(); + this.$node.attr("aria-expanded", !isEmpty); + return isEmpty; + }, this)); + }, + _getSelectables: function getSelectables() { + return this.$node.find(this.selectors.selectable); + }, + _removeCursor: function _removeCursor() { + var $selectable = this.getActiveSelectable(); + $selectable && $selectable.removeClass(this.classes.cursor); + }, + _ensureVisible: function ensureVisible($el) { + var elTop, elBottom, nodeScrollTop, nodeHeight; + elTop = $el.position().top; + elBottom = elTop + $el.outerHeight(true); + nodeScrollTop = this.$node.scrollTop(); + nodeHeight = this.$node.height() + parseInt(this.$node.css("paddingTop"), 10) + parseInt(this.$node.css("paddingBottom"), 10); + if (elTop < 0) { + this.$node.scrollTop(nodeScrollTop + elTop); + } else if (nodeHeight < elBottom) { + this.$node.scrollTop(nodeScrollTop + (elBottom - nodeHeight)); + } + }, + bind: function() { + var that = this, onSelectableClick; + onSelectableClick = _.bind(this._onSelectableClick, this); + this.$node.on("click.tt", this.selectors.selectable, onSelectableClick); + this.$node.on("mouseover", this.selectors.selectable, function() { + that.setCursor($(this)); + }); + this.$node.on("mouseleave", function() { + that._removeCursor(); + }); + _.each(this.datasets, function(dataset) { + dataset.onSync("asyncRequested", that._propagate, that).onSync("asyncCanceled", that._propagate, that).onSync("asyncReceived", that._propagate, that).onSync("rendered", that._onRendered, that).onSync("cleared", that._onCleared, that); + }); + return this; + }, + isOpen: function isOpen() { + return this.$node.hasClass(this.classes.open); + }, + open: function open() { + this.$node.scrollTop(0); + this.$node.addClass(this.classes.open); + }, + close: function close() { + this.$node.attr("aria-expanded", false); + this.$node.removeClass(this.classes.open); + this._removeCursor(); + }, + setLanguageDirection: function setLanguageDirection(dir) { + this.$node.attr("dir", dir); + }, + selectableRelativeToCursor: function selectableRelativeToCursor(delta) { + var $selectables, $oldCursor, oldIndex, newIndex; + $oldCursor = this.getActiveSelectable(); + $selectables = this._getSelectables(); + oldIndex = $oldCursor ? $selectables.index($oldCursor) : -1; + newIndex = oldIndex + delta; + newIndex = (newIndex + 1) % ($selectables.length + 1) - 1; + newIndex = newIndex < -1 ? $selectables.length - 1 : newIndex; + return newIndex === -1 ? null : $selectables.eq(newIndex); + }, + setCursor: function setCursor($selectable) { + this._removeCursor(); + if ($selectable = $selectable && $selectable.first()) { + $selectable.addClass(this.classes.cursor); + this._ensureVisible($selectable); + } + }, + getSelectableData: function getSelectableData($el) { + return $el && $el.length ? Dataset.extractData($el) : null; + }, + getActiveSelectable: function getActiveSelectable() { + var $selectable = this._getSelectables().filter(this.selectors.cursor).first(); + return $selectable.length ? $selectable : null; + }, + getTopSelectable: function getTopSelectable() { + var $selectable = this._getSelectables().first(); + return $selectable.length ? $selectable : null; + }, + update: function update(query) { + var isValidUpdate = query !== this.query; + if (isValidUpdate) { + this.query = query; + _.each(this.datasets, updateDataset); + } + return isValidUpdate; + function updateDataset(dataset) { + dataset.update(query); + } + }, + empty: function empty() { + _.each(this.datasets, clearDataset); + this.query = null; + this.$node.addClass(this.classes.empty); + function clearDataset(dataset) { + dataset.clear(); + } + }, + destroy: function destroy() { + this.$node.off(".tt"); + this.$node = $("
"); + _.each(this.datasets, destroyDataset); + function destroyDataset(dataset) { + dataset.destroy(); + } + } + }); + return Menu; + }(); + var Status = function() { + "use strict"; + function Status(options) { + this.$el = $("", { + role: "status", + "aria-live": "polite" + }).css({ + position: "absolute", + padding: "0", + border: "0", + height: "1px", + width: "1px", + "margin-bottom": "-1px", + "margin-right": "-1px", + overflow: "hidden", + clip: "rect(0 0 0 0)", + "white-space": "nowrap" + }); + options.$input.after(this.$el); + _.each(options.menu.datasets, _.bind(function(dataset) { + if (dataset.onSync) { + dataset.onSync("rendered", _.bind(this.update, this)); + dataset.onSync("cleared", _.bind(this.cleared, this)); + } + }, this)); + } + _.mixin(Status.prototype, { + update: function update(event, suggestions) { + var length = suggestions.length; + var words; + if (length === 1) { + words = { + result: "result", + is: "is" + }; + } else { + words = { + result: "results", + is: "are" + }; + } + this.$el.text(length + " " + words.result + " " + words.is + " available, use up and down arrow keys to navigate."); + }, + cleared: function() { + this.$el.text(""); + } + }); + return Status; + }(); + var DefaultMenu = function() { + "use strict"; + var s = Menu.prototype; + function DefaultMenu() { + Menu.apply(this, [].slice.call(arguments, 0)); + } + _.mixin(DefaultMenu.prototype, Menu.prototype, { + open: function open() { + !this._allDatasetsEmpty() && this._show(); + return s.open.apply(this, [].slice.call(arguments, 0)); + }, + close: function close() { + this._hide(); + return s.close.apply(this, [].slice.call(arguments, 0)); + }, + _onRendered: function onRendered() { + if (this._allDatasetsEmpty()) { + this._hide(); + } else { + this.isOpen() && this._show(); + } + return s._onRendered.apply(this, [].slice.call(arguments, 0)); + }, + _onCleared: function onCleared() { + if (this._allDatasetsEmpty()) { + this._hide(); + } else { + this.isOpen() && this._show(); + } + return s._onCleared.apply(this, [].slice.call(arguments, 0)); + }, + setLanguageDirection: function setLanguageDirection(dir) { + this.$node.css(dir === "ltr" ? this.css.ltr : this.css.rtl); + return s.setLanguageDirection.apply(this, [].slice.call(arguments, 0)); + }, + _hide: function hide() { + this.$node.hide(); + }, + _show: function show() { + this.$node.css("display", "block"); + } + }); + return DefaultMenu; + }(); + var Typeahead = function() { + "use strict"; + function Typeahead(o, www) { + var onFocused, onBlurred, onEnterKeyed, onTabKeyed, onEscKeyed, onUpKeyed, onDownKeyed, onLeftKeyed, onRightKeyed, onQueryChanged, onWhitespaceChanged; + o = o || {}; + if (!o.input) { + $.error("missing input"); + } + if (!o.menu) { + $.error("missing menu"); + } + if (!o.eventBus) { + $.error("missing event bus"); + } + www.mixin(this); + this.eventBus = o.eventBus; + this.minLength = _.isNumber(o.minLength) ? o.minLength : 1; + this.input = o.input; + this.menu = o.menu; + this.enabled = true; + this.autoselect = !!o.autoselect; + this.active = false; + this.input.hasFocus() && this.activate(); + this.dir = this.input.getLangDir(); + this._hacks(); + this.menu.bind().onSync("selectableClicked", this._onSelectableClicked, this).onSync("asyncRequested", this._onAsyncRequested, this).onSync("asyncCanceled", this._onAsyncCanceled, this).onSync("asyncReceived", this._onAsyncReceived, this).onSync("datasetRendered", this._onDatasetRendered, this).onSync("datasetCleared", this._onDatasetCleared, this); + onFocused = c(this, "activate", "open", "_onFocused"); + onBlurred = c(this, "deactivate", "_onBlurred"); + onEnterKeyed = c(this, "isActive", "isOpen", "_onEnterKeyed"); + onTabKeyed = c(this, "isActive", "isOpen", "_onTabKeyed"); + onEscKeyed = c(this, "isActive", "_onEscKeyed"); + onUpKeyed = c(this, "isActive", "open", "_onUpKeyed"); + onDownKeyed = c(this, "isActive", "open", "_onDownKeyed"); + onLeftKeyed = c(this, "isActive", "isOpen", "_onLeftKeyed"); + onRightKeyed = c(this, "isActive", "isOpen", "_onRightKeyed"); + onQueryChanged = c(this, "_openIfActive", "_onQueryChanged"); + onWhitespaceChanged = c(this, "_openIfActive", "_onWhitespaceChanged"); + this.input.bind().onSync("focused", onFocused, this).onSync("blurred", onBlurred, this).onSync("enterKeyed", onEnterKeyed, this).onSync("tabKeyed", onTabKeyed, this).onSync("escKeyed", onEscKeyed, this).onSync("upKeyed", onUpKeyed, this).onSync("downKeyed", onDownKeyed, this).onSync("leftKeyed", onLeftKeyed, this).onSync("rightKeyed", onRightKeyed, this).onSync("queryChanged", onQueryChanged, this).onSync("whitespaceChanged", onWhitespaceChanged, this).onSync("langDirChanged", this._onLangDirChanged, this); + } + _.mixin(Typeahead.prototype, { + _hacks: function hacks() { + var $input, $menu; + $input = this.input.$input || $("
"); + $menu = this.menu.$node || $("
"); + $input.on("blur.tt", function($e) { + var active, isActive, hasActive; + active = document.activeElement; + isActive = $menu.is(active); + hasActive = $menu.has(active).length > 0; + if (_.isMsie() && (isActive || hasActive)) { + $e.preventDefault(); + $e.stopImmediatePropagation(); + _.defer(function() { + $input.focus(); + }); + } + }); + $menu.on("mousedown.tt", function($e) { + $e.preventDefault(); + }); + }, + _onSelectableClicked: function onSelectableClicked(type, $el) { + this.select($el); + }, + _onDatasetCleared: function onDatasetCleared() { + this._updateHint(); + }, + _onDatasetRendered: function onDatasetRendered(type, suggestions, async, dataset) { + this._updateHint(); + if (this.autoselect) { + var cursorClass = this.selectors.cursor.substr(1); + this.menu.$node.find(this.selectors.suggestion).first().addClass(cursorClass); + } + this.eventBus.trigger("render", suggestions, async, dataset); + }, + _onAsyncRequested: function onAsyncRequested(type, dataset, query) { + this.eventBus.trigger("asyncrequest", query, dataset); + }, + _onAsyncCanceled: function onAsyncCanceled(type, dataset, query) { + this.eventBus.trigger("asynccancel", query, dataset); + }, + _onAsyncReceived: function onAsyncReceived(type, dataset, query) { + this.eventBus.trigger("asyncreceive", query, dataset); + }, + _onFocused: function onFocused() { + this._minLengthMet() && this.menu.update(this.input.getQuery()); + }, + _onBlurred: function onBlurred() { + if (this.input.hasQueryChangedSinceLastFocus()) { + this.eventBus.trigger("change", this.input.getQuery()); + } + }, + _onEnterKeyed: function onEnterKeyed(type, $e) { + var $selectable; + if ($selectable = this.menu.getActiveSelectable()) { + if (this.select($selectable)) { + $e.preventDefault(); + $e.stopPropagation(); + } + } else if (this.autoselect) { + if (this.select(this.menu.getTopSelectable())) { + $e.preventDefault(); + $e.stopPropagation(); + } + } + }, + _onTabKeyed: function onTabKeyed(type, $e) { + var $selectable; + if ($selectable = this.menu.getActiveSelectable()) { + this.select($selectable) && $e.preventDefault(); + } else if (this.autoselect) { + if ($selectable = this.menu.getTopSelectable()) { + this.autocomplete($selectable) && $e.preventDefault(); + } + } + }, + _onEscKeyed: function onEscKeyed() { + this.close(); + }, + _onUpKeyed: function onUpKeyed() { + this.moveCursor(-1); + }, + _onDownKeyed: function onDownKeyed() { + this.moveCursor(+1); + }, + _onLeftKeyed: function onLeftKeyed() { + if (this.dir === "rtl" && this.input.isCursorAtEnd()) { + this.autocomplete(this.menu.getActiveSelectable() || this.menu.getTopSelectable()); + } + }, + _onRightKeyed: function onRightKeyed() { + if (this.dir === "ltr" && this.input.isCursorAtEnd()) { + this.autocomplete(this.menu.getActiveSelectable() || this.menu.getTopSelectable()); + } + }, + _onQueryChanged: function onQueryChanged(e, query) { + this._minLengthMet(query) ? this.menu.update(query) : this.menu.empty(); + }, + _onWhitespaceChanged: function onWhitespaceChanged() { + this._updateHint(); + }, + _onLangDirChanged: function onLangDirChanged(e, dir) { + if (this.dir !== dir) { + this.dir = dir; + this.menu.setLanguageDirection(dir); + } + }, + _openIfActive: function openIfActive() { + this.isActive() && this.open(); + }, + _minLengthMet: function minLengthMet(query) { + query = _.isString(query) ? query : this.input.getQuery() || ""; + return query.length >= this.minLength; + }, + _updateHint: function updateHint() { + var $selectable, data, val, query, escapedQuery, frontMatchRegEx, match; + $selectable = this.menu.getTopSelectable(); + data = this.menu.getSelectableData($selectable); + val = this.input.getInputValue(); + if (data && !_.isBlankString(val) && !this.input.hasOverflow()) { + query = Input.normalizeQuery(val); + escapedQuery = _.escapeRegExChars(query); + frontMatchRegEx = new RegExp("^(?:" + escapedQuery + ")(.+$)", "i"); + match = frontMatchRegEx.exec(data.val); + match && this.input.setHint(val + match[1]); + } else { + this.input.clearHint(); + } + }, + isEnabled: function isEnabled() { + return this.enabled; + }, + enable: function enable() { + this.enabled = true; + }, + disable: function disable() { + this.enabled = false; + }, + isActive: function isActive() { + return this.active; + }, + activate: function activate() { + if (this.isActive()) { + return true; + } else if (!this.isEnabled() || this.eventBus.before("active")) { + return false; + } else { + this.active = true; + this.eventBus.trigger("active"); + return true; + } + }, + deactivate: function deactivate() { + if (!this.isActive()) { + return true; + } else if (this.eventBus.before("idle")) { + return false; + } else { + this.active = false; + this.close(); + this.eventBus.trigger("idle"); + return true; + } + }, + isOpen: function isOpen() { + return this.menu.isOpen(); + }, + open: function open() { + if (!this.isOpen() && !this.eventBus.before("open")) { + this.input.setAriaExpanded(true); + this.menu.open(); + this._updateHint(); + this.eventBus.trigger("open"); + } + return this.isOpen(); + }, + close: function close() { + if (this.isOpen() && !this.eventBus.before("close")) { + this.input.setAriaExpanded(false); + this.menu.close(); + this.input.clearHint(); + this.input.resetInputValue(); + this.eventBus.trigger("close"); + } + return !this.isOpen(); + }, + setVal: function setVal(val) { + this.input.setQuery(_.toStr(val)); + }, + getVal: function getVal() { + return this.input.getQuery(); + }, + select: function select($selectable) { + var data = this.menu.getSelectableData($selectable); + if (data && !this.eventBus.before("select", data.obj, data.dataset)) { + this.input.setQuery(data.val, true); + this.eventBus.trigger("select", data.obj, data.dataset); + this.close(); + return true; + } + return false; + }, + autocomplete: function autocomplete($selectable) { + var query, data, isValid; + query = this.input.getQuery(); + data = this.menu.getSelectableData($selectable); + isValid = data && query !== data.val; + if (isValid && !this.eventBus.before("autocomplete", data.obj, data.dataset)) { + this.input.setQuery(data.val); + this.eventBus.trigger("autocomplete", data.obj, data.dataset); + return true; + } + return false; + }, + moveCursor: function moveCursor(delta) { + var query, $candidate, data, suggestion, datasetName, cancelMove, id; + query = this.input.getQuery(); + $candidate = this.menu.selectableRelativeToCursor(delta); + data = this.menu.getSelectableData($candidate); + suggestion = data ? data.obj : null; + datasetName = data ? data.dataset : null; + id = $candidate ? $candidate.attr("id") : null; + this.input.trigger("cursorchange", id); + cancelMove = this._minLengthMet() && this.menu.update(query); + if (!cancelMove && !this.eventBus.before("cursorchange", suggestion, datasetName)) { + this.menu.setCursor($candidate); + if (data) { + if (typeof data.val === "string") { + this.input.setInputValue(data.val); + } + } else { + this.input.resetInputValue(); + this._updateHint(); + } + this.eventBus.trigger("cursorchange", suggestion, datasetName); + return true; + } + return false; + }, + destroy: function destroy() { + this.input.destroy(); + this.menu.destroy(); + } + }); + return Typeahead; + function c(ctx) { + var methods = [].slice.call(arguments, 1); + return function() { + var args = [].slice.call(arguments); + _.each(methods, function(method) { + return ctx[method].apply(ctx, args); + }); + }; + } + }(); + (function() { + "use strict"; + var old, keys, methods; + old = $.fn.typeahead; + keys = { + www: "tt-www", + attrs: "tt-attrs", + typeahead: "tt-typeahead" + }; + methods = { + initialize: function initialize(o, datasets) { + var www; + datasets = _.isArray(datasets) ? datasets : [].slice.call(arguments, 1); + o = o || {}; + www = WWW(o.classNames); + return this.each(attach); + function attach() { + var $input, $wrapper, $hint, $menu, defaultHint, defaultMenu, eventBus, input, menu, status, typeahead, MenuConstructor; + _.each(datasets, function(d) { + d.highlight = !!o.highlight; + }); + $input = $(this); + $wrapper = $(www.html.wrapper); + $hint = $elOrNull(o.hint); + $menu = $elOrNull(o.menu); + defaultHint = o.hint !== false && !$hint; + defaultMenu = o.menu !== false && !$menu; + defaultHint && ($hint = buildHintFromInput($input, www)); + defaultMenu && ($menu = $(www.html.menu).css(www.css.menu)); + $hint && $hint.val(""); + $input = prepInput($input, www); + if (defaultHint || defaultMenu) { + $wrapper.css(www.css.wrapper); + $input.css(defaultHint ? www.css.input : www.css.inputWithNoHint); + $input.wrap($wrapper).parent().prepend(defaultHint ? $hint : null).append(defaultMenu ? $menu : null); + } + MenuConstructor = defaultMenu ? DefaultMenu : Menu; + eventBus = new EventBus({ + el: $input + }); + input = new Input({ + hint: $hint, + input: $input, + menu: $menu + }, www); + menu = new MenuConstructor({ + node: $menu, + datasets: datasets + }, www); + status = new Status({ + $input: $input, + menu: menu + }); + typeahead = new Typeahead({ + input: input, + menu: menu, + eventBus: eventBus, + minLength: o.minLength, + autoselect: o.autoselect + }, www); + $input.data(keys.www, www); + $input.data(keys.typeahead, typeahead); + } + }, + isEnabled: function isEnabled() { + var enabled; + ttEach(this.first(), function(t) { + enabled = t.isEnabled(); + }); + return enabled; + }, + enable: function enable() { + ttEach(this, function(t) { + t.enable(); + }); + return this; + }, + disable: function disable() { + ttEach(this, function(t) { + t.disable(); + }); + return this; + }, + isActive: function isActive() { + var active; + ttEach(this.first(), function(t) { + active = t.isActive(); + }); + return active; + }, + activate: function activate() { + ttEach(this, function(t) { + t.activate(); + }); + return this; + }, + deactivate: function deactivate() { + ttEach(this, function(t) { + t.deactivate(); + }); + return this; + }, + isOpen: function isOpen() { + var open; + ttEach(this.first(), function(t) { + open = t.isOpen(); + }); + return open; + }, + open: function open() { + ttEach(this, function(t) { + t.open(); + }); + return this; + }, + close: function close() { + ttEach(this, function(t) { + t.close(); + }); + return this; + }, + select: function select(el) { + var success = false, $el = $(el); + ttEach(this.first(), function(t) { + success = t.select($el); + }); + return success; + }, + autocomplete: function autocomplete(el) { + var success = false, $el = $(el); + ttEach(this.first(), function(t) { + success = t.autocomplete($el); + }); + return success; + }, + moveCursor: function moveCursoe(delta) { + var success = false; + ttEach(this.first(), function(t) { + success = t.moveCursor(delta); + }); + return success; + }, + val: function val(newVal) { + var query; + if (!arguments.length) { + ttEach(this.first(), function(t) { + query = t.getVal(); + }); + return query; + } else { + ttEach(this, function(t) { + t.setVal(_.toStr(newVal)); + }); + return this; + } + }, + destroy: function destroy() { + ttEach(this, function(typeahead, $input) { + revert($input); + typeahead.destroy(); + }); + return this; + } + }; + $.fn.typeahead = function(method) { + if (methods[method]) { + return methods[method].apply(this, [].slice.call(arguments, 1)); + } else { + return methods.initialize.apply(this, arguments); + } + }; + $.fn.typeahead.noConflict = function noConflict() { + $.fn.typeahead = old; + return this; + }; + function ttEach($els, fn) { + $els.each(function() { + var $input = $(this), typeahead; + (typeahead = $input.data(keys.typeahead)) && fn(typeahead, $input); + }); + } + function buildHintFromInput($input, www) { + return $input.clone().addClass(www.classes.hint).removeData().css(www.css.hint).css(getBackgroundStyles($input)).prop({ + readonly: true, + required: false + }).removeAttr("id name placeholder").removeClass("required").attr({ + spellcheck: "false", + tabindex: -1 + }); + } + function prepInput($input, www) { + $input.data(keys.attrs, { + dir: $input.attr("dir"), + autocomplete: $input.attr("autocomplete"), + spellcheck: $input.attr("spellcheck"), + style: $input.attr("style") + }); + $input.addClass(www.classes.input).attr({ + spellcheck: false + }); + try { + !$input.attr("dir") && $input.attr("dir", "auto"); + } catch (e) {} + return $input; + } + function getBackgroundStyles($el) { + return { + backgroundAttachment: $el.css("background-attachment"), + backgroundClip: $el.css("background-clip"), + backgroundColor: $el.css("background-color"), + backgroundImage: $el.css("background-image"), + backgroundOrigin: $el.css("background-origin"), + backgroundPosition: $el.css("background-position"), + backgroundRepeat: $el.css("background-repeat"), + backgroundSize: $el.css("background-size") + }; + } + function revert($input) { + var www, $wrapper; + www = $input.data(keys.www); + $wrapper = $input.parent().filter(www.selectors.wrapper); + _.each($input.data(keys.attrs), function(val, key) { + _.isUndefined(val) ? $input.removeAttr(key) : $input.attr(key, val); + }); + $input.removeData(keys.typeahead).removeData(keys.www).removeData(keys.attr).removeClass(www.classes.input); + if ($wrapper.length) { + $input.detach().insertAfter($wrapper); + $wrapper.remove(); + } + } + function $elOrNull(obj) { + var isValid, $el; + isValid = _.isJQuery(obj) || _.isElement(obj); + $el = isValid ? $(obj).first() : []; + return $el.length ? $el : null; + } + })(); +}); \ No newline at end of file diff --git a/readme.html b/readme.html new file mode 100644 index 00000000..613bb94a --- /dev/null +++ b/readme.html @@ -0,0 +1,1033 @@ + + + + README Reference + + + + + + + + + + + + + + + +
+

+ + HyperwalletSDK + + (99% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ HyperwalletSDK Reference + + README Reference +

+ +
+ +
+ +
+
+ +

Hyperwallet iOS Core SDK

+ +

Platforms +Build Status +Coverage Status

+ +

CocoaPods +Carthage compatible

+ +

NOTE: This is a beta product available for use in your mobile app. If you are interested in using this product, please notify your Relationship Manager and / or Project Manager to support you during the integration process.

+ +

Welcome to Hyperwallet’s iOS SDK. This library will help you create transfer methods in your iOS app, such as bank account, PayPal account, etc. See our iOS Integration Guide to get started!

+ +

Note that this SDK is geared towards those who only require backend data, which means you will have to build your own UI.

+ +

We also provide an out-of-the-box Hyperwallet iOS UI SDK for you if you decide not to build your own UI.

+

Prerequisites

+ +
    +
  • A Hyperwallet merchant account
    • +
  • Set Up your server to manage the user’s authentication process on the Hyperwallet platform. See the Authentication section for more information.
    • +
  • iOS 13.0+
    • +
  • Xcode 10.2+
    • +
  • Swift 5.0
    • +
+

Installation

+ +

Use Carthage or CocoaPods to integrate to HyperwalletSDK.

+

Carthage

+ +

Specify it in your Cartfile:

+
github "hyperwallet/hyperwallet-ios-sdk" "1.0.0-beta17"
+
+

CocoaPods

+ +

Specify it in your Podfile:

+
pod 'HyperwalletSDK', '~> 1.0.0-beta17'
+
+

Initialization

+ +

After you’re done installing the SDK, you need to initialize an instance in order to utilize core SDK functions. Also, you need to provide a HyperwalletAuthenticationTokenProvider object to retrieve an authentication token.

+ +

Add in the header:

+
import HyperwalletSDK
+
+ +

Initialize the HyperwalletSDK with a HyperwalletAuthenticationTokenProvider implementation instance:

+
Hyperwallet.setup(authenticationTokenProvider :HyperwalletAuthenticationTokenProvider)
+
+

Authentication

+ +

Your server side should be able to send a POST request to Hyperwallet endpoint /rest/v3/users/{user-token}/authentication-token to retrieve an authentication token. +Then, you need to provide a class (an authentication provider) which implements HyperwalletAuthenticationTokenProvider to retrieve an authentication token from your server.

+ +

An example implementation using the URLRequest from Swift Foundation :

+
import Foundation
+import HyperwalletSDK
+
+public class AuthenticationTokenProvider: HyperwalletAuthenticationTokenProvider {
+    private let url = URL(string: "http://your/server/to/retrieve/authenticationToken")!
+
+    public func retrieveAuthenticationToken(
+        completionHandler: @escaping HyperwalletAuthenticationTokenProvider.CompletionHandler) {
+
+        var request = URLRequest(url: url)
+        request.httpMethod = "POST"
+        request.addValue("application/json", forHTTPHeaderField: "Content-Type")
+
+        let defaultSession = URLSession(configuration: .default)
+        let task = defaultSession.dataTask(with: request) {(data, response, error) in
+            DispatchQueue.main.async {
+                    guard let data = data,
+                        let clientToken = String(data: data, encoding: .utf8),
+                        let response = response as? HTTPURLResponse else {
+                            completionHandler(nil, HyperwalletAuthenticationErrorType.unexpected(error?.localizedDescription ??
+                                "authentication token cannot be retrieved"))
+                            return
+                    }
+
+                    switch response.statusCode {
+                        case 200 ..< 300:
+                            completionHandler(clientToken, nil)
+
+                        default:
+                            completionHandler(nil, HyperwalletAuthenticationErrorType
+                                .unexpected("authentication token cannot be retrieved"))
+                }
+            }
+        }
+        task.resume()
+    }
+}
+
+

Usage

+ +

The functions in the core SDK are available to use once the authentication is done.

+

Get User

+
Hyperwallet.shared.getUser { (user, error) in
+    guard error == nil else {
+        print(error?.getHyperwalletErrors()?.errorList?)
+        return
+    }
+
+    print(user?.firstName)
+    print(user?.lastName)
+}
+
+

Create PayPal Account

+
let payPalAccount = HyperwalletPayPalAccount.Builder(transferMethodCountry: "US", transferMethodCurrency: "USD")
+    .email("test@paypal.com")
+    .build()
+
+Hyperwallet.shared.createPayPalAccount(account: payPalAccount, completion: { (result, error) in
+    // Code to handle successful response or error
+    // On successful creation, response (HyperwalletPayPalAccount in this case) will contain information about the user’s PayPal account
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure of PayPal account creation
+})
+
+

Get PayPal Account

+
Hyperwallet.shared.getPayPalAccount(transferMethodToken: "123123", completion: { (result, error) in
+    // On success, response (HyperwalletPayPalAccount? in this case) will contain information about the user’s PayPal account or nil if not exist.
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure
+})
+
+

Update PayPal Account

+
let payPalAccount = HyperwalletPayPalAccount.Builder(token: "trm-12345")
+    .email("test@paypal.com")
+    .build()
+
+Hyperwallet.shared.updatePayPalAccount(account: payPalAccount, completion: { (result, error) in
+    // Code to handle successful response or error
+    // On successful update, response (HyperwalletPayPalAccount in this case) will contain information about the user’s PayPal account
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure of PayPal account updating
+})
+
+

Deactivate PayPal Account

+
Hyperwallet.shared.deactivatePayPalAccount(transferMethodToken: "trm-12345", notes: "deactivate PayPal account", completion: { (result, error) in
+    // Code to handle successful response or error
+    // On successful deactivation, response (HyperwalletStatusTransition in this case) will contain information about the status transition
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure of PayPal account deactivation
+})
+
+

List PayPal Account

+
let payPalQueryParam = HyperwalletPayPalAccountQueryParam()
+payPalQueryParam.status = HyperwalletPayPalAccountQueryParam.QueryStatus.activated.rawValue
+payPalQueryParam.sortBy = HyperwalletTransferMethodQueryParam.QuerySortable.ascendantCreatedOn.rawValue
+
+Hyperwallet.shared.listPayPalAccounts(queryParam: payPalQueryParam) { (result, error) in
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure
+    guard error == nil else {
+        print(error?.getHyperwalletErrors()?.errorList?)
+        return
+    }
+
+    // On success, response (HyperwalletPageList<HyperwalletPayPalAccount>? in this case) will contain information about or nil if not exist.
+    if let payPalAccounts = result?.data {
+        for payPalAccount in payPalAccounts {
+        print(payPalAccount.getField(fieldName: .token) ?? "")
+        }
+    }
+}
+
+

Create Venmo Account

+
let venmoAccount = HyperwalletVenmoAccount.Builder(transferMethodCountry: "US", transferMethodCurrency: "USD")
+    .accountId("9876543210")
+    .build()
+
+Hyperwallet.shared.createVenmoAccount(account: venmoAccount, completion: { (result, error) in
+    // Code to handle successful response or error
+    // On successful creation, response (HyperwalletVenmoAccount in this case) will contain information about the user’s Venmo account
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure of Venmo account creation
+})
+
+

Get Venmo Account

+
Hyperwallet.shared.getVenmoAccount(transferMethodToken: "123123", completion: { (result, error) in
+    // On success, response (HyperwalletVenmoAccount? in this case) will contain information about the user’s Venmo account or nil if not exist.
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure
+})
+
+

Update Venmo Account

+
let venmoAccount = HyperwalletVenmoAccount.Builder(token: "trm-12345")
+    .accountId("9876543210")
+    .build()
+
+Hyperwallet.shared.updateVenmoAccount(account: venmoAccount, completion: { (result, error) in
+    // Code to handle successful response or error
+    // On successful update, response (HyperwalletVenmoAccount in this case) will contain information about the user’s Venmo account
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure of Venmo account updating
+})
+
+

Deactivate Venmo Account

+
Hyperwallet.shared.deactivateVenmoAccount(transferMethodToken: "trm-12345", notes: "deactivate Venmo account", completion: { (result, error) in
+    // Code to handle successful response or error
+    // On successful deactivation, response (HyperwalletStatusTransition in this case) will contain information about the status transition
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure of Venmo account deactivation
+})
+
+

List Venmo Account

+
let venmoQueryParam = HyperwalletVenmoQueryParam()
+venmoQueryParam.status = HyperwalletVenmoQueryParam.QueryStatus.activated.rawValue
+venmoQueryParam.sortBy = HyperwalletVenmoQueryParam.QuerySortable.ascendantCreatedOn.rawValue
+
+Hyperwallet.shared.listVenmoAccounts(queryParam: venmoQueryParam) { (result, error) in
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure
+    guard error == nil else {
+        print(error?.getHyperwalletErrors()?.errorList?)
+        return
+    }
+
+    // On success, response (HyperwalletPageList<HyperwalletVenmoAccount>? in this case) will contain information about or nil if not exist.
+    if let venmoAccounts = result?.data {
+        for venmoAccount in venmoAccounts {
+           print(venmoAccount.getField(fieldName: .token) ?? "")
+        }
+    }
+}
+
+

Create Bank Account

+
let bankAccount = HyperwalletBankAccount.Builder(transferMethodCountry: "US",   
+                                                 transferMethodCurrency: "USD",
+                                                 transferMethodProfileType: "INDIVIDUAL")
+.bankAccountId("12345")
+.branchId("123456")
+.bankAccountPurpose(.checking)
+.build()
+
+Hyperwallet.shared.createBankAccount(account: bankAccount, completion: { (result, error) in
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure of account creation
+    guard error == nil else {
+        print(error?.getHyperwalletErrors()?.errorList?)
+        return
+    }   
+
+    // On successful creation, response (HyperwalletBankAccount in this case) payload will contain information about the account created
+    print(result)
+})
+
+

Get Bank Account

+
Hyperwallet.shared.getBankAccount(transferMethodToken: "123123", completion: { (result, error) in
+    // On success, response (HyperwalletBankCard? in this case) will contain information about the user’s bank account or nil if not exist.
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure
+})
+
+

Update Bank Account

+
let bankAccount = HyperwalletBankAccount
+.Builder(token: "12345")
+.branchId("026009593")
+.build()
+
+Hyperwallet.shared.updateBankAccount(account: bankAccount, completion: { (response, error) in
+    // Code to handle successful response or error
+    // On successful update, response (HyperwalletBankAccount in this case) payload will contain information about the account updated
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure of account updating
+})
+
+

Deactivate Bank Account

+
Hyperwallet.shared.deactivateBankAccount(transferMethodToken: "trm-12345", notes: "deactivate bank account", completion: { (result, error) in
+    // Code to handle successful response or error
+    // On successful deactivation, response (HyperwalletStatusTransition in this case) will contain information about the status transition
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure of account deactivation
+})
+
+

List Bank Account

+
let bankAccountQueryParam = HyperwalletBankAccountQueryParam()
+bankAccountQueryParam.status = HyperwalletBankAccountQueryParam.QueryStatus.activated.rawValue
+bankAccountQueryParam.sortBy = HyperwalletBankAccountQueryParam.QuerySortable.ascendantCreatedOn.rawValue
+
+Hyperwallet.shared.listBankAccounts(queryParam: bankAccountQueryParam) { (result, error) in
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure
+    guard error == nil else {
+        print(error?.getHyperwalletErrors()?.errorList?)
+        return
+    }
+
+    // On success, response (HyperwalletPageList<HyperwalletBankAccount>? in this case) will contain information about or nil if not exist.
+    if let bankAccounts = result?.data {
+        for bankAccount in bankAccounts {
+            print(bankAccount.token ?? "")
+        }
+    }
+}
+
+

Create Paper Check

+
let paperCheck = HyperwalletPaperCheck.Builder(transferMethodCountry: "US",   
+                                               transferMethodCurrency: "USD",
+                                               transferMethodProfileType: "INDIVIDUAL")
+.shippingMethod("STANDARD")
+.build()
+
+Hyperwallet.shared.createPaperCheck(account: paperCheck, completion: { (result, error) in
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure of account creation
+    guard error == nil else {
+        print(error?.getHyperwalletErrors()?.errorList?)
+        return
+    }   
+
+    // On successful creation, response (HyperwalletPaperCheck in this case) payload will contain information about the paper check created
+    print(result)
+})
+
+

Get Paper Check

+
Hyperwallet.shared.getPaperCheck(transferMethodToken: "123123", completion: { (result, error) in
+    // On success, response (HyperwalletPaperCheck? in this case) will contain information about the user’s paper check or nil if not exist.
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure
+})
+
+

Update Paper Check

+
let paperCheck = HyperwalletPaperCheck
+.Builder(token: "12345")
+.shippingMethod("STANDARD")
+.build()
+
+Hyperwallet.shared.updatePaperCheck(account: paperCheck, completion: { (response, error) in
+    // Code to handle successful response or error
+    // On successful update, response (HyperwalletPaperCheck in this case) payload will contain information about the paper check updated
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure while updating
+})
+
+

Deactivate Paper Check

+
Hyperwallet.shared.deactivatePaperCheck(transferMethodToken: "trm-12345", notes: "deactivate paper check", completion: { (result, error) in
+    // Code to handle successful response or error
+    // On successful deactivation, response (HyperwalletStatusTransition in this case) will contain information about the status transition
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure
+})
+
+

List Paper Check

+
let paperCheckQueryParam = HyperwalletPaperCheckQueryParam()
+paperCheckQueryParam.status = HyperwalletPaperCheckQueryParam.QueryStatus.activated.rawValue
+paperCheckQueryParam.sortBy = HyperwalletPaperCheckQueryParam.QuerySortable.ascendantCreatedOn.rawValue
+
+Hyperwallet.shared.listPaperChecks(queryParam: paperCheckQueryParam) { (result, error) in
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure
+    guard error == nil else {
+        print(error?.getHyperwalletErrors()?.errorList?)
+        return
+    }
+
+    // On success, response (HyperwalletPageList<HyperwalletPaperCheck>? in this case) will contain information about or nil if not exist.
+    if let paperChecks = result?.data {
+        for paperCheck in paperChecks {
+            print(paperCheck.token ?? "")
+        }
+    }
+}
+
+

Create Bank Card

+
let bankCard = HyperwalletBankCard.Builder(transferMethodCountry: "US",
+                                           transferMethodCurrency: "USD",
+                                           transferMethodProfileType: "INDIVIDUAL")
+.cardNumber("1234123412341234")
+.dateOfExpiry("2022-12")
+.cvv("123")
+.build()
+
+Hyperwallet.shared.createBankCard(account: bankCard, completion: { (result, error) in
+    // Code to handle successful response or error
+    // On successful creation, response (HyperwalletBankCard in this case) will contain information about the user’s bank card
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure of bank card creation
+})
+
+

Get Bank Card

+
Hyperwallet.shared.getBankCard(transferMethodToken: "123123", completion: { (result, error) in
+    // On success, response (HyperwalletBankCard? in this case) will contain information about the user’s bank card or nil if not exist.
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure
+})
+
+

Update Bank Card

+
let bankCard = HyperwalletBankCard
+.Builder(token: "trm-12345")
+.dateOfExpiry("2022-12")
+.build()
+
+Hyperwallet.shared.updateBankCard(account: bankCard, completion: { (result, error) in
+    // Code to handle successful response or error
+    // On successful update, response (HyperwalletBankCard in this case) will contain information about the user’s bank card
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure of bank card updating
+})
+
+

Deactivate Bank Card

+
Hyperwallet.shared.deactivateBankCard(transferMethodToken: "trm-12345", notes: "deactivate bank card", completion: { (result, error) in
+    // Code to handle successful response or error
+    // On successful deactivation, response (HyperwalletStatusTransition in this case) will contain information about the status transition
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure of bank card deactivation
+})
+
+

List Bank Card

+
let bankCardQueryParam = HyperwalletBankCardQueryParam()
+bankCardQueryParam.status = HyperwalletBankCardQueryParam.QueryStatus.activated.rawValue
+bankCardQueryParam.sortBy = HyperwalletBankCardQueryParam.QuerySortable.ascendantCreatedOn.rawValue
+
+Hyperwallet.shared.listBankCards(queryParam: bankCardQueryParam) { (result, error) in
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure
+    guard error == nil else {
+        print(error?.getHyperwalletErrors()?.errorList?)
+        return
+    }
+
+    // On success, response (HyperwalletPageList<HyperwalletBankCard>? in this case) will contain information about or nil if not exist.
+    if let bankCards = result?.data {
+        for bankCard in bankCards {
+            print(bankCard.token ?? "")
+        }
+    }
+}
+
+

Get Prepaid Card

+
Hyperwallet.shared.getPrepaidCard(transferMethodToken: "123123", completion: { (result, error) in
+    // On success, response (HyperwalletPrepaidCard? in this case) will contain information about the user’s prepaid card or nil if not exist.
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure
+})
+
+

List Prepaid Cards

+
let prepaidCardQueryParam = HyperwalletPrepaidCardQueryParam()
+prepaidCardQueryParam.status = HyperwalletPrepaidCardQueryParam.QueryStatus.activated.rawValue
+prepaidCardQueryParam.sortBy = HyperwalletPrepaidCardQueryParam.QuerySortable.ascendantCreatedOn.rawValue
+
+Hyperwallet.shared.listPrepaidCards(queryParam: prepaidCardQueryParam) { (result, error) in
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure
+    guard error == nil else {
+        print(error?.getHyperwalletErrors()?.errorList?)
+        return
+    }
+
+    // On success, response (HyperwalletPageList<HyperwalletPrepaidCard>? in this case) will contain information about or nil if not exist.
+    if let prepaidCards = result?.data {
+        for prepaidCard in prepaidCards {
+            print(prepaidCard.token)
+        }
+    }
+}
+
+

List Prepaid Card Receipts

+
let receiptQueryParam = HyperwalletReceiptQueryParam()
+receiptQueryParam.createdAfter = ISO8601DateFormatter.ignoreTimeZone.date(from: "2016-12-01T00:00:00")
+
+Hyperwallet.shared.listPrepaidCardReceipts(prepaidCardToken: prepaidCardToken,
+                                           queryParam: receiptQueryParam,
+                                           completion: { (result, error) in
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure
+    guard error == nil else {
+        print(error?.getHyperwalletErrors()?.errorList?)
+        return
+    }
+
+    // On success, response (HyperwalletPageList<HyperwalletReceipt>? in this case) will contain information about or nil if not exist.
+    if let receipts = result?.data {
+        for receipt in receipts {
+            print(receipt.destinationToken ?? "")
+        }
+    }
+}
+
+

List User Receipts

+
let receiptQueryParam = HyperwalletReceiptQueryParam()
+receiptQueryParam.createdAfter = ISO8601DateFormatter.ignoreTimeZone.date(from: "2018-12-01T00:00:00")
+receiptQueryParam.currency = "USD"
+receiptQueryParam.sortBy = HyperwalletReceiptQueryParam.QuerySortable.descendantAmount.rawValue
+
+Hyperwallet.shared.listUserReceipts(queryParam: receiptQueryParam) { (result, error) in
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure
+    guard error == nil else {
+        print(error?.getHyperwalletErrors()?.errorList?)
+        return
+        }
+
+    // On success, response (HyperwalletPageList<HyperwalletReceipt>? in this case) will contain information about or nil if not exist.
+    if let receipts = result?.data {
+        for receipt in receipts {
+            print(receipt.destinationToken ?? "")
+        }
+    }
+}
+
+

List Transfer Methods

+
let transferMethodQueryParam = HyperwalletTransferMethodQueryParam()
+transferMethodQueryParam.sortBy = HyperwalletTransferMethodQueryParam.QuerySortable.ascendantCreatedOn.rawValue
+
+Hyperwallet.shared.listTransferMethods(queryParam: transferMethodQueryParam) { (result, error) in
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure
+    guard error == nil else {
+        print(error?.getHyperwalletErrors()?.errorList?)
+        return
+    }
+
+    // On success, response (HyperwalletPageList<HyperwalletTransferMethod>? in this case) will contain information about or nil if not exist.
+    if let transferMethods = result?.data {
+        for transferMethod in transferMethods {
+            print(transferMethod.token ?? "")
+        }
+    }
+}
+
+

Create Transfer

+
let transfer = HyperwalletTransfer.Builder(clientTransferId: "6712348070812",
+                                           sourceToken: "source-token",
+                                           destinationToken: "destination-token")
+    .sourceAmount("100")
+    .sourceCurrency("CAD")
+    .destinationAmount("62.29")
+    .destinationCurrency("USD")
+    .memo("TransferClientId56387")
+    .notes("Partial-Balance Transfer")
+    .build()
+
+Hyperwallet.shared.createTransfer(transfer: transfer, completion: { (result, error) in
+    //Code to handle successful response or error
+    //On successfull creation, response (HyperwalletTransfer in this case) will contain information about the transfer
+    //in case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure of transfer creation
+})
+
+

Schedule Transfer

+
Hyperwallet.shared.scheduleTransfer(transferToken: "trf-123456", completion: { (result, error) in
+    //Code to handle successful response or error
+    // On successful scheduling, response (HyperwalletStatusTransition in this case) will contain information about the status transition
+    //in case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure of transfer creation
+})
+
+

Get Transfer

+
Hyperwallet.shared.getTransfer(transferToken: "trf-123456", completion: { (result, error) in
+    // On success, response (HyperwalletTransfer? in this case) will contain information about the transfer or nil if not exist.
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure
+})
+
+

List Transfers

+
Hyperwallet.shared.listTransfers { (result, error) in
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure
+    guard error == nil else {
+        print(error?.getHyperwalletErrors()?.errorList?)
+        return
+    }
+
+    // On success, response (HyperwalletPageList<HyperwalletTransfer>? in this case) will contain information about or nil if not exist.
+    if let transfers = result?.data {
+        for transfer in transfers {
+            print(transfer.token ?? "")
+        }
+    }
+})
+
+

List User Balances

+
let balanceQueryParam = HyperwalletBalanceQueryParam()
+balanceQueryParam.currency = "USD"
+balanceQueryParam.sortBy = HyperwalletBalanceQueryParam.QuerySortable.descendantAmount.rawValue
+
+Hyperwallet.shared.listUserBalances(queryParam: balanceQueryParam) { (result, error) in
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure
+    guard error == nil else {
+    print(error?.getHyperwalletErrors()?.errorList?)
+    return
+    }
+
+    // On success, response (HyperwalletPageList<HyperwalletBalance>? in this case) will contain information about or nil if not exist.
+    if let balances = result?.data {
+        for balance in balances {
+            print(balance.amount ?? "")
+        }
+    }
+}
+
+

List Prepaid Card Balances

+
let prepaidCardBalanceQueryParam = HyperwalletPrepaidCardBalanceQueryParam()
+prepaidCardBalanceQueryParam.sortBy = HyperwalletPrepaidCardBalanceQueryParam.QuerySortable.descendantAmount.rawValue
+
+Hyperwallet.shared.listPrepaidCardBalances(prepaidCardToken: "trm-1234", queryParam: prepaidCardBalanceQueryParam) { (result, error) in
+    // In case of failure, error (HyperwalletErrorType) will contain HyperwalletErrors containing information about what caused the failure
+    guard error == nil else {
+    print(error?.getHyperwalletErrors()?.errorList?)
+    return
+    }
+
+    // On success, response (HyperwalletPageList<HyperwalletBalance>? in this case) will contain information about or nil if not exist.
+    if let balances = result?.data {
+        for balance in balances {
+            print(balance.amount ?? "")
+        }
+    }
+}
+
+

Transfer Method Configurations

+

Get countries, currencies

+
let keysQuery = HyperwalletTransferMethodConfigurationKeysQuery()
+
+Hyperwallet.shared.retrieveTransferMethodConfigurationKeys(request: keysQuery) { (result, error) in
+
+    guard error == nil else {
+        print(error?.getHyperwalletErrors()?.errorList?)
+        return
+    }
+
+    guard let result = result else { return }
+    // Get countries
+    let countries = result.countries()
+
+    // Get currencies based on the first available country code
+    var currencies: [HyperwalletCurrency]?
+    if let countries = result.countries(), !countries.isEmpty {
+        currencies = result.currencies(from: countries.first!.code)
+    }
+
+    print(countries)
+    print(currencies)
+}
+
+

Get transfer method types, fees and processing times for Country and Currency

+
let country = "CA"
+let currency = "CAD"
+let keysQuery = HyperwalletTransferMethodTypesFeesAndProcessingTimesQuery(country: country, currency: currency)
+
+Hyperwallet
+    .shared
+    .retrieveTransferMethodTypesFeesAndProcessingTimes(request: keysQuery) { (result, error) in
+    guard error == nil else {
+        print(error?.getHyperwalletErrors()?.errorList?)
+        return
+    }
+
+    guard let result = result else { return }
+
+    // Get transfer method types based on the first country code and its first currency code
+    transferMethodTypes = result.transferMethodTypes(countryCode: country, currencyCode: currency)
+    print(transferMethodTypes)
+    print(transferMethodTypes?.first?.fees)
+    print(transferMethodTypes?.first?.processingTimes)
+}
+
+

Get fields for a transfer method type

+
let fieldQuery = HyperwalletTransferMethodConfigurationFieldQuery(country: "CA",
+                                                                  currency: "USD",
+                                                                  transferMethodType: "BANK_ACCOUNT",
+                                                                  profile: "INDIVIDUAL")
+
+Hyperwallet.shared.retrieveTransferMethodConfigurationFields(request: fieldQuery) { (result, error) in
+
+    guard error == nil else {
+        print(error?.getHyperwalletErrors()?.errorList?)
+        return
+    }
+
+    guard let result = result else { return }
+
+    print(result.transferMethodType()))
+    print(result.fieldGroups()?.fields))
+}
+
+

Get fields for updating transfer method

+
let fieldQuery = HyperwalletTransferMethodUpdateConfigurationFieldQuery(transferMethodToken: "trm-0000001")
+
+Hyperwallet.shared.retrieveTransferMethodUpdateConfigurationFields(request: fieldQuery) { (result, error) in
+    guard error == nil else {
+        print(error?.getHyperwalletErrors()?.errorList)
+        return
+    }
+
+    guard let result = result else { return }
+
+    print(result.transferMethodUpdateConfiguration()?.fieldGroups?.nodes)
+    print(result.transferMethodUpdateConfiguration()?.transferMethodType)
+}
+
+

License

+ +

The Hyperwallet iOS SDK is open source and available under the MIT license

+ +
+
+ + +
+
+
+

Copyright (c) 2018-present, Hyperwallet Systems Inc. All rights reserved.

+

Generated by jazzy ♪♫ v0.14.4, a Realm project.

+
+ + diff --git a/search.json b/search.json new file mode 100644 index 00000000..532a155d --- /dev/null +++ b/search.json @@ -0,0 +1 @@ +{"Structs/HyperwalletTransfer/Builder.html#/s:14HyperwalletSDK0A8TransferV7BuilderC06clientC2Id11sourceToken011destinationH0AESS_S2Stcfc":{"name":"init(clientTransferId:sourceToken:destinationToken:)","abstract":"\u003cp\u003eCreates a new instance of the \u003ccode\u003eHyperwalletTransfer.Builder\u003c/code\u003e based on the required parameters to create","parent_name":"Builder"},"Structs/HyperwalletTransfer/Builder.html#/s:14HyperwalletSDK0A8TransferV7BuilderC17destinationAmountyAESSSgF":{"name":"destinationAmount(_:)","abstract":"\u003cp\u003eSets the transfer destination amount.\u003c/p\u003e","parent_name":"Builder"},"Structs/HyperwalletTransfer/Builder.html#/s:14HyperwalletSDK0A8TransferV7BuilderC19destinationCurrencyyAESSSgF":{"name":"destinationCurrency(_:)","abstract":"\u003cp\u003eSets the transfer destination currency.\u003c/p\u003e","parent_name":"Builder"},"Structs/HyperwalletTransfer/Builder.html#/s:14HyperwalletSDK0A8TransferV7BuilderC4memoyAESSSgF":{"name":"memo(_:)","abstract":"\u003cp\u003eSets the transfer memo.\u003c/p\u003e","parent_name":"Builder"},"Structs/HyperwalletTransfer/Builder.html#/s:14HyperwalletSDK0A8TransferV7BuilderC5notesyAESSSgF":{"name":"notes(_:)","abstract":"\u003cp\u003eSets the transfer notes.\u003c/p\u003e","parent_name":"Builder"},"Structs/HyperwalletTransfer/Builder.html#/s:14HyperwalletSDK0A8TransferV7BuilderC12sourceAmountyAESSSgF":{"name":"sourceAmount(_:)","abstract":"\u003cp\u003eSets the transfer source amount.\u003c/p\u003e","parent_name":"Builder"},"Structs/HyperwalletTransfer/Builder.html#/s:14HyperwalletSDK0A8TransferV7BuilderC14sourceCurrencyyAESSSgF":{"name":"sourceCurrency(_:)","abstract":"\u003cp\u003eSets the transfer source currency.\u003c/p\u003e","parent_name":"Builder"},"Structs/HyperwalletTransfer/Builder.html#/s:14HyperwalletSDK0A8TransferV7BuilderC5buildACyF":{"name":"build()","parent_name":"Builder"},"Structs/HyperwalletTransfer/HyperwalletTransferStatus.html#/s:14HyperwalletSDK0A8TransferV0aC6StatusO9cancelledyA2EmF":{"name":"cancelled","abstract":"\u003cp\u003eThe transfer status is cancelled\u003c/p\u003e","parent_name":"HyperwalletTransferStatus"},"Structs/HyperwalletTransfer/HyperwalletTransferStatus.html#/s:14HyperwalletSDK0A8TransferV0aC6StatusO9completedyA2EmF":{"name":"completed","abstract":"\u003cp\u003eThe transfer status is completed\u003c/p\u003e","parent_name":"HyperwalletTransferStatus"},"Structs/HyperwalletTransfer/HyperwalletTransferStatus.html#/s:14HyperwalletSDK0A8TransferV0aC6StatusO7expiredyA2EmF":{"name":"expired","abstract":"\u003cp\u003eThe transfer status is expired\u003c/p\u003e","parent_name":"HyperwalletTransferStatus"},"Structs/HyperwalletTransfer/HyperwalletTransferStatus.html#/s:14HyperwalletSDK0A8TransferV0aC6StatusO6failedyA2EmF":{"name":"failed","abstract":"\u003cp\u003eThe transfer status is failed\u003c/p\u003e","parent_name":"HyperwalletTransferStatus"},"Structs/HyperwalletTransfer/HyperwalletTransferStatus.html#/s:14HyperwalletSDK0A8TransferV0aC6StatusO10inProgressyA2EmF":{"name":"inProgress","abstract":"\u003cp\u003eThe transfer status is in Progress\u003c/p\u003e","parent_name":"HyperwalletTransferStatus"},"Structs/HyperwalletTransfer/HyperwalletTransferStatus.html#/s:14HyperwalletSDK0A8TransferV0aC6StatusO6quotedyA2EmF":{"name":"quoted","abstract":"\u003cp\u003eThe transfer status is quoted\u003c/p\u003e","parent_name":"HyperwalletTransferStatus"},"Structs/HyperwalletTransfer/HyperwalletTransferStatus.html#/s:14HyperwalletSDK0A8TransferV0aC6StatusO8returnedyA2EmF":{"name":"returned","abstract":"\u003cp\u003eThe transfer status is returned\u003c/p\u003e","parent_name":"HyperwalletTransferStatus"},"Structs/HyperwalletTransfer/HyperwalletTransferStatus.html#/s:14HyperwalletSDK0A8TransferV0aC6StatusO9scheduledyA2EmF":{"name":"scheduled","abstract":"\u003cp\u003eThe transfer status is scheduled\u003c/p\u003e","parent_name":"HyperwalletTransferStatus"},"Structs/HyperwalletTransfer/HyperwalletTransferStatus.html#/s:14HyperwalletSDK0A8TransferV0aC6StatusO20verificationRequiredyA2EmF":{"name":"verificationRequired","abstract":"\u003cp\u003eThe verification required\u003c/p\u003e","parent_name":"HyperwalletTransferStatus"},"Structs/HyperwalletTransfer.html#/s:14HyperwalletSDK0A8TransferV06clientC2IdSSvp":{"name":"clientTransferId","abstract":"\u003cp\u003eA value that identifies the client transfer id.\u003c/p\u003e","parent_name":"HyperwalletTransfer"},"Structs/HyperwalletTransfer.html#/s:14HyperwalletSDK0A8TransferV9createdOnSSSgvp":{"name":"createdOn","abstract":"\u003cp\u003eThe created date\u003c/p\u003e","parent_name":"HyperwalletTransfer"},"Structs/HyperwalletTransfer.html#/s:14HyperwalletSDK0A8TransferV17destinationAmountSSSgvp":{"name":"destinationAmount","abstract":"\u003cp\u003eThe destination amount\u003c/p\u003e","parent_name":"HyperwalletTransfer"},"Structs/HyperwalletTransfer.html#/s:14HyperwalletSDK0A8TransferV19destinationCurrencySSSgvp":{"name":"destinationCurrency","abstract":"\u003cp\u003eThe destination currency\u003c/p\u003e","parent_name":"HyperwalletTransfer"},"Structs/HyperwalletTransfer.html#/s:14HyperwalletSDK0A8TransferV20destinationFeeAmountSSSgvp":{"name":"destinationFeeAmount","abstract":"\u003cp\u003eThe destination amount\u003c/p\u003e","parent_name":"HyperwalletTransfer"},"Structs/HyperwalletTransfer.html#/s:14HyperwalletSDK0A8TransferV16destinationTokenSSvp":{"name":"destinationToken","abstract":"\u003cp\u003eThe destination token\u003c/p\u003e","parent_name":"HyperwalletTransfer"},"Structs/HyperwalletTransfer.html#/s:14HyperwalletSDK0A8TransferV9expiresOnSSSgvp":{"name":"expiresOn","abstract":"\u003cp\u003eThe expiresOn\u003c/p\u003e","parent_name":"HyperwalletTransfer"},"Structs/HyperwalletTransfer.html#/s:14HyperwalletSDK0A8TransferV16foreignExchangesSayAA0A15ForeignExchangeVGSgvp":{"name":"foreignExchanges","abstract":"\u003cp\u003eThe list of foreignExchanges\u003c/p\u003e","parent_name":"HyperwalletTransfer"},"Structs/HyperwalletTransfer.html#/s:14HyperwalletSDK0A8TransferV4memoSSSgvp":{"name":"memo","abstract":"\u003cp\u003eThe memo\u003c/p\u003e","parent_name":"HyperwalletTransfer"},"Structs/HyperwalletTransfer.html#/s:14HyperwalletSDK0A8TransferV5notesSSSgvp":{"name":"notes","abstract":"\u003cp\u003eThe notes to add\u003c/p\u003e","parent_name":"HyperwalletTransfer"},"Structs/HyperwalletTransfer.html#/s:14HyperwalletSDK0A8TransferV12sourceAmountSSSgvp":{"name":"sourceAmount","abstract":"\u003cp\u003eThe source amount\u003c/p\u003e","parent_name":"HyperwalletTransfer"},"Structs/HyperwalletTransfer.html#/s:14HyperwalletSDK0A8TransferV14sourceCurrencySSSgvp":{"name":"sourceCurrency","abstract":"\u003cp\u003eThe source currency\u003c/p\u003e","parent_name":"HyperwalletTransfer"},"Structs/HyperwalletTransfer.html#/s:14HyperwalletSDK0A8TransferV15sourceFeeAmountSSSgvp":{"name":"sourceFeeAmount","abstract":"\u003cp\u003eThe source fee\u003c/p\u003e","parent_name":"HyperwalletTransfer"},"Structs/HyperwalletTransfer.html#/s:14HyperwalletSDK0A8TransferV11sourceTokenSSvp":{"name":"sourceToken","abstract":"\u003cp\u003eThe source token\u003c/p\u003e","parent_name":"HyperwalletTransfer"},"Structs/HyperwalletTransfer.html#/s:14HyperwalletSDK0A8TransferV6statusAC0aC6StatusOSgvp":{"name":"status","abstract":"\u003cp\u003eThe transfer status\u003c/p\u003e","parent_name":"HyperwalletTransfer"},"Structs/HyperwalletTransfer.html#/s:14HyperwalletSDK0A8TransferV5tokenSSSgvp":{"name":"token","abstract":"\u003cp\u003eThe token\u003c/p\u003e","parent_name":"HyperwalletTransfer"},"Structs/HyperwalletTransfer/HyperwalletTransferStatus.html":{"name":"HyperwalletTransferStatus","abstract":"\u003cp\u003eRepresentation of a \u003ccode\u003eHyperwalletTransferStatus\u003c/code\u003e\u003c/p\u003e","parent_name":"HyperwalletTransfer"},"Structs/HyperwalletTransfer/Builder.html":{"name":"Builder","abstract":"\u003cp\u003eA helper class to build the \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbStructs/HyperwalletTransfer.html\"\u003eHyperwalletTransfer\u003c/a\u003e\u003c/code\u003e instance.\u003c/p\u003e","parent_name":"HyperwalletTransfer"},"Structs/HyperwalletForeignExchange.html#/s:14HyperwalletSDK0A15ForeignExchangeV17destinationAmountSSSgvp":{"name":"destinationAmount","abstract":"\u003cp\u003eThe destination amount\u003c/p\u003e","parent_name":"HyperwalletForeignExchange"},"Structs/HyperwalletForeignExchange.html#/s:14HyperwalletSDK0A15ForeignExchangeV19destinationCurrencySSSgvp":{"name":"destinationCurrency","abstract":"\u003cp\u003eThe destination currency\u003c/p\u003e","parent_name":"HyperwalletForeignExchange"},"Structs/HyperwalletForeignExchange.html#/s:14HyperwalletSDK0A15ForeignExchangeV4rateSSSgvp":{"name":"rate","abstract":"\u003cp\u003eThe rate\u003c/p\u003e","parent_name":"HyperwalletForeignExchange"},"Structs/HyperwalletForeignExchange.html#/s:14HyperwalletSDK0A15ForeignExchangeV12sourceAmountSSSgvp":{"name":"sourceAmount","abstract":"\u003cp\u003eThe source amount\u003c/p\u003e","parent_name":"HyperwalletForeignExchange"},"Structs/HyperwalletForeignExchange.html#/s:14HyperwalletSDK0A15ForeignExchangeV14sourceCurrencySSSgvp":{"name":"sourceCurrency","abstract":"\u003cp\u003eThe source currency\u003c/p\u003e","parent_name":"HyperwalletForeignExchange"},"Structs/HyperwalletStatusTransition/Builder.html#/s:14HyperwalletSDK0A16StatusTransitionV7BuilderC5notes10transitionAESSSg_AC0C0Otcfc":{"name":"init(notes:transition:)","abstract":"\u003cp\u003eInitialization of Builder\u003c/p\u003e","parent_name":"Builder"},"Structs/HyperwalletStatusTransition/Builder.html#/s:14HyperwalletSDK0A16StatusTransitionV7BuilderC5buildACyF":{"name":"build()","parent_name":"Builder"},"Structs/HyperwalletStatusTransition/Status.html#/s:14HyperwalletSDK0A16StatusTransitionV0C0O9activatedyA2EmF":{"name":"activated","abstract":"\u003cp\u003eThe status is activate.\u003c/p\u003e","parent_name":"Status"},"Structs/HyperwalletStatusTransition/Status.html#/s:14HyperwalletSDK0A16StatusTransitionV0C0O9cancelledyA2EmF":{"name":"cancelled","abstract":"\u003cp\u003eThe status is cancel.\u003c/p\u003e","parent_name":"Status"},"Structs/HyperwalletStatusTransition/Status.html#/s:14HyperwalletSDK0A16StatusTransitionV0C0O9completedyA2EmF":{"name":"completed","abstract":"\u003cp\u003eThe status is complete.\u003c/p\u003e","parent_name":"Status"},"Structs/HyperwalletStatusTransition/Status.html#/s:14HyperwalletSDK0A16StatusTransitionV0C0O11deactivatedyA2EmF":{"name":"deactivated","abstract":"\u003cp\u003eThe status is deactivate.\u003c/p\u003e","parent_name":"Status"},"Structs/HyperwalletStatusTransition/Status.html#/s:14HyperwalletSDK0A16StatusTransitionV0C0O7expiredyA2EmF":{"name":"expired","abstract":"\u003cp\u003eThe status is expire.\u003c/p\u003e","parent_name":"Status"},"Structs/HyperwalletStatusTransition/Status.html#/s:14HyperwalletSDK0A16StatusTransitionV0C0O6failedyA2EmF":{"name":"failed","abstract":"\u003cp\u003eThe status is fail.\u003c/p\u003e","parent_name":"Status"},"Structs/HyperwalletStatusTransition/Status.html#/s:14HyperwalletSDK0A16StatusTransitionV0C0O10inProgressyA2EmF":{"name":"inProgress","abstract":"\u003cp\u003eThe status is in progress.\u003c/p\u003e","parent_name":"Status"},"Structs/HyperwalletStatusTransition/Status.html#/s:14HyperwalletSDK0A16StatusTransitionV0C0O7invalidyA2EmF":{"name":"invalid","abstract":"\u003cp\u003eThe status is invalid.\u003c/p\u003e","parent_name":"Status"},"Structs/HyperwalletStatusTransition/Status.html#/s:14HyperwalletSDK0A16StatusTransitionV0C0O12lostOrStolenyA2EmF":{"name":"lostOrStolen","abstract":"\u003cp\u003eThe status is lost or stolen.\u003c/p\u003e","parent_name":"Status"},"Structs/HyperwalletStatusTransition/Status.html#/s:14HyperwalletSDK0A16StatusTransitionV0C0O24pendingAccountActivationyA2EmF":{"name":"pendingAccountActivation","abstract":"\u003cp\u003eThe status is pending account activation.\u003c/p\u003e","parent_name":"Status"},"Structs/HyperwalletStatusTransition/Status.html#/s:14HyperwalletSDK0A16StatusTransitionV0C0O21pendingIdVerificationyA2EmF":{"name":"pendingIdVerification","abstract":"\u003cp\u003eThe status is pending identity verification.\u003c/p\u003e","parent_name":"Status"},"Structs/HyperwalletStatusTransition/Status.html#/s:14HyperwalletSDK0A16StatusTransitionV0C0O22pendingTaxVerificationyA2EmF":{"name":"pendingTaxVerification","abstract":"\u003cp\u003eThe status is pending tax verification.\u003c/p\u003e","parent_name":"Status"},"Structs/HyperwalletStatusTransition/Status.html#/s:14HyperwalletSDK0A16StatusTransitionV0C0O30pendingTransactionVerificationyA2EmF":{"name":"pendingTransactionVerification","abstract":"\u003cp\u003eThe status is pending transaction verification.\u003c/p\u003e","parent_name":"Status"},"Structs/HyperwalletStatusTransition/Status.html#/s:14HyperwalletSDK0A16StatusTransitionV0C0O27pendingTransferMethodActionyA2EmF":{"name":"pendingTransferMethodAction","abstract":"\u003cp\u003eThe status is pending transfer method action.\u003c/p\u003e","parent_name":"Status"},"Structs/HyperwalletStatusTransition/Status.html#/s:14HyperwalletSDK0A16StatusTransitionV0C0O6quotedyA2EmF":{"name":"quoted","abstract":"\u003cp\u003eThe status is quoted\u003c/p\u003e","parent_name":"Status"},"Structs/HyperwalletStatusTransition/Status.html#/s:14HyperwalletSDK0A16StatusTransitionV0C0O8recalledyA2EmF":{"name":"recalled","abstract":"\u003cp\u003eThe status is recall.\u003c/p\u003e","parent_name":"Status"},"Structs/HyperwalletStatusTransition/Status.html#/s:14HyperwalletSDK0A16StatusTransitionV0C0O8returnedyA2EmF":{"name":"returned","abstract":"\u003cp\u003eThe status is return.\u003c/p\u003e","parent_name":"Status"},"Structs/HyperwalletStatusTransition/Status.html#/s:14HyperwalletSDK0A16StatusTransitionV0C0O9scheduledyA2EmF":{"name":"scheduled","abstract":"\u003cp\u003eThe status is schedule.\u003c/p\u003e","parent_name":"Status"},"Structs/HyperwalletStatusTransition/Status.html#/s:14HyperwalletSDK0A16StatusTransitionV0C0O9suspendedyA2EmF":{"name":"suspended","abstract":"\u003cp\u003eThe status is suspend.\u003c/p\u003e","parent_name":"Status"},"Structs/HyperwalletStatusTransition/Status.html#/s:14HyperwalletSDK0A16StatusTransitionV0C0O11unsuspendedyA2EmF":{"name":"unsuspended","abstract":"\u003cp\u003eThe status is not suspended.\u003c/p\u003e","parent_name":"Status"},"Structs/HyperwalletStatusTransition/Status.html#/s:14HyperwalletSDK0A16StatusTransitionV0C0O20verificationRequiredyA2EmF":{"name":"verificationRequired","abstract":"\u003cp\u003eThe status is verification required\u003c/p\u003e","parent_name":"Status"},"Structs/HyperwalletStatusTransition/Status.html#/s:14HyperwalletSDK0A16StatusTransitionV0C0O8verifiedyA2EmF":{"name":"verified","abstract":"\u003cp\u003eThe status is verified.\u003c/p\u003e","parent_name":"Status"},"Structs/HyperwalletStatusTransition.html#/s:14HyperwalletSDK0A16StatusTransitionV9createdOnSSSgvp":{"name":"createdOn","abstract":"\u003cp\u003eThe datetime the status changed in ISO 8601 format (YYYY-MM-DDThh:mm:ss). Note that the timezone used is UTC,","parent_name":"HyperwalletStatusTransition"},"Structs/HyperwalletStatusTransition.html#/s:14HyperwalletSDK0A16StatusTransitionV04fromC0AC0C0OSgvp":{"name":"fromStatus","abstract":"\u003cp\u003eThe status before the transition.\u003c/p\u003e","parent_name":"HyperwalletStatusTransition"},"Structs/HyperwalletStatusTransition.html#/s:14HyperwalletSDK0A16StatusTransitionV5notesSSSgvp":{"name":"notes","abstract":"\u003cp\u003eComments regarding the status change.\u003c/p\u003e","parent_name":"HyperwalletStatusTransition"},"Structs/HyperwalletStatusTransition.html#/s:14HyperwalletSDK0A16StatusTransitionV5tokenSSSgvp":{"name":"token","abstract":"\u003cp\u003eThe unique, auto-generated status transition identifier.\u003c/p\u003e","parent_name":"HyperwalletStatusTransition"},"Structs/HyperwalletStatusTransition.html#/s:14HyperwalletSDK0A16StatusTransitionV02toC0AC0C0OSgvp":{"name":"toStatus","abstract":"\u003cp\u003eThe status after the transition.\u003c/p\u003e","parent_name":"HyperwalletStatusTransition"},"Structs/HyperwalletStatusTransition.html#/s:14HyperwalletSDK0A16StatusTransitionV10transitionAC0C0OSgvp":{"name":"transition","abstract":"\u003cp\u003eThe new status of the resource.\u003c/p\u003e","parent_name":"HyperwalletStatusTransition"},"Structs/HyperwalletStatusTransition/Status.html":{"name":"Status","abstract":"\u003cp\u003eRepresentation of the status.\u003c/p\u003e","parent_name":"HyperwalletStatusTransition"},"Structs/HyperwalletStatusTransition/Builder.html":{"name":"Builder","abstract":"\u003cp\u003eA helper class to build the \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbStructs/HyperwalletStatusTransition.html\"\u003eHyperwalletStatusTransition\u003c/a\u003e\u003c/code\u003e instance.\u003c/p\u003e","parent_name":"HyperwalletStatusTransition"},"Structs/HyperwalletReceipt/HyperwalletEntryType.html#/s:14HyperwalletSDK0A7ReceiptV0A9EntryTypeO6credityA2EmF":{"name":"credit","abstract":"\u003cp\u003eThe credit entry type\u003c/p\u003e","parent_name":"HyperwalletEntryType"},"Structs/HyperwalletReceipt/HyperwalletEntryType.html#/s:14HyperwalletSDK0A7ReceiptV0A9EntryTypeO5debityA2EmF":{"name":"debit","abstract":"\u003cp\u003eThe debit entry type\u003c/p\u003e","parent_name":"HyperwalletEntryType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO9annualFeeyA2EmF":{"name":"annualFee","abstract":"\u003cp\u003eThe annual fee\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO15annualFeeRefundyA2EmF":{"name":"annualFeeRefund","abstract":"\u003cp\u003eThe annual fee refund\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO18customerServiceFeeyA2EmF":{"name":"customerServiceFee","abstract":"\u003cp\u003eThe customer service fee\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO24customerServiceFeeRefundyA2EmF":{"name":"customerServiceFeeRefund","abstract":"\u003cp\u003eThe customer service fee refund\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO20expeditedShippingFeeyA2EmF":{"name":"expeditedShippingFee","abstract":"\u003cp\u003eThe expedited shipping fee\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO16genericFeeRefundyA2EmF":{"name":"genericFeeRefund","abstract":"\u003cp\u003eThe generic fee refund\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO10monthlyFeeyA2EmF":{"name":"monthlyFee","abstract":"\u003cp\u003eThe monthly fee\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO16monthlyFeeRefundyA2EmF":{"name":"monthlyFeeRefund","abstract":"\u003cp\u003eThe monthly fee refund\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO16paymentExpiryFeeyA2EmF":{"name":"paymentExpiryFee","abstract":"\u003cp\u003eThe payment expiry fee\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO10paymentFeeyA2EmF":{"name":"paymentFee","abstract":"\u003cp\u003eThe payment fee\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO13processingFeeyA2EmF":{"name":"processingFee","abstract":"\u003cp\u003eThe processing fee\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO19standardShippingFeeyA2EmF":{"name":"standardShippingFee","abstract":"\u003cp\u003eThe standard shipping fee\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO11transferFeeyA2EmF":{"name":"transferFee","abstract":"\u003cp\u003eThe transfer fee\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO10adjustmentyA2EmF":{"name":"adjustment","abstract":"\u003cp\u003eThe adjustment\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO7deposityA2EmF":{"name":"deposit","abstract":"\u003cp\u003eThe deposit\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO15foreignExchangeyA2EmF":{"name":"foreignExchange","abstract":"\u003cp\u003eThe foreign exchange\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO16manualAdjustmentyA2EmF":{"name":"manualAdjustment","abstract":"\u003cp\u003eThe manual adjustment\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO17paymentExpirationyA2EmF":{"name":"paymentExpiration","abstract":"\u003cp\u003eThe payment expiration\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO22bankAccountTransferFeeyA2EmF":{"name":"bankAccountTransferFee","abstract":"\u003cp\u003eThe bank account transfer fee\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO25bankAccountTransferReturnyA2EmF":{"name":"bankAccountTransferReturn","abstract":"\u003cp\u003eThe bank account transfer return\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO28bankAccountTransferReturnFeeyA2EmF":{"name":"bankAccountTransferReturnFee","abstract":"\u003cp\u003eThe bank account transfer return fee\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO21transferToBankAccountyA2EmF":{"name":"transferToBankAccount","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO17cardActivationFeeyA2EmF":{"name":"cardActivationFee","abstract":"\u003cp\u003eThe card activation fee\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO23cardActivationFeeWaiveryA2EmF":{"name":"cardActivationFeeWaiver","abstract":"\u003cp\u003eThe card activation fee waiver\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO7cardFeeyA2EmF":{"name":"cardFee","abstract":"\u003cp\u003eThe card fee\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO27manualTransferToPrepaidCardyA2EmF":{"name":"manualTransferToPrepaidCard","abstract":"\u003cp\u003eThe manual transfer to prepaid card\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO28prepaidCardBalanceInquiryFeeyA2EmF":{"name":"prepaidCardBalanceInquiryFee","abstract":"\u003cp\u003eThe prepaid card balance inquiry fee\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO22prepaidCardCashAdvanceyA2EmF":{"name":"prepaidCardCashAdvance","abstract":"\u003cp\u003eThe prepaid card cash advance\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO31prepaidCardDisputedChargeRefundyA2EmF":{"name":"prepaidCardDisputedChargeRefund","abstract":"\u003cp\u003eThe prepaid card disputed charge refund\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO25prepaidCardDisputeDeposityA2EmF":{"name":"prepaidCardDisputeDeposit","abstract":"\u003cp\u003eThe prepaid card dispute deposit\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO36prepaidCardDomesticCashWithdrawalFeeyA2EmF":{"name":"prepaidCardDomesticCashWithdrawalFee","abstract":"\u003cp\u003eThe prepaid card domestic cash withdrawal fee\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO33prepaidCardExchangeRateDifferenceyA2EmF":{"name":"prepaidCardExchangeRateDifference","abstract":"\u003cp\u003eThe prepaid card exchange rate difference\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO23prepaidCardManualUnloadyA2EmF":{"name":"prepaidCardManualUnload","abstract":"\u003cp\u003eThe prepaid card manual unload\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO36prepaidCardOverseasCashWithdrawalFeeyA2EmF":{"name":"prepaidCardOverseasCashWithdrawalFee","abstract":"\u003cp\u003eThe prepaid card overseas cash withdrawal fee\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO23prepaidCardPinChangeFeeyA2EmF":{"name":"prepaidCardPinChangeFee","abstract":"\u003cp\u003eThe prepaid card pin change fee\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO17prepaidCardRefundyA2EmF":{"name":"prepaidCardRefund","abstract":"\u003cp\u003eThe prepaid card refund\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO25prepaidCardReplacementFeeyA2EmF":{"name":"prepaidCardReplacementFee","abstract":"\u003cp\u003eThe prepaid card replacement fee\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO23prepaidCardSaleReversalyA2EmF":{"name":"prepaidCardSaleReversal","abstract":"\u003cp\u003eThe prepaid card sale reversal\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO17prepaidCardUnloadyA2EmF":{"name":"prepaidCardUnload","abstract":"\u003cp\u003eThe prepaid card unload\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO19transferToDebitCardyA2EmF":{"name":"transferToDebitCard","abstract":"\u003cp\u003eThe transfer to debit card\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO21transferToPrepaidCardyA2EmF":{"name":"transferToPrepaidCard","abstract":"\u003cp\u003eThe transfer to prepaid card\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO25prepaidCardAccountDeposityA2EmF":{"name":"prepaidCardAccountDeposit","abstract":"\u003cp\u003eThe prepaid card account deposit\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO21prepaidCardAccountFeeyA2EmF":{"name":"prepaidCardAccountFee","abstract":"\u003cp\u003eThe prepaid card account fee\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO28prepaidCardAnnualFeeDiscountyA2EmF":{"name":"prepaidCardAnnualFeeDiscount","abstract":"\u003cp\u003eThe prepaid card annual fee discount\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO25prepaidCardBillReprintFeeyA2EmF":{"name":"prepaidCardBillReprintFee","abstract":"\u003cp\u003eThe prepaid card bill reprint fee\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO30prepaidCardAtmOrCashAdvanceFeeyA2EmF":{"name":"prepaidCardAtmOrCashAdvanceFee","abstract":"\u003cp\u003eThe prepaid card atm or cash advance fee\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO32prepaidCardCashAdvanceChargebackyA2EmF":{"name":"prepaidCardCashAdvanceChargeback","abstract":"\u003cp\u003eThe prepaid card cash advance chargeback\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO40prepaidCardCashAdvanceChargebackReversalyA2EmF":{"name":"prepaidCardCashAdvanceChargebackReversal","abstract":"\u003cp\u003eThe prepaid card cash advance chargeback reversal\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO29prepaidCardCashAdvanceRepressyA2EmF":{"name":"prepaidCardCashAdvanceRepress","abstract":"\u003cp\u003eThe prepaid card cash advance repress\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO37prepaidCardCashAdvanceRepressReversalyA2EmF":{"name":"prepaidCardCashAdvanceRepressReversal","abstract":"\u003cp\u003eThe prepaid card cash advance repress reversal\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO21prepaidCardChargebackyA2EmF":{"name":"prepaidCardChargeback","abstract":"\u003cp\u003eThe prepaid card chargeback\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO27prepaidCardChargebackRefundyA2EmF":{"name":"prepaidCardChargebackRefund","abstract":"\u003cp\u003eThe prepaid card chargeback refund\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO35prepaidCardChargebackRefundReversalyA2EmF":{"name":"prepaidCardChargebackRefundReversal","abstract":"\u003cp\u003eThe prepaid card chargeback refund reversal\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO29prepaidCardChargebackReversalyA2EmF":{"name":"prepaidCardChargebackReversal","abstract":"\u003cp\u003eThe prepaid card chargeback reversal\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO26prepaidCardCommissionOrFeeyA2EmF":{"name":"prepaidCardCommissionOrFee","abstract":"\u003cp\u003eThe prepaid card commission or fee\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO24prepaidCardDebitTransferyA2EmF":{"name":"prepaidCardDebitTransfer","abstract":"\u003cp\u003eThe prepaid card debit transfer\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO29prepaidCardDocumentRequestFeeyA2EmF":{"name":"prepaidCardDocumentRequestFee","abstract":"\u003cp\u003eThe prepaid card document request fee\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO24prepaidCardEmergencyCashyA2EmF":{"name":"prepaidCardEmergencyCash","abstract":"\u003cp\u003eThe prepaid card emergency cash\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO020prepaidCardEmergencyF0yA2EmF":{"name":"prepaidCardEmergencyCard","abstract":"\u003cp\u003eThe prepaid card emergency card\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO17prepaidCardIncomeyA2EmF":{"name":"prepaidCardIncome","abstract":"\u003cp\u003eThe prepaid card income\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO18prepaidCardLoadFeeyA2EmF":{"name":"prepaidCardLoadFee","abstract":"\u003cp\u003eThe prepaid card load fee\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO33prepaidCardOverduePaymentInterestyA2EmF":{"name":"prepaidCardOverduePaymentInterest","abstract":"\u003cp\u003eThe prepaid card overdue payment interest\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO18prepaidCardPaymentyA2EmF":{"name":"prepaidCardPayment","abstract":"\u003cp\u003eThe prepaid card payment\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO24prepaidCardPinReprintFeeyA2EmF":{"name":"prepaidCardPinReprintFee","abstract":"\u003cp\u003eThe prepaid card pin reprint fee\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO26prepaidCardPriorityPassFeeyA2EmF":{"name":"prepaidCardPriorityPassFee","abstract":"\u003cp\u003eThe prepaid card priority pass fee\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO30prepaidCardPriorityPassRenewalyA2EmF":{"name":"prepaidCardPriorityPassRenewal","abstract":"\u003cp\u003eThe prepaid card priority pass renewal\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO28prepaidCardRecurringInterestyA2EmF":{"name":"prepaidCardRecurringInterest","abstract":"\u003cp\u003eThe prepaid card recurring interest\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO24prepaidCardRefundRepressyA2EmF":{"name":"prepaidCardRefundRepress","abstract":"\u003cp\u003eThe prepaid card refund repress\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO32prepaidCardRefundRepressReversalyA2EmF":{"name":"prepaidCardRefundRepressReversal","abstract":"\u003cp\u003eThe prepaid card refund repress reversal\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO23prepaidCardStatementFeeyA2EmF":{"name":"prepaidCardStatementFee","abstract":"\u003cp\u003eThe prepaid card statement fee\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO30prepaidCardTelephoneSupportFeeyA2EmF":{"name":"prepaidCardTelephoneSupportFee","abstract":"\u003cp\u003eThe prepaid card telephone support fee\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO22prepaidCardTransferFeeyA2EmF":{"name":"prepaidCardTransferFee","abstract":"\u003cp\u003eThe prepaid card transfer fee\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO25prepaidCardTransferReturnyA2EmF":{"name":"prepaidCardTransferReturn","abstract":"\u003cp\u003eThe prepaid card transfer return\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO35prepaidCardBankWithdrawalChargebackyA2EmF":{"name":"prepaidCardBankWithdrawalChargeback","abstract":"\u003cp\u003eThe prepaid card bank withdrawal chargeback\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO20prepaidCardRefundfeeyA2EmF":{"name":"prepaidCardRefundfee","abstract":"\u003cp\u003eThe prepaid card refund fee\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO32prepaidCardMonthlyMaintenanceFeeyA2EmF":{"name":"prepaidCardMonthlyMaintenanceFee","abstract":"\u003cp\u003eThe prepaid card monthly maintenance fee\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO25prepaidCardTransactionFeeyA2EmF":{"name":"prepaidCardTransactionFee","abstract":"\u003cp\u003eThe prepaid card transaction fee\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO17prepaidCardSmsFeeyA2EmF":{"name":"prepaidCardSmsFee","abstract":"\u003cp\u003eThe prepaid card sms fee\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO35prepaidCardDeclinedAuthorizationFeeyA2EmF":{"name":"prepaidCardDeclinedAuthorizationFee","abstract":"\u003cp\u003eThe prepaid card declined authorization fee\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO5fispcyA2EmF":{"name":"fispc","abstract":"\u003cp\u003eThe prepaid card purchases\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO8donationyA2EmF":{"name":"donation","abstract":"\u003cp\u003eThe donation\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO11donationFeeyA2EmF":{"name":"donationFee","abstract":"\u003cp\u003eThe donation fee\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO14donationReturnyA2EmF":{"name":"donationReturn","abstract":"\u003cp\u003eThe donation return\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO15merchantPaymentyA2EmF":{"name":"merchantPayment","abstract":"\u003cp\u003eThe merchant payment\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO18merchantPaymentFeeyA2EmF":{"name":"merchantPaymentFee","abstract":"\u003cp\u003eThe merchant payment fee\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO21merchantPaymentRefundyA2EmF":{"name":"merchantPaymentRefund","abstract":"\u003cp\u003eThe merchant payment refund\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO21merchantPaymentReturnyA2EmF":{"name":"merchantPaymentReturn","abstract":"\u003cp\u003eThe merchant payment return\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO23moneygramTransferReturnyA2EmF":{"name":"moneygramTransferReturn","abstract":"\u003cp\u003eThe money gram transfer return\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO19transferToMoneygramyA2EmF":{"name":"transferToMoneygram","abstract":"\u003cp\u003eThe transfer to money gram\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO13paperCheckFeeyA2EmF":{"name":"paperCheckFee","abstract":"\u003cp\u003eThe paper check fee\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO16paperCheckRefundyA2EmF":{"name":"paperCheckRefund","abstract":"\u003cp\u003eThe paper check refund\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO20transferToPaperCheckyA2EmF":{"name":"transferToPaperCheck","abstract":"\u003cp\u003eThe transfer to paper check\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO14accountClosureyA2EmF":{"name":"accountClosure","abstract":"\u003cp\u003eThe account to be closed\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO17accountClosureFeeyA2EmF":{"name":"accountClosureFee","abstract":"\u003cp\u003eThe account closure fee\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO13accountUnloadyA2EmF":{"name":"accountUnload","abstract":"\u003cp\u003eThe account unload\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO14dormantUserFeeyA2EmF":{"name":"dormantUserFee","abstract":"\u003cp\u003eThe dormant user fee\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO20dormantUserFeeRefundyA2EmF":{"name":"dormantUserFeeRefund","abstract":"\u003cp\u003eThe dormant user fee refund\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO7paymentyA2EmF":{"name":"payment","abstract":"\u003cp\u003eThe payment\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO19paymentCancellationyA2EmF":{"name":"paymentCancellation","abstract":"\u003cp\u003eThe payment cancellation\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO15paymentReversalyA2EmF":{"name":"paymentReversal","abstract":"\u003cp\u003eThe payment reversal\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO18paymentReversalFeeyA2EmF":{"name":"paymentReversalFee","abstract":"\u003cp\u003eThe payment reversal fee\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO13paymentReturnyA2EmF":{"name":"paymentReturn","abstract":"\u003cp\u003eThe payment return\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO24transferToProgramAccountyA2EmF":{"name":"transferToProgramAccount","abstract":"\u003cp\u003eThe transfer to program account\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO14transferToUseryA2EmF":{"name":"transferToUser","abstract":"\u003cp\u003eThe transfer to user\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO28virtualIncentiveCancellationyA2EmF":{"name":"virtualIncentiveCancellation","abstract":"\u003cp\u003eThe virtual incentive cancellation\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO24virtualIncentiveIssuanceyA2EmF":{"name":"virtualIncentiveIssuance","abstract":"\u003cp\u003eThe virtual incentive issuance\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO24virtualIncentivePurchaseyA2EmF":{"name":"virtualIncentivePurchase","abstract":"\u003cp\u003eThe virtual incentive purchase\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO22virtualIncentiveRefundyA2EmF":{"name":"virtualIncentiveRefund","abstract":"\u003cp\u003eThe virtual incentive refund\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO22transferToWesternUnionyA2EmF":{"name":"transferToWesternUnion","abstract":"\u003cp\u003eThe transfer to western union\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO18transferToWubsWireyA2EmF":{"name":"transferToWubsWire","abstract":"\u003cp\u003eThe transfer to wubs wire\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO26westernUnionTransferReturnyA2EmF":{"name":"westernUnionTransferReturn","abstract":"\u003cp\u003eThe western union transfer return\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO22wubsWireTransferReturnyA2EmF":{"name":"wubsWireTransferReturn","abstract":"\u003cp\u003eThe wubs wire transfer return\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO14transferToWireyA2EmF":{"name":"transferToWire","abstract":"\u003cp\u003eThe transfer to Wire\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO15wireTransferFeeyA2EmF":{"name":"wireTransferFee","abstract":"\u003cp\u003eThe wire transfer fee\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO18wireTransferReturnyA2EmF":{"name":"wireTransferReturn","abstract":"\u003cp\u003eThe wire transfer return\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO15prepaidCardSaleyA2EmF":{"name":"prepaidCardSale","abstract":"\u003cp\u003eThe prepaid card sale\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO23transferToPayPalAccountyA2EmF":{"name":"transferToPayPalAccount","abstract":"\u003cp\u003eTransfer to PayPal account\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO27paypalAccountTransferReturnyA2EmF":{"name":"paypalAccountTransferReturn","abstract":"\u003cp\u003eReturn to Paypal Account\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO22transferToVenmoAccountyA2EmF":{"name":"transferToVenmoAccount","abstract":"\u003cp\u003eTransfer to Venmo account\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO26venmoAccountTransferReturnyA2EmF":{"name":"venmoAccountTransferReturn","abstract":"\u003cp\u003eReturn to Venmo account\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO18transferToBankCardyA2EmF":{"name":"transferToBankCard","abstract":"\u003cp\u003eTransfer To Bank Card\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO7unknownyA2EmF":{"name":"unknown","abstract":"\u003cp\u003eDefault - unknown transfer type\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html#/s:14HyperwalletSDK0A7ReceiptV0aC4TypeO4fromAEs7Decoder_p_tKcfc":{"name":"init(from:)","abstract":"\u003cp\u003eA safe initializer for creating a HyperwalletReceiptType object\u003c/p\u003e","parent_name":"HyperwalletReceiptType"},"Structs/HyperwalletReceipt.html#/s:14HyperwalletSDK0A7ReceiptV6amountSSSgvp":{"name":"amount","abstract":"\u003cp\u003eThe gross amount of the transaction.\u003c/p\u003e","parent_name":"HyperwalletReceipt"},"Structs/HyperwalletReceipt.html#/s:14HyperwalletSDK0A7ReceiptV9createdOnSSSgvp":{"name":"createdOn","abstract":"\u003cp\u003eThe datetime the transaction was created on in ISO 8601 format \u0026lsquo;YYYY-MM-DDThh:mm:ss\u0026rsquo; (UTC timezone)\u003c/p\u003e","parent_name":"HyperwalletReceipt"},"Structs/HyperwalletReceipt.html#/s:14HyperwalletSDK0A7ReceiptV8currencySSSgvp":{"name":"currency","abstract":"\u003cp\u003eThe 3-letter currency code for the transaction.\u003c/p\u003e","parent_name":"HyperwalletReceipt"},"Structs/HyperwalletReceipt.html#/s:14HyperwalletSDK0A7ReceiptV16destinationTokenSSSgvp":{"name":"destinationToken","abstract":"\u003cp\u003eA token identifying where the funds were sent.\u003c/p\u003e","parent_name":"HyperwalletReceipt"},"Structs/HyperwalletReceipt.html#/s:14HyperwalletSDK0A7ReceiptV7detailsAA0aC7DetailsVSgvp":{"name":"details","abstract":"\u003cp\u003eDetails of the transaction.\u003c/p\u003e","parent_name":"HyperwalletReceipt"},"Structs/HyperwalletReceipt.html#/s:14HyperwalletSDK0A7ReceiptV5entryAC0A9EntryTypeOSgvp":{"name":"entry","abstract":"\u003cp\u003eThe type of transaction.\u003c/p\u003e","parent_name":"HyperwalletReceipt"},"Structs/HyperwalletReceipt.html#/s:14HyperwalletSDK0A7ReceiptV3feeSSSgvp":{"name":"fee","abstract":"\u003cp\u003eThe fee amount.\u003c/p\u003e","parent_name":"HyperwalletReceipt"},"Structs/HyperwalletReceipt.html#/s:14HyperwalletSDK0A7ReceiptV23foreignExchangeCurrencySSSgvp":{"name":"foreignExchangeCurrency","abstract":"\u003cp\u003eThe 3-letter currency code for the foreign exchange.\u003c/p\u003e","parent_name":"HyperwalletReceipt"},"Structs/HyperwalletReceipt.html#/s:14HyperwalletSDK0A7ReceiptV19foreignExchangeRateSSSgvp":{"name":"foreignExchangeRate","abstract":"\u003cp\u003eThe foreign exchange rate.\u003c/p\u003e","parent_name":"HyperwalletReceipt"},"Structs/HyperwalletReceipt.html#/s:14HyperwalletSDK0A7ReceiptV9journalIdSSSgvp":{"name":"journalId","abstract":"\u003cp\u003eThe journal entry number for the transaction.\u003c/p\u003e","parent_name":"HyperwalletReceipt"},"Structs/HyperwalletReceipt.html#/s:14HyperwalletSDK0A7ReceiptV11sourceTokenSSSgvp":{"name":"sourceToken","abstract":"\u003cp\u003eA token identifying the source of funds.\u003c/p\u003e","parent_name":"HyperwalletReceipt"},"Structs/HyperwalletReceipt.html#/s:14HyperwalletSDK0A7ReceiptV4typeAC0aC4TypeOSgvp":{"name":"type","abstract":"\u003cp\u003eThe transaction type.\u003c/p\u003e","parent_name":"HyperwalletReceipt"},"Structs/HyperwalletReceipt.html#/s:SQ2eeoiySbx_xtFZ":{"name":"==(_:_:)","parent_name":"HyperwalletReceipt"},"Structs/HyperwalletReceipt/HyperwalletReceiptType.html":{"name":"HyperwalletReceiptType","abstract":"\u003cp\u003eThe transaction type.\u003c/p\u003e","parent_name":"HyperwalletReceipt"},"Structs/HyperwalletReceipt/HyperwalletEntryType.html":{"name":"HyperwalletEntryType","abstract":"\u003cp\u003eThe entry type.\u003c/p\u003e","parent_name":"HyperwalletReceipt"},"Structs/HyperwalletReceiptDetails.html#/s:14HyperwalletSDK0A14ReceiptDetailsV13bankAccountIdSSSgvp":{"name":"bankAccountId","abstract":"\u003cp\u003eThe bank account number, IBAN or equivalent\u003c/p\u003e","parent_name":"HyperwalletReceiptDetails"},"Structs/HyperwalletReceiptDetails.html#/s:14HyperwalletSDK0A14ReceiptDetailsV18bankAccountPurposeSSSgvp":{"name":"bankAccountPurpose","abstract":"\u003cp\u003eThe bank account type, e.g. CHECKING or SAVINGS\u003c/p\u003e","parent_name":"HyperwalletReceiptDetails"},"Structs/HyperwalletReceiptDetails.html#/s:14HyperwalletSDK0A14ReceiptDetailsV6bankIdSSSgvp":{"name":"bankId","abstract":"\u003cp\u003eThe bank code, BIC/SWIFT or equivalent\u003c/p\u003e","parent_name":"HyperwalletReceiptDetails"},"Structs/HyperwalletReceiptDetails.html#/s:14HyperwalletSDK0A14ReceiptDetailsV8bankNameSSSgvp":{"name":"bankName","abstract":"\u003cp\u003eThe bank name\u003c/p\u003e","parent_name":"HyperwalletReceiptDetails"},"Structs/HyperwalletReceiptDetails.html#/s:14HyperwalletSDK0A14ReceiptDetailsV18branchAddressLine1SSSgvp":{"name":"branchAddressLine1","abstract":"\u003cp\u003eThe branch address, first line\u003c/p\u003e","parent_name":"HyperwalletReceiptDetails"},"Structs/HyperwalletReceiptDetails.html#/s:14HyperwalletSDK0A14ReceiptDetailsV18branchAddressLine2SSSgvp":{"name":"branchAddressLine2","abstract":"\u003cp\u003eThe branch address, second line\u003c/p\u003e","parent_name":"HyperwalletReceiptDetails"},"Structs/HyperwalletReceiptDetails.html#/s:14HyperwalletSDK0A14ReceiptDetailsV10branchCitySSSgvp":{"name":"branchCity","abstract":"\u003cp\u003eThe branch city\u003c/p\u003e","parent_name":"HyperwalletReceiptDetails"},"Structs/HyperwalletReceiptDetails.html#/s:14HyperwalletSDK0A14ReceiptDetailsV13branchCountrySSSgvp":{"name":"branchCountry","abstract":"\u003cp\u003eThe 2-letter country code of the branch\u003c/p\u003e","parent_name":"HyperwalletReceiptDetails"},"Structs/HyperwalletReceiptDetails.html#/s:14HyperwalletSDK0A14ReceiptDetailsV8branchIdSSSgvp":{"name":"branchId","abstract":"\u003cp\u003eThe branch code or equivalent\u003c/p\u003e","parent_name":"HyperwalletReceiptDetails"},"Structs/HyperwalletReceiptDetails.html#/s:14HyperwalletSDK0A14ReceiptDetailsV10branchNameSSSgvp":{"name":"branchName","abstract":"\u003cp\u003eThe branch name\u003c/p\u003e","parent_name":"HyperwalletReceiptDetails"},"Structs/HyperwalletReceiptDetails.html#/s:14HyperwalletSDK0A14ReceiptDetailsV16branchPostalCodeSSSgvp":{"name":"branchPostalCode","abstract":"\u003cp\u003eThe branch postal code\u003c/p\u003e","parent_name":"HyperwalletReceiptDetails"},"Structs/HyperwalletReceiptDetails.html#/s:14HyperwalletSDK0A14ReceiptDetailsV19branchStateProvinceSSSgvp":{"name":"branchStateProvince","abstract":"\u003cp\u003eThe branch state or province\u003c/p\u003e","parent_name":"HyperwalletReceiptDetails"},"Structs/HyperwalletReceiptDetails.html#/s:14HyperwalletSDK0A14ReceiptDetailsV14cardExpiryDateSSSgvp":{"name":"cardExpiryDate","abstract":"\u003cp\u003eThe card expiry date in YYYY-MM format\u003c/p\u003e","parent_name":"HyperwalletReceiptDetails"},"Structs/HyperwalletReceiptDetails.html#/s:14HyperwalletSDK0A14ReceiptDetailsV14cardHolderNameSSSgvp":{"name":"cardHolderName","abstract":"\u003cp\u003eThe card holder\u0026rsquo;s full name\u003c/p\u003e","parent_name":"HyperwalletReceiptDetails"},"Structs/HyperwalletReceiptDetails.html#/s:14HyperwalletSDK0A14ReceiptDetailsV10cardNumberSSSgvp":{"name":"cardNumber","abstract":"\u003cp\u003eThe card number\u003c/p\u003e","parent_name":"HyperwalletReceiptDetails"},"Structs/HyperwalletReceiptDetails.html#/s:14HyperwalletSDK0A14ReceiptDetailsV11charityNameSSSgvp":{"name":"charityName","abstract":"\u003cp\u003eThe name of the charity that is receiving the donation\u003c/p\u003e","parent_name":"HyperwalletReceiptDetails"},"Structs/HyperwalletReceiptDetails.html#/s:14HyperwalletSDK0A14ReceiptDetailsV11checkNumberSSSgvp":{"name":"checkNumber","abstract":"\u003cp\u003eThe paper check number\u003c/p\u003e","parent_name":"HyperwalletReceiptDetails"},"Structs/HyperwalletReceiptDetails.html#/s:14HyperwalletSDK0A14ReceiptDetailsV15clientPaymentIdSSSgvp":{"name":"clientPaymentId","abstract":"\u003cp\u003eThe client-assigned transaction identifier\u003c/p\u003e","parent_name":"HyperwalletReceiptDetails"},"Structs/HyperwalletReceiptDetails.html#/s:14HyperwalletSDK0A14ReceiptDetailsV4memoSSSgvp":{"name":"memo","abstract":"\u003cp\u003eAn internal note added by a client operator\u003c/p\u003e","parent_name":"HyperwalletReceiptDetails"},"Structs/HyperwalletReceiptDetails.html#/s:14HyperwalletSDK0A14ReceiptDetailsV5notesSSSgvp":{"name":"notes","abstract":"\u003cp\u003eA description for the receipt\u003c/p\u003e","parent_name":"HyperwalletReceiptDetails"},"Structs/HyperwalletReceiptDetails.html#/s:14HyperwalletSDK0A14ReceiptDetailsV17payeeAddressLine1SSSgvp":{"name":"payeeAddressLine1","abstract":"\u003cp\u003eThe payee\u0026rsquo;s address first line\u003c/p\u003e","parent_name":"HyperwalletReceiptDetails"},"Structs/HyperwalletReceiptDetails.html#/s:14HyperwalletSDK0A14ReceiptDetailsV17payeeAddressLine2SSSgvp":{"name":"payeeAddressLine2","abstract":"\u003cp\u003eThe payee\u0026rsquo;s address, second line\u003c/p\u003e","parent_name":"HyperwalletReceiptDetails"},"Structs/HyperwalletReceiptDetails.html#/s:14HyperwalletSDK0A14ReceiptDetailsV9payeeCitySSSgvp":{"name":"payeeCity","abstract":"\u003cp\u003eThe payee\u0026rsquo;s city\u003c/p\u003e","parent_name":"HyperwalletReceiptDetails"},"Structs/HyperwalletReceiptDetails.html#/s:14HyperwalletSDK0A14ReceiptDetailsV12payeeCountrySSSgvp":{"name":"payeeCountry","abstract":"\u003cp\u003eThe payee\u0026rsquo;s 2-letter country code\u003c/p\u003e","parent_name":"HyperwalletReceiptDetails"},"Structs/HyperwalletReceiptDetails.html#/s:14HyperwalletSDK0A14ReceiptDetailsV10payeeEmailSSSgvp":{"name":"payeeEmail","abstract":"\u003cp\u003eThe payee\u0026rsquo;s email address on record\u003c/p\u003e","parent_name":"HyperwalletReceiptDetails"},"Structs/HyperwalletReceiptDetails.html#/s:14HyperwalletSDK0A14ReceiptDetailsV9payeeNameSSSgvp":{"name":"payeeName","abstract":"\u003cp\u003eThe payee\u0026rsquo;s full name\u003c/p\u003e","parent_name":"HyperwalletReceiptDetails"},"Structs/HyperwalletReceiptDetails.html#/s:14HyperwalletSDK0A14ReceiptDetailsV15payeePostalCodeSSSgvp":{"name":"payeePostalCode","abstract":"\u003cp\u003eThe payee\u0026rsquo;s postal code, ZIP code or equivalent\u003c/p\u003e","parent_name":"HyperwalletReceiptDetails"},"Structs/HyperwalletReceiptDetails.html#/s:14HyperwalletSDK0A14ReceiptDetailsV18payeeStateProvinceSSSgvp":{"name":"payeeStateProvince","abstract":"\u003cp\u003eThe payee\u0026rsquo;s state or province\u003c/p\u003e","parent_name":"HyperwalletReceiptDetails"},"Structs/HyperwalletReceiptDetails.html#/s:14HyperwalletSDK0A14ReceiptDetailsV9payerNameSSSgvp":{"name":"payerName","abstract":"\u003cp\u003eThe payer\u0026rsquo;s full name\u003c/p\u003e","parent_name":"HyperwalletReceiptDetails"},"Structs/HyperwalletReceiptDetails.html#/s:14HyperwalletSDK0A14ReceiptDetailsV17paymentExpiryDateSSSgvp":{"name":"paymentExpiryDate","abstract":"\u003cp\u003eThe payment expiry date in YYYY-MM-DD format\u003c/p\u003e","parent_name":"HyperwalletReceiptDetails"},"Structs/HyperwalletReceiptDetails.html#/s:14HyperwalletSDK0A14ReceiptDetailsV20returnOrRecallReasonSSSgvp":{"name":"returnOrRecallReason","abstract":"\u003cp\u003eThe reason for returning or recalling the payment\u003c/p\u003e","parent_name":"HyperwalletReceiptDetails"},"Structs/HyperwalletReceiptDetails.html#/s:14HyperwalletSDK0A14ReceiptDetailsV14securityAnswerSSSgvp":{"name":"securityAnswer","abstract":"\u003cp\u003eThe answer to the securityQuestion\u003c/p\u003e","parent_name":"HyperwalletReceiptDetails"},"Structs/HyperwalletReceiptDetails.html#/s:14HyperwalletSDK0A14ReceiptDetailsV16securityQuestionSSSgvp":{"name":"securityQuestion","abstract":"\u003cp\u003eA security question\u003c/p\u003e","parent_name":"HyperwalletReceiptDetails"},"Structs/HyperwalletReceiptDetails.html#/s:14HyperwalletSDK0A14ReceiptDetailsV7websiteSSSgvp":{"name":"website","abstract":"\u003cp\u003eThe URL of the client website where the virtual incentive was accrued\u003c/p\u003e","parent_name":"HyperwalletReceiptDetails"},"Structs/HyperwalletPageParameter.html#/s:14HyperwalletSDK0A13PageParameterV3relSSSgvp":{"name":"rel","abstract":"\u003cp\u003eThe relationship\u003c/p\u003e","parent_name":"HyperwalletPageParameter"},"Structs/HyperwalletPageLink.html#/s:14HyperwalletSDK0A8PageLinkV4href10Foundation3URLVSgvp":{"name":"href","abstract":"\u003cp\u003eThe URL of the link\u003c/p\u003e","parent_name":"HyperwalletPageLink"},"Structs/HyperwalletPageLink.html#/s:14HyperwalletSDK0A8PageLinkV6paramsAA0aC9ParameterVSgvp":{"name":"params","abstract":"\u003cp\u003eThe \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbStructs/HyperwalletPageParameter.html\"\u003eHyperwalletPageParameter\u003c/a\u003e\u003c/code\u003e\u003c/p\u003e","parent_name":"HyperwalletPageLink"},"Structs/HyperwalletPageList.html#/s:14HyperwalletSDK0A8PageListV5countSiSgvp":{"name":"count","abstract":"\u003cp\u003eThe amount of the dataset\u003c/p\u003e","parent_name":"HyperwalletPageList"},"Structs/HyperwalletPageList.html#/s:14HyperwalletSDK0A8PageListV4dataSayxGSgvp":{"name":"data","abstract":"\u003cp\u003eThe \u003ccode\u003eListType\u003c/code\u003e items\u003c/p\u003e","parent_name":"HyperwalletPageList"},"Structs/HyperwalletPageList.html#/s:14HyperwalletSDK0A8PageListV5limitSiSgvp":{"name":"limit","abstract":"\u003cp\u003eThe maximum number of records that will be returned per page\u003c/p\u003e","parent_name":"HyperwalletPageList"},"Structs/HyperwalletPageList.html#/s:14HyperwalletSDK0A8PageListV5linksSayAA0aC4LinkVGSgvp":{"name":"links","abstract":"\u003cp\u003eThe links\u003c/p\u003e","parent_name":"HyperwalletPageList"},"Structs/HyperwalletPageList.html#/s:14HyperwalletSDK0A8PageListV6offsetSiSgvp":{"name":"offset","abstract":"\u003cp\u003eThe number of records to skip.\u003c/p\u003e","parent_name":"HyperwalletPageList"},"Structs/HyperwalletTransferMethodUpdateConfigurationFieldQuery.html#/s:14HyperwalletSDK0A43TransferMethodUpdateConfigurationFieldQueryV08transferD5TokenACSS_tcfc":{"name":"init(transferMethodToken:)","abstract":"\u003cp\u003eCreate a new \u003ccode\u003eHyperwalletTransferMethodUpdateConfigurationFieldQuery\u003c/code\u003e from the transferMethodToken\u003c/p\u003e","parent_name":"HyperwalletTransferMethodUpdateConfigurationFieldQuery"},"Structs/HyperwalletTransferMethodUpdateConfigurationFieldQuery.html#/s:14HyperwalletSDK12GraphQlQueryP02tocD09userTokenS2S_tF":{"name":"toGraphQl(userToken:)","parent_name":"HyperwalletTransferMethodUpdateConfigurationFieldQuery"},"Structs/HyperwalletTransferMethodUpdateConfigurationFieldQuery.html#/s:SH4hash4intoys6HasherVz_tF":{"name":"hash(into:)","parent_name":"HyperwalletTransferMethodUpdateConfigurationFieldQuery"},"Structs/HyperwalletTransferMethodTypesFeesAndProcessingTimesQuery.html#/s:14HyperwalletSDK12GraphQlQueryP02tocD09userTokenS2S_tF":{"name":"toGraphQl(userToken:)","parent_name":"HyperwalletTransferMethodTypesFeesAndProcessingTimesQuery"},"Structs/HyperwalletTransferMethodTypesFeesAndProcessingTimesQuery.html#/s:SH4hash4intoys6HasherVz_tF":{"name":"hash(into:)","parent_name":"HyperwalletTransferMethodTypesFeesAndProcessingTimesQuery"},"Structs/HyperwalletTransferMethodConfigurationKeysQuery.html#/s:14HyperwalletSDK0A36TransferMethodConfigurationKeysQueryV5limitACSi_tcfc":{"name":"init(limit:)","abstract":"\u003cp\u003e/ Create a new \u003ccode\u003eHyperwalletTransferMethodConfigurationKeysQuery\u003c/code\u003e instance\u003c/p\u003e","parent_name":"HyperwalletTransferMethodConfigurationKeysQuery"},"Structs/HyperwalletTransferMethodConfigurationKeysQuery.html#/s:14HyperwalletSDK12GraphQlQueryP02tocD09userTokenS2S_tF":{"name":"toGraphQl(userToken:)","parent_name":"HyperwalletTransferMethodConfigurationKeysQuery"},"Structs/HyperwalletTransferMethodConfigurationFieldQuery.html#/s:14HyperwalletSDK0A37TransferMethodConfigurationFieldQueryV7country8currency08transferD4Type7profileACSS_S3Stcfc":{"name":"init(country:currency:transferMethodType:profile:)","abstract":"\u003cp\u003eCreate a new \u003ccode\u003eHyperwalletTransferMethodConfigurationQuery\u003c/code\u003e from the country, currency, transferMethodType","parent_name":"HyperwalletTransferMethodConfigurationFieldQuery"},"Structs/HyperwalletTransferMethodConfigurationFieldQuery.html#/s:14HyperwalletSDK12GraphQlQueryP02tocD09userTokenS2S_tF":{"name":"toGraphQl(userToken:)","parent_name":"HyperwalletTransferMethodConfigurationFieldQuery"},"Structs/HyperwalletTransferMethodConfigurationFieldQuery.html#/s:SH4hash4intoys6HasherVz_tF":{"name":"hash(into:)","parent_name":"HyperwalletTransferMethodConfigurationFieldQuery"},"Structs/HyperwalletConditionalPattern.html#/s:14HyperwalletSDK0A18ConditionalPatternV7patternSSvp":{"name":"pattern","abstract":"\u003cp\u003eThe pattern\u003c/p\u003e","parent_name":"HyperwalletConditionalPattern"},"Structs/HyperwalletConditionalPattern.html#/s:14HyperwalletSDK0A18ConditionalPatternV5regexSSvp":{"name":"regex","abstract":"\u003cp\u003eThe regex\u003c/p\u003e","parent_name":"HyperwalletConditionalPattern"},"Structs/HyperwalletMask.html#/s:14HyperwalletSDK0A4MaskV19conditionalPatternsSayAA0A18ConditionalPatternVGSgvp":{"name":"conditionalPatterns","abstract":"\u003cp\u003eThe conditional pattern, or nil if none exists\u003c/p\u003e","parent_name":"HyperwalletMask"},"Structs/HyperwalletMask.html#/s:14HyperwalletSDK0A4MaskV14defaultPatternSSvp":{"name":"defaultPattern","abstract":"\u003cp\u003eThe default pattern\u003c/p\u003e","parent_name":"HyperwalletMask"},"Structs/HyperwalletMask.html#/s:14HyperwalletSDK0A4MaskV10scrubRegexSSSgvp":{"name":"scrubRegex","abstract":"\u003cp\u003eThe scrub regex, or nil if none exists\u003c/p\u003e","parent_name":"HyperwalletMask"},"Structs/HyperwalletTransferMethodConfiguration.html#/s:14HyperwalletSDK0A27TransferMethodConfigurationV7countrySSSgvp":{"name":"country","abstract":"\u003cp\u003eThe country\u003c/p\u003e","parent_name":"HyperwalletTransferMethodConfiguration"},"Structs/HyperwalletTransferMethodConfiguration.html#/s:14HyperwalletSDK0A27TransferMethodConfigurationV8currencySSSgvp":{"name":"currency","abstract":"\u003cp\u003eThe currency\u003c/p\u003e","parent_name":"HyperwalletTransferMethodConfiguration"},"Structs/HyperwalletTransferMethodConfiguration.html#/s:14HyperwalletSDK0A27TransferMethodConfigurationV08transferD4TypeSSSgvp":{"name":"transferMethodType","abstract":"\u003cp\u003eThe transfer method type\u003c/p\u003e","parent_name":"HyperwalletTransferMethodConfiguration"},"Structs/HyperwalletTransferMethodConfiguration.html#/s:14HyperwalletSDK0A27TransferMethodConfigurationV7profileSSSgvp":{"name":"profile","abstract":"\u003cp\u003eThe profile type\u003c/p\u003e","parent_name":"HyperwalletTransferMethodConfiguration"},"Structs/HyperwalletTransferMethodConfiguration.html#/s:14HyperwalletSDK0A27TransferMethodConfigurationV11fieldGroupsAA10ConnectionVyAA0A10FieldGroupVGSgvp":{"name":"fieldGroups","abstract":"\u003cp\u003eThe \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbStructs/HyperwalletFieldGroup.html\"\u003eHyperwalletFieldGroup\u003c/a\u003e\u003c/code\u003e, or nil if none exists\u003c/p\u003e","parent_name":"HyperwalletTransferMethodConfiguration"},"Structs/HyperwalletValidationMessage.html#/s:14HyperwalletSDK0A17ValidationMessageV6lengthSSSgvp":{"name":"length","abstract":"\u003cp\u003eThe validation message length, or nil if none exists\u003c/p\u003e","parent_name":"HyperwalletValidationMessage"},"Structs/HyperwalletValidationMessage.html#/s:14HyperwalletSDK0A17ValidationMessageV7patternSSSgvp":{"name":"pattern","abstract":"\u003cp\u003eThe validation message pattern, or nil if none exists\u003c/p\u003e","parent_name":"HyperwalletValidationMessage"},"Structs/HyperwalletValidationMessage.html#/s:14HyperwalletSDK0A17ValidationMessageV5emptySSSgvp":{"name":"empty","abstract":"\u003cp\u003eThe validation message empty, or nil if none exists\u003c/p\u003e","parent_name":"HyperwalletValidationMessage"},"Structs/HyperwalletTransferMethodType.html#/s:14HyperwalletSDK0A18TransferMethodTypeV4codeSSSgvp":{"name":"code","abstract":"\u003cp\u003eThe country code\u003c/p\u003e","parent_name":"HyperwalletTransferMethodType"},"Structs/HyperwalletTransferMethodType.html#/s:14HyperwalletSDK0A18TransferMethodTypeV4nameSSSgvp":{"name":"name","abstract":"\u003cp\u003eThe country name\u003c/p\u003e","parent_name":"HyperwalletTransferMethodType"},"Structs/HyperwalletTransferMethodType.html#/s:14HyperwalletSDK0A18TransferMethodTypeV4feesAA10ConnectionVyAA0A3FeeVGSgvp":{"name":"fees","abstract":"\u003cp\u003eThe fees for transfer\u003c/p\u003e","parent_name":"HyperwalletTransferMethodType"},"Structs/HyperwalletTransferMethodType.html#/s:14HyperwalletSDK0A18TransferMethodTypeV15processingTimesAA10ConnectionVyAA0A14ProcessingTimeVGSgvp":{"name":"processingTimes","abstract":"\u003cp\u003eThe processing time for transfer\u003c/p\u003e","parent_name":"HyperwalletTransferMethodType"},"Structs/HyperwalletProcessingTime.html#/s:14HyperwalletSDK0A14ProcessingTimeV7countrySSSgvp":{"name":"country","abstract":"\u003cp\u003eThe country to process\u003c/p\u003e","parent_name":"HyperwalletProcessingTime"},"Structs/HyperwalletProcessingTime.html#/s:14HyperwalletSDK0A14ProcessingTimeV8currencySSSgvp":{"name":"currency","abstract":"\u003cp\u003eThe currency to process\u003c/p\u003e","parent_name":"HyperwalletProcessingTime"},"Structs/HyperwalletProcessingTime.html#/s:14HyperwalletSDK0A14ProcessingTimeV18transferMethodTypeSSSgvp":{"name":"transferMethodType","abstract":"\u003cp\u003eThe transfer method type\u003c/p\u003e","parent_name":"HyperwalletProcessingTime"},"Structs/HyperwalletProcessingTime.html#/s:14HyperwalletSDK0A14ProcessingTimeV5valueSSSgvp":{"name":"value","abstract":"\u003cp\u003eThe value to process\u003c/p\u003e","parent_name":"HyperwalletProcessingTime"},"Structs/HyperwalletFieldSelectionOption.html#/s:14HyperwalletSDK0A20FieldSelectionOptionV5labelSSSgvp":{"name":"label","abstract":"\u003cp\u003eThe label\u003c/p\u003e","parent_name":"HyperwalletFieldSelectionOption"},"Structs/HyperwalletFieldSelectionOption.html#/s:14HyperwalletSDK0A20FieldSelectionOptionV5valueSSSgvp":{"name":"value","abstract":"\u003cp\u003eThe value\u003c/p\u003e","parent_name":"HyperwalletFieldSelectionOption"},"Structs/HyperwalletFieldGroup.html#/s:14HyperwalletSDK0A10FieldGroupV5groupSSSgvp":{"name":"group","abstract":"\u003cp\u003eThe group\u003c/p\u003e","parent_name":"HyperwalletFieldGroup"},"Structs/HyperwalletFieldGroup.html#/s:14HyperwalletSDK0A10FieldGroupV6fieldsSayAA0aC0VGSgvp":{"name":"fields","abstract":"\u003cp\u003eThe list of HyperwalletField\u003c/p\u003e","parent_name":"HyperwalletFieldGroup"},"Structs/HyperwalletField.html#/s:14HyperwalletSDK0A5FieldV8dataTypeSSSgvp":{"name":"dataType","abstract":"\u003cp\u003eThe field data type, or nil if none exists\u003c/p\u003e","parent_name":"HyperwalletField"},"Structs/HyperwalletField.html#/s:14HyperwalletSDK0A5FieldV21fieldSelectionOptionsSayAA0acE6OptionVGSgvp":{"name":"fieldSelectionOptions","abstract":"\u003cp\u003eThe list of selection option, or nil if none exists\u003c/p\u003e","parent_name":"HyperwalletField"},"Structs/HyperwalletField.html#/s:14HyperwalletSDK0A5FieldV10isRequiredSbSgvp":{"name":"isRequired","abstract":"\u003cp\u003eIndicate if the field is mandatory, or nil if none exists\u003c/p\u003e","parent_name":"HyperwalletField"},"Structs/HyperwalletField.html#/s:14HyperwalletSDK0A5FieldV10isEditableSbSgvp":{"name":"isEditable","abstract":"\u003cp\u003eIndicate if the field is editable, or nil if none exists\u003c/p\u003e","parent_name":"HyperwalletField"},"Structs/HyperwalletField.html#/s:14HyperwalletSDK0A5FieldV5labelSSSgvp":{"name":"label","abstract":"\u003cp\u003eThe field label\u003c/p\u003e","parent_name":"HyperwalletField"},"Structs/HyperwalletField.html#/s:14HyperwalletSDK0A5FieldV9maxLengthSiSgvp":{"name":"maxLength","abstract":"\u003cp\u003eThe field maximum length, or nil if none exists\u003c/p\u003e","parent_name":"HyperwalletField"},"Structs/HyperwalletField.html#/s:14HyperwalletSDK0A5FieldV9minLengthSiSgvp":{"name":"minLength","abstract":"\u003cp\u003eThe field minimum length, or nil if none exists\u003c/p\u003e","parent_name":"HyperwalletField"},"Structs/HyperwalletField.html#/s:14HyperwalletSDK0A5FieldV4nameSSSgvp":{"name":"name","abstract":"\u003cp\u003eThe field name, or nil if none exists\u003c/p\u003e","parent_name":"HyperwalletField"},"Structs/HyperwalletField.html#/s:14HyperwalletSDK0A5FieldV11placeholderSSSgvp":{"name":"placeholder","abstract":"\u003cp\u003eThe field placeholder, or nil if none exists\u003c/p\u003e","parent_name":"HyperwalletField"},"Structs/HyperwalletField.html#/s:14HyperwalletSDK0A5FieldV17regularExpressionSSSgvp":{"name":"regularExpression","abstract":"\u003cp\u003eThe regular expression to validate the field value, or nil if none exists\u003c/p\u003e","parent_name":"HyperwalletField"},"Structs/HyperwalletField.html#/s:14HyperwalletSDK0A5FieldV17validationMessageAA0a10ValidationE0VSgvp":{"name":"validationMessage","abstract":"\u003cp\u003eThe validation message\u003c/p\u003e","parent_name":"HyperwalletField"},"Structs/HyperwalletField.html#/s:14HyperwalletSDK0A5FieldV5valueSSSgvp":{"name":"value","abstract":"\u003cp\u003eThe field value\u003c/p\u003e","parent_name":"HyperwalletField"},"Structs/HyperwalletField.html#/s:14HyperwalletSDK0A5FieldV4maskAA0A4MaskVSgvp":{"name":"mask","abstract":"\u003cp\u003eThe mask, or nil if none exists\u003c/p\u003e","parent_name":"HyperwalletField"},"Structs/HyperwalletField.html#/s:14HyperwalletSDK0A5FieldV16fieldValueMaskedSbSgvp":{"name":"fieldValueMasked","abstract":"\u003cp\u003eIndicate if the field is masked, or nil if none exists\u003c/p\u003e","parent_name":"HyperwalletField"},"Structs/HyperwalletFee.html#/s:14HyperwalletSDK0A3FeeV11feeRateTypeSSSgvp":{"name":"feeRateType","abstract":"\u003cp\u003eThe fee rate type (FLAT or PERCENT)\u003c/p\u003e","parent_name":"HyperwalletFee"},"Structs/HyperwalletFee.html#/s:14HyperwalletSDK0A3FeeV5valueSSSgvp":{"name":"value","abstract":"\u003cp\u003eThe fee value\u003c/p\u003e","parent_name":"HyperwalletFee"},"Structs/HyperwalletFee.html#/s:14HyperwalletSDK0A3FeeV8currencySSSgvp":{"name":"currency","abstract":"\u003cp\u003eThe fee currency\u003c/p\u003e","parent_name":"HyperwalletFee"},"Structs/HyperwalletFee.html#/s:14HyperwalletSDK0A3FeeV7minimumSSSgvp":{"name":"minimum","abstract":"\u003cp\u003eThe minimum fee, or nil if none exists\u003c/p\u003e","parent_name":"HyperwalletFee"},"Structs/HyperwalletFee.html#/s:14HyperwalletSDK0A3FeeV7maximumSSSgvp":{"name":"maximum","abstract":"\u003cp\u003eThe maximum fee, or nil if none exists\u003c/p\u003e","parent_name":"HyperwalletFee"},"Structs/HyperwalletCurrency.html#/s:14HyperwalletSDK0A8CurrencyV4codeSSSgvp":{"name":"code","abstract":"\u003cp\u003eThe 3 letter ISO 4217-1 currency code\u003c/p\u003e","parent_name":"HyperwalletCurrency"},"Structs/HyperwalletCurrency.html#/s:14HyperwalletSDK0A8CurrencyV4nameSSSgvp":{"name":"name","abstract":"\u003cp\u003eThe currency name\u003c/p\u003e","parent_name":"HyperwalletCurrency"},"Structs/HyperwalletCurrency.html#/s:14HyperwalletSDK0A8CurrencyV19transferMethodTypesAA10ConnectionVyAA0a8TransferE4TypeVGSgvp":{"name":"transferMethodTypes","abstract":"\u003cp\u003eThe \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbStructs/HyperwalletTransferMethodType.html\"\u003eHyperwalletTransferMethodType\u003c/a\u003e\u003c/code\u003e nodes that connect to this currency node\u003c/p\u003e","parent_name":"HyperwalletCurrency"},"Structs/HyperwalletCountry.html#/s:14HyperwalletSDK0A7CountryV4codeSSSgvp":{"name":"code","abstract":"\u003cp\u003eThe 2 letter ISO 3166-1 country code\u003c/p\u003e","parent_name":"HyperwalletCountry"},"Structs/HyperwalletCountry.html#/s:14HyperwalletSDK0A7CountryV4nameSSSgvp":{"name":"name","abstract":"\u003cp\u003eThe country name\u003c/p\u003e","parent_name":"HyperwalletCountry"},"Structs/HyperwalletCountry.html#/s:14HyperwalletSDK0A7CountryV10currenciesAA10ConnectionVyAA0A8CurrencyVGSgvp":{"name":"currencies","abstract":"\u003cp\u003eThe \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbStructs/HyperwalletCurrency.html\"\u003eHyperwalletCurrency\u003c/a\u003e\u003c/code\u003e nodes that connect to this country node\u003c/p\u003e","parent_name":"HyperwalletCountry"},"Structs/Connection.html#/s:14HyperwalletSDK10ConnectionV5nodesSayxGSgvp":{"name":"nodes","abstract":"\u003cp\u003eArray of Connection type\u003c/p\u003e","parent_name":"Connection"},"Structs/HyperwalletBalance.html#/s:14HyperwalletSDK0A7BalanceV8currencySSSgvp":{"name":"currency","abstract":"\u003cp\u003eThe currency of balance\u003c/p\u003e","parent_name":"HyperwalletBalance"},"Structs/HyperwalletBalance.html#/s:14HyperwalletSDK0A7BalanceV6amountSSSgvp":{"name":"amount","abstract":"\u003cp\u003eThe amount of balance\u003c/p\u003e","parent_name":"HyperwalletBalance"},"Structs/HyperwalletError.html#/s:14HyperwalletSDK0A5ErrorV7messageSSvp":{"name":"message","abstract":"\u003cp\u003eThe error message\u003c/p\u003e","parent_name":"HyperwalletError"},"Structs/HyperwalletError.html#/s:14HyperwalletSDK0A5ErrorV4codeSSvp":{"name":"code","abstract":"\u003cp\u003eThe error code\u003c/p\u003e","parent_name":"HyperwalletError"},"Structs/HyperwalletError.html#/s:14HyperwalletSDK0A5ErrorV9fieldNameSSSgvp":{"name":"fieldName","abstract":"\u003cp\u003eThe field name\u003c/p\u003e","parent_name":"HyperwalletError"},"Structs/HyperwalletError.html#/s:14HyperwalletSDK0A5ErrorV16relatedResourcesSaySSGSgvp":{"name":"relatedResources","abstract":"\u003cp\u003eThe list of related resources\u003c/p\u003e","parent_name":"HyperwalletError"},"Structs/HyperwalletError.html#/s:14HyperwalletSDK0A5ErrorV7message4code9fieldName16relatedResourcesACSS_S2SSgSaySSGSgtcfc":{"name":"init(message:code:fieldName:relatedResources:)","abstract":"\u003cp\u003eCreates an instance of HyperwalletError\u003c/p\u003e","parent_name":"HyperwalletError"},"Structs/HyperwalletErrors/CodingKeys.html#/s:14HyperwalletSDK0A6ErrorsV10CodingKeysO9errorListyA2EmF":{"name":"errorList","parent_name":"CodingKeys"},"Structs/HyperwalletErrors.html#/s:14HyperwalletSDK0A6ErrorsV9errorListSayAA0A5ErrorVGSgvp":{"name":"errorList","abstract":"\u003cp\u003eThe error list\u003c/p\u003e","parent_name":"HyperwalletErrors"},"Structs/HyperwalletErrors.html#/s:14HyperwalletSDK0A6ErrorsV13originalErrors0E0_pSgvp":{"name":"originalError","abstract":"\u003cp\u003eThe original error\u003c/p\u003e","parent_name":"HyperwalletErrors"},"Structs/HyperwalletErrors/CodingKeys.html":{"name":"CodingKeys","abstract":"\u003cp\u003eThe CodingKeys for Hyperwallet errors\u003c/p\u003e","parent_name":"HyperwalletErrors"},"Structs/HyperwalletErrors.html#/s:14HyperwalletSDK0A6ErrorsV9errorListACSayAA0A5ErrorVG_tcfc":{"name":"init(errorList:)","abstract":"\u003cp\u003eCreates an instance of HyperwalletErrors\u003c/p\u003e","parent_name":"HyperwalletErrors"},"Structs/HyperwalletErrors.html#/s:14HyperwalletSDK0A6ErrorsV9errorList13originalErrorACSayAA0aG0VG_s0G0_pSgtcfc":{"name":"init(errorList:originalError:)","abstract":"\u003cp\u003eCreates an instance of HyperwalletErrors\u003c/p\u003e","parent_name":"HyperwalletErrors"},"Structs/Configuration.html#/s:14HyperwalletSDK13ConfigurationV11environmentSSSgvp":{"name":"environment","abstract":"\u003cp\u003eThe environment type\u003c/p\u003e","parent_name":"Configuration"},"Structs/Configuration.html#/s:14HyperwalletSDK13ConfigurationV11insightsUrlSSSgvp":{"name":"insightsUrl","abstract":"\u003cp\u003eThe insights Url\u003c/p\u003e","parent_name":"Configuration"},"Structs/Configuration.html#/s:14HyperwalletSDK13ConfigurationV6issuerSSvp":{"name":"issuer","abstract":"\u003cp\u003eThe issuer\u003c/p\u003e","parent_name":"Configuration"},"Structs/Configuration.html#/s:14HyperwalletSDK13ConfigurationV9userTokenSSvp":{"name":"userToken","abstract":"\u003cp\u003eThe user token\u003c/p\u003e","parent_name":"Configuration"},"Structs/Configuration.html#/s:14HyperwalletSDK13ConfigurationV12programModelSSSgvp":{"name":"programModel","abstract":"\u003cp\u003eThe program model\u003c/p\u003e","parent_name":"Configuration"},"Structs/Configuration.html":{"name":"Configuration","abstract":"\u003cp\u003eConfiguration object retrieved on successful authentication\u003c/p\u003e"},"Structs/HyperwalletErrors.html":{"name":"HyperwalletErrors","abstract":"\u003cp\u003eRepresentation of the Hyperwallet error list\u003c/p\u003e"},"Structs/HyperwalletError.html":{"name":"HyperwalletError","abstract":"\u003cp\u003eRepresentation of the Hyperwallet error entity.\u003c/p\u003e"},"Structs/HyperwalletBalance.html":{"name":"HyperwalletBalance","abstract":"\u003cp\u003eDetails of the balance.\u003c/p\u003e"},"Structs/Connection.html":{"name":"Connection","abstract":"\u003cp\u003eRepresentation of the GraphQL\u0026rsquo;s Connection type\u003c/p\u003e"},"Structs/HyperwalletCountry.html":{"name":"HyperwalletCountry","abstract":"\u003cp\u003eRepresentation of a \u003ccode\u003eHyperwalletCountry\u003c/code\u003e node\u003c/p\u003e"},"Structs/HyperwalletCurrency.html":{"name":"HyperwalletCurrency","abstract":"\u003cp\u003eRepresentation of a \u003ccode\u003eHyperwalletCurrency\u003c/code\u003e node\u003c/p\u003e"},"Structs/HyperwalletFee.html":{"name":"HyperwalletFee","abstract":"\u003cp\u003eRepresentation of the fee\u003c/p\u003e"},"Structs/HyperwalletField.html":{"name":"HyperwalletField","abstract":"\u003cp\u003eRepresentation of the transfer method configuration field\u003c/p\u003e"},"Structs/HyperwalletFieldGroup.html":{"name":"HyperwalletFieldGroup","abstract":"\u003cp\u003eRepresentation of list of HyperwalletField and the group to which it belongs\u003c/p\u003e"},"Structs/HyperwalletFieldSelectionOption.html":{"name":"HyperwalletFieldSelectionOption","abstract":"\u003cp\u003eRepresentation of the transfer method configuration field selection option\u003c/p\u003e"},"Structs/HyperwalletProcessingTime.html":{"name":"HyperwalletProcessingTime","abstract":"\u003cp\u003eRepresentation of the transfer method configuration field processing times\u003c/p\u003e"},"Structs/HyperwalletTransferMethodType.html":{"name":"HyperwalletTransferMethodType","abstract":"\u003cp\u003eRepresentation of transfer method type\u003c/p\u003e"},"Structs/HyperwalletValidationMessage.html":{"name":"HyperwalletValidationMessage","abstract":"\u003cp\u003eRepresentation of the transfer method configuration field validation message\u003c/p\u003e"},"Structs/HyperwalletTransferMethodConfiguration.html":{"name":"HyperwalletTransferMethodConfiguration","abstract":"\u003cp\u003eRepresentation of the transfer method configuration\u003c/p\u003e"},"Structs/HyperwalletMask.html":{"name":"HyperwalletMask","abstract":"\u003cp\u003eRepresentation of the transfer method configuration field mask\u003c/p\u003e"},"Structs/HyperwalletConditionalPattern.html":{"name":"HyperwalletConditionalPattern","abstract":"\u003cp\u003eRepresentation of the transfer method configuration field conditionalPatterns\u003c/p\u003e"},"Structs/HyperwalletTransferMethodConfigurationFieldQuery.html":{"name":"HyperwalletTransferMethodConfigurationFieldQuery","abstract":"\u003cp\u003eThe \u003ccode\u003eHyperwalletTransferMethodConfigurationFieldQuery\u003c/code\u003e struct defines and builds a query to retrieve the fields"},"Structs/HyperwalletTransferMethodConfigurationKeysQuery.html":{"name":"HyperwalletTransferMethodConfigurationKeysQuery","abstract":"\u003cp\u003eThe \u0026lsquo;HyperwalletTransferMethodConfigurationKeysQuery\u0026rsquo; struct defines and builds a query to retrieve the key set"},"Structs/HyperwalletTransferMethodTypesFeesAndProcessingTimesQuery.html":{"name":"HyperwalletTransferMethodTypesFeesAndProcessingTimesQuery","abstract":"\u003cp\u003eThe \u0026lsquo;HyperwalletTransferMethodTypesFeesAndProcessingTimesQuery\u0026rsquo; struct defines"},"Structs/HyperwalletTransferMethodUpdateConfigurationFieldQuery.html":{"name":"HyperwalletTransferMethodUpdateConfigurationFieldQuery","abstract":"\u003cp\u003eThe \u003ccode\u003eHyperwalletTransferMethodUpdateConfigurationFieldQuery\u003c/code\u003e"},"Structs/HyperwalletPageList.html":{"name":"HyperwalletPageList","abstract":"\u003cp\u003eRepresentation of subset content from a dataset\u003c/p\u003e"},"Structs/HyperwalletPageLink.html":{"name":"HyperwalletPageLink","abstract":"\u003cp\u003eRepresentation of the page link\u003c/p\u003e"},"Structs/HyperwalletPageParameter.html":{"name":"HyperwalletPageParameter","abstract":"\u003cp\u003eRepresentation of the relationship between the current document and the linked document\u003c/p\u003e"},"Structs/HyperwalletReceiptDetails.html":{"name":"HyperwalletReceiptDetails","abstract":"\u003cp\u003eDetails of the transaction.\u003c/p\u003e"},"Structs/HyperwalletReceipt.html":{"name":"HyperwalletReceipt","abstract":"\u003cp\u003eRepresentation of the Hyperwallet\u0026rsquo;s receipt.\u003c/p\u003e"},"Structs/HyperwalletStatusTransition.html":{"name":"HyperwalletStatusTransition","abstract":"\u003cp\u003eRepresentation of the status transition.\u003c/p\u003e"},"Structs/HyperwalletForeignExchange.html":{"name":"HyperwalletForeignExchange","abstract":"\u003cp\u003eRepresentation of a \u003ccode\u003eHyperwalletForeignExchange\u003c/code\u003e\u003c/p\u003e"},"Structs/HyperwalletTransfer.html":{"name":"HyperwalletTransfer","abstract":"\u003cp\u003eRepresentation of a \u003ccode\u003eHyperwalletTransfer\u003c/code\u003e\u003c/p\u003e"},"Protocols/HyperwalletTransferMethodUpdateConfigurationField.html#/s:14HyperwalletSDK0A38TransferMethodUpdateConfigurationFieldP08transferdeF0AA0acdF0VSgyF":{"name":"transferMethodUpdateConfiguration()","abstract":"\u003cp\u003eReturns \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbStructs/HyperwalletTransferMethodConfiguration.html\"\u003eHyperwalletTransferMethodConfiguration\u003c/a\u003e\u003c/code\u003e\u003c/p\u003e","parent_name":"HyperwalletTransferMethodUpdateConfigurationField"},"Protocols/HyperwalletTransferMethodConfigurationKey.html#/s:14HyperwalletSDK0A30TransferMethodConfigurationKeyP9countriesSayAA0A7CountryVGSgyF":{"name":"countries()","abstract":"\u003cp\u003eReturns the list of countries\u003c/p\u003e","parent_name":"HyperwalletTransferMethodConfigurationKey"},"Protocols/HyperwalletTransferMethodConfigurationKey.html#/s:14HyperwalletSDK0A30TransferMethodConfigurationKeyP10currencies4fromSayAA0A8CurrencyVGSgSS_tF":{"name":"currencies(from:)","abstract":"\u003cp\u003eReturns the list of currencies based on the country\u003c/p\u003e","parent_name":"HyperwalletTransferMethodConfigurationKey"},"Protocols/HyperwalletTransferMethodConfigurationKey.html#/s:14HyperwalletSDK0A30TransferMethodConfigurationKeyP08transferD5Types11countryCode08currencyJ0SayAA0acD4TypeVGSgSS_SStF":{"name":"transferMethodTypes(countryCode:currencyCode:)","abstract":"\u003cp\u003eReturns the list of transfer method types based on the parameters\u003c/p\u003e","parent_name":"HyperwalletTransferMethodConfigurationKey"},"Protocols/HyperwalletTransferMethodConfigurationField.html#/s:14HyperwalletSDK0A32TransferMethodConfigurationFieldP11fieldGroupsSayAA0aF5GroupVGSgyF":{"name":"fieldGroups()","abstract":"\u003cp\u003eReturns a list of \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbStructs/HyperwalletField.html\"\u003eHyperwalletField\u003c/a\u003e\u003c/code\u003e\u003c/p\u003e","parent_name":"HyperwalletTransferMethodConfigurationField"},"Protocols/HyperwalletTransferMethodConfigurationField.html#/s:14HyperwalletSDK0A32TransferMethodConfigurationFieldP08transferD4TypeAA0acdH0VSgyF":{"name":"transferMethodType()","abstract":"\u003cp\u003eReturns the list of transfer method types based on the parameters\u003c/p\u003e","parent_name":"HyperwalletTransferMethodConfigurationField"},"Protocols/HyperwalletAuthenticationTokenProvider.html#/s:14HyperwalletSDK0A27AuthenticationTokenProviderP17CompletionHandlera":{"name":"CompletionHandler","abstract":"\u003cp\u003eA callback interface to handle the submission of an authentication token or an error message in case of failure.\u003c/p\u003e","parent_name":"HyperwalletAuthenticationTokenProvider"},"Protocols/HyperwalletAuthenticationTokenProvider.html#/c:@M@HyperwalletSDK@objc(pl)HyperwalletAuthenticationTokenProvider(im)retrieveAuthenticationTokenWithCompletionHandler:":{"name":"retrieveAuthenticationToken(completionHandler:)","abstract":"\u003cp\u003eInvoked when the Hyperwallet iOS Core SDK requires an authentication token.\u003c/p\u003e","parent_name":"HyperwalletAuthenticationTokenProvider"},"Protocols/HyperwalletAuthenticationTokenProvider.html":{"name":"HyperwalletAuthenticationTokenProvider","abstract":"\u003cp\u003eThe \u003ccode\u003eHyperwalletAuthenticationTokenProvider\u003c/code\u003e protocol provides the Hyperwallet iOS Core SDK with an"},"Protocols/HyperwalletTransferMethodConfigurationField.html":{"name":"HyperwalletTransferMethodConfigurationField","abstract":"\u003cp\u003eThe \u003ccode\u003eHyperwalletTransferMethodConfigurationField\u003c/code\u003e protocol for processing the transfer method"},"Protocols/HyperwalletTransferMethodConfigurationKey.html":{"name":"HyperwalletTransferMethodConfigurationKey","abstract":"\u003cp\u003eThe \u003ccode\u003eHyperwalletTransferMethodConfigurationKey\u003c/code\u003e protocol for processing the transfer method configuration"},"Protocols/HyperwalletTransferMethodUpdateConfigurationField.html":{"name":"HyperwalletTransferMethodUpdateConfigurationField","abstract":"\u003cp\u003eThe \u003ccode\u003eHyperwalletTransferMethodUpdateConfigurationField\u003c/code\u003e protocol for processing the update transfer method"},"Extensions/ISO8601DateFormatter.html#/s:So22NSISO8601DateFormatterC14HyperwalletSDKE14ignoreTimeZoneABvpZ":{"name":"ignoreTimeZone","abstract":"\u003cp\u003eThe thread-safe date formatter to work with ISO8601 date representations.","parent_name":"ISO8601DateFormatter"},"Extensions/ISO8601DateFormatter.html":{"name":"ISO8601DateFormatter","abstract":"\u003cp\u003eDate extension.\u003c/p\u003e"},"Enums/HyperwalletDataType.html#/s:14HyperwalletSDK0A8DataTypeO4textyA2CmF":{"name":"text","abstract":"\u003cp\u003eThe text field type\u003c/p\u003e","parent_name":"HyperwalletDataType"},"Enums/HyperwalletDataType.html#/s:14HyperwalletSDK0A8DataTypeO9selectionyA2CmF":{"name":"selection","abstract":"\u003cp\u003eThe selecion option field type\u003c/p\u003e","parent_name":"HyperwalletDataType"},"Enums/HyperwalletDataType.html#/s:14HyperwalletSDK0A8DataTypeO7booleanyA2CmF":{"name":"boolean","abstract":"\u003cp\u003eThe boolean field type\u003c/p\u003e","parent_name":"HyperwalletDataType"},"Enums/HyperwalletDataType.html#/s:14HyperwalletSDK0A8DataTypeO6numberyA2CmF":{"name":"number","abstract":"\u003cp\u003eThe numeric field type\u003c/p\u003e","parent_name":"HyperwalletDataType"},"Enums/HyperwalletDataType.html#/s:14HyperwalletSDK0A8DataTypeO5rangeyA2CmF":{"name":"range","abstract":"\u003cp\u003eThe range field type\u003c/p\u003e","parent_name":"HyperwalletDataType"},"Enums/HyperwalletDataType.html#/s:14HyperwalletSDK0A8DataTypeO4dateyA2CmF":{"name":"date","abstract":"\u003cp\u003eThe date field type\u003c/p\u003e","parent_name":"HyperwalletDataType"},"Enums/HyperwalletDataType.html#/s:14HyperwalletSDK0A8DataTypeO8datetimeyA2CmF":{"name":"datetime","abstract":"\u003cp\u003eThe datetime field type\u003c/p\u003e","parent_name":"HyperwalletDataType"},"Enums/HyperwalletDataType.html#/s:14HyperwalletSDK0A8DataTypeO10expiryDateyA2CmF":{"name":"expiryDate","abstract":"\u003cp\u003eThe expiry date field type\u003c/p\u003e","parent_name":"HyperwalletDataType"},"Enums/HyperwalletDataType.html#/s:14HyperwalletSDK0A8DataTypeO5phoneyA2CmF":{"name":"phone","abstract":"\u003cp\u003eThe phone field type\u003c/p\u003e","parent_name":"HyperwalletDataType"},"Enums/HyperwalletDataType.html#/s:14HyperwalletSDK0A8DataTypeO5emailyA2CmF":{"name":"email","abstract":"\u003cp\u003eThe email field type\u003c/p\u003e","parent_name":"HyperwalletDataType"},"Enums/HyperwalletDataType.html#/s:14HyperwalletSDK0A8DataTypeO4fileyA2CmF":{"name":"file","abstract":"\u003cp\u003eThe file field type\u003c/p\u003e","parent_name":"HyperwalletDataType"},"Enums/HyperwalletErrorGroup.html#/s:14HyperwalletSDK0A10ErrorGroupO8businessyA2CmF":{"name":"business","abstract":"\u003cp\u003eReturned when a business error is thrown\u003c/p\u003e","parent_name":"HyperwalletErrorGroup"},"Enums/HyperwalletErrorGroup.html#/s:14HyperwalletSDK0A10ErrorGroupO10unexpectedyA2CmF":{"name":"unexpected","abstract":"\u003cp\u003eReturned when an unexpected error is thrown\u003c/p\u003e","parent_name":"HyperwalletErrorGroup"},"Enums/HyperwalletErrorGroup.html#/s:14HyperwalletSDK0A10ErrorGroupO10connectionyA2CmF":{"name":"connection","abstract":"\u003cp\u003eReturned when a connection error is thrown\u003c/p\u003e","parent_name":"HyperwalletErrorGroup"},"Enums/HyperwalletErrorGroup.html#/s:14HyperwalletSDK0A10ErrorGroupO14authenticationyA2CmF":{"name":"authentication","abstract":"\u003cp\u003eReturned when a authentication error is thrown\u003c/p\u003e","parent_name":"HyperwalletErrorGroup"},"Enums/HyperwalletAuthenticationErrorType.html#/s:14HyperwalletSDK0A23AuthenticationErrorTypeO7expiredyACSScACmF":{"name":"expired(_:)","parent_name":"HyperwalletAuthenticationErrorType"},"Enums/HyperwalletAuthenticationErrorType.html#/s:14HyperwalletSDK0A23AuthenticationErrorTypeO10unexpectedyACSScACmF":{"name":"unexpected(_:)","parent_name":"HyperwalletAuthenticationErrorType"},"Enums/HyperwalletAuthenticationErrorType.html#/s:14HyperwalletSDK0A23AuthenticationErrorTypeO7messageSSyF":{"name":"message()","abstract":"\u003cp\u003eGets the AuthenticationErrorType error message\u003c/p\u003e","parent_name":"HyperwalletAuthenticationErrorType"},"Enums/HyperwalletErrorType.html#/s:14HyperwalletSDK0A9ErrorTypeO4httpyAcA0A6ErrorsV_SitcACmF":{"name":"http(_:_:)","abstract":"\u003cp\u003eReturned when an HTTP code is not in the range 2xx.\u003c/p\u003e","parent_name":"HyperwalletErrorType"},"Enums/HyperwalletErrorType.html#/s:14HyperwalletSDK0A9ErrorTypeO05parseC0yAcA0A6ErrorsVcACmF":{"name":"parseError(_:)","abstract":"\u003cp\u003eReturned when a response parser process throws error.\u003c/p\u003e","parent_name":"HyperwalletErrorType"},"Enums/HyperwalletErrorType.html#/s:14HyperwalletSDK0A9ErrorTypeO14notInitializedyAcA0A6ErrorsVcACmF":{"name":"notInitialized(_:)","abstract":"\u003cp\u003eReturned when the SDK was not initialized properly.\u003c/p\u003e","parent_name":"HyperwalletErrorType"},"Enums/HyperwalletErrorType.html#/s:14HyperwalletSDK0A9ErrorTypeO10invalidUrlyAcA0A6ErrorsVcACmF":{"name":"invalidUrl(_:)","abstract":"\u003cp\u003eReturned when a provided URL is not valid\u003c/p\u003e","parent_name":"HyperwalletErrorType"},"Enums/HyperwalletErrorType.html#/s:14HyperwalletSDK0A9ErrorTypeO18transactionAbortedyAcA0A6ErrorsVcACmF":{"name":"transactionAborted(_:)","abstract":"\u003cp\u003eReturned when a transaction is explicitly aborted.\u003c/p\u003e","parent_name":"HyperwalletErrorType"},"Enums/HyperwalletErrorType.html#/s:14HyperwalletSDK0A9ErrorTypeO014authenticationC0yAcA0a14AuthenticationcD0OcACmF":{"name":"authenticationError(_:)","abstract":"\u003cp\u003eReturned on authentication failure\u003c/p\u003e","parent_name":"HyperwalletErrorType"},"Enums/HyperwalletErrorType.html#/s:14HyperwalletSDK0A9ErrorTypeO10unexpectedyAcA0A6ErrorsVcACmF":{"name":"unexpected(_:)","abstract":"\u003cp\u003eReturned when an unexpected behavior happened.\u003c/p\u003e","parent_name":"HyperwalletErrorType"},"Enums/HyperwalletErrorType.html#/s:14HyperwalletSDK0A9ErrorTypeO13graphQlErrorsyAcA0aG0VcACmF":{"name":"graphQlErrors(_:)","abstract":"\u003cp\u003eReturned when a GraphQL parser process throws error.\u003c/p\u003e","parent_name":"HyperwalletErrorType"},"Enums/HyperwalletErrorType.html#/s:14HyperwalletSDK0A9ErrorTypeO14invalidRequestyAcA0A6ErrorsVcACmF":{"name":"invalidRequest(_:)","abstract":"\u003cp\u003eReturned when some step-in builds the request throws error.\u003c/p\u003e","parent_name":"HyperwalletErrorType"},"Enums/HyperwalletErrorType.html#/s:14HyperwalletSDK0A9ErrorTypeO010connectionC0yAcA0A6ErrorsVcACmF":{"name":"connectionError(_:)","abstract":"\u003cp\u003eReturned when during the connection process throws error.\u003c/p\u003e","parent_name":"HyperwalletErrorType"},"Enums/HyperwalletErrorType.html#/s:14HyperwalletSDK0A9ErrorTypeO5groupAA0aC5GroupOvp":{"name":"group","abstract":"\u003cp\u003eThe error type group\u003c/p\u003e","parent_name":"HyperwalletErrorType"},"Enums/HyperwalletErrorType.html#/s:14HyperwalletSDK0A9ErrorTypeO03getA6ErrorsAA0aF0VSgyF":{"name":"getHyperwalletErrors()","abstract":"\u003cp\u003eGets the \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbStructs/HyperwalletErrors.html\"\u003eHyperwalletErrors\u003c/a\u003e\u003c/code\u003e based on the ErrorType\u003c/p\u003e","parent_name":"HyperwalletErrorType"},"Enums/HyperwalletErrorType.html#/s:14HyperwalletSDK0A9ErrorTypeO017getAuthenticationC0AA0afcD0OSgyF":{"name":"getAuthenticationError()","abstract":"\u003cp\u003eGets the \u003ccode\u003eAuthenticationErrorType\u003c/code\u003e on the ErrorType\u003c/p\u003e","parent_name":"HyperwalletErrorType"},"Enums/HyperwalletErrorType.html#/s:14HyperwalletSDK0A9ErrorTypeO11getHttpCodeSiSgyF":{"name":"getHttpCode()","abstract":"\u003cp\u003eGets the HTTP Code based on the ErrorType.http\u003c/p\u003e","parent_name":"HyperwalletErrorType"},"Enums/HyperwalletErrorType.html":{"name":"HyperwalletErrorType","abstract":"\u003cp\u003eThe \u003ccode\u003eHyperwalletErrorType\u003c/code\u003e is the error type returned By Hyperwallet SDK.\u003c/p\u003e"},"Enums/HyperwalletAuthenticationErrorType.html":{"name":"HyperwalletAuthenticationErrorType","abstract":"\u003cp\u003eThe \u003ccode\u003eHyperwalletAuthenticationErrorType\u003c/code\u003e is the authentication error type returned By Hyperwallet SDK.\u003c/p\u003e"},"Enums/HyperwalletErrorGroup.html":{"name":"HyperwalletErrorGroup","abstract":"\u003cp\u003eRepresentation of the error type group\u003c/p\u003e"},"Enums/HyperwalletDataType.html":{"name":"HyperwalletDataType","abstract":"\u003cp\u003eRepresentation of the transfer method configuration field data type\u003c/p\u003e"},"Classes/HyperwalletUser/Builder.html#/s:14HyperwalletSDK0A4UserC7BuilderC12addressLine1yAESSF":{"name":"addressLine1(_:)","abstract":"\u003cp\u003eSets the user\u0026rsquo;s street address.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletUser/Builder.html#/s:14HyperwalletSDK0A4UserC7BuilderC12addressLine2yAESSF":{"name":"addressLine2(_:)","abstract":"\u003cp\u003eSets the user\u0026rsquo;s address, second line.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletUser/Builder.html#/s:14HyperwalletSDK0A4UserC7BuilderC5buildACyF":{"name":"build()","abstract":"\u003cp\u003eBuilds a new instance of the \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/HyperwalletUser.html\"\u003eHyperwalletUser\u003c/a\u003e\u003c/code\u003e.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletUser/Builder.html#/s:14HyperwalletSDK0A4UserC7BuilderC27businessContactAddressLine1yAESSF":{"name":"businessContactAddressLine1(_:)","abstract":"\u003cp\u003eSets the business contact\u0026rsquo;s street address.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletUser/Builder.html#/s:14HyperwalletSDK0A4UserC7BuilderC27businessContactAddressLine2yAESSF":{"name":"businessContactAddressLine2(_:)","abstract":"\u003cp\u003eSets the business contact\u0026rsquo;s address, second line.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletUser/Builder.html#/s:14HyperwalletSDK0A4UserC7BuilderC19businessContactCityyAESSF":{"name":"businessContactCity(_:)","abstract":"\u003cp\u003eSets the business contact\u0026rsquo;s city.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletUser/Builder.html#/s:14HyperwalletSDK0A4UserC7BuilderC22businessContactCountryyAESSF":{"name":"businessContactCountry(_:)","abstract":"\u003cp\u003eSets the business contact\u0026rsquo;s country.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletUser/Builder.html#/s:14HyperwalletSDK0A4UserC7BuilderC25businessContactPostalCodeyAESSF":{"name":"businessContactPostalCode(_:)","abstract":"\u003cp\u003eSets the business contact\u0026rsquo;s postal code.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletUser/Builder.html#/s:14HyperwalletSDK0A4UserC7BuilderC19businessContactRoleyAeC08BusinessfG0OF":{"name":"businessContactRole(_:)","abstract":"\u003cp\u003eSets the user\u0026rsquo;s role in the organization.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletUser/Builder.html#/s:14HyperwalletSDK0A4UserC7BuilderC28businessContactStateProvinceyAESSF":{"name":"businessContactStateProvince(_:)","abstract":"\u003cp\u003eSets the business contact\u0026rsquo;s state, province or region.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletUser/Builder.html#/s:14HyperwalletSDK0A4UserC7BuilderC12businessNameyAESSF":{"name":"businessName(_:)","abstract":"\u003cp\u003eSets the business name.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletUser/Builder.html#/s:14HyperwalletSDK0A4UserC7BuilderC21businessOperatingNameyAESSF":{"name":"businessOperatingName(_:)","abstract":"\u003cp\u003eSets the business\u0026rsquo; operating name.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletUser/Builder.html#/s:14HyperwalletSDK0A4UserC7BuilderC27businessRegistrationCountryyAESSF":{"name":"businessRegistrationCountry(_:)","abstract":"\u003cp\u003eSets the country where the business is registered.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletUser/Builder.html#/s:14HyperwalletSDK0A4UserC7BuilderC22businessRegistrationIdyAESSF":{"name":"businessRegistrationId(_:)","abstract":"\u003cp\u003eSets the business registration number or identifier assigned by a government body.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletUser/Builder.html#/s:14HyperwalletSDK0A4UserC7BuilderC33businessRegistrationStateProvinceyAESSF":{"name":"businessRegistrationStateProvince(_:)","abstract":"\u003cp\u003eSets the state, province or region where the business is registered.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletUser/Builder.html#/s:14HyperwalletSDK0A4UserC7BuilderC12businessTypeyAeC08BusinessF0OF":{"name":"businessType(_:)","abstract":"\u003cp\u003eSets the business type.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletUser/Builder.html#/s:14HyperwalletSDK0A4UserC7BuilderC4cityyAESSF":{"name":"city(_:)","abstract":"\u003cp\u003eSets the user\u0026rsquo;s city.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletUser/Builder.html#/s:14HyperwalletSDK0A4UserC7BuilderC7countryyAESSF":{"name":"country(_:)","abstract":"\u003cp\u003eSets the user\u0026rsquo;s country.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletUser/Builder.html#/s:14HyperwalletSDK0A4UserC7BuilderC14countryOfBirthyAESSF":{"name":"countryOfBirth(_:)","abstract":"\u003cp\u003eSets the user\u0026rsquo;s birth country.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletUser/Builder.html#/s:14HyperwalletSDK0A4UserC7BuilderC20countryOfNationalityyAESSF":{"name":"countryOfNationality(_:)","abstract":"\u003cp\u003eSets the user\u0026rsquo;s country of citizenship or nationality.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletUser/Builder.html#/s:14HyperwalletSDK0A4UserC7BuilderC9createdOnyAESSF":{"name":"createdOn(_:)","abstract":"\u003cp\u003eSets the datetime the user account was created on in ISO 8601 format (YYYY-MM-DDThh:mm:ss). Note that the","parent_name":"Builder"},"Classes/HyperwalletUser/Builder.html#/s:14HyperwalletSDK0A4UserC7BuilderC11dateOfBirthyAESSF":{"name":"dateOfBirth(_:)","abstract":"\u003cp\u003eSets the user\u0026rsquo;s date of birth (All users must be at least 13 years old).\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletUser/Builder.html#/s:14HyperwalletSDK0A4UserC7BuilderC16driversLicenseIdyAESSF":{"name":"driversLicenseId(_:)","abstract":"\u003cp\u003eSets the user\u0026rsquo;s driver\u0026rsquo;s license number.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletUser/Builder.html#/s:14HyperwalletSDK0A4UserC7BuilderC5emailyAESSF":{"name":"email(_:)","abstract":"\u003cp\u003eSets the contact email address for the user account. This must be unique for your program, so you cannot","parent_name":"Builder"},"Classes/HyperwalletUser/Builder.html#/s:14HyperwalletSDK0A4UserC7BuilderC10employerIdyAESSF":{"name":"employerId(_:)","abstract":"\u003cp\u003eSets the user\u0026rsquo;s employer identifier, generally used for tax purposes.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletUser/Builder.html#/s:14HyperwalletSDK0A4UserC7BuilderC9firstNameyAESSF":{"name":"firstName(_:)","abstract":"\u003cp\u003eSets the user\u0026rsquo;s first name.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletUser/Builder.html#/s:14HyperwalletSDK0A4UserC7BuilderC6genderyAeC6GenderOF":{"name":"gender(_:)","abstract":"\u003cp\u003eSets the user\u0026rsquo;s gender.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletUser/Builder.html#/s:14HyperwalletSDK0A4UserC7BuilderC12governmentIdyAESSF":{"name":"governmentId(_:)","abstract":"\u003cp\u003eSets the user\u0026rsquo;s government ID number, such as a Social Security Number.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletUser/Builder.html#/s:14HyperwalletSDK0A4UserC7BuilderC16governmentIdTypeyAESSF":{"name":"governmentIdType(_:)","abstract":"\u003cp\u003eSets the user\u0026rsquo;s government ID type.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletUser/Builder.html#/s:14HyperwalletSDK0A4UserC7BuilderC8languageyAESSF":{"name":"language(_:)","abstract":"\u003cp\u003eSets the preferred language for the user\u0026rsquo;s account. Defaults to English if not provided.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletUser/Builder.html#/s:14HyperwalletSDK0A4UserC7BuilderC8lastNameyAESSF":{"name":"lastName(_:)","abstract":"\u003cp\u003eSets the user\u0026rsquo;s last name.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletUser/Builder.html#/s:14HyperwalletSDK0A4UserC7BuilderC10middleNameyAESSF":{"name":"middleName(_:)","abstract":"\u003cp\u003eSets the user\u0026rsquo;s middle name.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletUser/Builder.html#/s:14HyperwalletSDK0A4UserC7BuilderC12mobileNumberyAESSF":{"name":"mobileNumber(_:)","abstract":"\u003cp\u003eSets the user\u0026rsquo;s cell phone number.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletUser/Builder.html#/s:14HyperwalletSDK0A4UserC7BuilderC10passportIdyAESSF":{"name":"passportId(_:)","abstract":"\u003cp\u003eSets the user\u0026rsquo;s passport number.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletUser/Builder.html#/s:14HyperwalletSDK0A4UserC7BuilderC11phoneNumberyAESSF":{"name":"phoneNumber(_:)","abstract":"\u003cp\u003eSets the user\u0026rsquo;s phone number.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletUser/Builder.html#/s:14HyperwalletSDK0A4UserC7BuilderC10postalCodeyAESSF":{"name":"postalCode(_:)","abstract":"\u003cp\u003eSets the user\u0026rsquo;s postal code.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletUser/Builder.html#/s:14HyperwalletSDK0A4UserC7BuilderC11profileTypeyAeC07ProfileF0OF":{"name":"profileType(_:)","abstract":"\u003cp\u003eSets the user\u0026rsquo;s profile type.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletUser/Builder.html#/s:14HyperwalletSDK0A4UserC7BuilderC12programTokenyAESSF":{"name":"programToken(_:)","abstract":"\u003cp\u003eSets the unique identifier for the program to which the user will belong.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletUser/Builder.html#/s:14HyperwalletSDK0A4UserC7BuilderC8setField3key5valueAeC0cF0O_SStF":{"name":"setField(key:value:)","abstract":"\u003cp\u003eSets the field value based on the \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/HyperwalletUser/UserField.html\"\u003eUserField\u003c/a\u003e\u003c/code\u003e\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletUser/Builder.html#/s:14HyperwalletSDK0A4UserC7BuilderC8setField3key5valueAESS_SStF":{"name":"setField(key:value:)","abstract":"\u003cp\u003eSets the field value based on the \u003ccode\u003eUserField.RawValue\u003c/code\u003e\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletUser/Builder.html#/s:14HyperwalletSDK0A4UserC7BuilderC13stateProvinceyAESSF":{"name":"stateProvince(_:)","abstract":"\u003cp\u003eSets the user\u0026rsquo;s state, province or region.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletUser/Builder.html#/s:14HyperwalletSDK0A4UserC7BuilderC6statusyAeC6StatusOF":{"name":"status(_:)","abstract":"\u003cp\u003eSets the user account status.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletUser/Builder.html#/s:14HyperwalletSDK0A4UserC7BuilderC8timeZoneyAESSF":{"name":"timeZone(_:)","abstract":"\u003cp\u003eSets the local time of a region or a country. e.g. GMT, PST, \u0026hellip;\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletUser/Builder.html#/s:14HyperwalletSDK0A4UserC7BuilderC5tokenyAESSF":{"name":"token(_:)","abstract":"\u003cp\u003eSets the unique, auto-generated user identifier. Max 64 characters, prefixed with \u0026ldquo;usr-\u0026rdquo;.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletUser/Builder.html#/s:14HyperwalletSDK0A4UserC7BuilderC18verificationStatusyAeC012VerificationF0OF":{"name":"verificationStatus(_:)","abstract":"\u003cp\u003eSets the the user\u0026rsquo;s verification status. A user may be required to verify their identity after a certain","parent_name":"Builder"},"Classes/HyperwalletUser/VerificationStatus.html#/s:14HyperwalletSDK0A4UserC18VerificationStatusO6failedyA2EmF":{"name":"failed","abstract":"\u003cp\u003eThe user\u0026rsquo;s verification status is fail. Temporary status before changing to REQUIRED.\u003c/p\u003e","parent_name":"VerificationStatus"},"Classes/HyperwalletUser/VerificationStatus.html#/s:14HyperwalletSDK0A4UserC18VerificationStatusO11notRequiredyA2EmF":{"name":"notRequired","abstract":"\u003cp\u003eThe user\u0026rsquo;s verification status is not require.\u003c/p\u003e","parent_name":"VerificationStatus"},"Classes/HyperwalletUser/VerificationStatus.html#/s:14HyperwalletSDK0A4UserC18VerificationStatusO8requiredyA2EmF":{"name":"required","abstract":"\u003cp\u003eThe user\u0026rsquo;s verification status is require.\u003c/p\u003e","parent_name":"VerificationStatus"},"Classes/HyperwalletUser/VerificationStatus.html#/s:14HyperwalletSDK0A4UserC18VerificationStatusO11underReviewyA2EmF":{"name":"underReview","abstract":"\u003cp\u003eThe user\u0026rsquo;s verification status is under review.\u003c/p\u003e","parent_name":"VerificationStatus"},"Classes/HyperwalletUser/VerificationStatus.html#/s:14HyperwalletSDK0A4UserC18VerificationStatusO8verifiedyA2EmF":{"name":"verified","abstract":"\u003cp\u003eThe user\u0026rsquo;s verification status is verified.\u003c/p\u003e","parent_name":"VerificationStatus"},"Classes/HyperwalletUser/Status.html#/s:14HyperwalletSDK0A4UserC6StatusO9activatedyA2EmF":{"name":"activated","abstract":"\u003cp\u003eThe user account is activated.\u003c/p\u003e","parent_name":"Status"},"Classes/HyperwalletUser/Status.html#/s:14HyperwalletSDK0A4UserC6StatusO11deactivatedyA2EmF":{"name":"deactivated","abstract":"\u003cp\u003eThe user account is deactivated.\u003c/p\u003e","parent_name":"Status"},"Classes/HyperwalletUser/Status.html#/s:14HyperwalletSDK0A4UserC6StatusO6frozenyA2EmF":{"name":"frozen","abstract":"\u003cp\u003eThe user account is frozen.\u003c/p\u003e","parent_name":"Status"},"Classes/HyperwalletUser/Status.html#/s:14HyperwalletSDK0A4UserC6StatusO6lockedyA2EmF":{"name":"locked","abstract":"\u003cp\u003eThe user account is locked.\u003c/p\u003e","parent_name":"Status"},"Classes/HyperwalletUser/Status.html#/s:14HyperwalletSDK0A4UserC6StatusO12preActivatedyA2EmF":{"name":"preActivated","abstract":"\u003cp\u003eThe user account is pre activated.\u003c/p\u003e","parent_name":"Status"},"Classes/HyperwalletUser/ProfileType.html#/s:14HyperwalletSDK0A4UserC11ProfileTypeO8businessyA2EmF":{"name":"business","abstract":"\u003cp\u003eThe business profile type.\u003c/p\u003e","parent_name":"ProfileType"},"Classes/HyperwalletUser/ProfileType.html#/s:14HyperwalletSDK0A4UserC11ProfileTypeO10individualyA2EmF":{"name":"individual","abstract":"\u003cp\u003eThe individual profile type.\u003c/p\u003e","parent_name":"ProfileType"},"Classes/HyperwalletUser/Gender.html#/s:14HyperwalletSDK0A4UserC6GenderO6femaleyA2EmF":{"name":"female","abstract":"\u003cp\u003eThe female gender\u003c/p\u003e","parent_name":"Gender"},"Classes/HyperwalletUser/Gender.html#/s:14HyperwalletSDK0A4UserC6GenderO4maleyA2EmF":{"name":"male","abstract":"\u003cp\u003eThe male gender\u003c/p\u003e","parent_name":"Gender"},"Classes/HyperwalletUser/BusinessContactRole.html#/s:14HyperwalletSDK0A4UserC19BusinessContactRoleO8directoryA2EmF":{"name":"director","abstract":"\u003cp\u003eThe director role\u003c/p\u003e","parent_name":"BusinessContactRole"},"Classes/HyperwalletUser/BusinessContactRole.html#/s:14HyperwalletSDK0A4UserC19BusinessContactRoleO5otheryA2EmF":{"name":"other","abstract":"\u003cp\u003eThe other role\u003c/p\u003e","parent_name":"BusinessContactRole"},"Classes/HyperwalletUser/BusinessContactRole.html#/s:14HyperwalletSDK0A4UserC19BusinessContactRoleO5owneryA2EmF":{"name":"owner","abstract":"\u003cp\u003eThe owner role\u003c/p\u003e","parent_name":"BusinessContactRole"},"Classes/HyperwalletUser/BusinessType.html#/s:14HyperwalletSDK0A4UserC12BusinessTypeO11corporationyA2EmF":{"name":"corporation","abstract":"\u003cp\u003eThe corporation business type\u003c/p\u003e","parent_name":"BusinessType"},"Classes/HyperwalletUser/BusinessType.html#/s:14HyperwalletSDK0A4UserC12BusinessTypeO11partnershipyA2EmF":{"name":"partnership","abstract":"\u003cp\u003eThe partnership business type\u003c/p\u003e","parent_name":"BusinessType"},"Classes/HyperwalletUser/UserField.html#/s:14HyperwalletSDK0A4UserC0C5FieldO12addressLine1yA2EmF":{"name":"addressLine1","abstract":"\u003cp\u003eThe user\u0026rsquo;s street address.\u003c/p\u003e","parent_name":"UserField"},"Classes/HyperwalletUser/UserField.html#/s:14HyperwalletSDK0A4UserC0C5FieldO12addressLine2yA2EmF":{"name":"addressLine2","abstract":"\u003cp\u003eThe user\u0026rsquo;s address, second line.\u003c/p\u003e","parent_name":"UserField"},"Classes/HyperwalletUser/UserField.html#/s:14HyperwalletSDK0A4UserC0C5FieldO27businessContactAddressLine1yA2EmF":{"name":"businessContactAddressLine1","abstract":"\u003cp\u003eThe business contact\u0026rsquo;s street address.\u003c/p\u003e","parent_name":"UserField"},"Classes/HyperwalletUser/UserField.html#/s:14HyperwalletSDK0A4UserC0C5FieldO27businessContactAddressLine2yA2EmF":{"name":"businessContactAddressLine2","abstract":"\u003cp\u003eThe business contact\u0026rsquo;s address, second line.\u003c/p\u003e","parent_name":"UserField"},"Classes/HyperwalletUser/UserField.html#/s:14HyperwalletSDK0A4UserC0C5FieldO19businessContactCityyA2EmF":{"name":"businessContactCity","abstract":"\u003cp\u003eThe business contact\u0026rsquo;s city.\u003c/p\u003e","parent_name":"UserField"},"Classes/HyperwalletUser/UserField.html#/s:14HyperwalletSDK0A4UserC0C5FieldO22businessContactCountryyA2EmF":{"name":"businessContactCountry","abstract":"\u003cp\u003eThe business contact\u0026rsquo;s country.\u003c/p\u003e","parent_name":"UserField"},"Classes/HyperwalletUser/UserField.html#/s:14HyperwalletSDK0A4UserC0C5FieldO25businessContactPostalCodeyA2EmF":{"name":"businessContactPostalCode","abstract":"\u003cp\u003eThe business contact\u0026rsquo;s postal code.\u003c/p\u003e","parent_name":"UserField"},"Classes/HyperwalletUser/UserField.html#/s:14HyperwalletSDK0A4UserC0C5FieldO19businessContactRoleyA2EmF":{"name":"businessContactRole","abstract":"\u003cp\u003eThe user\u0026rsquo;s role in the organization.\u003c/p\u003e","parent_name":"UserField"},"Classes/HyperwalletUser/UserField.html#/s:14HyperwalletSDK0A4UserC0C5FieldO28businessContactStateProvinceyA2EmF":{"name":"businessContactStateProvince","abstract":"\u003cp\u003eThe business contact\u0026rsquo;s state, province or region.\u003c/p\u003e","parent_name":"UserField"},"Classes/HyperwalletUser/UserField.html#/s:14HyperwalletSDK0A4UserC0C5FieldO12businessNameyA2EmF":{"name":"businessName","abstract":"\u003cp\u003eThe business name.\u003c/p\u003e","parent_name":"UserField"},"Classes/HyperwalletUser/UserField.html#/s:14HyperwalletSDK0A4UserC0C5FieldO21businessOperatingNameyA2EmF":{"name":"businessOperatingName","abstract":"\u003cp\u003eThe business\u0026rsquo; operating name.\u003c/p\u003e","parent_name":"UserField"},"Classes/HyperwalletUser/UserField.html#/s:14HyperwalletSDK0A4UserC0C5FieldO27businessRegistrationCountryyA2EmF":{"name":"businessRegistrationCountry","abstract":"\u003cp\u003eThe country where the business is registered.\u003c/p\u003e","parent_name":"UserField"},"Classes/HyperwalletUser/UserField.html#/s:14HyperwalletSDK0A4UserC0C5FieldO22businessRegistrationIdyA2EmF":{"name":"businessRegistrationId","abstract":"\u003cp\u003eThe business registration number or identifier assigned by a government body.\u003c/p\u003e","parent_name":"UserField"},"Classes/HyperwalletUser/UserField.html#/s:14HyperwalletSDK0A4UserC0C5FieldO33businessRegistrationStateProvinceyA2EmF":{"name":"businessRegistrationStateProvince","abstract":"\u003cp\u003eThe state, province or region where the business is registered.\u003c/p\u003e","parent_name":"UserField"},"Classes/HyperwalletUser/UserField.html#/s:14HyperwalletSDK0A4UserC0C5FieldO12businessTypeyA2EmF":{"name":"businessType","abstract":"\u003cp\u003eThe business type.\u003c/p\u003e","parent_name":"UserField"},"Classes/HyperwalletUser/UserField.html#/s:14HyperwalletSDK0A4UserC0C5FieldO4cityyA2EmF":{"name":"city","abstract":"\u003cp\u003eThe user\u0026rsquo;s city.\u003c/p\u003e","parent_name":"UserField"},"Classes/HyperwalletUser/UserField.html#/s:14HyperwalletSDK0A4UserC0C5FieldO06clientC2IdyA2EmF":{"name":"clientUserId","abstract":"\u003cp\u003eA client-defined identifier for the user. This is the unique ID assigned to the user","parent_name":"UserField"},"Classes/HyperwalletUser/UserField.html#/s:14HyperwalletSDK0A4UserC0C5FieldO7countryyA2EmF":{"name":"country","abstract":"\u003cp\u003eThe user\u0026rsquo;s country.\u003c/p\u003e","parent_name":"UserField"},"Classes/HyperwalletUser/UserField.html#/s:14HyperwalletSDK0A4UserC0C5FieldO14countryOfBirthyA2EmF":{"name":"countryOfBirth","abstract":"\u003cp\u003eThe user\u0026rsquo;s birth country.\u003c/p\u003e","parent_name":"UserField"},"Classes/HyperwalletUser/UserField.html#/s:14HyperwalletSDK0A4UserC0C5FieldO20countryOfNationalityyA2EmF":{"name":"countryOfNationality","abstract":"\u003cp\u003eThe user\u0026rsquo;s country of citizenship or nationality.\u003c/p\u003e","parent_name":"UserField"},"Classes/HyperwalletUser/UserField.html#/s:14HyperwalletSDK0A4UserC0C5FieldO9createdOnyA2EmF":{"name":"createdOn","abstract":"\u003cp\u003eThe datetime the user account was created on in ISO 8601 format (YYYY-MM-DDThh:mm:ss).","parent_name":"UserField"},"Classes/HyperwalletUser/UserField.html#/s:14HyperwalletSDK0A4UserC0C5FieldO11dateOfBirthyA2EmF":{"name":"dateOfBirth","abstract":"\u003cp\u003eThe user\u0026rsquo;s date of birth (All users must be at least 13 years old).\u003c/p\u003e","parent_name":"UserField"},"Classes/HyperwalletUser/UserField.html#/s:14HyperwalletSDK0A4UserC0C5FieldO16driversLicenseIdyA2EmF":{"name":"driversLicenseId","abstract":"\u003cp\u003eThe user\u0026rsquo;s driver\u0026rsquo;s license number.\u003c/p\u003e","parent_name":"UserField"},"Classes/HyperwalletUser/UserField.html#/s:14HyperwalletSDK0A4UserC0C5FieldO5emailyA2EmF":{"name":"email","abstract":"\u003cp\u003eThe contact email address for the user account. This must be unique for your program,","parent_name":"UserField"},"Classes/HyperwalletUser/UserField.html#/s:14HyperwalletSDK0A4UserC0C5FieldO10employerIdyA2EmF":{"name":"employerId","abstract":"\u003cp\u003eThe user\u0026rsquo;s employer identifier, generally used for tax purposes.\u003c/p\u003e","parent_name":"UserField"},"Classes/HyperwalletUser/UserField.html#/s:14HyperwalletSDK0A4UserC0C5FieldO9firstNameyA2EmF":{"name":"firstName","abstract":"\u003cp\u003eThe user\u0026rsquo;s first name.\u003c/p\u003e","parent_name":"UserField"},"Classes/HyperwalletUser/UserField.html#/s:14HyperwalletSDK0A4UserC0C5FieldO6genderyA2EmF":{"name":"gender","abstract":"\u003cp\u003eThe user\u0026rsquo;s gender.\u003c/p\u003e","parent_name":"UserField"},"Classes/HyperwalletUser/UserField.html#/s:14HyperwalletSDK0A4UserC0C5FieldO12governmentIdyA2EmF":{"name":"governmentId","abstract":"\u003cp\u003eThe user\u0026rsquo;s government ID number, such as a Social Security Number.\u003c/p\u003e","parent_name":"UserField"},"Classes/HyperwalletUser/UserField.html#/s:14HyperwalletSDK0A4UserC0C5FieldO16governmentIdTypeyA2EmF":{"name":"governmentIdType","abstract":"\u003cp\u003eThe user\u0026rsquo;s government ID type.\u003c/p\u003e","parent_name":"UserField"},"Classes/HyperwalletUser/UserField.html#/s:14HyperwalletSDK0A4UserC0C5FieldO8languageyA2EmF":{"name":"language","abstract":"\u003cp\u003eThe preferred language for the user\u0026rsquo;s account. Defaults to English if not provided.\u003c/p\u003e","parent_name":"UserField"},"Classes/HyperwalletUser/UserField.html#/s:14HyperwalletSDK0A4UserC0C5FieldO8lastNameyA2EmF":{"name":"lastName","abstract":"\u003cp\u003eThe user\u0026rsquo;s last name.\u003c/p\u003e","parent_name":"UserField"},"Classes/HyperwalletUser/UserField.html#/s:14HyperwalletSDK0A4UserC0C5FieldO10middleNameyA2EmF":{"name":"middleName","abstract":"\u003cp\u003eThe user\u0026rsquo;s middle name.\u003c/p\u003e","parent_name":"UserField"},"Classes/HyperwalletUser/UserField.html#/s:14HyperwalletSDK0A4UserC0C5FieldO12mobileNumberyA2EmF":{"name":"mobileNumber","abstract":"\u003cp\u003eThe user\u0026rsquo;s cell phone number.\u003c/p\u003e","parent_name":"UserField"},"Classes/HyperwalletUser/UserField.html#/s:14HyperwalletSDK0A4UserC0C5FieldO10passportIdyA2EmF":{"name":"passportId","abstract":"\u003cp\u003eThe user\u0026rsquo;s passport number.\u003c/p\u003e","parent_name":"UserField"},"Classes/HyperwalletUser/UserField.html#/s:14HyperwalletSDK0A4UserC0C5FieldO11phoneNumberyA2EmF":{"name":"phoneNumber","abstract":"\u003cp\u003eThe user\u0026rsquo;s phone number.\u003c/p\u003e","parent_name":"UserField"},"Classes/HyperwalletUser/UserField.html#/s:14HyperwalletSDK0A4UserC0C5FieldO10postalCodeyA2EmF":{"name":"postalCode","abstract":"\u003cp\u003eThe user\u0026rsquo;s postal code.\u003c/p\u003e","parent_name":"UserField"},"Classes/HyperwalletUser/UserField.html#/s:14HyperwalletSDK0A4UserC0C5FieldO11profileTypeyA2EmF":{"name":"profileType","abstract":"\u003cp\u003eThe user\u0026rsquo;s postal code.\u003c/p\u003e","parent_name":"UserField"},"Classes/HyperwalletUser/UserField.html#/s:14HyperwalletSDK0A4UserC0C5FieldO12programTokenyA2EmF":{"name":"programToken","abstract":"\u003cp\u003eThe unique identifier for the program to which the user will belong.\u003c/p\u003e","parent_name":"UserField"},"Classes/HyperwalletUser/UserField.html#/s:14HyperwalletSDK0A4UserC0C5FieldO13stateProvinceyA2EmF":{"name":"stateProvince","abstract":"\u003cp\u003eThe user\u0026rsquo;s state, province or region.\u003c/p\u003e","parent_name":"UserField"},"Classes/HyperwalletUser/UserField.html#/s:14HyperwalletSDK0A4UserC0C5FieldO6statusyA2EmF":{"name":"status","abstract":"\u003cp\u003eThe user account status.\u003c/p\u003e","parent_name":"UserField"},"Classes/HyperwalletUser/UserField.html#/s:14HyperwalletSDK0A4UserC0C5FieldO8timeZoneyA2EmF":{"name":"timeZone","abstract":"\u003cp\u003eThe local time of a region or a country. e.g. GMT, PST, \u0026hellip;\u003c/p\u003e","parent_name":"UserField"},"Classes/HyperwalletUser/UserField.html#/s:14HyperwalletSDK0A4UserC0C5FieldO5tokenyA2EmF":{"name":"token","abstract":"\u003cp\u003eThe unique, auto-generated user identifier. Max 64 characters, prefixed with \u0026ldquo;usr-\u0026rdquo;.\u003c/p\u003e","parent_name":"UserField"},"Classes/HyperwalletUser/UserField.html#/s:14HyperwalletSDK0A4UserC0C5FieldO18verificationStatusyA2EmF":{"name":"verificationStatus","abstract":"\u003cp\u003eThe user\u0026rsquo;s verification status. A user may be required to verify their identity after","parent_name":"UserField"},"Classes/HyperwalletUser/UserField.html":{"name":"UserField","abstract":"\u003cp\u003eRepresentation of the user field type.\u003c/p\u003e","parent_name":"HyperwalletUser"},"Classes/HyperwalletUser/BusinessType.html":{"name":"BusinessType","abstract":"\u003cp\u003eThe business type.\u003c/p\u003e","parent_name":"HyperwalletUser"},"Classes/HyperwalletUser/BusinessContactRole.html":{"name":"BusinessContactRole","abstract":"\u003cp\u003eThe user\u0026rsquo;s role in the organization.\u003c/p\u003e","parent_name":"HyperwalletUser"},"Classes/HyperwalletUser/Gender.html":{"name":"Gender","abstract":"\u003cp\u003eRepresentation of the gender.\u003c/p\u003e","parent_name":"HyperwalletUser"},"Classes/HyperwalletUser/ProfileType.html":{"name":"ProfileType","abstract":"\u003cp\u003eRepresentation of the user\u0026rsquo;s profile type.\u003c/p\u003e","parent_name":"HyperwalletUser"},"Classes/HyperwalletUser/Status.html":{"name":"Status","abstract":"\u003cp\u003eRepresentation of the user account status type.\u003c/p\u003e","parent_name":"HyperwalletUser"},"Classes/HyperwalletUser/VerificationStatus.html":{"name":"VerificationStatus","abstract":"\u003cp\u003eRepresentation of the user\u0026rsquo;s verification status type.\u003c/p\u003e","parent_name":"HyperwalletUser"},"Classes/HyperwalletUser.html#/s:Se4fromxs7Decoder_p_tKcfc":{"name":"init(from:)","parent_name":"HyperwalletUser"},"Classes/HyperwalletUser.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletUser(py)addressLine1":{"name":"addressLine1","abstract":"\u003cp\u003eThe user\u0026rsquo;s street address.\u003c/p\u003e","parent_name":"HyperwalletUser"},"Classes/HyperwalletUser.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletUser(py)addressLine2":{"name":"addressLine2","abstract":"\u003cp\u003eThe user\u0026rsquo;s address, second line.\u003c/p\u003e","parent_name":"HyperwalletUser"},"Classes/HyperwalletUser.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletUser(py)businessContactAddressLine1":{"name":"businessContactAddressLine1","abstract":"\u003cp\u003eThe business contact\u0026rsquo;s street address.\u003c/p\u003e","parent_name":"HyperwalletUser"},"Classes/HyperwalletUser.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletUser(py)businessContactAddressLine2":{"name":"businessContactAddressLine2","abstract":"\u003cp\u003eThe business contact\u0026rsquo;s address, second line.\u003c/p\u003e","parent_name":"HyperwalletUser"},"Classes/HyperwalletUser.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletUser(py)businessContactCity":{"name":"businessContactCity","abstract":"\u003cp\u003eThe business contact\u0026rsquo;s city.\u003c/p\u003e","parent_name":"HyperwalletUser"},"Classes/HyperwalletUser.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletUser(py)businessContactCountry":{"name":"businessContactCountry","abstract":"\u003cp\u003eThe business contact\u0026rsquo;s country,\u003c/p\u003e","parent_name":"HyperwalletUser"},"Classes/HyperwalletUser.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletUser(py)businessContactPostalCode":{"name":"businessContactPostalCode","abstract":"\u003cp\u003eThe business contact\u0026rsquo;s postal code.\u003c/p\u003e","parent_name":"HyperwalletUser"},"Classes/HyperwalletUser.html#/s:14HyperwalletSDK0A4UserC19businessContactRoleAC08BusinesseF0OSgvp":{"name":"businessContactRole","abstract":"\u003cp\u003eThe user\u0026rsquo;s role in the organization\u003c/p\u003e","parent_name":"HyperwalletUser"},"Classes/HyperwalletUser.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletUser(py)businessContactStateProvince":{"name":"businessContactStateProvince","abstract":"\u003cp\u003eThe business contact\u0026rsquo;s state, province or region.\u003c/p\u003e","parent_name":"HyperwalletUser"},"Classes/HyperwalletUser.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletUser(py)businessName":{"name":"businessName","abstract":"\u003cp\u003eThe business name.\u003c/p\u003e","parent_name":"HyperwalletUser"},"Classes/HyperwalletUser.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletUser(py)businessOperatingName":{"name":"businessOperatingName","abstract":"\u003cp\u003eThe business\u0026rsquo; operating name.\u003c/p\u003e","parent_name":"HyperwalletUser"},"Classes/HyperwalletUser.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletUser(py)businessRegistrationCountry":{"name":"businessRegistrationCountry","abstract":"\u003cp\u003eThe country where the business is registered.\u003c/p\u003e","parent_name":"HyperwalletUser"},"Classes/HyperwalletUser.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletUser(py)businessRegistrationId":{"name":"businessRegistrationId","abstract":"\u003cp\u003eThe business registration number or identifier assigned by a government body.\u003c/p\u003e","parent_name":"HyperwalletUser"},"Classes/HyperwalletUser.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletUser(py)businessRegistrationStateProvince":{"name":"businessRegistrationStateProvince","abstract":"\u003cp\u003eThe state, province or region where the business is registered.\u003c/p\u003e","parent_name":"HyperwalletUser"},"Classes/HyperwalletUser.html#/s:14HyperwalletSDK0A4UserC12businessTypeAC08BusinessE0OSgvp":{"name":"businessType","abstract":"\u003cp\u003eThe business type\u003c/p\u003e","parent_name":"HyperwalletUser"},"Classes/HyperwalletUser.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletUser(py)city":{"name":"city","abstract":"\u003cp\u003eThe user\u0026rsquo;s city.\u003c/p\u003e","parent_name":"HyperwalletUser"},"Classes/HyperwalletUser.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletUser(py)clientUserId":{"name":"clientUserId","abstract":"\u003cp\u003eA client-defined identifier for the user. This is the unique ID assigned to the user on your system.\u003c/p\u003e","parent_name":"HyperwalletUser"},"Classes/HyperwalletUser.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletUser(py)country":{"name":"country","abstract":"\u003cp\u003eThe user\u0026rsquo;s country.\u003c/p\u003e","parent_name":"HyperwalletUser"},"Classes/HyperwalletUser.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletUser(py)countryOfBirth":{"name":"countryOfBirth","abstract":"\u003cp\u003eThe user\u0026rsquo;s birth country.\u003c/p\u003e","parent_name":"HyperwalletUser"},"Classes/HyperwalletUser.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletUser(py)countryOfNationality":{"name":"countryOfNationality","abstract":"\u003cp\u003eThe user\u0026rsquo;s country of citizenship or nationality.\u003c/p\u003e","parent_name":"HyperwalletUser"},"Classes/HyperwalletUser.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletUser(py)createdOn":{"name":"createdOn","abstract":"\u003cp\u003eThe datetime the user account was created on in ISO 8601 format (YYYY-MM-DDThh:mm:ss). Note that the timezone","parent_name":"HyperwalletUser"},"Classes/HyperwalletUser.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletUser(py)dateOfBirth":{"name":"dateOfBirth","abstract":"\u003cp\u003eThe user\u0026rsquo;s date of birth (All users must be at least 13 years old).\u003c/p\u003e","parent_name":"HyperwalletUser"},"Classes/HyperwalletUser.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletUser(py)driversLicenseId":{"name":"driversLicenseId","abstract":"\u003cp\u003eThe user\u0026rsquo;s driver\u0026rsquo;s license number.\u003c/p\u003e","parent_name":"HyperwalletUser"},"Classes/HyperwalletUser.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletUser(py)email":{"name":"email","abstract":"\u003cp\u003eThe contact email address for the user account. This must be unique for your program, so you cannot have two","parent_name":"HyperwalletUser"},"Classes/HyperwalletUser.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletUser(py)employerId":{"name":"employerId","abstract":"\u003cp\u003eThe user\u0026rsquo;s employer identifier, generally used for tax purposes.\u003c/p\u003e","parent_name":"HyperwalletUser"},"Classes/HyperwalletUser.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletUser(py)firstName":{"name":"firstName","abstract":"\u003cp\u003eThe user\u0026rsquo;s first name.\u003c/p\u003e","parent_name":"HyperwalletUser"},"Classes/HyperwalletUser.html#/s:14HyperwalletSDK0A4UserC6genderAC6GenderOSgvp":{"name":"gender","abstract":"\u003cp\u003eThe user\u0026rsquo;s gender.\u003c/p\u003e","parent_name":"HyperwalletUser"},"Classes/HyperwalletUser.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletUser(py)governmentId":{"name":"governmentId","abstract":"\u003cp\u003eThe user\u0026rsquo;s government ID number, such as a Social Security Number.\u003c/p\u003e","parent_name":"HyperwalletUser"},"Classes/HyperwalletUser.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletUser(py)governmentIdType":{"name":"governmentIdType","abstract":"\u003cp\u003eThe user\u0026rsquo;s government ID type.\u003c/p\u003e","parent_name":"HyperwalletUser"},"Classes/HyperwalletUser.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletUser(py)language":{"name":"language","abstract":"\u003cp\u003eThe preferred language for the user\u0026rsquo;s account. Defaults to English if not provided.\u003c/p\u003e","parent_name":"HyperwalletUser"},"Classes/HyperwalletUser.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletUser(py)lastName":{"name":"lastName","abstract":"\u003cp\u003eThe user\u0026rsquo;s last name.\u003c/p\u003e","parent_name":"HyperwalletUser"},"Classes/HyperwalletUser.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletUser(py)middleName":{"name":"middleName","abstract":"\u003cp\u003eThe user\u0026rsquo;s middle name.\u003c/p\u003e","parent_name":"HyperwalletUser"},"Classes/HyperwalletUser.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletUser(py)mobileNumber":{"name":"mobileNumber","abstract":"\u003cp\u003eThe user\u0026rsquo;s cell phone number.\u003c/p\u003e","parent_name":"HyperwalletUser"},"Classes/HyperwalletUser.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletUser(py)passportId":{"name":"passportId","abstract":"\u003cp\u003eThe user\u0026rsquo;s passport number.\u003c/p\u003e","parent_name":"HyperwalletUser"},"Classes/HyperwalletUser.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletUser(py)phoneNumber":{"name":"phoneNumber","abstract":"\u003cp\u003eThe user\u0026rsquo;s phone number.\u003c/p\u003e","parent_name":"HyperwalletUser"},"Classes/HyperwalletUser.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletUser(py)postalCode":{"name":"postalCode","abstract":"\u003cp\u003eThe user\u0026rsquo;s postal code.\u003c/p\u003e","parent_name":"HyperwalletUser"},"Classes/HyperwalletUser.html#/s:14HyperwalletSDK0A4UserC11profileTypeAC07ProfileE0OSgvp":{"name":"profileType","abstract":"\u003cp\u003eThe user\u0026rsquo;s profile type. See \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/HyperwalletUser/ProfileType.html\"\u003eProfileType\u003c/a\u003e\u003c/code\u003e\u003c/p\u003e","parent_name":"HyperwalletUser"},"Classes/HyperwalletUser.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletUser(py)programToken":{"name":"programToken","abstract":"\u003cp\u003eThe unique identifier for the program to which the user will belong.\u003c/p\u003e","parent_name":"HyperwalletUser"},"Classes/HyperwalletUser.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletUser(py)stateProvince":{"name":"stateProvince","abstract":"\u003cp\u003eThe user\u0026rsquo;s state, province or region.\u003c/p\u003e","parent_name":"HyperwalletUser"},"Classes/HyperwalletUser.html#/s:14HyperwalletSDK0A4UserC6statusAC6StatusOSgvp":{"name":"status","abstract":"\u003cp\u003eThe user account status.\u003c/p\u003e","parent_name":"HyperwalletUser"},"Classes/HyperwalletUser.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletUser(py)timeZone":{"name":"timeZone","abstract":"\u003cp\u003eThe local time of a region or a country. e.g. GMT, PST, \u0026hellip;\u003c/p\u003e","parent_name":"HyperwalletUser"},"Classes/HyperwalletUser.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletUser(py)token":{"name":"token","abstract":"\u003cp\u003eThe unique, auto-generated user identifier. Max 64 characters, prefixed with \u0026ldquo;usr-\u0026rdquo;.\u003c/p\u003e","parent_name":"HyperwalletUser"},"Classes/HyperwalletUser.html#/s:14HyperwalletSDK0A4UserC18verificationStatusAC012VerificationE0OSgvp":{"name":"verificationStatus","abstract":"\u003cp\u003eThe user\u0026rsquo;s verification status. A user may be required to verify their identity after a certain","parent_name":"HyperwalletUser"},"Classes/HyperwalletUser.html#/s:SE6encode2toys7Encoder_p_tKF":{"name":"encode(to:)","parent_name":"HyperwalletUser"},"Classes/HyperwalletUser.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletUser(im)getField:":{"name":"getField(_:)","abstract":"\u003cp\u003eGets the field value\u003c/p\u003e","parent_name":"HyperwalletUser"},"Classes/HyperwalletUser/Builder.html":{"name":"Builder","abstract":"\u003cp\u003eA helper class to build the \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/HyperwalletUser.html\"\u003eHyperwalletUser\u003c/a\u003e\u003c/code\u003e instance.\u003c/p\u003e","parent_name":"HyperwalletUser"},"Classes/HyperwalletVenmoQueryParam.html#/s:14HyperwalletSDK0A15VenmoQueryParamC02toD0SDyS2SGyF":{"name":"toQuery()","parent_name":"HyperwalletVenmoQueryParam"},"Classes/HyperwalletVenmoAccount/Builder.html#/s:14HyperwalletSDK0A12VenmoAccountC7BuilderC5tokenAESS_tcfc":{"name":"init(token:)","abstract":"\u003cp\u003eCreates a new instance of the \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/HyperwalletVenmoAccount.html\"\u003eHyperwalletVenmoAccount\u003c/a\u003e\u003c/code\u003e based on the required parameter to update","parent_name":"Builder"},"Classes/HyperwalletVenmoAccount/Builder.html#/s:14HyperwalletSDK0A12VenmoAccountC7BuilderC21transferMethodCountry0fG8Currency0fG11ProfileTypeAESS_S2Stcfc":{"name":"init(transferMethodCountry:transferMethodCurrency:transferMethodProfileType:)","abstract":"\u003cp\u003eCreates a new instance of the \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/HyperwalletVenmoAccount.html\"\u003eHyperwalletVenmoAccount\u003c/a\u003e\u003c/code\u003e based on the required parameters to create","parent_name":"Builder"},"Classes/HyperwalletVenmoAccount/Builder.html#/s:14HyperwalletSDK0A12VenmoAccountC7BuilderC9accountIdyAESSF":{"name":"accountId(_:)","abstract":"\u003cp\u003eSets the accountId address\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletVenmoAccount/Builder.html#/s:14HyperwalletSDK0A12VenmoAccountC7BuilderC11profileTypeyAESSF":{"name":"profileType(_:)","abstract":"\u003cp\u003eSets the bank account holder\u0026rsquo;s profile type.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletVenmoAccount/Builder.html#/s:14HyperwalletSDK0A12VenmoAccountC7BuilderC5buildACyF":{"name":"build()","abstract":"\u003cp\u003eBuilds a new instance of the \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/HyperwalletVenmoAccount.html\"\u003eHyperwalletVenmoAccount\u003c/a\u003e\u003c/code\u003e.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletVenmoAccount.html#/s:14HyperwalletSDK0A12VenmoAccountC4fromACs7Decoder_p_tKcfc":{"name":"init(from:)","abstract":"\u003cp\u003eThe required initializer\u003c/p\u003e","parent_name":"HyperwalletVenmoAccount"},"Classes/HyperwalletVenmoAccount.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletVenmoAccount(py)accountId":{"name":"accountId","abstract":"\u003cp\u003eThe accountId as phone number.\u003c/p\u003e","parent_name":"HyperwalletVenmoAccount"},"Classes/HyperwalletVenmoAccount/Builder.html":{"name":"Builder","abstract":"\u003cp\u003eA helper class to build the \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/HyperwalletVenmoAccount.html\"\u003eHyperwalletVenmoAccount\u003c/a\u003e\u003c/code\u003e instance.\u003c/p\u003e","parent_name":"HyperwalletVenmoAccount"},"Classes/HyperwalletTransferMethodQueryParam/QueryType.html#/s:14HyperwalletSDK0A24TransferMethodQueryParamC0E4TypeO11bankAccountyA2EmF":{"name":"bankAccount","abstract":"\u003cp\u003eWhen the transfer method is Bank Account\u003c/p\u003e","parent_name":"QueryType"},"Classes/HyperwalletTransferMethodQueryParam/QueryType.html#/s:14HyperwalletSDK0A24TransferMethodQueryParamC0E4TypeO8bankCardyA2EmF":{"name":"bankCard","abstract":"\u003cp\u003eWhen the transfer method is Bank Card\u003c/p\u003e","parent_name":"QueryType"},"Classes/HyperwalletTransferMethodQueryParam/QueryType.html#/s:14HyperwalletSDK0A24TransferMethodQueryParamC0E4TypeO13payPalAccountyA2EmF":{"name":"payPalAccount","abstract":"\u003cp\u003eWhen the transfer method is PayPal Account\u003c/p\u003e","parent_name":"QueryType"},"Classes/HyperwalletTransferMethodQueryParam/QueryType.html#/s:14HyperwalletSDK0A24TransferMethodQueryParamC0E4TypeO11wireAccountyA2EmF":{"name":"wireAccount","abstract":"\u003cp\u003eWhen the transfer method is Wire Account\u003c/p\u003e","parent_name":"QueryType"},"Classes/HyperwalletTransferMethodQueryParam/QueryType.html#/s:14HyperwalletSDK0A24TransferMethodQueryParamC0E4TypeO11prepaidCardyA2EmF":{"name":"prepaidCard","abstract":"\u003cp\u003eWhen the transfer method is Prepaid Card\u003c/p\u003e","parent_name":"QueryType"},"Classes/HyperwalletTransferMethodQueryParam/QueryType.html#/s:14HyperwalletSDK0A24TransferMethodQueryParamC0E4TypeO12venmoAccountyA2EmF":{"name":"venmoAccount","abstract":"\u003cp\u003eWhen the transfer method is Venmo Account\u003c/p\u003e","parent_name":"QueryType"},"Classes/HyperwalletTransferMethodQueryParam/QueryType.html#/s:14HyperwalletSDK0A24TransferMethodQueryParamC0E4TypeO10paperCheckyA2EmF":{"name":"paperCheck","abstract":"\u003cp\u003eWhen the transfer method is Paper Check\u003c/p\u003e","parent_name":"QueryType"},"Classes/HyperwalletTransferMethodQueryParam/QuerySortable.html#/s:14HyperwalletSDK0A24TransferMethodQueryParamC0E8SortableO18ascendantCreatedOnyA2EmF":{"name":"ascendantCreatedOn","abstract":"\u003cp\u003eSort the result by ascendant created on\u003c/p\u003e","parent_name":"QuerySortable"},"Classes/HyperwalletTransferMethodQueryParam/QuerySortable.html#/s:14HyperwalletSDK0A24TransferMethodQueryParamC0E8SortableO15ascendantStatusyA2EmF":{"name":"ascendantStatus","abstract":"\u003cp\u003eSort the result by ascendant status\u003c/p\u003e","parent_name":"QuerySortable"},"Classes/HyperwalletTransferMethodQueryParam/QuerySortable.html#/s:14HyperwalletSDK0A24TransferMethodQueryParamC0E8SortableO19descendantCreatedOnyA2EmF":{"name":"descendantCreatedOn","abstract":"\u003cp\u003eSort the result by descendant created on\u003c/p\u003e","parent_name":"QuerySortable"},"Classes/HyperwalletTransferMethodQueryParam/QuerySortable.html#/s:14HyperwalletSDK0A24TransferMethodQueryParamC0E8SortableO16descendantStatusyA2EmF":{"name":"descendantStatus","abstract":"\u003cp\u003eSort the result by descendant status\u003c/p\u003e","parent_name":"QuerySortable"},"Classes/HyperwalletTransferMethodQueryParam/QueryStatus.html#/s:14HyperwalletSDK0A24TransferMethodQueryParamC0E6StatusO9activatedyA2EmF":{"name":"activated","abstract":"\u003cp\u003eFilter by activated transfer methods\u003c/p\u003e","parent_name":"QueryStatus"},"Classes/HyperwalletTransferMethodQueryParam/QueryStatus.html#/s:14HyperwalletSDK0A24TransferMethodQueryParamC0E6StatusO11deActivatedyA2EmF":{"name":"deActivated","abstract":"\u003cp\u003eFilter by deActivated transfer methods\u003c/p\u003e","parent_name":"QueryStatus"},"Classes/HyperwalletTransferMethodQueryParam/QueryStatus.html#/s:14HyperwalletSDK0A24TransferMethodQueryParamC0E6StatusO7invalidyA2EmF":{"name":"invalid","abstract":"\u003cp\u003eFilter only invalid transfer methods\u003c/p\u003e","parent_name":"QueryStatus"},"Classes/HyperwalletTransferMethodQueryParam/QueryStatus.html#/s:14HyperwalletSDK0A24TransferMethodQueryParamC0E6StatusO12lostOrStolenyA2EmF":{"name":"lostOrStolen","abstract":"\u003cp\u003eFilter only lost or stolen prepaid cards\u003c/p\u003e","parent_name":"QueryStatus"},"Classes/HyperwalletTransferMethodQueryParam/QueryStatus.html#/s:14HyperwalletSDK0A24TransferMethodQueryParamC0E6StatusO12preActivatedyA2EmF":{"name":"preActivated","abstract":"\u003cp\u003eFilter by preActivated prepaid cards\u003c/p\u003e","parent_name":"QueryStatus"},"Classes/HyperwalletTransferMethodQueryParam/QueryStatus.html#/s:14HyperwalletSDK0A24TransferMethodQueryParamC0E6StatusO9suspendedyA2EmF":{"name":"suspended","abstract":"\u003cp\u003eFilter only suspended prepaid cards\u003c/p\u003e","parent_name":"QueryStatus"},"Classes/HyperwalletTransferMethodQueryParam/QueryStatus.html#/s:14HyperwalletSDK0A24TransferMethodQueryParamC0E6StatusO8verifiedyA2EmF":{"name":"verified","abstract":"\u003cp\u003eFilter only verified transfer methods\u003c/p\u003e","parent_name":"QueryStatus"},"Classes/HyperwalletTransferMethodQueryParam.html#/s:14HyperwalletSDK0A24TransferMethodQueryParamC6statusSSSgvp":{"name":"status","abstract":"\u003cp\u003eReturns transfer method with this status.\u003c/p\u003e","parent_name":"HyperwalletTransferMethodQueryParam"},"Classes/HyperwalletTransferMethodQueryParam.html#/s:14HyperwalletSDK0A24TransferMethodQueryParamC4typeSSSgvp":{"name":"type","abstract":"\u003cp\u003eReturns transfer method of that type\u003c/p\u003e","parent_name":"HyperwalletTransferMethodQueryParam"},"Classes/HyperwalletTransferMethodQueryParam/QueryStatus.html":{"name":"QueryStatus","abstract":"\u003cp\u003eRepresentation of the transfer method status\u003c/p\u003e","parent_name":"HyperwalletTransferMethodQueryParam"},"Classes/HyperwalletTransferMethodQueryParam/QuerySortable.html":{"name":"QuerySortable","abstract":"\u003cp\u003eRepresentation of the field\u0026rsquo;s sortable\u003c/p\u003e","parent_name":"HyperwalletTransferMethodQueryParam"},"Classes/HyperwalletTransferMethodQueryParam/QueryType.html":{"name":"QueryType","abstract":"\u003cp\u003eRepresentation of the transfer method\u0026rsquo;s type\u003c/p\u003e","parent_name":"HyperwalletTransferMethodQueryParam"},"Classes/HyperwalletTransferMethodQueryParam.html#/s:14HyperwalletSDK0A24TransferMethodQueryParamC02toE0SDyS2SGyF":{"name":"toQuery()","parent_name":"HyperwalletTransferMethodQueryParam"},"Classes/HyperwalletTransferMethod/TransferMethodType.html#/s:14HyperwalletSDK0A14TransferMethodC0cD4TypeO11bankAccountyA2EmF":{"name":"bankAccount","abstract":"\u003cp\u003eWhen the transfer method is Bank Account\u003c/p\u003e","parent_name":"TransferMethodType"},"Classes/HyperwalletTransferMethod/TransferMethodType.html#/s:14HyperwalletSDK0A14TransferMethodC0cD4TypeO8bankCardyA2EmF":{"name":"bankCard","abstract":"\u003cp\u003eWhen the transfer method is Bank Card\u003c/p\u003e","parent_name":"TransferMethodType"},"Classes/HyperwalletTransferMethod/TransferMethodType.html#/s:14HyperwalletSDK0A14TransferMethodC0cD4TypeO13payPalAccountyA2EmF":{"name":"payPalAccount","abstract":"\u003cp\u003eWhen the transfer method is PayPal Account\u003c/p\u003e","parent_name":"TransferMethodType"},"Classes/HyperwalletTransferMethod/TransferMethodType.html#/s:14HyperwalletSDK0A14TransferMethodC0cD4TypeO11wireAccountyA2EmF":{"name":"wireAccount","abstract":"\u003cp\u003eWhen the transfer method is Wire Account\u003c/p\u003e","parent_name":"TransferMethodType"},"Classes/HyperwalletTransferMethod/TransferMethodType.html#/s:14HyperwalletSDK0A14TransferMethodC0cD4TypeO11prepaidCardyA2EmF":{"name":"prepaidCard","abstract":"\u003cp\u003eWhen the transfer method is Prepaid Card\u003c/p\u003e","parent_name":"TransferMethodType"},"Classes/HyperwalletTransferMethod/TransferMethodType.html#/s:14HyperwalletSDK0A14TransferMethodC0cD4TypeO12venmoAccountyA2EmF":{"name":"venmoAccount","abstract":"\u003cp\u003eWhen the transfer method is Venmo Account\u003c/p\u003e","parent_name":"TransferMethodType"},"Classes/HyperwalletTransferMethod/TransferMethodType.html#/s:14HyperwalletSDK0A14TransferMethodC0cD4TypeO10paperCheckyA2EmF":{"name":"paperCheck","abstract":"\u003cp\u003ewhen transfer method is paper check\u003c/p\u003e","parent_name":"TransferMethodType"},"Classes/HyperwalletTransferMethod/TransferMethodField.html#/s:14HyperwalletSDK0A14TransferMethodC0cD5FieldO9createdOnyA2EmF":{"name":"createdOn","abstract":"\u003cp\u003eThe datetime when the transfer method was created on.\u003c/p\u003e","parent_name":"TransferMethodField"},"Classes/HyperwalletTransferMethod/TransferMethodField.html#/s:14HyperwalletSDK0A14TransferMethodC0cD5FieldO6statusyA2EmF":{"name":"status","abstract":"\u003cp\u003eThe transfer method status transition.\u003c/p\u003e","parent_name":"TransferMethodField"},"Classes/HyperwalletTransferMethod/TransferMethodField.html#/s:14HyperwalletSDK0A14TransferMethodC0cD5FieldO5tokenyA2EmF":{"name":"token","abstract":"\u003cp\u003eThe transfer method identifier.\u003c/p\u003e","parent_name":"TransferMethodField"},"Classes/HyperwalletTransferMethod/TransferMethodField.html#/s:14HyperwalletSDK0A14TransferMethodC0cD5FieldO08transferD7CountryyA2EmF":{"name":"transferMethodCountry","abstract":"\u003cp\u003eThe transfer method country.\u003c/p\u003e","parent_name":"TransferMethodField"},"Classes/HyperwalletTransferMethod/TransferMethodField.html#/s:14HyperwalletSDK0A14TransferMethodC0cD5FieldO08transferD8CurrencyyA2EmF":{"name":"transferMethodCurrency","abstract":"\u003cp\u003eThe transfer method currency.\u003c/p\u003e","parent_name":"TransferMethodField"},"Classes/HyperwalletTransferMethod/TransferMethodField.html#/s:14HyperwalletSDK0A14TransferMethodC0cD5FieldO4typeyA2EmF":{"name":"type","abstract":"\u003cp\u003eThe transfer method type.\u003c/p\u003e","parent_name":"TransferMethodField"},"Classes/HyperwalletTransferMethod/TransferMethodField.html#/s:14HyperwalletSDK0A14TransferMethodC0cD5FieldO12addressLine1yA2EmF":{"name":"addressLine1","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s street address.\u003c/p\u003e","parent_name":"TransferMethodField"},"Classes/HyperwalletTransferMethod/TransferMethodField.html#/s:14HyperwalletSDK0A14TransferMethodC0cD5FieldO12addressLine2yA2EmF":{"name":"addressLine2","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s address, second line.\u003c/p\u003e","parent_name":"TransferMethodField"},"Classes/HyperwalletTransferMethod/TransferMethodField.html#/s:14HyperwalletSDK0A14TransferMethodC0cD5FieldO13bankAccountIdyA2EmF":{"name":"bankAccountId","abstract":"\u003cp\u003eThe bank account number, IBAN or equivalent. If you are providing an IBAN,","parent_name":"TransferMethodField"},"Classes/HyperwalletTransferMethod/TransferMethodField.html#/s:14HyperwalletSDK0A14TransferMethodC0cD5FieldO18bankAccountPurposeyA2EmF":{"name":"bankAccountPurpose","abstract":"\u003cp\u003eThe purpose of the bank account (e.g. checking, savings, etc).\u003c/p\u003e","parent_name":"TransferMethodField"},"Classes/HyperwalletTransferMethod/TransferMethodField.html#/s:14HyperwalletSDK0A14TransferMethodC0cD5FieldO23bankAccountRelationshipyA2EmF":{"name":"bankAccountRelationship","abstract":"\u003cp\u003eThe user\u0026rsquo;s relationship with the bank account holder.\u003c/p\u003e","parent_name":"TransferMethodField"},"Classes/HyperwalletTransferMethod/TransferMethodField.html#/s:14HyperwalletSDK0A14TransferMethodC0cD5FieldO6bankIdyA2EmF":{"name":"bankId","abstract":"\u003cp\u003eThe bank code or equivalent (e.g. BIC/SWIFT code).\u003c/p\u003e","parent_name":"TransferMethodField"},"Classes/HyperwalletTransferMethod/TransferMethodField.html#/s:14HyperwalletSDK0A14TransferMethodC0cD5FieldO8bankNameyA2EmF":{"name":"bankName","abstract":"\u003cp\u003eThe bank name.\u003c/p\u003e","parent_name":"TransferMethodField"},"Classes/HyperwalletTransferMethod/TransferMethodField.html#/s:14HyperwalletSDK0A14TransferMethodC0cD5FieldO8branchIdyA2EmF":{"name":"branchId","abstract":"\u003cp\u003eThe branch code, transit number, routing number or equivalent.\u003c/p\u003e","parent_name":"TransferMethodField"},"Classes/HyperwalletTransferMethod/TransferMethodField.html#/s:14HyperwalletSDK0A14TransferMethodC0cD5FieldO10branchNameyA2EmF":{"name":"branchName","abstract":"\u003cp\u003eThe branch name\u003c/p\u003e","parent_name":"TransferMethodField"},"Classes/HyperwalletTransferMethod/TransferMethodField.html#/s:14HyperwalletSDK0A14TransferMethodC0cD5FieldO19businessContactRoleyA2EmF":{"name":"businessContactRole","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s role in the organization.\u003c/p\u003e","parent_name":"TransferMethodField"},"Classes/HyperwalletTransferMethod/TransferMethodField.html#/s:14HyperwalletSDK0A14TransferMethodC0cD5FieldO12businessNameyA2EmF":{"name":"businessName","abstract":"\u003cp\u003eThe name of the transfer method holder\u0026rsquo;s business\u003c/p\u003e","parent_name":"TransferMethodField"},"Classes/HyperwalletTransferMethod/TransferMethodField.html#/s:14HyperwalletSDK0A14TransferMethodC0cD5FieldO27businessRegistrationCountryyA2EmF":{"name":"businessRegistrationCountry","abstract":"\u003cp\u003eThe country where the transfer method holder\u0026rsquo;s business is registered\u003c/p\u003e","parent_name":"TransferMethodField"},"Classes/HyperwalletTransferMethod/TransferMethodField.html#/s:14HyperwalletSDK0A14TransferMethodC0cD5FieldO22businessRegistrationIdyA2EmF":{"name":"businessRegistrationId","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s business registration number or identifier, as","parent_name":"TransferMethodField"},"Classes/HyperwalletTransferMethod/TransferMethodField.html#/s:14HyperwalletSDK0A14TransferMethodC0cD5FieldO33businessRegistrationStateProvinceyA2EmF":{"name":"businessRegistrationStateProvince","abstract":"\u003cp\u003eThe state, province or region where the bank account holder\u0026rsquo;s business","parent_name":"TransferMethodField"},"Classes/HyperwalletTransferMethod/TransferMethodField.html#/s:14HyperwalletSDK0A14TransferMethodC0cD5FieldO12businessTypeyA2EmF":{"name":"businessType","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s business type.\u003c/p\u003e","parent_name":"TransferMethodField"},"Classes/HyperwalletTransferMethod/TransferMethodField.html#/s:14HyperwalletSDK0A14TransferMethodC0cD5FieldO4cityyA2EmF":{"name":"city","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s city.\u003c/p\u003e","parent_name":"TransferMethodField"},"Classes/HyperwalletTransferMethod/TransferMethodField.html#/s:14HyperwalletSDK0A14TransferMethodC0cD5FieldO7countryyA2EmF":{"name":"country","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s country.\u003c/p\u003e","parent_name":"TransferMethodField"},"Classes/HyperwalletTransferMethod/TransferMethodField.html#/s:14HyperwalletSDK0A14TransferMethodC0cD5FieldO14countryOfBirthyA2EmF":{"name":"countryOfBirth","abstract":"\u003cp\u003eThe country where bank account holder born\u003c/p\u003e","parent_name":"TransferMethodField"},"Classes/HyperwalletTransferMethod/TransferMethodField.html#/s:14HyperwalletSDK0A14TransferMethodC0cD5FieldO20countryOfNationalityyA2EmF":{"name":"countryOfNationality","abstract":"\u003cp\u003eThe Nationality of the bank account holder\u003c/p\u003e","parent_name":"TransferMethodField"},"Classes/HyperwalletTransferMethod/TransferMethodField.html#/s:14HyperwalletSDK0A14TransferMethodC0cD5FieldO11dateOfBirthyA2EmF":{"name":"dateOfBirth","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s date of birth.\u003c/p\u003e","parent_name":"TransferMethodField"},"Classes/HyperwalletTransferMethod/TransferMethodField.html#/s:14HyperwalletSDK0A14TransferMethodC0cD5FieldO16driversLicenseIdyA2EmF":{"name":"driversLicenseId","abstract":"\u003cp\u003eThe LicenseId of the bank account holder\u003c/p\u003e","parent_name":"TransferMethodField"},"Classes/HyperwalletTransferMethod/TransferMethodField.html#/s:14HyperwalletSDK0A14TransferMethodC0cD5FieldO10employerIdyA2EmF":{"name":"employerId","abstract":"\u003cp\u003eThe employer Id of the bank account holder\u003c/p\u003e","parent_name":"TransferMethodField"},"Classes/HyperwalletTransferMethod/TransferMethodField.html#/s:14HyperwalletSDK0A14TransferMethodC0cD5FieldO9firstNameyA2EmF":{"name":"firstName","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s first name.\u003c/p\u003e","parent_name":"TransferMethodField"},"Classes/HyperwalletTransferMethod/TransferMethodField.html#/s:14HyperwalletSDK0A14TransferMethodC0cD5FieldO6genderyA2EmF":{"name":"gender","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s gender\u003c/p\u003e","parent_name":"TransferMethodField"},"Classes/HyperwalletTransferMethod/TransferMethodField.html#/s:14HyperwalletSDK0A14TransferMethodC0cD5FieldO12governmentIdyA2EmF":{"name":"governmentId","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s government ID number, such as a Social Security Number.\u003c/p\u003e","parent_name":"TransferMethodField"},"Classes/HyperwalletTransferMethod/TransferMethodField.html#/s:14HyperwalletSDK0A14TransferMethodC0cD5FieldO16governmentIdTypeyA2EmF":{"name":"governmentIdType","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s government IdType\u003c/p\u003e","parent_name":"TransferMethodField"},"Classes/HyperwalletTransferMethod/TransferMethodField.html#/s:14HyperwalletSDK0A14TransferMethodC0cD5FieldO25intermediaryBankAccountIdyA2EmF":{"name":"intermediaryBankAccountId","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s Intermediary Bank AccountId\u003c/p\u003e","parent_name":"TransferMethodField"},"Classes/HyperwalletTransferMethod/TransferMethodField.html#/s:14HyperwalletSDK0A14TransferMethodC0cD5FieldO28intermediaryBankAddressLine1yA2EmF":{"name":"intermediaryBankAddressLine1","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s Intermediary Bank AddressLine1\u003c/p\u003e","parent_name":"TransferMethodField"},"Classes/HyperwalletTransferMethod/TransferMethodField.html#/s:14HyperwalletSDK0A14TransferMethodC0cD5FieldO28intermediaryBankAddressLine2yA2EmF":{"name":"intermediaryBankAddressLine2","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s Intermediary Bank AddressLine2\u003c/p\u003e","parent_name":"TransferMethodField"},"Classes/HyperwalletTransferMethod/TransferMethodField.html#/s:14HyperwalletSDK0A14TransferMethodC0cD5FieldO20intermediaryBankCityyA2EmF":{"name":"intermediaryBankCity","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s Intermediary Bank\u0026rsquo;s City\u003c/p\u003e","parent_name":"TransferMethodField"},"Classes/HyperwalletTransferMethod/TransferMethodField.html#/s:14HyperwalletSDK0A14TransferMethodC0cD5FieldO23intermediaryBankCountryyA2EmF":{"name":"intermediaryBankCountry","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s Intermediary Bank\u0026rsquo;s Country\u003c/p\u003e","parent_name":"TransferMethodField"},"Classes/HyperwalletTransferMethod/TransferMethodField.html#/s:14HyperwalletSDK0A14TransferMethodC0cD5FieldO18intermediaryBankIdyA2EmF":{"name":"intermediaryBankId","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s Intermediary Bank Id\u003c/p\u003e","parent_name":"TransferMethodField"},"Classes/HyperwalletTransferMethod/TransferMethodField.html#/s:14HyperwalletSDK0A14TransferMethodC0cD5FieldO20intermediaryBankNameyA2EmF":{"name":"intermediaryBankName","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s Intermediary Bank Name\u003c/p\u003e","parent_name":"TransferMethodField"},"Classes/HyperwalletTransferMethod/TransferMethodField.html#/s:14HyperwalletSDK0A14TransferMethodC0cD5FieldO26intermediaryBankPostalCodeyA2EmF":{"name":"intermediaryBankPostalCode","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s Intermediary PostalCode:\u003c/p\u003e","parent_name":"TransferMethodField"},"Classes/HyperwalletTransferMethod/TransferMethodField.html#/s:14HyperwalletSDK0A14TransferMethodC0cD5FieldO29intermediaryBankStateProvinceyA2EmF":{"name":"intermediaryBankStateProvince","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s Intermediary Bank\u0026rsquo;s State and Province\u003c/p\u003e","parent_name":"TransferMethodField"},"Classes/HyperwalletTransferMethod/TransferMethodField.html#/s:14HyperwalletSDK0A14TransferMethodC0cD5FieldO8lastNameyA2EmF":{"name":"lastName","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s last name.\u003c/p\u003e","parent_name":"TransferMethodField"},"Classes/HyperwalletTransferMethod/TransferMethodField.html#/s:14HyperwalletSDK0A14TransferMethodC0cD5FieldO10middleNameyA2EmF":{"name":"middleName","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s middle name.\u003c/p\u003e","parent_name":"TransferMethodField"},"Classes/HyperwalletTransferMethod/TransferMethodField.html#/s:14HyperwalletSDK0A14TransferMethodC0cD5FieldO12mobileNumberyA2EmF":{"name":"mobileNumber","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s mobile number\u003c/p\u003e","parent_name":"TransferMethodField"},"Classes/HyperwalletTransferMethod/TransferMethodField.html#/s:14HyperwalletSDK0A14TransferMethodC0cD5FieldO10passportIdyA2EmF":{"name":"passportId","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s passport Id\u003c/p\u003e","parent_name":"TransferMethodField"},"Classes/HyperwalletTransferMethod/TransferMethodField.html#/s:14HyperwalletSDK0A14TransferMethodC0cD5FieldO11phoneNumberyA2EmF":{"name":"phoneNumber","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s phone number.\u003c/p\u003e","parent_name":"TransferMethodField"},"Classes/HyperwalletTransferMethod/TransferMethodField.html#/s:14HyperwalletSDK0A14TransferMethodC0cD5FieldO10postalCodeyA2EmF":{"name":"postalCode","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s postal code.\u003c/p\u003e","parent_name":"TransferMethodField"},"Classes/HyperwalletTransferMethod/TransferMethodField.html#/s:14HyperwalletSDK0A14TransferMethodC0cD5FieldO11profileTypeyA2EmF":{"name":"profileType","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s profile type.\u003c/p\u003e","parent_name":"TransferMethodField"},"Classes/HyperwalletTransferMethod/TransferMethodField.html#/s:14HyperwalletSDK0A14TransferMethodC0cD5FieldO13stateProvinceyA2EmF":{"name":"stateProvince","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s state, province or region.\u003c/p\u003e","parent_name":"TransferMethodField"},"Classes/HyperwalletTransferMethod/TransferMethodField.html#/s:14HyperwalletSDK0A14TransferMethodC0cD5FieldO16wireInstructionsyA2EmF":{"name":"wireInstructions","abstract":"\u003cp\u003eThe wire transfer instructions\u003c/p\u003e","parent_name":"TransferMethodField"},"Classes/HyperwalletTransferMethod/TransferMethodField.html#/s:14HyperwalletSDK0A14TransferMethodC0cD5FieldO9cardBrandyA2EmF":{"name":"cardBrand","abstract":"\u003cp\u003eThe card brand.\u003c/p\u003e","parent_name":"TransferMethodField"},"Classes/HyperwalletTransferMethod/TransferMethodField.html#/s:14HyperwalletSDK0A14TransferMethodC0cD5FieldO10cardNumberyA2EmF":{"name":"cardNumber","abstract":"\u003cp\u003eThe 16-digit card number.\u003c/p\u003e","parent_name":"TransferMethodField"},"Classes/HyperwalletTransferMethod/TransferMethodField.html#/s:14HyperwalletSDK0A14TransferMethodC0cD5FieldO8cardTypeyA2EmF":{"name":"cardType","abstract":"\u003cp\u003eThe bank card type.\u003c/p\u003e","parent_name":"TransferMethodField"},"Classes/HyperwalletTransferMethod/TransferMethodField.html#/s:14HyperwalletSDK0A14TransferMethodC0cD5FieldO3cvvyA2EmF":{"name":"cvv","abstract":"\u003cp\u003eThe card security code which is embossed or printed on the card.\u003c/p\u003e","parent_name":"TransferMethodField"},"Classes/HyperwalletTransferMethod/TransferMethodField.html#/s:14HyperwalletSDK0A14TransferMethodC0cD5FieldO12dateOfExpiryyA2EmF":{"name":"dateOfExpiry","abstract":"\u003cp\u003eThe expiration date for the card (YYYY-MM).\u003c/p\u003e","parent_name":"TransferMethodField"},"Classes/HyperwalletTransferMethod/TransferMethodField.html#/s:14HyperwalletSDK0A14TransferMethodC0cD5FieldO16primaryCardTokenyA2EmF":{"name":"primaryCardToken","abstract":"\u003cp\u003eThe primary card token\u003c/p\u003e","parent_name":"TransferMethodField"},"Classes/HyperwalletTransferMethod/TransferMethodField.html#/s:14HyperwalletSDK0A14TransferMethodC0cD5FieldO5emailyA2EmF":{"name":"email","abstract":"\u003cp\u003eThe email address associated with the PayPal account.\u003c/p\u003e","parent_name":"TransferMethodField"},"Classes/HyperwalletTransferMethod/TransferMethodField.html#/s:14HyperwalletSDK0A14TransferMethodC0cD5FieldO9accountIdyA2EmF":{"name":"accountId","abstract":"\u003cp\u003eThe mobile number associated with the Venmo account.\u003c/p\u003e","parent_name":"TransferMethodField"},"Classes/HyperwalletTransferMethod/TransferMethodField.html#/s:14HyperwalletSDK0A14TransferMethodC0cD5FieldO11cardPackageyA2EmF":{"name":"cardPackage","abstract":"\u003cp\u003eThe card\u0026rsquo;s package\u003c/p\u003e","parent_name":"TransferMethodField"},"Classes/HyperwalletTransferMethod/TransferMethodField.html#/s:14HyperwalletSDK0A14TransferMethodC0cD5FieldO9userTokenyA2EmF":{"name":"userToken","abstract":"\u003cp\u003eThe user token\u003c/p\u003e","parent_name":"TransferMethodField"},"Classes/HyperwalletTransferMethod/TransferMethodField.html#/s:14HyperwalletSDK0A14TransferMethodC0cD5FieldO08shippingD0yA2EmF":{"name":"shippingMethod","abstract":"\u003cp\u003eThe shipping method\u003c/p\u003e","parent_name":"TransferMethodField"},"Classes/HyperwalletTransferMethod/TransferMethodField.html":{"name":"TransferMethodField","abstract":"\u003cp\u003eRepresentation of the transfer method\u0026rsquo;s field type\u003c/p\u003e","parent_name":"HyperwalletTransferMethod"},"Classes/HyperwalletTransferMethod/TransferMethodType.html":{"name":"TransferMethodType","abstract":"\u003cp\u003eRepresentation of the transfer method\u0026rsquo;s type\u003c/p\u003e","parent_name":"HyperwalletTransferMethod"},"Classes/HyperwalletTransferMethod.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletTransferMethod(im)init":{"name":"init()","abstract":"\u003cp\u003eCreates a new instance of the \u003ccode\u003eHyperwalletTransferMethod\u003c/code\u003e\u003c/p\u003e","parent_name":"HyperwalletTransferMethod"},"Classes/HyperwalletTransferMethod.html#/s:Se4fromxs7Decoder_p_tKcfc":{"name":"init(from:)","parent_name":"HyperwalletTransferMethod"},"Classes/HyperwalletTransferMethod.html#/s:SE6encode2toys7Encoder_p_tKF":{"name":"encode(to:)","parent_name":"HyperwalletTransferMethod"},"Classes/HyperwalletTransferMethod.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletTransferMethod(im)getField:":{"name":"getField(_:)","abstract":"\u003cp\u003eGets the field value\u003c/p\u003e","parent_name":"HyperwalletTransferMethod"},"Classes/HyperwalletTransferMethod.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletTransferMethod(im)setFieldWithKey:value:":{"name":"setField(key:value:)","abstract":"\u003cp\u003eSets the field value based on the key\u003c/p\u003e","parent_name":"HyperwalletTransferMethod"},"Classes/HyperwalletTransferMethod.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletTransferMethod(py)createdOn":{"name":"createdOn","abstract":"\u003cp\u003eThe transfer method\u0026rsquo;s created time\u003c/p\u003e","parent_name":"HyperwalletTransferMethod"},"Classes/HyperwalletTransferMethod.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletTransferMethod(py)profileType":{"name":"profileType","abstract":"\u003cp\u003eThe transfer method holder\u0026rsquo;s profile type, e.g. INDIVIDUAL or BUSINESS.\u003c/p\u003e","parent_name":"HyperwalletTransferMethod"},"Classes/HyperwalletTransferMethod.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletTransferMethod(py)status":{"name":"status","abstract":"\u003cp\u003eThe transfer method\u0026rsquo;s status\u003c/p\u003e","parent_name":"HyperwalletTransferMethod"},"Classes/HyperwalletTransferMethod.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletTransferMethod(py)token":{"name":"token","abstract":"\u003cp\u003eThe transfer method\u0026rsquo;s token\u003c/p\u003e","parent_name":"HyperwalletTransferMethod"},"Classes/HyperwalletTransferMethod.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletTransferMethod(py)transferMethodCountry":{"name":"transferMethodCountry","abstract":"\u003cp\u003eThe transfer method\u0026rsquo;s country\u003c/p\u003e","parent_name":"HyperwalletTransferMethod"},"Classes/HyperwalletTransferMethod.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletTransferMethod(py)transferMethodCurrency":{"name":"transferMethodCurrency","abstract":"\u003cp\u003eThe transfer method\u0026rsquo;s currency\u003c/p\u003e","parent_name":"HyperwalletTransferMethod"},"Classes/HyperwalletTransferMethod.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletTransferMethod(py)type":{"name":"type","abstract":"\u003cp\u003eThe transfer method\u0026rsquo;s type\u003c/p\u003e","parent_name":"HyperwalletTransferMethod"},"Classes/HyperwalletPrepaidCardQueryParam.html#/s:14HyperwalletSDK0A21PrepaidCardQueryParamC02toE0SDyS2SGyF":{"name":"toQuery()","parent_name":"HyperwalletPrepaidCardQueryParam"},"Classes/HyperwalletPrepaidCard/Builder.html#/s:14HyperwalletSDK0A11PrepaidCardC7BuilderC5tokenAESS_tcfc":{"name":"init(token:)","abstract":"\u003cp\u003eCreates a new instance of the \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/HyperwalletPayPalAccount.html\"\u003eHyperwalletPayPalAccount\u003c/a\u003e\u003c/code\u003e based on the required parameter to update","parent_name":"Builder"},"Classes/HyperwalletPrepaidCard/Builder.html#/s:14HyperwalletSDK0A11PrepaidCardC7BuilderC25transferMethodProfileTypeAESS_tcfc":{"name":"init(transferMethodProfileType:)","abstract":"\u003cp\u003eCreates a new instance of the \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/HyperwalletPrepaidCard.html\"\u003eHyperwalletPrepaidCard\u003c/a\u003e\u003c/code\u003e based on the required parameters to create","parent_name":"Builder"},"Classes/HyperwalletPrepaidCard/Builder.html#/s:14HyperwalletSDK0A11PrepaidCardC7BuilderC11cardPackageyAESSF":{"name":"cardPackage(_:)","abstract":"\u003cp\u003eSets the card package\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletPrepaidCard/Builder.html#/s:14HyperwalletSDK0A11PrepaidCardC7BuilderC9userTokenyAESSF":{"name":"userToken(_:)","abstract":"\u003cp\u003eSets userToken for an instant issue card\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletPrepaidCard/Builder.html#/s:14HyperwalletSDK0A11PrepaidCardC7BuilderC5buildACyF":{"name":"build()","abstract":"\u003cp\u003eBuilds a new instance of the \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/HyperwalletPrepaidCard.html\"\u003eHyperwalletPrepaidCard\u003c/a\u003e\u003c/code\u003e.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletPrepaidCard.html#/s:14HyperwalletSDK0A11PrepaidCardC4fromACs7Decoder_p_tKcfc":{"name":"init(from:)","abstract":"\u003cp\u003eThe required initializer\u003c/p\u003e","parent_name":"HyperwalletPrepaidCard"},"Classes/HyperwalletPrepaidCard.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletPrepaidCard(py)cardType":{"name":"cardType","abstract":"\u003cp\u003eThe prepaid card\u0026rsquo;s type\u003c/p\u003e","parent_name":"HyperwalletPrepaidCard"},"Classes/HyperwalletPrepaidCard.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletPrepaidCard(py)cardPackage":{"name":"cardPackage","abstract":"\u003cp\u003eThe prepaid card\u0026rsquo;s package\u003c/p\u003e","parent_name":"HyperwalletPrepaidCard"},"Classes/HyperwalletPrepaidCard.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletPrepaidCard(py)cardNumber":{"name":"cardNumber","abstract":"\u003cp\u003eThe prepaid card\u0026rsquo;s number\u003c/p\u003e","parent_name":"HyperwalletPrepaidCard"},"Classes/HyperwalletPrepaidCard.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletPrepaidCard(py)cardBrand":{"name":"cardBrand","abstract":"\u003cp\u003eThe prepaid card\u0026rsquo;s brand\u003c/p\u003e","parent_name":"HyperwalletPrepaidCard"},"Classes/HyperwalletPrepaidCard.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletPrepaidCard(py)dateOfExpiry":{"name":"dateOfExpiry","abstract":"\u003cp\u003eThe prepaid card\u0026rsquo;s expiry date\u003c/p\u003e","parent_name":"HyperwalletPrepaidCard"},"Classes/HyperwalletPrepaidCard.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletPrepaidCard(py)primaryCardToken":{"name":"primaryCardToken","abstract":"\u003cp\u003eThe primary prepaid card\u0026rsquo;s token\u003c/p\u003e","parent_name":"HyperwalletPrepaidCard"},"Classes/HyperwalletPrepaidCard.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletPrepaidCard(py)userToken":{"name":"userToken","abstract":"\u003cp\u003eThe prepaid card\u0026rsquo;s user token (instant issue cards only)\u003c/p\u003e","parent_name":"HyperwalletPrepaidCard"},"Classes/HyperwalletPrepaidCard/Builder.html":{"name":"Builder","abstract":"\u003cp\u003eA helper class to build the \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/HyperwalletPrepaidCard.html\"\u003eHyperwalletPrepaidCard\u003c/a\u003e\u003c/code\u003e instance.\u003c/p\u003e","parent_name":"HyperwalletPrepaidCard"},"Classes/HyperwalletPayPalAccountQueryParam.html#/s:14HyperwalletSDK0A23PayPalAccountQueryParamC02toF0SDyS2SGyF":{"name":"toQuery()","parent_name":"HyperwalletPayPalAccountQueryParam"},"Classes/HyperwalletPayPalAccount/Builder.html#/s:14HyperwalletSDK0A13PayPalAccountC7BuilderC5tokenAESS_tcfc":{"name":"init(token:)","abstract":"\u003cp\u003eCreates a new instance of the \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/HyperwalletPayPalAccount.html\"\u003eHyperwalletPayPalAccount\u003c/a\u003e\u003c/code\u003e based on the required parameter to update","parent_name":"Builder"},"Classes/HyperwalletPayPalAccount/Builder.html#/s:14HyperwalletSDK0A13PayPalAccountC7BuilderC21transferMethodCountry0gH8Currency0gH11ProfileTypeAESS_S2Stcfc":{"name":"init(transferMethodCountry:transferMethodCurrency:transferMethodProfileType:)","abstract":"\u003cp\u003eCreates a new instance of the \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/HyperwalletPayPalAccount.html\"\u003eHyperwalletPayPalAccount\u003c/a\u003e\u003c/code\u003e based on the required parameters to create","parent_name":"Builder"},"Classes/HyperwalletPayPalAccount/Builder.html#/s:14HyperwalletSDK0A13PayPalAccountC7BuilderC5emailyAESSF":{"name":"email(_:)","abstract":"\u003cp\u003eSets the email address\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletPayPalAccount/Builder.html#/s:14HyperwalletSDK0A13PayPalAccountC7BuilderC11profileTypeyAESSF":{"name":"profileType(_:)","abstract":"\u003cp\u003eSets the bank account holder\u0026rsquo;s profile type.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletPayPalAccount/Builder.html#/s:14HyperwalletSDK0A13PayPalAccountC7BuilderC5buildACyF":{"name":"build()","abstract":"\u003cp\u003eBuilds a new instance of the \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/HyperwalletPayPalAccount.html\"\u003eHyperwalletPayPalAccount\u003c/a\u003e\u003c/code\u003e.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletPayPalAccount.html#/s:14HyperwalletSDK0A13PayPalAccountC4fromACs7Decoder_p_tKcfc":{"name":"init(from:)","abstract":"\u003cp\u003eThe required initializer\u003c/p\u003e","parent_name":"HyperwalletPayPalAccount"},"Classes/HyperwalletPayPalAccount.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletPayPalAccount(py)email":{"name":"email","abstract":"\u003cp\u003eThe email address.\u003c/p\u003e","parent_name":"HyperwalletPayPalAccount"},"Classes/HyperwalletPayPalAccount/Builder.html":{"name":"Builder","abstract":"\u003cp\u003eA helper class to build the \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/HyperwalletPayPalAccount.html\"\u003eHyperwalletPayPalAccount\u003c/a\u003e\u003c/code\u003e instance.\u003c/p\u003e","parent_name":"HyperwalletPayPalAccount"},"Classes/HyperwalletPaperCheckQueryParam.html#/s:14HyperwalletSDK0A20PaperCheckQueryParamC02toE0SDyS2SGyF":{"name":"toQuery()","parent_name":"HyperwalletPaperCheckQueryParam"},"Classes/HyperwalletPaperCheck/Builder.html#/s:14HyperwalletSDK0A10PaperCheckC7BuilderC5tokenAESS_tcfc":{"name":"init(token:)","abstract":"\u003cp\u003eCreates a new instance of the \u003ccode\u003eHyperwalletPaperCheck.Builder\u003c/code\u003e","parent_name":"Builder"},"Classes/HyperwalletPaperCheck/Builder.html#/s:14HyperwalletSDK0A10PaperCheckC7BuilderC21transferMethodCountry0fG8Currency0fG11ProfileType0fgK0AESS_S3Stcfc":{"name":"init(transferMethodCountry:transferMethodCurrency:transferMethodProfileType:transferMethodType:)","abstract":"\u003cp\u003eCreates a new instance of the \u003ccode\u003eHyperwalletPaperCheck.Builder\u003c/code\u003e","parent_name":"Builder"},"Classes/HyperwalletPaperCheck/Builder.html#/s:14HyperwalletSDK0A10PaperCheckC7BuilderC12addressLine1yAESSF":{"name":"addressLine1(_:)","abstract":"\u003cp\u003eSets the bank account holder\u0026rsquo;s street address.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletPaperCheck/Builder.html#/s:14HyperwalletSDK0A10PaperCheckC7BuilderC12addressLine2yAESSF":{"name":"addressLine2(_:)","abstract":"\u003cp\u003eSets the bank account holder\u0026rsquo;s address, second line.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletPaperCheck/Builder.html#/s:14HyperwalletSDK0A10PaperCheckC7BuilderC23bankAccountRelationshipyAESSF":{"name":"bankAccountRelationship(_:)","abstract":"\u003cp\u003eSets the user\u0026rsquo;s relationship with the bank account holder.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletPaperCheck/Builder.html#/s:14HyperwalletSDK0A10PaperCheckC7BuilderC4cityyAESSF":{"name":"city(_:)","abstract":"\u003cp\u003eSets the bank account holder\u0026rsquo;s city.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletPaperCheck/Builder.html#/s:14HyperwalletSDK0A10PaperCheckC7BuilderC7countryyAESSF":{"name":"country(_:)","abstract":"\u003cp\u003eSets the bank account holder\u0026rsquo;s country.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletPaperCheck/Builder.html#/s:14HyperwalletSDK0A10PaperCheckC7BuilderC10postalCodeyAESSF":{"name":"postalCode(_:)","abstract":"\u003cp\u003eSets the bank account holder\u0026rsquo;s postal code.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletPaperCheck/Builder.html#/s:14HyperwalletSDK0A10PaperCheckC7BuilderC14shippingMethodyAESSF":{"name":"shippingMethod(_:)","abstract":"\u003cp\u003eSets the shipping method for paper check.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletPaperCheck/Builder.html#/s:14HyperwalletSDK0A10PaperCheckC7BuilderC13stateProvinceyAESSF":{"name":"stateProvince(_:)","abstract":"\u003cp\u003eSets the bank account holder\u0026rsquo;s state, province or region.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletPaperCheck/Builder.html#/s:14HyperwalletSDK0A10PaperCheckC7BuilderC11profileTypeyAESSF":{"name":"profileType(_:)","parent_name":"Builder"},"Classes/HyperwalletPaperCheck/Builder.html#/s:14HyperwalletSDK0A10PaperCheckC7BuilderC8lastNameyAESSF":{"name":"lastName(_:)","abstract":"\u003cp\u003eSets the bank account holder\u0026rsquo;s last name.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletPaperCheck/Builder.html#/s:14HyperwalletSDK0A10PaperCheckC7BuilderC10middleNameyAESSF":{"name":"middleName(_:)","abstract":"\u003cp\u003eSets the bank account holder\u0026rsquo;s middle name.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletPaperCheck/Builder.html#/s:14HyperwalletSDK0A10PaperCheckC7BuilderC12mobileNumberyAESSF":{"name":"mobileNumber(_:)","abstract":"\u003cp\u003eSets the bank account holder\u0026rsquo;s cell phone number.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletPaperCheck/Builder.html#/s:14HyperwalletSDK0A10PaperCheckC7BuilderC10passportIdyAESSF":{"name":"passportId(_:)","abstract":"\u003cp\u003eSets the bank account holder\u0026rsquo;s passport number.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletPaperCheck/Builder.html#/s:14HyperwalletSDK0A10PaperCheckC7BuilderC11phoneNumberyAESSF":{"name":"phoneNumber(_:)","abstract":"\u003cp\u003eSets the bank account holder\u0026rsquo;s phone number.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletPaperCheck/Builder.html#/s:14HyperwalletSDK0A10PaperCheckC7BuilderC14countryOfBirthyAESSF":{"name":"countryOfBirth(_:)","abstract":"\u003cp\u003eSets the bank account holder\u0026rsquo;s birth country.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletPaperCheck/Builder.html#/s:14HyperwalletSDK0A10PaperCheckC7BuilderC20countryOfNationalityyAESSF":{"name":"countryOfNationality(_:)","parent_name":"Builder"},"Classes/HyperwalletPaperCheck/Builder.html#/s:14HyperwalletSDK0A10PaperCheckC7BuilderC11dateOfBirthyAESSF":{"name":"dateOfBirth(_:)","abstract":"\u003cp\u003eSets the bank account holder\u0026rsquo;s date of birth (All users must be at least 13 years old).\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletPaperCheck/Builder.html#/s:14HyperwalletSDK0A10PaperCheckC7BuilderC16driversLicenseIdyAESSF":{"name":"driversLicenseId(_:)","abstract":"\u003cp\u003eSets the bank account holder\u0026rsquo;s driver\u0026rsquo;s license number.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletPaperCheck/Builder.html#/s:14HyperwalletSDK0A10PaperCheckC7BuilderC10employerIdyAESSF":{"name":"employerId(_:)","abstract":"\u003cp\u003eSets the bank account holder\u0026rsquo;s employer identifier, generally used for tax purposes.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletPaperCheck/Builder.html#/s:14HyperwalletSDK0A10PaperCheckC7BuilderC9firstNameyAESSF":{"name":"firstName(_:)","abstract":"\u003cp\u003eSets the bank account holder\u0026rsquo;s first name.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletPaperCheck/Builder.html#/s:14HyperwalletSDK0A10PaperCheckC7BuilderC6genderyAESSF":{"name":"gender(_:)","abstract":"\u003cp\u003eSets the bank account holder\u0026rsquo;s gender.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletPaperCheck/Builder.html#/s:14HyperwalletSDK0A10PaperCheckC7BuilderC12governmentIdyAESSF":{"name":"governmentId(_:)","abstract":"\u003cp\u003eSets the bank account holder\u0026rsquo;s government ID number, such as a Social Security Number.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletPaperCheck/Builder.html#/s:14HyperwalletSDK0A10PaperCheckC7BuilderC16governmentIdTypeyAESSF":{"name":"governmentIdType(_:)","abstract":"\u003cp\u003eSets the bank account holder\u0026rsquo;s government ID type.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletPaperCheck/Builder.html#/s:14HyperwalletSDK0A10PaperCheckC7BuilderC19businessContactRoleyAESSF":{"name":"businessContactRole(_:)","abstract":"\u003cp\u003eSets the bank account holder\u0026rsquo;s role in the organization.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletPaperCheck/Builder.html#/s:14HyperwalletSDK0A10PaperCheckC7BuilderC12businessNameyAESSF":{"name":"businessName(_:)","abstract":"\u003cp\u003eSets the name of the bank account holder\u0026rsquo;s business.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletPaperCheck/Builder.html#/s:14HyperwalletSDK0A10PaperCheckC7BuilderC27businessRegistrationCountryyAESSF":{"name":"businessRegistrationCountry(_:)","abstract":"\u003cp\u003eSets the country where the bank account holder\u0026rsquo;s business is registered.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletPaperCheck/Builder.html#/s:14HyperwalletSDK0A10PaperCheckC7BuilderC22businessRegistrationIdyAESSF":{"name":"businessRegistrationId(_:)","abstract":"\u003cp\u003eSets the bank account holder\u0026rsquo;s business registration number or identifier,","parent_name":"Builder"},"Classes/HyperwalletPaperCheck/Builder.html#/s:14HyperwalletSDK0A10PaperCheckC7BuilderC33businessRegistrationStateProvinceyAESSF":{"name":"businessRegistrationStateProvince(_:)","abstract":"\u003cp\u003eSets the state, province or region where the bank account holder\u0026rsquo;s business is registered.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletPaperCheck/Builder.html#/s:14HyperwalletSDK0A10PaperCheckC7BuilderC12businessTypeyAESSF":{"name":"businessType(_:)","abstract":"\u003cp\u003eSets the bank account holder\u0026rsquo;s business type.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletPaperCheck/Builder.html#/s:14HyperwalletSDK0A10PaperCheckC7BuilderC5buildACyF":{"name":"build()","abstract":"\u003cp\u003eBuilds a new instance of the \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/HyperwalletPaperCheck.html\"\u003eHyperwalletPaperCheck\u003c/a\u003e\u003c/code\u003e.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletPaperCheck.html#/s:14HyperwalletSDK0A10PaperCheckC4fromACs7Decoder_p_tKcfc":{"name":"init(from:)","abstract":"\u003cp\u003eThe required initializer\u003c/p\u003e","parent_name":"HyperwalletPaperCheck"},"Classes/HyperwalletPaperCheck.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletPaperCheck(py)bankAccountRelationship":{"name":"bankAccountRelationship","abstract":"\u003cp\u003eThe user\u0026rsquo;s relationship with the bank account holder.\u003c/p\u003e","parent_name":"HyperwalletPaperCheck"},"Classes/HyperwalletPaperCheck.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletPaperCheck(py)addressLine1":{"name":"addressLine1","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s street address.\u003c/p\u003e","parent_name":"HyperwalletPaperCheck"},"Classes/HyperwalletPaperCheck.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletPaperCheck(py)addressLine2":{"name":"addressLine2","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s address, second line.\u003c/p\u003e","parent_name":"HyperwalletPaperCheck"},"Classes/HyperwalletPaperCheck.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletPaperCheck(py)city":{"name":"city","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s city.\u003c/p\u003e","parent_name":"HyperwalletPaperCheck"},"Classes/HyperwalletPaperCheck.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletPaperCheck(py)country":{"name":"country","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s country.\u003c/p\u003e","parent_name":"HyperwalletPaperCheck"},"Classes/HyperwalletPaperCheck.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletPaperCheck(py)postalCode":{"name":"postalCode","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s postal code.\u003c/p\u003e","parent_name":"HyperwalletPaperCheck"},"Classes/HyperwalletPaperCheck.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletPaperCheck(py)stateProvince":{"name":"stateProvince","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s state, province or region.\u003c/p\u003e","parent_name":"HyperwalletPaperCheck"},"Classes/HyperwalletPaperCheck.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletPaperCheck(py)shippingMethod":{"name":"shippingMethod","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s state, province or region.\u003c/p\u003e","parent_name":"HyperwalletPaperCheck"},"Classes/HyperwalletPaperCheck.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletPaperCheck(py)businessName":{"name":"businessName","abstract":"\u003cp\u003eThe name of the bank account holder\u0026rsquo;s business.\u003c/p\u003e","parent_name":"HyperwalletPaperCheck"},"Classes/HyperwalletPaperCheck.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletPaperCheck(py)businessRegistrationCountry":{"name":"businessRegistrationCountry","abstract":"\u003cp\u003eThe country where the bank account holder\u0026rsquo;s business is registered.\u003c/p\u003e","parent_name":"HyperwalletPaperCheck"},"Classes/HyperwalletPaperCheck.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletPaperCheck(py)businessRegistrationId":{"name":"businessRegistrationId","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s business registration number or identifier,","parent_name":"HyperwalletPaperCheck"},"Classes/HyperwalletPaperCheck.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletPaperCheck(py)businessRegistrationStateProvince":{"name":"businessRegistrationStateProvince","abstract":"\u003cp\u003eThe state, province or region where the bank account holder\u0026rsquo;s business is registered.\u003c/p\u003e","parent_name":"HyperwalletPaperCheck"},"Classes/HyperwalletPaperCheck.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletPaperCheck(py)businessType":{"name":"businessType","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s business type.\u003c/p\u003e","parent_name":"HyperwalletPaperCheck"},"Classes/HyperwalletPaperCheck.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletPaperCheck(py)countryOfBirth":{"name":"countryOfBirth","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s birth country.\u003c/p\u003e","parent_name":"HyperwalletPaperCheck"},"Classes/HyperwalletPaperCheck.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletPaperCheck(py)countryOfNationality":{"name":"countryOfNationality","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s nationality country.\u003c/p\u003e","parent_name":"HyperwalletPaperCheck"},"Classes/HyperwalletPaperCheck.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletPaperCheck(py)dateOfBirth":{"name":"dateOfBirth","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s date of birth (All users must be at least 13 years old).\u003c/p\u003e","parent_name":"HyperwalletPaperCheck"},"Classes/HyperwalletPaperCheck.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletPaperCheck(py)driversLicenseId":{"name":"driversLicenseId","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s driver\u0026rsquo;s license number.\u003c/p\u003e","parent_name":"HyperwalletPaperCheck"},"Classes/HyperwalletPaperCheck.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletPaperCheck(py)employerId":{"name":"employerId","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s employer identifier, generally used for tax purposes.\u003c/p\u003e","parent_name":"HyperwalletPaperCheck"},"Classes/HyperwalletPaperCheck.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletPaperCheck(py)firstName":{"name":"firstName","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s first name.\u003c/p\u003e","parent_name":"HyperwalletPaperCheck"},"Classes/HyperwalletPaperCheck.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletPaperCheck(py)gender":{"name":"gender","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s gender.\u003c/p\u003e","parent_name":"HyperwalletPaperCheck"},"Classes/HyperwalletPaperCheck.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletPaperCheck(py)governmentId":{"name":"governmentId","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s government ID number, such as a Social Security Number.\u003c/p\u003e","parent_name":"HyperwalletPaperCheck"},"Classes/HyperwalletPaperCheck.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletPaperCheck(py)governmentIdType":{"name":"governmentIdType","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s government ID type.\u003c/p\u003e","parent_name":"HyperwalletPaperCheck"},"Classes/HyperwalletPaperCheck.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletPaperCheck(py)phoneNumber":{"name":"phoneNumber","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s phone number.\u003c/p\u003e","parent_name":"HyperwalletPaperCheck"},"Classes/HyperwalletPaperCheck.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletPaperCheck(py)mobileNumber":{"name":"mobileNumber","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s cell phone number.\u003c/p\u003e","parent_name":"HyperwalletPaperCheck"},"Classes/HyperwalletPaperCheck.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletPaperCheck(py)lastName":{"name":"lastName","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s last name.\u003c/p\u003e","parent_name":"HyperwalletPaperCheck"},"Classes/HyperwalletPaperCheck.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletPaperCheck(py)middleName":{"name":"middleName","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s middle name.\u003c/p\u003e","parent_name":"HyperwalletPaperCheck"},"Classes/HyperwalletPaperCheck.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletPaperCheck(py)passportId":{"name":"passportId","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s passport number.\u003c/p\u003e","parent_name":"HyperwalletPaperCheck"},"Classes/HyperwalletPaperCheck/Builder.html":{"name":"Builder","abstract":"\u003cp\u003eA helper class to build the \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/HyperwalletPaperCheck.html\"\u003eHyperwalletPaperCheck\u003c/a\u003e\u003c/code\u003e instance.\u003c/p\u003e","parent_name":"HyperwalletPaperCheck"},"Classes/HyperwalletBankCardQueryParam.html#/s:14HyperwalletSDK0A18BankCardQueryParamC02toE0SDyS2SGyF":{"name":"toQuery()","parent_name":"HyperwalletBankCardQueryParam"},"Classes/HyperwalletBankCard/Builder.html#/s:14HyperwalletSDK0A8BankCardC7BuilderC5tokenAESS_tcfc":{"name":"init(token:)","abstract":"\u003cp\u003eCreates a new instance of the \u003ccode\u003eHyperwalletBankCard.Builder\u003c/code\u003e based on the required parameter to update","parent_name":"Builder"},"Classes/HyperwalletBankCard/Builder.html#/s:14HyperwalletSDK0A8BankCardC7BuilderC21transferMethodCountry0fG8Currency0fG11ProfileTypeAESS_S2Stcfc":{"name":"init(transferMethodCountry:transferMethodCurrency:transferMethodProfileType:)","abstract":"\u003cp\u003eCreates a new instance of the \u003ccode\u003eHyperwalletBankCard.Builder\u003c/code\u003e based on the required parameters to create","parent_name":"Builder"},"Classes/HyperwalletBankCard/Builder.html#/s:14HyperwalletSDK0A8BankCardC7BuilderC5buildACyF":{"name":"build()","abstract":"\u003cp\u003eBuilds a new instance of the \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/HyperwalletBankCard.html\"\u003eHyperwalletBankCard\u003c/a\u003e\u003c/code\u003e.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletBankCard/Builder.html#/s:14HyperwalletSDK0A8BankCardC7BuilderC10cardNumberyAESSF":{"name":"cardNumber(_:)","abstract":"\u003cp\u003eSets the card number\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletBankCard/Builder.html#/s:14HyperwalletSDK0A8BankCardC7BuilderC3cvvyAESSF":{"name":"cvv(_:)","abstract":"\u003cp\u003eSets the card security code which is embossed or printed on the card.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletBankCard/Builder.html#/s:14HyperwalletSDK0A8BankCardC7BuilderC12dateOfExpiryyAESSF":{"name":"dateOfExpiry(_:)","abstract":"\u003cp\u003eSets the expiration date.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletBankCard.html#/s:14HyperwalletSDK0A8BankCardC4fromACs7Decoder_p_tKcfc":{"name":"init(from:)","abstract":"\u003cp\u003eThe required initializer\u003c/p\u003e","parent_name":"HyperwalletBankCard"},"Classes/HyperwalletBankCard.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletBankCard(py)cardBrand":{"name":"cardBrand","abstract":"\u003cp\u003eThe card brand\u003c/p\u003e","parent_name":"HyperwalletBankCard"},"Classes/HyperwalletBankCard.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletBankCard(py)cardNumber":{"name":"cardNumber","abstract":"\u003cp\u003eThe card number\u003c/p\u003e","parent_name":"HyperwalletBankCard"},"Classes/HyperwalletBankCard.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletBankCard(py)cardType":{"name":"cardType","abstract":"\u003cp\u003eThe card type\u003c/p\u003e","parent_name":"HyperwalletBankCard"},"Classes/HyperwalletBankCard.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletBankCard(py)dateOfExpiry":{"name":"dateOfExpiry","abstract":"\u003cp\u003eThe expiration date.\u003c/p\u003e","parent_name":"HyperwalletBankCard"},"Classes/HyperwalletBankCard/Builder.html":{"name":"Builder","abstract":"\u003cp\u003eA helper class to build the \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/HyperwalletBankCard.html\"\u003eHyperwalletBankCard\u003c/a\u003e\u003c/code\u003e instance.\u003c/p\u003e","parent_name":"HyperwalletBankCard"},"Classes/HyperwalletBankAccountQueryParam.html#/s:14HyperwalletSDK0A21BankAccountQueryParamC02toE0SDyS2SGyF":{"name":"toQuery()","parent_name":"HyperwalletBankAccountQueryParam"},"Classes/HyperwalletBankAccount/Builder.html#/s:14HyperwalletSDK0A11BankAccountC7BuilderC5tokenAESS_tcfc":{"name":"init(token:)","abstract":"\u003cp\u003eCreates a new instance of the \u003ccode\u003eHyperwalletBankAccount.Builder\u003c/code\u003e based on the required parameter to update","parent_name":"Builder"},"Classes/HyperwalletBankAccount/Builder.html#/s:14HyperwalletSDK0A11BankAccountC7BuilderC21transferMethodCountry0fG8Currency0fG11ProfileType0fgK0AESS_S3Stcfc":{"name":"init(transferMethodCountry:transferMethodCurrency:transferMethodProfileType:transferMethodType:)","abstract":"\u003cp\u003eCreates a new instance of the \u003ccode\u003eHyperwalletBankAccount.Builder\u003c/code\u003e based on the required parameters to create","parent_name":"Builder"},"Classes/HyperwalletBankAccount/Builder.html#/s:14HyperwalletSDK0A11BankAccountC7BuilderC12addressLine1yAESSF":{"name":"addressLine1(_:)","abstract":"\u003cp\u003eSets the bank account holder\u0026rsquo;s street address.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletBankAccount/Builder.html#/s:14HyperwalletSDK0A11BankAccountC7BuilderC12addressLine2yAESSF":{"name":"addressLine2(_:)","abstract":"\u003cp\u003eSets the bank account holder\u0026rsquo;s address, second line.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletBankAccount/Builder.html#/s:14HyperwalletSDK0A11BankAccountC7BuilderC04bankD2IdyAESSF":{"name":"bankAccountId(_:)","abstract":"\u003cp\u003eSets the bank account number, IBAN or equivalent. If you are providing an IBAN, the first two","parent_name":"Builder"},"Classes/HyperwalletBankAccount/Builder.html#/s:14HyperwalletSDK0A11BankAccountC7BuilderC04bankD7PurposeyAESSF":{"name":"bankAccountPurpose(_:)","abstract":"\u003cp\u003eSets the purpose of the bank account (e.g. checking, savings, etc).\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletBankAccount/Builder.html#/s:14HyperwalletSDK0A11BankAccountC7BuilderC04bankD12RelationshipyAESSF":{"name":"bankAccountRelationship(_:)","abstract":"\u003cp\u003eSets the user\u0026rsquo;s relationship with the bank account holder.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletBankAccount/Builder.html#/s:14HyperwalletSDK0A11BankAccountC7BuilderC6bankIdyAESSF":{"name":"bankId(_:)","abstract":"\u003cp\u003eSets the bank code or equivalent (e.g. BIC/SWIFT code).\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletBankAccount/Builder.html#/s:14HyperwalletSDK0A11BankAccountC7BuilderC8bankNameyAESSF":{"name":"bankName(_:)","abstract":"\u003cp\u003eSets the bank name.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletBankAccount/Builder.html#/s:14HyperwalletSDK0A11BankAccountC7BuilderC8branchIdyAESSF":{"name":"branchId(_:)","abstract":"\u003cp\u003eSets the branch code, transit number, routing number or equivalent.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletBankAccount/Builder.html#/s:14HyperwalletSDK0A11BankAccountC7BuilderC10branchNameyAESSF":{"name":"branchName(_:)","abstract":"\u003cp\u003eSets the branch name.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletBankAccount/Builder.html#/s:14HyperwalletSDK0A11BankAccountC7BuilderC19businessContactRoleyAESSF":{"name":"businessContactRole(_:)","abstract":"\u003cp\u003eSets the bank account holder\u0026rsquo;s role in the organization.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletBankAccount/Builder.html#/s:14HyperwalletSDK0A11BankAccountC7BuilderC12businessNameyAESSF":{"name":"businessName(_:)","abstract":"\u003cp\u003eSets the name of the bank account holder\u0026rsquo;s business.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletBankAccount/Builder.html#/s:14HyperwalletSDK0A11BankAccountC7BuilderC27businessRegistrationCountryyAESSF":{"name":"businessRegistrationCountry(_:)","abstract":"\u003cp\u003eSets the country where the bank account holder\u0026rsquo;s business is registered.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletBankAccount/Builder.html#/s:14HyperwalletSDK0A11BankAccountC7BuilderC22businessRegistrationIdyAESSF":{"name":"businessRegistrationId(_:)","abstract":"\u003cp\u003eSets the bank account holder\u0026rsquo;s business registration number or identifier,","parent_name":"Builder"},"Classes/HyperwalletBankAccount/Builder.html#/s:14HyperwalletSDK0A11BankAccountC7BuilderC33businessRegistrationStateProvinceyAESSF":{"name":"businessRegistrationStateProvince(_:)","abstract":"\u003cp\u003eSets the state, province or region where the bank account holder\u0026rsquo;s business is registered.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletBankAccount/Builder.html#/s:14HyperwalletSDK0A11BankAccountC7BuilderC12businessTypeyAESSF":{"name":"businessType(_:)","abstract":"\u003cp\u003eSets the bank account holder\u0026rsquo;s business type.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletBankAccount/Builder.html#/s:14HyperwalletSDK0A11BankAccountC7BuilderC4cityyAESSF":{"name":"city(_:)","abstract":"\u003cp\u003eSets the bank account holder\u0026rsquo;s city.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletBankAccount/Builder.html#/s:14HyperwalletSDK0A11BankAccountC7BuilderC7countryyAESSF":{"name":"country(_:)","abstract":"\u003cp\u003eSets the bank account holder\u0026rsquo;s country.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletBankAccount/Builder.html#/s:14HyperwalletSDK0A11BankAccountC7BuilderC14countryOfBirthyAESSF":{"name":"countryOfBirth(_:)","abstract":"\u003cp\u003eSets the bank account holder\u0026rsquo;s birth country.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletBankAccount/Builder.html#/s:14HyperwalletSDK0A11BankAccountC7BuilderC20countryOfNationalityyAESSF":{"name":"countryOfNationality(_:)","parent_name":"Builder"},"Classes/HyperwalletBankAccount/Builder.html#/s:14HyperwalletSDK0A11BankAccountC7BuilderC11dateOfBirthyAESSF":{"name":"dateOfBirth(_:)","abstract":"\u003cp\u003eSets the bank account holder\u0026rsquo;s date of birth (All users must be at least 13 years old).\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletBankAccount/Builder.html#/s:14HyperwalletSDK0A11BankAccountC7BuilderC16driversLicenseIdyAESSF":{"name":"driversLicenseId(_:)","abstract":"\u003cp\u003eSets the bank account holder\u0026rsquo;s driver\u0026rsquo;s license number.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletBankAccount/Builder.html#/s:14HyperwalletSDK0A11BankAccountC7BuilderC10employerIdyAESSF":{"name":"employerId(_:)","abstract":"\u003cp\u003eSets the bank account holder\u0026rsquo;s employer identifier, generally used for tax purposes.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletBankAccount/Builder.html#/s:14HyperwalletSDK0A11BankAccountC7BuilderC9firstNameyAESSF":{"name":"firstName(_:)","abstract":"\u003cp\u003eSets the bank account holder\u0026rsquo;s first name.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletBankAccount/Builder.html#/s:14HyperwalletSDK0A11BankAccountC7BuilderC6genderyAESSF":{"name":"gender(_:)","abstract":"\u003cp\u003eSets the bank account holder\u0026rsquo;s gender.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletBankAccount/Builder.html#/s:14HyperwalletSDK0A11BankAccountC7BuilderC12governmentIdyAESSF":{"name":"governmentId(_:)","abstract":"\u003cp\u003eSets the bank account holder\u0026rsquo;s government ID number, such as a Social Security Number.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletBankAccount/Builder.html#/s:14HyperwalletSDK0A11BankAccountC7BuilderC16governmentIdTypeyAESSF":{"name":"governmentIdType(_:)","abstract":"\u003cp\u003eSets the bank account holder\u0026rsquo;s government ID type.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletBankAccount/Builder.html#/s:14HyperwalletSDK0A11BankAccountC7BuilderC012intermediarycD2IdyAESSF":{"name":"intermediaryBankAccountId(_:)","abstract":"\u003cp\u003eSets the account number at the intermediary bank.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletBankAccount/Builder.html#/s:14HyperwalletSDK0A11BankAccountC7BuilderC012intermediaryC12AddressLine1yAESSF":{"name":"intermediaryBankAddressLine1(_:)","abstract":"\u003cp\u003eSets the intermediary bank street address.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletBankAccount/Builder.html#/s:14HyperwalletSDK0A11BankAccountC7BuilderC012intermediaryC12AddressLine2yAESSF":{"name":"intermediaryBankAddressLine2(_:)","abstract":"\u003cp\u003eSets the intermediary bank street address, second line.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletBankAccount/Builder.html#/s:14HyperwalletSDK0A11BankAccountC7BuilderC012intermediaryC4CityyAESSF":{"name":"intermediaryBankCity(_:)","abstract":"\u003cp\u003eSets the intermediary bank city.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletBankAccount/Builder.html#/s:14HyperwalletSDK0A11BankAccountC7BuilderC012intermediaryC7CountryyAESSF":{"name":"intermediaryBankCountry(_:)","abstract":"\u003cp\u003eSets the intermediary bank country.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletBankAccount/Builder.html#/s:14HyperwalletSDK0A11BankAccountC7BuilderC012intermediaryC2IdyAESSF":{"name":"intermediaryBankId(_:)","abstract":"\u003cp\u003eSets the intermediary bank\u0026rsquo;s 11-character SWIFT code.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletBankAccount/Builder.html#/s:14HyperwalletSDK0A11BankAccountC7BuilderC012intermediaryC4NameyAESSF":{"name":"intermediaryBankName(_:)","abstract":"\u003cp\u003eSets the intermediary bank name.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletBankAccount/Builder.html#/s:14HyperwalletSDK0A11BankAccountC7BuilderC012intermediaryC10PostalCodeyAESSF":{"name":"intermediaryBankPostalCode(_:)","abstract":"\u003cp\u003eSets the intermediary bank postal code.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletBankAccount/Builder.html#/s:14HyperwalletSDK0A11BankAccountC7BuilderC012intermediaryC13StateProvinceyAESSF":{"name":"intermediaryBankStateProvince(_:)","abstract":"\u003cp\u003eSets the intermediary bank state, province or region.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletBankAccount/Builder.html#/s:14HyperwalletSDK0A11BankAccountC7BuilderC8lastNameyAESSF":{"name":"lastName(_:)","abstract":"\u003cp\u003eSets the bank account holder\u0026rsquo;s last name.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletBankAccount/Builder.html#/s:14HyperwalletSDK0A11BankAccountC7BuilderC10middleNameyAESSF":{"name":"middleName(_:)","abstract":"\u003cp\u003eSets the bank account holder\u0026rsquo;s middle name.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletBankAccount/Builder.html#/s:14HyperwalletSDK0A11BankAccountC7BuilderC12mobileNumberyAESSF":{"name":"mobileNumber(_:)","abstract":"\u003cp\u003eSets the bank account holder\u0026rsquo;s cell phone number.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletBankAccount/Builder.html#/s:14HyperwalletSDK0A11BankAccountC7BuilderC10passportIdyAESSF":{"name":"passportId(_:)","abstract":"\u003cp\u003eSets the bank account holder\u0026rsquo;s passport number.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletBankAccount/Builder.html#/s:14HyperwalletSDK0A11BankAccountC7BuilderC11phoneNumberyAESSF":{"name":"phoneNumber(_:)","abstract":"\u003cp\u003eSets the bank account holder\u0026rsquo;s phone number.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletBankAccount/Builder.html#/s:14HyperwalletSDK0A11BankAccountC7BuilderC10postalCodeyAESSF":{"name":"postalCode(_:)","abstract":"\u003cp\u003eSets the bank account holder\u0026rsquo;s postal code.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletBankAccount/Builder.html#/s:14HyperwalletSDK0A11BankAccountC7BuilderC11profileTypeyAESSF":{"name":"profileType(_:)","abstract":"\u003cp\u003eSets the bank account holder\u0026rsquo;s profile type.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletBankAccount/Builder.html#/s:14HyperwalletSDK0A11BankAccountC7BuilderC13stateProvinceyAESSF":{"name":"stateProvince(_:)","abstract":"\u003cp\u003eSets the bank account holder\u0026rsquo;s state, province or region.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletBankAccount/Builder.html#/s:14HyperwalletSDK0A11BankAccountC7BuilderC4typeyAESSF":{"name":"type(_:)","abstract":"\u003cp\u003eSets the type of transfer method, e.g. BANK_ACCOUNT or WIRE_ACCOUNT.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletBankAccount/Builder.html#/s:14HyperwalletSDK0A11BankAccountC7BuilderC16wireInstructionsyAESSF":{"name":"wireInstructions(_:)","abstract":"\u003cp\u003eSets wire transfer instructions.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletBankAccount/Builder.html#/s:14HyperwalletSDK0A11BankAccountC7BuilderC5buildACyF":{"name":"build()","abstract":"\u003cp\u003eBuilds a new instance of the \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/HyperwalletBankAccount.html\"\u003eHyperwalletBankAccount\u003c/a\u003e\u003c/code\u003e.\u003c/p\u003e","parent_name":"Builder"},"Classes/HyperwalletBankAccount.html#/s:14HyperwalletSDK0A11BankAccountC4fromACs7Decoder_p_tKcfc":{"name":"init(from:)","abstract":"\u003cp\u003eThe required initializer\u003c/p\u003e","parent_name":"HyperwalletBankAccount"},"Classes/HyperwalletBankAccount.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletBankAccount(py)addressLine1":{"name":"addressLine1","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s street address.\u003c/p\u003e","parent_name":"HyperwalletBankAccount"},"Classes/HyperwalletBankAccount.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletBankAccount(py)addressLine2":{"name":"addressLine2","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s address, second line.\u003c/p\u003e","parent_name":"HyperwalletBankAccount"},"Classes/HyperwalletBankAccount.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletBankAccount(py)bankAccountId":{"name":"bankAccountId","abstract":"\u003cp\u003eThe bank account number, IBAN or equivalent. If you are providing an IBAN, the first two","parent_name":"HyperwalletBankAccount"},"Classes/HyperwalletBankAccount.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletBankAccount(py)bankAccountPurpose":{"name":"bankAccountPurpose","abstract":"\u003cp\u003eThe purpose of the bank account (e.g. checking, savings, etc).\u003c/p\u003e","parent_name":"HyperwalletBankAccount"},"Classes/HyperwalletBankAccount.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletBankAccount(py)bankAccountRelationship":{"name":"bankAccountRelationship","abstract":"\u003cp\u003eThe user\u0026rsquo;s relationship with the bank account holder.\u003c/p\u003e","parent_name":"HyperwalletBankAccount"},"Classes/HyperwalletBankAccount.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletBankAccount(py)bankId":{"name":"bankId","abstract":"\u003cp\u003eThe bank code or equivalent (e.g. BIC/SWIFT code).\u003c/p\u003e","parent_name":"HyperwalletBankAccount"},"Classes/HyperwalletBankAccount.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletBankAccount(py)bankName":{"name":"bankName","abstract":"\u003cp\u003eThe bank name.\u003c/p\u003e","parent_name":"HyperwalletBankAccount"},"Classes/HyperwalletBankAccount.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletBankAccount(py)branchId":{"name":"branchId","abstract":"\u003cp\u003eThe branch code, transit number, routing number or equivalent.\u003c/p\u003e","parent_name":"HyperwalletBankAccount"},"Classes/HyperwalletBankAccount.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletBankAccount(py)branchName":{"name":"branchName","abstract":"\u003cp\u003eThe branch name.\u003c/p\u003e","parent_name":"HyperwalletBankAccount"},"Classes/HyperwalletBankAccount.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletBankAccount(py)businessContactRole":{"name":"businessContactRole","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s role in the organization.\u003c/p\u003e","parent_name":"HyperwalletBankAccount"},"Classes/HyperwalletBankAccount.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletBankAccount(py)businessName":{"name":"businessName","abstract":"\u003cp\u003eThe name of the bank account holder\u0026rsquo;s business.\u003c/p\u003e","parent_name":"HyperwalletBankAccount"},"Classes/HyperwalletBankAccount.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletBankAccount(py)businessRegistrationCountry":{"name":"businessRegistrationCountry","abstract":"\u003cp\u003eThe country where the bank account holder\u0026rsquo;s business is registered.\u003c/p\u003e","parent_name":"HyperwalletBankAccount"},"Classes/HyperwalletBankAccount.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletBankAccount(py)businessRegistrationId":{"name":"businessRegistrationId","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s business registration number or identifier,","parent_name":"HyperwalletBankAccount"},"Classes/HyperwalletBankAccount.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletBankAccount(py)businessRegistrationStateProvince":{"name":"businessRegistrationStateProvince","abstract":"\u003cp\u003eThe state, province or region where the bank account holder\u0026rsquo;s business is registered.\u003c/p\u003e","parent_name":"HyperwalletBankAccount"},"Classes/HyperwalletBankAccount.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletBankAccount(py)businessType":{"name":"businessType","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s business type.\u003c/p\u003e","parent_name":"HyperwalletBankAccount"},"Classes/HyperwalletBankAccount.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletBankAccount(py)city":{"name":"city","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s city.\u003c/p\u003e","parent_name":"HyperwalletBankAccount"},"Classes/HyperwalletBankAccount.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletBankAccount(py)country":{"name":"country","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s country.\u003c/p\u003e","parent_name":"HyperwalletBankAccount"},"Classes/HyperwalletBankAccount.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletBankAccount(py)countryOfBirth":{"name":"countryOfBirth","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s birth country.\u003c/p\u003e","parent_name":"HyperwalletBankAccount"},"Classes/HyperwalletBankAccount.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletBankAccount(py)countryOfNationality":{"name":"countryOfNationality","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s nationality country.\u003c/p\u003e","parent_name":"HyperwalletBankAccount"},"Classes/HyperwalletBankAccount.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletBankAccount(py)dateOfBirth":{"name":"dateOfBirth","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s date of birth (All users must be at least 13 years old).\u003c/p\u003e","parent_name":"HyperwalletBankAccount"},"Classes/HyperwalletBankAccount.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletBankAccount(py)driversLicenseId":{"name":"driversLicenseId","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s driver\u0026rsquo;s license number.\u003c/p\u003e","parent_name":"HyperwalletBankAccount"},"Classes/HyperwalletBankAccount.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletBankAccount(py)employerId":{"name":"employerId","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s employer identifier, generally used for tax purposes.\u003c/p\u003e","parent_name":"HyperwalletBankAccount"},"Classes/HyperwalletBankAccount.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletBankAccount(py)firstName":{"name":"firstName","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s first name.\u003c/p\u003e","parent_name":"HyperwalletBankAccount"},"Classes/HyperwalletBankAccount.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletBankAccount(py)gender":{"name":"gender","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s gender.\u003c/p\u003e","parent_name":"HyperwalletBankAccount"},"Classes/HyperwalletBankAccount.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletBankAccount(py)governmentId":{"name":"governmentId","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s government ID number, such as a Social Security Number.\u003c/p\u003e","parent_name":"HyperwalletBankAccount"},"Classes/HyperwalletBankAccount.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletBankAccount(py)governmentIdType":{"name":"governmentIdType","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s government ID type.\u003c/p\u003e","parent_name":"HyperwalletBankAccount"},"Classes/HyperwalletBankAccount.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletBankAccount(py)intermediaryBankAccountId":{"name":"intermediaryBankAccountId","abstract":"\u003cp\u003eThe account number at the intermediary bank.\u003c/p\u003e","parent_name":"HyperwalletBankAccount"},"Classes/HyperwalletBankAccount.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletBankAccount(py)intermediaryBankAddressLine1":{"name":"intermediaryBankAddressLine1","abstract":"\u003cp\u003eThe intermediary bank street address.\u003c/p\u003e","parent_name":"HyperwalletBankAccount"},"Classes/HyperwalletBankAccount.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletBankAccount(py)intermediaryBankAddressLine2":{"name":"intermediaryBankAddressLine2","abstract":"\u003cp\u003eThe intermediary bank street address, second line.\u003c/p\u003e","parent_name":"HyperwalletBankAccount"},"Classes/HyperwalletBankAccount.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletBankAccount(py)intermediaryBankCity":{"name":"intermediaryBankCity","abstract":"\u003cp\u003eThe intermediary bank city.\u003c/p\u003e","parent_name":"HyperwalletBankAccount"},"Classes/HyperwalletBankAccount.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletBankAccount(py)intermediaryBankCountry":{"name":"intermediaryBankCountry","abstract":"\u003cp\u003eThe intermediary bank country.\u003c/p\u003e","parent_name":"HyperwalletBankAccount"},"Classes/HyperwalletBankAccount.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletBankAccount(py)intermediaryBankId":{"name":"intermediaryBankId","abstract":"\u003cp\u003eThe intermediary bank\u0026rsquo;s 11-character SWIFT code.\u003c/p\u003e","parent_name":"HyperwalletBankAccount"},"Classes/HyperwalletBankAccount.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletBankAccount(py)intermediaryBankName":{"name":"intermediaryBankName","abstract":"\u003cp\u003eThe intermediary bank name.\u003c/p\u003e","parent_name":"HyperwalletBankAccount"},"Classes/HyperwalletBankAccount.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletBankAccount(py)intermediaryBankPostalCode":{"name":"intermediaryBankPostalCode","abstract":"\u003cp\u003eThe intermediary bank postal code.\u003c/p\u003e","parent_name":"HyperwalletBankAccount"},"Classes/HyperwalletBankAccount.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletBankAccount(py)intermediaryBankStateProvince":{"name":"intermediaryBankStateProvince","abstract":"\u003cp\u003eThe intermediary bank state, province or region.\u003c/p\u003e","parent_name":"HyperwalletBankAccount"},"Classes/HyperwalletBankAccount.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletBankAccount(py)lastName":{"name":"lastName","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s last name.\u003c/p\u003e","parent_name":"HyperwalletBankAccount"},"Classes/HyperwalletBankAccount.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletBankAccount(py)middleName":{"name":"middleName","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s middle name.\u003c/p\u003e","parent_name":"HyperwalletBankAccount"},"Classes/HyperwalletBankAccount.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletBankAccount(py)mobileNumber":{"name":"mobileNumber","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s cell phone number.\u003c/p\u003e","parent_name":"HyperwalletBankAccount"},"Classes/HyperwalletBankAccount.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletBankAccount(py)passportId":{"name":"passportId","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s passport number.\u003c/p\u003e","parent_name":"HyperwalletBankAccount"},"Classes/HyperwalletBankAccount.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletBankAccount(py)phoneNumber":{"name":"phoneNumber","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s phone number.\u003c/p\u003e","parent_name":"HyperwalletBankAccount"},"Classes/HyperwalletBankAccount.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletBankAccount(py)postalCode":{"name":"postalCode","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s postal code.\u003c/p\u003e","parent_name":"HyperwalletBankAccount"},"Classes/HyperwalletBankAccount.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletBankAccount(py)stateProvince":{"name":"stateProvince","abstract":"\u003cp\u003eThe bank account holder\u0026rsquo;s state, province or region.\u003c/p\u003e","parent_name":"HyperwalletBankAccount"},"Classes/HyperwalletBankAccount.html#/c:@M@HyperwalletSDK@objc(cs)HyperwalletBankAccount(py)wireInstructions":{"name":"wireInstructions","abstract":"\u003cp\u003eThe wire transfer instructions\u003c/p\u003e","parent_name":"HyperwalletBankAccount"},"Classes/HyperwalletBankAccount/Builder.html":{"name":"Builder","abstract":"\u003cp\u003eA helper class to build the \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/HyperwalletBankAccount.html\"\u003eHyperwalletBankAccount\u003c/a\u003e\u003c/code\u003e instance.\u003c/p\u003e","parent_name":"HyperwalletBankAccount"},"Classes/HyperwalletTransferQueryParam.html#/s:14HyperwalletSDK0A18TransferQueryParamC06clientC2IdSSSgvp":{"name":"clientTransferId","abstract":"\u003cp\u003eA value that identifies the client transfer id.\u003c/p\u003e","parent_name":"HyperwalletTransferQueryParam"},"Classes/HyperwalletTransferQueryParam.html#/s:14HyperwalletSDK0A18TransferQueryParamC16destinationTokenSSSgvp":{"name":"destinationToken","abstract":"\u003cp\u003eA value that identifies the destination token.\u003c/p\u003e","parent_name":"HyperwalletTransferQueryParam"},"Classes/HyperwalletTransferQueryParam.html#/s:14HyperwalletSDK0A18TransferQueryParamC11sourceTokenSSSgvp":{"name":"sourceToken","abstract":"\u003cp\u003eA value that identifies the source token.\u003c/p\u003e","parent_name":"HyperwalletTransferQueryParam"},"Classes/HyperwalletReceiptQueryParam/QuerySortable.html#/s:14HyperwalletSDK0A17ReceiptQueryParamC0D8SortableO15ascendantAmountyA2EmF":{"name":"ascendantAmount","abstract":"\u003cp\u003eSort the result by ascendant amount\u003c/p\u003e","parent_name":"QuerySortable"},"Classes/HyperwalletReceiptQueryParam/QuerySortable.html#/s:14HyperwalletSDK0A17ReceiptQueryParamC0D8SortableO18ascendantCreatedOnyA2EmF":{"name":"ascendantCreatedOn","abstract":"\u003cp\u003eSort the result by ascendant created on\u003c/p\u003e","parent_name":"QuerySortable"},"Classes/HyperwalletReceiptQueryParam/QuerySortable.html#/s:14HyperwalletSDK0A17ReceiptQueryParamC0D8SortableO17ascendantCurrencyyA2EmF":{"name":"ascendantCurrency","abstract":"\u003cp\u003eSort the result by ascendant currency\u003c/p\u003e","parent_name":"QuerySortable"},"Classes/HyperwalletReceiptQueryParam/QuerySortable.html#/s:14HyperwalletSDK0A17ReceiptQueryParamC0D8SortableO13ascendantTypeyA2EmF":{"name":"ascendantType","abstract":"\u003cp\u003eSort the result by ascendant type\u003c/p\u003e","parent_name":"QuerySortable"},"Classes/HyperwalletReceiptQueryParam/QuerySortable.html#/s:14HyperwalletSDK0A17ReceiptQueryParamC0D8SortableO16descendantAmountyA2EmF":{"name":"descendantAmount","abstract":"\u003cp\u003eSort the result by descendant amount\u003c/p\u003e","parent_name":"QuerySortable"},"Classes/HyperwalletReceiptQueryParam/QuerySortable.html#/s:14HyperwalletSDK0A17ReceiptQueryParamC0D8SortableO19descendantCreatedOnyA2EmF":{"name":"descendantCreatedOn","abstract":"\u003cp\u003eSort the result by descendant created on\u003c/p\u003e","parent_name":"QuerySortable"},"Classes/HyperwalletReceiptQueryParam/QuerySortable.html#/s:14HyperwalletSDK0A17ReceiptQueryParamC0D8SortableO18descendantCurrencyyA2EmF":{"name":"descendantCurrency","abstract":"\u003cp\u003eSort the result by descendant currency\u003c/p\u003e","parent_name":"QuerySortable"},"Classes/HyperwalletReceiptQueryParam/QuerySortable.html#/s:14HyperwalletSDK0A17ReceiptQueryParamC0D8SortableO14descendantTypeyA2EmF":{"name":"descendantType","abstract":"\u003cp\u003eSort the result by descendant type\u003c/p\u003e","parent_name":"QuerySortable"},"Classes/HyperwalletReceiptQueryParam.html#/s:14HyperwalletSDK0A17ReceiptQueryParamC8currencySSSgvp":{"name":"currency","abstract":"\u003cp\u003eA value that identifies the user receipts currency.\u003c/p\u003e","parent_name":"HyperwalletReceiptQueryParam"},"Classes/HyperwalletReceiptQueryParam/QuerySortable.html":{"name":"QuerySortable","abstract":"\u003cp\u003eRepresentation of the field\u0026rsquo;s sortable\u003c/p\u003e","parent_name":"HyperwalletReceiptQueryParam"},"Classes/QueryParam.html#/s:14HyperwalletSDK10QueryParamC12createdAfter10Foundation4DateVSgvp":{"name":"createdAfter","abstract":"\u003cp\u003eReturns user receipts created after this datetime.\u003c/p\u003e","parent_name":"QueryParam"},"Classes/QueryParam.html#/s:14HyperwalletSDK10QueryParamC13createdBefore10Foundation4DateVSgvp":{"name":"createdBefore","abstract":"\u003cp\u003eReturns user receipts created before this datetime.\u003c/p\u003e","parent_name":"QueryParam"},"Classes/QueryParam.html#/s:14HyperwalletSDK10QueryParamC5limitSiSgvp":{"name":"limit","abstract":"\u003cp\u003eThe maximum number of records that will be returned per page\u003c/p\u003e","parent_name":"QueryParam"},"Classes/QueryParam.html#/s:14HyperwalletSDK10QueryParamC6offsetSiSgvp":{"name":"offset","abstract":"\u003cp\u003eThe number of records to skip. If no filters are applied, records will be skipped from the beginning","parent_name":"QueryParam"},"Classes/QueryParam.html#/s:14HyperwalletSDK10QueryParamC6sortBySSSgvp":{"name":"sortBy","abstract":"\u003cp\u003eThe user receipts attribute to sort the result set by.\u003c/p\u003e","parent_name":"QueryParam"},"Classes/QueryParam.html#/s:14HyperwalletSDK10QueryParamCACycfc":{"name":"init()","abstract":"\u003cp\u003eCreates a new instance of \u003ccode\u003eQueryParam\u003c/code\u003e]\u003c/p\u003e","parent_name":"QueryParam"},"Classes/HyperwalletPrepaidCardBalanceQueryParam/QuerySortable.html#/s:14HyperwalletSDK0A28PrepaidCardBalanceQueryParamC0F8SortableO15ascendantAmountyA2EmF":{"name":"ascendantAmount","abstract":"\u003cp\u003eSort the result by ascendant amount\u003c/p\u003e","parent_name":"QuerySortable"},"Classes/HyperwalletPrepaidCardBalanceQueryParam/QuerySortable.html#/s:14HyperwalletSDK0A28PrepaidCardBalanceQueryParamC0F8SortableO17ascendantCurrencyyA2EmF":{"name":"ascendantCurrency","abstract":"\u003cp\u003eSort the result by ascendant currency\u003c/p\u003e","parent_name":"QuerySortable"},"Classes/HyperwalletPrepaidCardBalanceQueryParam/QuerySortable.html#/s:14HyperwalletSDK0A28PrepaidCardBalanceQueryParamC0F8SortableO16descendantAmountyA2EmF":{"name":"descendantAmount","abstract":"\u003cp\u003eSort the result by descendant amount\u003c/p\u003e","parent_name":"QuerySortable"},"Classes/HyperwalletPrepaidCardBalanceQueryParam/QuerySortable.html#/s:14HyperwalletSDK0A28PrepaidCardBalanceQueryParamC0F8SortableO18descendantCurrencyyA2EmF":{"name":"descendantCurrency","abstract":"\u003cp\u003eSort the result by descendant currency\u003c/p\u003e","parent_name":"QuerySortable"},"Classes/HyperwalletPrepaidCardBalanceQueryParam/QuerySortable.html":{"name":"QuerySortable","abstract":"\u003cp\u003eRepresentation of the sortable fields\u003c/p\u003e","parent_name":"HyperwalletPrepaidCardBalanceQueryParam"},"Classes/HyperwalletBalanceQueryParam/QuerySortable.html#/s:14HyperwalletSDK0A17BalanceQueryParamC0D8SortableO15ascendantAmountyA2EmF":{"name":"ascendantAmount","abstract":"\u003cp\u003eSort the result by ascendant amount\u003c/p\u003e","parent_name":"QuerySortable"},"Classes/HyperwalletBalanceQueryParam/QuerySortable.html#/s:14HyperwalletSDK0A17BalanceQueryParamC0D8SortableO17ascendantCurrencyyA2EmF":{"name":"ascendantCurrency","abstract":"\u003cp\u003eSort the result by ascendant currency\u003c/p\u003e","parent_name":"QuerySortable"},"Classes/HyperwalletBalanceQueryParam/QuerySortable.html#/s:14HyperwalletSDK0A17BalanceQueryParamC0D8SortableO16descendantAmountyA2EmF":{"name":"descendantAmount","abstract":"\u003cp\u003eSort the result by descendant amount\u003c/p\u003e","parent_name":"QuerySortable"},"Classes/HyperwalletBalanceQueryParam/QuerySortable.html#/s:14HyperwalletSDK0A17BalanceQueryParamC0D8SortableO18descendantCurrencyyA2EmF":{"name":"descendantCurrency","abstract":"\u003cp\u003eSort the result by descendant currency\u003c/p\u003e","parent_name":"QuerySortable"},"Classes/HyperwalletBalanceQueryParam.html#/s:14HyperwalletSDK0A17BalanceQueryParamC8currencySSSgvp":{"name":"currency","abstract":"\u003cp\u003eA value that identifies the currency of balance\u003c/p\u003e","parent_name":"HyperwalletBalanceQueryParam"},"Classes/HyperwalletBalanceQueryParam/QuerySortable.html":{"name":"QuerySortable","abstract":"\u003cp\u003eRepresentation of the sortable fields\u003c/p\u003e","parent_name":"HyperwalletBalanceQueryParam"},"Classes/Hyperwallet.html#/c:@M@HyperwalletSDK@objc(cs)Hyperwallet(cpy)shared":{"name":"shared","abstract":"\u003cp\u003eReturns the previously initialized instance of the Hyperwallet Core SDK interface object\u003c/p\u003e","parent_name":"Hyperwallet"},"Classes/Hyperwallet.html#/c:@M@HyperwalletSDK@objc(cs)Hyperwallet(cm)clearInstance":{"name":"clearInstance()","abstract":"\u003cp\u003eClears Hyperwallet instance.\u003c/p\u003e","parent_name":"Hyperwallet"},"Classes/Hyperwallet.html#/c:@M@HyperwalletSDK@objc(cs)Hyperwallet(cm)setup:":{"name":"setup(_:)","abstract":"\u003cp\u003eCreates a new instance of the Hyperwallet Core SDK interface object. If a previously created instance exists,","parent_name":"Hyperwallet"},"Classes/Hyperwallet.html#/s:14HyperwalletSDK0A0C16getConfiguration10completionyyAA0D0VSg_AA0A9ErrorTypeOSgtc_tF":{"name":"getConfiguration(completion:)","abstract":"\u003cp\u003eRetrieves a configuration if one exists - else using the authentication token from the provider,","parent_name":"Hyperwallet"},"Classes/Hyperwallet.html#/s:14HyperwalletSDK0A0C7getUser10completionyyAA0aD0CSg_AA0A9ErrorTypeOSgtc_tF":{"name":"getUser(completion:)","abstract":"\u003cp\u003eReturns the \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/HyperwalletUser.html\"\u003eHyperwalletUser\u003c/a\u003e\u003c/code\u003e for the User associated with the authentication token returned from","parent_name":"Hyperwallet"},"Classes/Hyperwallet.html#/s:14HyperwalletSDK0A0C17createBankAccount7account10completionyAA0adE0C_yAHSg_AA0A9ErrorTypeOSgtctF":{"name":"createBankAccount(account:completion:)","abstract":"\u003cp\u003eCreates a \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/HyperwalletBankAccount.html\"\u003eHyperwalletBankAccount\u003c/a\u003e\u003c/code\u003e for the User associated with the authentication token returned from","parent_name":"Hyperwallet"},"Classes/Hyperwallet.html#/s:14HyperwalletSDK0A0C16createPaperCheck7account10completionyAA0adE0C_yAHSg_AA0A9ErrorTypeOSgtctF":{"name":"createPaperCheck(account:completion:)","abstract":"\u003cp\u003eCreates a \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/HyperwalletPaperCheck.html\"\u003eHyperwalletPaperCheck\u003c/a\u003e\u003c/code\u003e for the User associated with the authentication token returned from","parent_name":"Hyperwallet"},"Classes/Hyperwallet.html#/s:14HyperwalletSDK0A0C14createBankCard7account10completionyAA0adE0C_yAHSg_AA0A9ErrorTypeOSgtctF":{"name":"createBankCard(account:completion:)","abstract":"\u003cp\u003eCreates a \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/HyperwalletBankCard.html\"\u003eHyperwalletBankCard\u003c/a\u003e\u003c/code\u003e for the User associated with the authentication token returned from","parent_name":"Hyperwallet"},"Classes/Hyperwallet.html#/s:14HyperwalletSDK0A0C19createPayPalAccount7account10completionyAA0adeF0C_yAHSg_AA0A9ErrorTypeOSgtctF":{"name":"createPayPalAccount(account:completion:)","abstract":"\u003cp\u003eCreates a \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/HyperwalletPayPalAccount.html\"\u003eHyperwalletPayPalAccount\u003c/a\u003e\u003c/code\u003e for the User associated with the authentication token returned from","parent_name":"Hyperwallet"},"Classes/Hyperwallet.html#/s:14HyperwalletSDK0A0C14createTransfer8transfer10completionyAA0aD0V_yAHSg_AA0A9ErrorTypeOSgtctF":{"name":"createTransfer(transfer:completion:)","abstract":"\u003cp\u003eCreates a \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbStructs/HyperwalletTransfer.html\"\u003eHyperwalletTransfer\u003c/a\u003e\u003c/code\u003e for the User associated with the authentication token returned from","parent_name":"Hyperwallet"},"Classes/Hyperwallet.html#/s:14HyperwalletSDK0A0C18createVenmoAccount7account10completionyAA0adE0C_yAHSg_AA0A9ErrorTypeOSgtctF":{"name":"createVenmoAccount(account:completion:)","abstract":"\u003cp\u003eCreates a \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/HyperwalletVenmoAccount.html\"\u003eHyperwalletVenmoAccount\u003c/a\u003e\u003c/code\u003e for the User associated with the authentication token returned from","parent_name":"Hyperwallet"},"Classes/Hyperwallet.html#/s:14HyperwalletSDK0A0C21deactivateBankAccount19transferMethodToken5notes10completionySS_SSSgyAA0A16StatusTransitionVSg_AA0A9ErrorTypeOSgtctF":{"name":"deactivateBankAccount(transferMethodToken:notes:completion:)","abstract":"\u003cp\u003eDeactivates the \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/HyperwalletBankAccount.html\"\u003eHyperwalletBankAccount\u003c/a\u003e\u003c/code\u003e linked to the transfer method token specified. The","parent_name":"Hyperwallet"},"Classes/Hyperwallet.html#/s:14HyperwalletSDK0A0C20deactivatePaperCheck19transferMethodToken5notes10completionySS_SSSgyAA0A16StatusTransitionVSg_AA0A9ErrorTypeOSgtctF":{"name":"deactivatePaperCheck(transferMethodToken:notes:completion:)","abstract":"\u003cp\u003eDeactivates the \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/HyperwalletPaperCheck.html\"\u003eHyperwalletPaperCheck\u003c/a\u003e\u003c/code\u003e linked to the transfer method token specified. The","parent_name":"Hyperwallet"},"Classes/Hyperwallet.html#/s:14HyperwalletSDK0A0C18deactivateBankCard19transferMethodToken5notes10completionySS_SSSgyAA0A16StatusTransitionVSg_AA0A9ErrorTypeOSgtctF":{"name":"deactivateBankCard(transferMethodToken:notes:completion:)","abstract":"\u003cp\u003eDeactivates the \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/HyperwalletBankCard.html\"\u003eHyperwalletBankCard\u003c/a\u003e\u003c/code\u003e linked to the transfer method token specified. The","parent_name":"Hyperwallet"},"Classes/Hyperwallet.html#/s:14HyperwalletSDK0A0C23deactivatePayPalAccount19transferMethodToken5notes10completionySS_SSSgyAA0A16StatusTransitionVSg_AA0A9ErrorTypeOSgtctF":{"name":"deactivatePayPalAccount(transferMethodToken:notes:completion:)","abstract":"\u003cp\u003eDeactivates the \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/HyperwalletPayPalAccount.html\"\u003eHyperwalletPayPalAccount\u003c/a\u003e\u003c/code\u003e linked to the transfer method token specified. The","parent_name":"Hyperwallet"},"Classes/Hyperwallet.html#/s:14HyperwalletSDK0A0C22deactivateVenmoAccount19transferMethodToken5notes10completionySS_SSSgyAA0A16StatusTransitionVSg_AA0A9ErrorTypeOSgtctF":{"name":"deactivateVenmoAccount(transferMethodToken:notes:completion:)","abstract":"\u003cp\u003eDeactivates the \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/HyperwalletVenmoAccount.html\"\u003eHyperwalletVenmoAccount\u003c/a\u003e\u003c/code\u003e linked to the transfer method token specified. The","parent_name":"Hyperwallet"},"Classes/Hyperwallet.html#/s:14HyperwalletSDK0A0C16scheduleTransfer13transferToken5notes10completionySS_SSSgyAA0A16StatusTransitionVSg_AA0A9ErrorTypeOSgtctF":{"name":"scheduleTransfer(transferToken:notes:completion:)","abstract":"\u003cp\u003eSchedules the \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbStructs/HyperwalletTransfer.html\"\u003eHyperwalletTransfer\u003c/a\u003e\u003c/code\u003e linked to the transfer method token specified.\u003c/p\u003e","parent_name":"Hyperwallet"},"Classes/Hyperwallet.html#/s:14HyperwalletSDK0A0C14getBankAccount19transferMethodToken10completionySS_yAA0adE0CSg_AA0A9ErrorTypeOSgtctF":{"name":"getBankAccount(transferMethodToken:completion:)","abstract":"\u003cp\u003eReturns the \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/HyperwalletBankAccount.html\"\u003eHyperwalletBankAccount\u003c/a\u003e\u003c/code\u003e linked to the transfer method token specified, or nil if none exists.\u003c/p\u003e","parent_name":"Hyperwallet"},"Classes/Hyperwallet.html#/s:14HyperwalletSDK0A0C13getPaperCheck19transferMethodToken10completionySS_yAA0adE0CSg_AA0A9ErrorTypeOSgtctF":{"name":"getPaperCheck(transferMethodToken:completion:)","abstract":"\u003cp\u003eReturns the \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/HyperwalletPaperCheck.html\"\u003eHyperwalletPaperCheck\u003c/a\u003e\u003c/code\u003e linked to the transfer method token specified, or nil if none exists.\u003c/p\u003e","parent_name":"Hyperwallet"},"Classes/Hyperwallet.html#/s:14HyperwalletSDK0A0C11getBankCard19transferMethodToken10completionySS_yAA0adE0CSg_AA0A9ErrorTypeOSgtctF":{"name":"getBankCard(transferMethodToken:completion:)","abstract":"\u003cp\u003eReturns the \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/HyperwalletBankCard.html\"\u003eHyperwalletBankCard\u003c/a\u003e\u003c/code\u003e linked to the transfer method token specified, or nil if none exists.\u003c/p\u003e","parent_name":"Hyperwallet"},"Classes/Hyperwallet.html#/s:14HyperwalletSDK0A0C16getPayPalAccount19transferMethodToken10completionySS_yAA0adeF0CSg_AA0A9ErrorTypeOSgtctF":{"name":"getPayPalAccount(transferMethodToken:completion:)","abstract":"\u003cp\u003eReturns the \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/HyperwalletPayPalAccount.html\"\u003eHyperwalletPayPalAccount\u003c/a\u003e\u003c/code\u003e linked to the transfer method token specified, or nil if none exists.\u003c/p\u003e","parent_name":"Hyperwallet"},"Classes/Hyperwallet.html#/s:14HyperwalletSDK0A0C14getPrepaidCard19transferMethodToken10completionySS_yAA0adE0CSg_AA0A9ErrorTypeOSgtctF":{"name":"getPrepaidCard(transferMethodToken:completion:)","abstract":"\u003cp\u003eReturns the \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/HyperwalletPrepaidCard.html\"\u003eHyperwalletPrepaidCard\u003c/a\u003e\u003c/code\u003e linked to the transfer method token specified, or nil if none exists.\u003c/p\u003e","parent_name":"Hyperwallet"},"Classes/Hyperwallet.html#/s:14HyperwalletSDK0A0C11getTransfer13transferToken10completionySS_yAA0aD0VSg_AA0A9ErrorTypeOSgtctF":{"name":"getTransfer(transferToken:completion:)","abstract":"\u003cp\u003eReturns the \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbStructs/HyperwalletTransfer.html\"\u003eHyperwalletTransfer\u003c/a\u003e\u003c/code\u003e linked to the transfer method token specified, or nil if none exists.\u003c/p\u003e","parent_name":"Hyperwallet"},"Classes/Hyperwallet.html#/s:14HyperwalletSDK0A0C15getVenmoAccount19transferMethodToken10completionySS_yAA0adE0CSg_AA0A9ErrorTypeOSgtctF":{"name":"getVenmoAccount(transferMethodToken:completion:)","abstract":"\u003cp\u003eReturns the \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/HyperwalletVenmoAccount.html\"\u003eHyperwalletVenmoAccount\u003c/a\u003e\u003c/code\u003e linked to the transfer method token specified, or nil if none exists.\u003c/p\u003e","parent_name":"Hyperwallet"},"Classes/Hyperwallet.html#/s:14HyperwalletSDK0A0C16listBankAccounts10queryParam10completionyAA0ad12AccountQueryG0CSg_yAA0A8PageListVyAA0adI0CGSg_AA0A9ErrorTypeOSgtctF":{"name":"listBankAccounts(queryParam:completion:)","abstract":"\u003cp\u003eReturns the list of \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/HyperwalletBankAccount.html\"\u003eHyperwalletBankAccount\u003c/a\u003e\u003c/code\u003es for the User associated with the authentication token","parent_name":"Hyperwallet"},"Classes/Hyperwallet.html#/s:14HyperwalletSDK0A0C15listPaperChecks10queryParam10completionyAA0ad10CheckQueryG0CSg_yAA0A8PageListVyAA0adI0CGSg_AA0A9ErrorTypeOSgtctF":{"name":"listPaperChecks(queryParam:completion:)","abstract":"\u003cp\u003eReturns the list of \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/HyperwalletPaperCheck.html\"\u003eHyperwalletPaperCheck\u003c/a\u003e\u003c/code\u003es for the User associated with the authentication token","parent_name":"Hyperwallet"},"Classes/Hyperwallet.html#/s:14HyperwalletSDK0A0C13listBankCards10queryParam10completionyAA0ad9CardQueryG0CSg_yAA0A8PageListVyAA0adI0CGSg_AA0A9ErrorTypeOSgtctF":{"name":"listBankCards(queryParam:completion:)","abstract":"\u003cp\u003eReturns the \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/HyperwalletBankCard.html\"\u003eHyperwalletBankCard\u003c/a\u003e\u003c/code\u003e for the User associated with the authentication token returned from","parent_name":"Hyperwallet"},"Classes/Hyperwallet.html#/s:14HyperwalletSDK0A0C18listPayPalAccounts10queryParam10completionyAA0ade12AccountQueryH0CSg_yAA0A8PageListVyAA0adeJ0CGSg_AA0A9ErrorTypeOSgtctF":{"name":"listPayPalAccounts(queryParam:completion:)","abstract":"\u003cp\u003eReturns the \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/HyperwalletPayPalAccount.html\"\u003eHyperwalletPayPalAccount\u003c/a\u003e\u003c/code\u003e for the User associated with the authentication token returned from","parent_name":"Hyperwallet"},"Classes/Hyperwallet.html#/s:14HyperwalletSDK0A0C19listTransferMethods10queryParam10completionyAA0ad11MethodQueryG0CSg_yAA0A8PageListVyAA0adI0CGSg_AA0A9ErrorTypeOSgtctF":{"name":"listTransferMethods(queryParam:completion:)","abstract":"\u003cp\u003eReturns the \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/HyperwalletTransferMethod.html\"\u003eHyperwalletTransferMethod\u003c/a\u003e\u003c/code\u003e (Bank Account, Bank Card, PayPay Account, Prepaid Card, Paper Checks)","parent_name":"Hyperwallet"},"Classes/Hyperwallet.html#/s:14HyperwalletSDK0A0C16listPrepaidCards10queryParam10completionyAA0ad9CardQueryG0CSg_yAA0A8PageListVyAA0adI0CGSg_AA0A9ErrorTypeOSgtctF":{"name":"listPrepaidCards(queryParam:completion:)","abstract":"\u003cp\u003eReturns the \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/HyperwalletPrepaidCard.html\"\u003eHyperwalletPrepaidCard\u003c/a\u003e\u003c/code\u003e","parent_name":"Hyperwallet"},"Classes/Hyperwallet.html#/s:14HyperwalletSDK0A0C17listVenmoAccounts10queryParam10completionyAA0ad5QueryG0CSg_yAA0A8PageListVyAA0aD7AccountCGSg_AA0A9ErrorTypeOSgtctF":{"name":"listVenmoAccounts(queryParam:completion:)","abstract":"\u003cp\u003eReturns the \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/HyperwalletVenmoAccount.html\"\u003eHyperwalletVenmoAccount\u003c/a\u003e\u003c/code\u003e for the User associated with the authentication token returned from","parent_name":"Hyperwallet"},"Classes/Hyperwallet.html#/s:14HyperwalletSDK0A0C16listUserReceipts10queryParam10completionyAA0a12ReceiptQueryG0CSg_yAA0A8PageListVyAA0aI0VGSg_AA0A9ErrorTypeOSgtctF":{"name":"listUserReceipts(queryParam:completion:)","abstract":"\u003cp\u003eReturns the list of receipts for the User associated with the authentication token.\u003c/p\u003e","parent_name":"Hyperwallet"},"Classes/Hyperwallet.html#/s:14HyperwalletSDK0A0C23listPrepaidCardReceipts07prepaidE5Token10queryParam10completionySS_AA0a12ReceiptQueryJ0CSgyAA0A8PageListVyAA0aL0VGSg_AA0A9ErrorTypeOSgtctF":{"name":"listPrepaidCardReceipts(prepaidCardToken:queryParam:completion:)","abstract":"\u003cp\u003eThe filtering of \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbStructs/HyperwalletReceipt.html\"\u003eHyperwalletReceipt\u003c/a\u003e\u003c/code\u003e will be based on the criteria specified within the","parent_name":"Hyperwallet"},"Classes/Hyperwallet.html#/s:14HyperwalletSDK0A0C13listTransfers10queryParam10completionyAA0a13TransferQueryF0CSg_yAA0A8PageListVyAA0aH0VGSg_AA0A9ErrorTypeOSgtctF":{"name":"listTransfers(queryParam:completion:)","abstract":"\u003cp\u003eReturns the list of transfers for the User associated with the authentication token.\u003c/p\u003e","parent_name":"Hyperwallet"},"Classes/Hyperwallet.html#/s:14HyperwalletSDK0A0C41retrieveTransferMethodConfigurationFields7request10completionyAA0adeF10FieldQueryV_yAA0adefJ0_pSg_AA0A9ErrorTypeOSgtctF":{"name":"retrieveTransferMethodConfigurationFields(request:completion:)","abstract":"\u003cp\u003eReturns the transfer method configuration field set for the User that is associated with the authentication","parent_name":"Hyperwallet"},"Classes/Hyperwallet.html#/s:14HyperwalletSDK0A0C47retrieveTransferMethodUpdateConfigurationFields7request10completionyAA0adefG10FieldQueryV_yAA0adefgK0_pSg_AA0A9ErrorTypeOSgtctF":{"name":"retrieveTransferMethodUpdateConfigurationFields(request:completion:)","abstract":"\u003cp\u003eReturns the transfer method update configuration fields set for the User that is associated with","parent_name":"Hyperwallet"},"Classes/Hyperwallet.html#/s:14HyperwalletSDK0A0C39retrieveTransferMethodConfigurationKeys7request10completionyAA0adefG5QueryV_yAA0adeF3Key_pSg_AA0A9ErrorTypeOSgtctF":{"name":"retrieveTransferMethodConfigurationKeys(request:completion:)","abstract":"\u003cp\u003eReturns the transfer method configuration key set for the User that is associated","parent_name":"Hyperwallet"},"Classes/Hyperwallet.html#/s:14HyperwalletSDK0A0C49retrieveTransferMethodTypesFeesAndProcessingTimes7request10completionyAA0adefghiJ5QueryV_yAA0adE16ConfigurationKey_pSg_AA0A9ErrorTypeOSgtctF":{"name":"retrieveTransferMethodTypesFeesAndProcessingTimes(request:completion:)","abstract":"\u003cp\u003eReturns the transfer method types, processing times, and fees for the User that is associated","parent_name":"Hyperwallet"},"Classes/Hyperwallet.html#/s:14HyperwalletSDK0A0C17updateBankAccount7account10completionyAA0adE0C_yAHSg_AA0A9ErrorTypeOSgtctF":{"name":"updateBankAccount(account:completion:)","abstract":"\u003cp\u003eUpdates the \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/HyperwalletBankAccount.html\"\u003eHyperwalletBankAccount\u003c/a\u003e\u003c/code\u003e for the User associated with the authentication token returned from","parent_name":"Hyperwallet"},"Classes/Hyperwallet.html#/s:14HyperwalletSDK0A0C16updatePaperCheck7account10completionyAA0adE0C_yAHSg_AA0A9ErrorTypeOSgtctF":{"name":"updatePaperCheck(account:completion:)","abstract":"\u003cp\u003eUpdates the \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/HyperwalletPaperCheck.html\"\u003eHyperwalletPaperCheck\u003c/a\u003e\u003c/code\u003e for the User associated with the authentication token returned from","parent_name":"Hyperwallet"},"Classes/Hyperwallet.html#/s:14HyperwalletSDK0A0C14updateBankCard7account10completionyAA0adE0C_yAHSg_AA0A9ErrorTypeOSgtctF":{"name":"updateBankCard(account:completion:)","abstract":"\u003cp\u003eUpdates the \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/HyperwalletBankCard.html\"\u003eHyperwalletBankCard\u003c/a\u003e\u003c/code\u003e for the User associated with the authentication token returned from","parent_name":"Hyperwallet"},"Classes/Hyperwallet.html#/s:14HyperwalletSDK0A0C19updatePayPalAccount7account10completionyAA0adeF0C_yAHSg_AA0A9ErrorTypeOSgtctF":{"name":"updatePayPalAccount(account:completion:)","abstract":"\u003cp\u003eUpdates the \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/HyperwalletPayPalAccount.html\"\u003eHyperwalletPayPalAccount\u003c/a\u003e\u003c/code\u003e for the User associated with the authentication token returned from","parent_name":"Hyperwallet"},"Classes/Hyperwallet.html#/s:14HyperwalletSDK0A0C18updateVenmoAccount7account10completionyAA0adE0C_yAHSg_AA0A9ErrorTypeOSgtctF":{"name":"updateVenmoAccount(account:completion:)","abstract":"\u003cp\u003eUpdates the \u003ccode\u003e\u003ca href=\"36f8f5912051ae747ef441d6511ca4cbClasses/HyperwalletVenmoAccount.html\"\u003eHyperwalletVenmoAccount\u003c/a\u003e\u003c/code\u003e for the User associated with the authentication token returned from","parent_name":"Hyperwallet"},"Classes/Hyperwallet.html#/s:14HyperwalletSDK0A0C16listUserBalances10queryParam10completionyAA0a12BalanceQueryG0CSg_yAA0A8PageListVyAA0aI0VGSg_AA0A9ErrorTypeOSgtctF":{"name":"listUserBalances(queryParam:completion:)","abstract":"\u003cp\u003eReturns the list of balances for the User associated with the authentication token.\u003c/p\u003e","parent_name":"Hyperwallet"},"Classes/Hyperwallet.html#/s:14HyperwalletSDK0A0C23listPrepaidCardBalances07prepaidE5Token10queryParam10completionySS_AA0ade12BalanceQueryJ0CSgyAA0A8PageListVyAA0aL0VGSg_AA0A9ErrorTypeOSgtctF":{"name":"listPrepaidCardBalances(prepaidCardToken:queryParam:completion:)","abstract":"\u003cp\u003eReturns the list of prepaid card balances for the User associated with the authentication token.\u003c/p\u003e","parent_name":"Hyperwallet"},"Classes/Hyperwallet.html":{"name":"Hyperwallet","abstract":"\u003cp\u003eThe \u003ccode\u003eHyperwallet\u003c/code\u003e class is an iOS specific implementation of the"},"Classes/HyperwalletBalanceQueryParam.html":{"name":"HyperwalletBalanceQueryParam","abstract":"\u003cp\u003eRepresentation of the balance QueryParam fields.\u003c/p\u003e"},"Classes/HyperwalletPrepaidCardBalanceQueryParam.html":{"name":"HyperwalletPrepaidCardBalanceQueryParam","abstract":"\u003cp\u003eRepresentation of the prepaid card balance QueryParam fields.\u003c/p\u003e"},"Classes/QueryParam.html":{"name":"QueryParam","abstract":"\u003cp\u003eRepresentation of the common query parameters.\u003c/p\u003e"},"Classes/HyperwalletReceiptQueryParam.html":{"name":"HyperwalletReceiptQueryParam","abstract":"\u003cp\u003eRepresentation of the user receipts QueryParam fields.\u003c/p\u003e"},"Classes/HyperwalletTransferQueryParam.html":{"name":"HyperwalletTransferQueryParam","abstract":"\u003cp\u003eRepresentation of the user transfers QueryParams fields.\u003c/p\u003e"},"Classes/HyperwalletBankAccount.html":{"name":"HyperwalletBankAccount","abstract":"\u003cp\u003eRepresentation of the user\u0026rsquo;s bank account\u003c/p\u003e"},"Classes/HyperwalletBankAccountQueryParam.html":{"name":"HyperwalletBankAccountQueryParam","abstract":"\u003cp\u003eRepresentation of the bank account query parameters.\u003c/p\u003e"},"Classes/HyperwalletBankCard.html":{"name":"HyperwalletBankCard","abstract":"\u003cp\u003eRepresentation of the user\u0026rsquo;s bank card\u003c/p\u003e"},"Classes/HyperwalletBankCardQueryParam.html":{"name":"HyperwalletBankCardQueryParam","abstract":"\u003cp\u003eRepresentation of the bank card query parameters.\u003c/p\u003e"},"Classes/HyperwalletPaperCheck.html":{"name":"HyperwalletPaperCheck","abstract":"\u003cp\u003eRepresentation of the user\u0026rsquo;s paper check\u003c/p\u003e"},"Classes/HyperwalletPaperCheckQueryParam.html":{"name":"HyperwalletPaperCheckQueryParam","abstract":"\u003cp\u003eRepresentation of the paper check query parameters.\u003c/p\u003e"},"Classes/HyperwalletPayPalAccount.html":{"name":"HyperwalletPayPalAccount","abstract":"\u003cp\u003eRepresentation of the user\u0026rsquo;s PayPal account\u003c/p\u003e"},"Classes/HyperwalletPayPalAccountQueryParam.html":{"name":"HyperwalletPayPalAccountQueryParam","abstract":"\u003cp\u003eRepresentation of the PayPal account query parameters.\u003c/p\u003e"},"Classes/HyperwalletPrepaidCard.html":{"name":"HyperwalletPrepaidCard","abstract":"\u003cp\u003eRepresentation of the user\u0026rsquo;s Prepaid card account\u003c/p\u003e"},"Classes/HyperwalletPrepaidCardQueryParam.html":{"name":"HyperwalletPrepaidCardQueryParam","abstract":"\u003cp\u003eRepresentation of the prepaid card query parameters.\u003c/p\u003e"},"Classes/HyperwalletTransferMethod.html":{"name":"HyperwalletTransferMethod","abstract":"\u003cp\u003eRepresentation of the transfer method (bank account, bank card, PayPal account, prepaid card, paper check).\u003c/p\u003e"},"Classes/HyperwalletTransferMethodQueryParam.html":{"name":"HyperwalletTransferMethodQueryParam","abstract":"\u003cp\u003eRepresentation of the common transfer method\u0026rsquo;s query parameters.\u003c/p\u003e"},"Classes/HyperwalletVenmoAccount.html":{"name":"HyperwalletVenmoAccount","abstract":"\u003cp\u003eRepresentation of the user\u0026rsquo;s Venmo account\u003c/p\u003e"},"Classes/HyperwalletVenmoQueryParam.html":{"name":"HyperwalletVenmoQueryParam","abstract":"\u003cp\u003eRepresentation of the common Venmo\u0026rsquo;s query parameters.\u003c/p\u003e"},"Classes/HyperwalletUser.html":{"name":"HyperwalletUser","abstract":"\u003cp\u003eRepresentation of the Hyperwallet\u0026rsquo;s user.\u003c/p\u003e"},"changelog.html":{"name":"CHANGELOG"},"readme.html":{"name":"README"},"Guides.html":{"name":"Guides","abstract":"\u003cp\u003eThe following guides are available globally.\u003c/p\u003e"},"Classes.html":{"name":"Classes","abstract":"\u003cp\u003eThe following classes are available globally.\u003c/p\u003e"},"Enums.html":{"name":"Enumerations","abstract":"\u003cp\u003eThe following enumerations are available globally.\u003c/p\u003e"},"Extensions.html":{"name":"Extensions","abstract":"\u003cp\u003eThe following extensions are available globally.\u003c/p\u003e"},"Protocols.html":{"name":"Protocols","abstract":"\u003cp\u003eThe following protocols are available globally.\u003c/p\u003e"},"Structs.html":{"name":"Structures","abstract":"\u003cp\u003eThe following structures are available globally.\u003c/p\u003e"}} \ No newline at end of file diff --git a/undocumented.json b/undocumented.json new file mode 100644 index 00000000..d75e12b4 --- /dev/null +++ b/undocumented.json @@ -0,0 +1,12 @@ +{ + "warnings": [ + { + "file": "/Users/runner/work/hyperwallet-ios-sdk/hyperwallet-ios-sdk/Sources/Model/GraphQL/Query/HyperwalletTransferMethodConfigurationQueries.swift", + "line": 242, + "symbol": "HyperwalletTransferMethodTypesFeesAndProcessingTimesQuery.init(country:currency:)", + "symbol_kind": "source.lang.swift.decl.function.method.instance", + "warning": "undocumented" + } + ], + "source_directory": "/Users/runner/work/hyperwallet-ios-sdk/hyperwallet-ios-sdk/Sources" +} \ No newline at end of file