Hyperwallet Class Reference


                    
                    
                    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.


                    
                    
                    getConfiguration(completion:)

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


                    
                    
                    createBankAccount(account:completion:)

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


                    
                    
                    createPaperCheck(account:completion:)

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


                    
                    
                    createBankCard(account:completion:)

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


                    
                    
                    createPayPalAccount(account:completion:)

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


                    
                    
                    createTransfer(transfer:completion:)

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


                    
                    
                    createVenmoAccount(account:completion:)

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


                    
                    
                    deactivateBankAccount(transferMethodToken:notes:completion:)

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


                    
                    
                    deactivatePaperCheck(transferMethodToken:notes:completion:)

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


                    
                    
                    deactivateBankCard(transferMethodToken:notes:completion:)

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


                    
                    
                    deactivatePayPalAccount(transferMethodToken:notes:completion:)

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


                    
                    
                    deactivateVenmoAccount(transferMethodToken:notes:completion:)

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


                    
                    
                    scheduleTransfer(transferToken:notes:completion:)

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


                    
                    
                    getBankAccount(transferMethodToken:completion:)

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


                    
                    
                    getPaperCheck(transferMethodToken:completion:)

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


                    
                    
                    getBankCard(transferMethodToken:completion:)

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


                    
                    
                    getPayPalAccount(transferMethodToken:completion:)

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


                    
                    
                    getPrepaidCard(transferMethodToken:completion:)

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


                    
                    
                    getTransfer(transferToken:completion:)

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


                    
                    
                    getVenmoAccount(transferMethodToken:completion:)

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


                    
                    
                    listBankAccounts(queryParam:completion:)

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


                    
                    
                    listPaperChecks(queryParam:completion:)

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


                    
                    
                    listBankCards(queryParam:completion:)

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


                    
                    
                    listPayPalAccounts(queryParam:completion:)

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


                    
                    
                    listTransferMethods(queryParam:completion:)

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


                    
                    
                    listPrepaidCards(queryParam:completion:)

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


                    
                    
                    listVenmoAccounts(queryParam:completion:)

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


                    
                    
                    listUserReceipts(queryParam:completion:)

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


                    
                    
                    listPrepaidCardReceipts(prepaidCardToken:queryParam:completion:)

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


                    
                    
                    listTransfers(queryParam:completion:)

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


                    
                    
                    retrieveTransferMethodConfigurationFields(request:completion:)

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


                    
                    
                    retrieveTransferMethodUpdateConfigurationFields(request:completion:)

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


                    
                    
                    retrieveTransferMethodConfigurationKeys(request:completion:)

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


                    
                    
                    retrieveTransferMethodTypesFeesAndProcessingTimes(request:completion:)

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


                    
                    
                    updateBankAccount(account:completion:)

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)


                    
                    
                    updatePaperCheck(account:completion:)

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)


                    
                    
                    updateBankCard(account:completion:)

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


                    
                    
                    updatePayPalAccount(account:completion:)

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


                    
                    
                    updateVenmoAccount(account:completion:)

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


                    
                    
                    listUserBalances(queryParam:completion:)

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


                    
                    
                    listPrepaidCardBalances(prepaidCardToken:queryParam:completion:)

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