Package com.hyperwallet.clientsdk

Class Hyperwallet

  • public class Hyperwallet
extends Object
    The Hyperwallet Client

    • Constructor Detail

      • Hyperwallet

        public Hyperwallet​(String username,
                   String password,
                   String programToken,
                   String server,
                   HyperwalletEncryption hyperwalletEncryption,
                   int connectionTimeout,
                   int readTimeout)
        Create Hyperwallet SDK instance
        Parameters:
        username - API key assigned
        password - API Password assigned
        programToken - API program token
        server - API server url
        hyperwalletEncryption - API encryption data
        connectionTimeout - the timeout value that will be used for making new connections to the Hyperwallet API (in milliseconds).
        readTimeout - the timeout value that will be used when reading data from an established connection to the Hyperwallet API (in milliseconds).

      • Hyperwallet

        public Hyperwallet​(String username,
                   String password,
                   String programToken,
                   String server,
                   HyperwalletEncryption hyperwalletEncryption)
        Create Hyperwallet SDK instance
        Parameters:
        username - API key assigned
        password - API Password assigned
        programToken - API program token
        server - API server url
        hyperwalletEncryption - API encryption data

      • Hyperwallet

        public Hyperwallet​(String username,
                   String password,
                   String programToken,
                   String server,
                   int connectionTimeout,
                   int readTimeout)
        Create Hyperwallet SDK instance
        Parameters:
        username - API key assigned
        password - API Password assigned
        programToken - API program token
        server - API server url
        connectionTimeout - the timeout value that will be used for making new connections to the Hyperwallet API (in milliseconds).
        readTimeout - the timeout value that will be used when reading data from an established connection to the Hyperwallet API (in milliseconds).

      • Hyperwallet

        public Hyperwallet​(String username,
                   String password,
                   String programToken,
                   String server)
        Create Hyperwallet SDK instance
        Parameters:
        username - API key assigned
        password - API Password assigned
        programToken - API program token
        server - API serer url

      • Hyperwallet

        public Hyperwallet​(String username,
                   String password,
                   String programToken,
                   int connectionTimeout,
                   int readTimeout)
        Create Hyperwallet SDK instance
        Parameters:
        username - API key assigned
        password - API Password assigned
        programToken - API program token
        connectionTimeout - the timeout value that will be used for making new connections to the Hyperwallet API (in milliseconds).
        readTimeout - the timeout value that will be used when reading data from an established connection to the Hyperwallet API (in milliseconds).

      • Hyperwallet

        public Hyperwallet​(String username,
                   String password,
                   String programToken)
        Create Hyperwallet SDK instance
        Parameters:
        username - API key assigned
        password - API password
        programToken - API program token assigned

      • Hyperwallet

        public Hyperwallet​(String username,
                   String password,
                   String programToken,
                   HyperwalletEncryption hyperwalletEncryption)
        Create Hyperwallet SDK instance
        Parameters:
        username - API key assigned
        password - API password
        programToken - API program token assigned
        hyperwalletEncryption - API encryption data

      • Hyperwallet

        public Hyperwallet​(String username,
                   String password)
        Create Hyperwallet SDK instance
        Parameters:
        username - API key assigned
        password - API password

    • Method Detail

      • setHyperwalletProxy

        public void setHyperwalletProxy​(String url,
                                Integer port)
        Create Proxy setting for Hyperwallet API Client instance
        Parameters:
        url - url of Proxy
        port - port of Proxy

      • setHyperwalletProxy

        public void setHyperwalletProxy​(Proxy proxy)
        Create Proxy setting for Hyperwallet API Client instance
        Parameters:
        proxy - value of Proxy

      • getHyperwalletProxy

        public Proxy getHyperwalletProxy()
        Returns Proxy setting for Hyperwallet API Client instance
        Returns:
        Proxy current Proxy config of client

      • usesHyperwalletProxy

        public Boolean usesHyperwalletProxy()
        Checks if current Hyperwallet API Client instance uses a proxy
        Returns:
        Boolean if client has a proxy config

      • setHyperwalletProxyUsername

        public void setHyperwalletProxyUsername​(String proxyUsername)
        Create Proxy Username setting for Authentication
        Parameters:
        proxyUsername - username of Proxy

      • getHyperwalletProxyUsername

        public String getHyperwalletProxyUsername()
        Returns Proxy Username for Hyperwallet API Client instance
        Returns:
        current ProxyUsername

      • setHyperwalletProxyPassword

        public void setHyperwalletProxyPassword​(String proxyPassword)
        Create Proxy Password setting for Authentication
        Parameters:
        proxyPassword - username of Proxy

      • getHyperwalletProxyPassword

        public String getHyperwalletProxyPassword()
        Returns Proxy Password for Hyperwallet API Client instance
        Returns:
        current ProxyUsername

      • createUser

        public HyperwalletUser createUser​(HyperwalletUser user)
        Create a User
        Parameters:
        user - Hyperwallet user representation
        Returns:
        HyperwalletUser created User

      • getUser

        public HyperwalletUser getUser​(String token)
        Get User
        Parameters:
        token - user account token
        Returns:
        HyperwalletUser retreived user

      • updateUser

        public HyperwalletUser updateUser​(HyperwalletUser user)
        Update User
        Parameters:
        user - Hyperwallet User representation object
        Returns:
        HyperwalletUser updated user object

      • createBusinessStakeholder

        public HyperwalletBusinessStakeholder createBusinessStakeholder​(String userToken,
                                                                HyperwalletBusinessStakeholder stakeholder)
        Create Business Stakeholder
        Parameters:
        stakeholder - Hyperwallet Stakeholder representation
        userToken - String
        Returns:
        HyperwalletBusinessStakeholder created Stakeholder

      • updateBusinessStakeholder

        public HyperwalletBusinessStakeholder updateBusinessStakeholder​(String userToken,
                                                                HyperwalletBusinessStakeholder stakeholder)
        Update Business Stakeholder
        Parameters:
        userToken - String
        stakeholder - Hyperwallet Stakeholder representation
        Returns:
        HyperwalletBusinessStakeholder updated Stakeholder

      • uploadStakeholderDocuments

        public HyperwalletBusinessStakeholder uploadStakeholderDocuments​(String userToken,
                                                                 String businessStakeholderToken,
                                                                 List<HyperwalletVerificationDocument> uploadData)
        Uploading documents for Business Stakeholder
        Parameters:
        userToken - String
        businessStakeholderToken - Hyperwallet Stakeholder representation
        uploadData - HyperwalletVerificationDocument to get uploaded
        Returns:
        HyperwalletBusinessStakeholder updated Stakeholder with document status

      • createBusinessStakeholderStatusTransition

        public HyperwalletStatusTransition createBusinessStakeholderStatusTransition​(String userToken,
                                                                             String stakeholderToken,
                                                                             HyperwalletStatusTransition transition)
        Create Business Stakeholder Status transition
        Parameters:
        userToken - String
        stakeholderToken - Hyperwallet Stakeholder token
        transition - Hyperwallet Status Transition
        Returns:
        HyperwalletStatusTransition new status for Business Stakeholder

      • getBusinessStakeholderStatusTransition

        public HyperwalletStatusTransition getBusinessStakeholderStatusTransition​(String userToken,
                                                                          String stakeholderToken,
                                                                          String statusTransitionToken)
        Get Business Stakeholder Status transition
        Parameters:
        userToken - String
        stakeholderToken - Hyperwallet Stakeholder token
        statusTransitionToken - Hyperwallet Status Transition token
        Returns:
        HyperwalletStatusTransition

      • listBusinessStakeholderStatusTransition

        public HyperwalletList<HyperwalletStatusTransition> listBusinessStakeholderStatusTransition​(String userToken,
                                                                                            String stakeholderToken)
        List Business Stakeholder Status transition
        Parameters:
        userToken - String
        stakeholderToken - Hyperwallet Stakeholder token
        Returns:
        HyperwalletList of HyperwalletStatusTransition

      • activateBusinessStakeholder

        public HyperwalletStatusTransition activateBusinessStakeholder​(String userToken,
                                                               String stakeholderToken)
        Activate a business stakeholder
        Parameters:
        userToken - User token
        stakeholderToken - Business Stakeholder token
        Returns:
        The status transition

      • deactivateBusinessStakeholder

        public HyperwalletStatusTransition deactivateBusinessStakeholder​(String userToken,
                                                                 String stakeholderToken)
        De-activate a business stakeholder
        Parameters:
        userToken - User token
        stakeholderToken - Business Stakeholder token
        Returns:
        The status transition

      • getAuthenticationToken

        public HyperwalletAuthenticationToken getAuthenticationToken​(String token)
        Get Authentication Token
        Parameters:
        token - user account token
        Returns:
        HyperwalletAuthenticationToken retreived authentication token

      • getUserStatusTransition

        public HyperwalletStatusTransition getUserStatusTransition​(String userToken,
                                                           String statusTransitionToken)
        Get User Status Transition
        Parameters:
        userToken - User token
        statusTransitionToken - Status transition token
        Returns:
        HyperwalletStatusTransition

      • listUserStatusTransitions

        public HyperwalletList<HyperwalletStatusTransition> listUserStatusTransitions​(String userToken)
        List All User Status Transition information
        Parameters:
        userToken - User token
        Returns:
        HyperwalletList of HyperwalletStatusTransition

      • createUserStatusTransition

        public HyperwalletStatusTransition createUserStatusTransition​(String userToken,
                                                              HyperwalletStatusTransition transition)
        Create User Status transition
        Parameters:
        userToken - String
        transition - Hyperwallet Status Transition
        Returns:
        HyperwalletStatusTransition new status for Hyperwallet User

      • activateUser

        public HyperwalletStatusTransition activateUser​(String userToken)
        Activate a User
        Parameters:
        userToken - User token
        Returns:
        The status transition

      • deactivateUser

        public HyperwalletStatusTransition deactivateUser​(String userToken)
        De-activate a User
        Parameters:
        userToken - User token
        Returns:
        The status transition

      • freezeUser

        public HyperwalletStatusTransition freezeUser​(String userToken)
        Freeze a User account
        Parameters:
        userToken - User token
        Returns:
        The status transition

      • preactivateUser

        public HyperwalletStatusTransition preactivateUser​(String userToken)
        Pre-activate a User account
        Parameters:
        userToken - User token
        Returns:
        The status transition

      • createOrReplacePrepaidCard

        public HyperwalletPrepaidCard createOrReplacePrepaidCard​(HyperwalletPrepaidCard prepaidCard)
        Create Prepaid Card
        Parameters:
        prepaidCard - Prepaid Card object to create
        Returns:
        HyperwalletPrepaidCard Prepaid Card object created

      • getPrepaidCard

        public HyperwalletPrepaidCard getPrepaidCard​(String userToken,
                                             String prepaidCardToken)
        Get Prepaid Card
        Parameters:
        userToken - User token assigned
        prepaidCardToken - Prepaid Card token
        Returns:
        HyperwalletPrepaidCard Prepaid Card

      • updatePrepaidCard

        public HyperwalletPrepaidCard updatePrepaidCard​(HyperwalletPrepaidCard prepaidCard)
        Update Prepaid Card
        Parameters:
        prepaidCard - Prepaid Card object to create
        Returns:
        HyperwalletPrepaidCard Prepaid Card object created

      • listPrepaidCards

        public HyperwalletList<HyperwalletPrepaidCard> listPrepaidCards​(String userToken)
        List User's Prepaid Card
        Parameters:
        userToken - User token assigned
        Returns:
        HyperwalletList of HyperwalletPrepaidCard

      • suspendPrepaidCard

        public HyperwalletStatusTransition suspendPrepaidCard​(String userToken,
                                                      String prepaidCardToken)
        Suspend a prepaid card
        Parameters:
        userToken - User token
        prepaidCardToken - Prepaid card token
        Returns:
        The status transition

      • unsuspendPrepaidCard

        public HyperwalletStatusTransition unsuspendPrepaidCard​(String userToken,
                                                        String prepaidCardToken)
        Unsuspend a prepaid card
        Parameters:
        userToken - User token
        prepaidCardToken - Prepaid card token
        Returns:
        The status transition

      • lostOrStolenPrepaidCard

        public HyperwalletStatusTransition lostOrStolenPrepaidCard​(String userToken,
                                                           String prepaidCardToken)
        Mark a prepaid card as lost or stolen
        Parameters:
        userToken - User token
        prepaidCardToken - Prepaid card token
        Returns:
        The status transition

      • deactivatePrepaidCard

        public HyperwalletStatusTransition deactivatePrepaidCard​(String userToken,
                                                         String prepaidCardToken)
        Deactivate a prepaid card
        Parameters:
        userToken - User token
        prepaidCardToken - Prepaid card token
        Returns:
        The status transition

      • lockPrepaidCard

        public HyperwalletStatusTransition lockPrepaidCard​(String userToken,
                                                   String prepaidCardToken)
        Lock a prepaid card
        Parameters:
        userToken - User token
        prepaidCardToken - Prepaid card token
        Returns:
        The status transition

      • unlockPrepaidCard

        public HyperwalletStatusTransition unlockPrepaidCard​(String userToken,
                                                     String prepaidCardToken)
        Unlock a prepaid card
        Parameters:
        userToken - User token
        prepaidCardToken - Prepaid card token
        Returns:
        The status transition

      • createPrepaidCardStatusTransition

        public HyperwalletStatusTransition createPrepaidCardStatusTransition​(String userToken,
                                                                     String prepaidCardToken,
                                                                     HyperwalletStatusTransition transition)
        Create Prepaid Card Status Transition
        Parameters:
        userToken - User token
        prepaidCardToken - Prepaid Card token
        transition - Status transition information
        Returns:
        HyperwalletStatusTransition new status for Prepaid Card

      • getPrepaidCardStatusTransition

        public HyperwalletStatusTransition getPrepaidCardStatusTransition​(String userToken,
                                                                  String prepaidCardToken,
                                                                  String statusTransitionToken)
        Get Prepaid Card Status Transition
        Parameters:
        userToken - User token
        prepaidCardToken - Prepaid Card token
        statusTransitionToken - Status transition token
        Returns:
        HyperwalletStatusTransition

      • listPrepaidCardStatusTransitions

        public HyperwalletList<HyperwalletStatusTransition> listPrepaidCardStatusTransitions​(String userToken,
                                                                                     String prepaidCardToken)
        List All Prepaid Card Status Transition information
        Parameters:
        userToken - User token
        prepaidCardToken - Prepaid Card token
        Returns:
        HyperwalletList of HyperwalletStatusTransition

      • createBankCard

        public HyperwalletBankCard createBankCard​(HyperwalletBankCard bankCard)
        Create Bank Card
        Parameters:
        bankCard - Bank Card object to create
        Returns:
        HyperwalletBankCard Bank Card object created

      • getBankCard

        public HyperwalletBankCard getBankCard​(String userToken,
                                       String bankCardToken)
        Get Bank Card
        Parameters:
        userToken - User token assigned
        bankCardToken - Bank Card token
        Returns:
        HyperwalletBankCard Bank Card

      • updateBankCard

        public HyperwalletBankCard updateBankCard​(HyperwalletBankCard bankCard)
        Update Bank Card
        Parameters:
        bankCard - Bank Card object to create
        Returns:
        HyperwalletBankCard Bank Card object created

      • listBankCards

        public HyperwalletList<HyperwalletBankCard> listBankCards​(String userToken)
        List User's Bank Card
        Parameters:
        userToken - User token assigned
        Returns:
        HyperwalletList of HyperwalletBankCard

      • deactivateBankCard

        public HyperwalletStatusTransition deactivateBankCard​(String userToken,
                                                      String bankCardToken)
        Deactivate a bank card
        Parameters:
        userToken - User token
        bankCardToken - Bank card token
        Returns:
        The status transition

      • deactivateBankCard

        public HyperwalletStatusTransition deactivateBankCard​(String userToken,
                                                      String bankCardToken,
                                                      String notes)
        Deactivate a bank card
        Parameters:
        userToken - User token
        bankCardToken - Bank card token
        notes - Comments regarding the status change
        Returns:
        The status transition

      • createBankCardStatusTransition

        public HyperwalletStatusTransition createBankCardStatusTransition​(String userToken,
                                                                  String bankCardToken,
                                                                  HyperwalletStatusTransition transition)
        Create Bank Card Status Transition
        Parameters:
        userToken - User token
        bankCardToken - Bank Card token
        transition - Status transition information
        Returns:
        HyperwalletStatusTransition new status for Bank Card

      • getBankCardStatusTransition

        public HyperwalletStatusTransition getBankCardStatusTransition​(String userToken,
                                                               String bankCardToken,
                                                               String statusTransitionToken)
        Get Bank Card Status Transition
        Parameters:
        userToken - User token
        bankCardToken - Bank Card token
        statusTransitionToken - Status transition token
        Returns:
        HyperwalletStatusTransition

      • listBankCardStatusTransitions

        public HyperwalletList<HyperwalletStatusTransition> listBankCardStatusTransitions​(String userToken,
                                                                                  String bankCardToken)
        List All Bank Card Status Transition information
        Parameters:
        userToken - User token
        bankCardToken - Bank Card token
        Returns:
        HyperwalletList of HyperwalletStatusTransition

      • createPaperCheck

        public HyperwalletPaperCheck createPaperCheck​(HyperwalletPaperCheck paperCheck)
        Create Paper Check
        Parameters:
        paperCheck - Paper Check object to create
        Returns:
        HyperwalletPaperCheck Paper Check object created

      • getPaperCheck

        public HyperwalletPaperCheck getPaperCheck​(String userToken,
                                           String paperCheckToken)
        Get Paper Check
        Parameters:
        userToken - User token assigned
        paperCheckToken - Paper Check token
        Returns:
        HyperwalletPaperCheck Paper Check

      • updatePaperCheck

        public HyperwalletPaperCheck updatePaperCheck​(HyperwalletPaperCheck paperCheck)
        Update Paper Check
        Parameters:
        paperCheck - Paper Check object to create
        Returns:
        HyperwalletPaperCheck Paper Check object created

      • listPaperChecks

        public HyperwalletList<HyperwalletPaperCheck> listPaperChecks​(String userToken)
        List User's Paper Check
        Parameters:
        userToken - User token assigned
        Returns:
        HyperwalletList of HyperwalletPaperCheck

      • deactivatePaperCheck

        public HyperwalletStatusTransition deactivatePaperCheck​(String userToken,
                                                        String paperCheckToken)
        Deactivate a Paper Check
        Parameters:
        userToken - User token
        paperCheckToken - Paper Check token
        Returns:
        The status transition

      • deactivatePaperCheck

        public HyperwalletStatusTransition deactivatePaperCheck​(String userToken,
                                                        String paperCheckToken,
                                                        String notes)
        Deactivate a Paper Check
        Parameters:
        userToken - User token
        paperCheckToken - Paper Check token
        notes - user notes
        Returns:
        The status transition

      • createPaperCheckStatusTransition

        public HyperwalletStatusTransition createPaperCheckStatusTransition​(String userToken,
                                                                    String paperCheckToken,
                                                                    HyperwalletStatusTransition transition)
        Create Paper Check Status Transition
        Parameters:
        userToken - User token
        paperCheckToken - Paper Check token
        transition - Status transition information
        Returns:
        HyperwalletStatusTransition new status for Paper Check

      • getPaperCheckStatusTransition

        public HyperwalletStatusTransition getPaperCheckStatusTransition​(String userToken,
                                                                 String paperCheckToken,
                                                                 String statusTransitionToken)
        Get Paper Check Status Transition
        Parameters:
        userToken - User token
        paperCheckToken - Paper Check token
        statusTransitionToken - Status transition token
        Returns:
        HyperwalletStatusTransition

      • listPaperCheckStatusTransitions

        public HyperwalletList<HyperwalletStatusTransition> listPaperCheckStatusTransitions​(String userToken,
                                                                                    String paperCheckToken)
        List All Paper Check Status Transition information
        Parameters:
        userToken - User token
        paperCheckToken - Paper Check token
        Returns:
        HyperwalletList of HyperwalletStatusTransition

      • createTransfer

        public HyperwalletTransfer createTransfer​(HyperwalletTransfer transfer)
        Create Transfer Request
        Parameters:
        transfer - HyperwalletTransfer object to create
        Returns:
        HyperwalletTransfer Transfer object created

      • getTransfer

        public HyperwalletTransfer getTransfer​(String transferToken)
        Get Transfer Request
        Parameters:
        transferToken - Transfer token assigned
        Returns:
        HyperwalletTransfer Transfer

      • createTransferStatusTransition

        public HyperwalletStatusTransition createTransferStatusTransition​(String transferToken,
                                                                  HyperwalletStatusTransition transition)
        Create Transfer Status Transition
        Parameters:
        transferToken - Transfer token assigned
        transition - transition value
        Returns:
        HyperwalletStatusTransition new status for Transfer Request

      • getTransferStatusTransition

        public HyperwalletStatusTransition getTransferStatusTransition​(String transferToken,
                                                               String statusTransitionToken)
        Get Transfer Status Transition
        Parameters:
        transferToken - Transfer token assigned
        statusTransitionToken - Status transition token
        Returns:
        HyperwalletStatusTransition new status for Transfer Request

      • createTransferRefund

        public HyperwalletTransferRefund createTransferRefund​(String transferToken,
                                                      HyperwalletTransferRefund transferRefund)
        Create Transfer Refund
        Parameters:
        transferToken - Transfer token assigned
        transferRefund - Transfer Refund object to create
        Returns:
        Created Transfer Refund

      • getTransferRefund

        public HyperwalletTransferRefund getTransferRefund​(String transferToken,
                                                   String transferRefundToken)
        Get Transfer Refund
        Parameters:
        transferToken - Transfer token assigned
        transferRefundToken - Transfer Refund token assigned
        Returns:
        Transfer Refund object

      • createPayPalAccount

        public HyperwalletPayPalAccount createPayPalAccount​(HyperwalletPayPalAccount payPalAccount)
        Create PayPal Account Request
        Parameters:
        payPalAccount - HyperwalletPayPalAccount object to create
        Returns:
        HyperwalletPayPalAccount created PayPal account for the specified user

      • getPayPalAccount

        public HyperwalletPayPalAccount getPayPalAccount​(String userToken,
                                                 String payPalAccountToken)
        Get PayPal Account Request
        Parameters:
        userToken - User token assigned
        payPalAccountToken - PayPal Account token assigned
        Returns:
        HyperwalletPayPalAccount PayPal Account

      • listPayPalAccounts

        public HyperwalletList<HyperwalletPayPalAccount> listPayPalAccounts​(String userToken)
        List PayPal Accounts
        Parameters:
        userToken - User token assigned
        Returns:
        HyperwalletList of HyperwalletPayPalAccount

      • deactivatePayPalAccount

        public HyperwalletStatusTransition deactivatePayPalAccount​(String userToken,
                                                           String payPalAccountToken)
        Deactivate PayPal Account
        Parameters:
        userToken - User token
        payPalAccountToken - PayPal Account token
        Returns:
        HyperwalletStatusTransition deactivated PayPal account

      • deactivatePayPalAccount

        public HyperwalletStatusTransition deactivatePayPalAccount​(String userToken,
                                                           String payPalAccountToken,
                                                           String notes)
        Deactivate PayPal Account
        Parameters:
        userToken - User token
        payPalAccountToken - PayPal Account token
        notes - Comments regarding the status change
        Returns:
        HyperwalletStatusTransition deactivated PayPal account

      • createPayPalAccountStatusTransition

        public HyperwalletStatusTransition createPayPalAccountStatusTransition​(String userToken,
                                                                       String payPalAccountToken,
                                                                       HyperwalletStatusTransition transition)
        Create PayPal Account Status Transition
        Parameters:
        userToken - User token
        payPalAccountToken - PayPal Account token
        transition - Status transition information
        Returns:
        HyperwalletStatusTransition new status for PayPal Account

      • getPayPalAccountStatusTransition

        public HyperwalletStatusTransition getPayPalAccountStatusTransition​(String userToken,
                                                                    String payPalAccountToken,
                                                                    String statusTransitionToken)
        Get PayPal Account Status Transition
        Parameters:
        userToken - User token
        payPalAccountToken - PayPal Account token
        statusTransitionToken - Status transition token
        Returns:
        HyperwalletStatusTransition

      • listPayPalAccountStatusTransitions

        public HyperwalletList<HyperwalletStatusTransition> listPayPalAccountStatusTransitions​(String userToken,
                                                                                       String payPalAccountToken)
        List All PayPal Account Status Transition information
        Parameters:
        userToken - User token
        payPalAccountToken - PayPal Account token
        Returns:
        HyperwalletList of HyperwalletStatusTransition

      • updatePayPalAccount

        public HyperwalletPayPalAccount updatePayPalAccount​(HyperwalletPayPalAccount payPalAccount)
        Update PayPal Account
        Parameters:
        payPalAccount - PayPal Account to Update.
        Returns:
        HyperwalletPayPalAccount Updated PayPal Account

      • createVenmoAccount

        public HyperwalletVenmoAccount createVenmoAccount​(HyperwalletVenmoAccount venmoAccount)
        Create Venmo Account
        Parameters:
        venmoAccount - HyperwalletVenmoAccount object to create
        Returns:
        HyperwalletVenmoAccount created Venmo account for the specified user

      • getVenmoAccount

        public HyperwalletVenmoAccount getVenmoAccount​(String userToken,
                                               String venmoAccountToken)
        Get Venmo Account
        Parameters:
        userToken - User token assigned
        venmoAccountToken - Venmo Account token assigned
        Returns:
        HyperwalletVenmoAccount Venmo Account

      • listVenmoAccounts

        public HyperwalletList<HyperwalletVenmoAccount> listVenmoAccounts​(String userToken)
        List Venmo Accounts
        Parameters:
        userToken - User token assigned
        Returns:
        HyperwalletList of HyperwalletVenmoAccount

      • updateVenmoAccount

        public HyperwalletVenmoAccount updateVenmoAccount​(HyperwalletVenmoAccount venmoAccount)
        Update Venmo Account
        Parameters:
        venmoAccount - Venmo Account to Update.
        Returns:
        HyperwalletVenmoAccount Updated Venmo Account

      • deactivateVenmoAccount

        public HyperwalletStatusTransition deactivateVenmoAccount​(String userToken,
                                                          String venmoAccountToken)
        Deactivate Venmo Account
        Parameters:
        userToken - User token
        venmoAccountToken - Venmo account token
        Returns:
        HyperwalletStatusTransition deactivated venmo account

      • deactivateVenmoAccount

        public HyperwalletStatusTransition deactivateVenmoAccount​(String userToken,
                                                          String venmoAccountToken,
                                                          String notes)
        Deactivate Venmo Account
        Parameters:
        userToken - User token
        venmoAccountToken - Venmo account token
        notes - Comments regarding the status change
        Returns:
        HyperwalletStatusTransition deactivated Venmo account

      • createVenmoAccountStatusTransition

        public HyperwalletStatusTransition createVenmoAccountStatusTransition​(String userToken,
                                                                      String venmoAccountToken,
                                                                      HyperwalletStatusTransition transition)
        Create Venmo Account Status Transition
        Parameters:
        userToken - User token
        venmoAccountToken - Venmo account token
        transition - Status transition information
        Returns:
        HyperwalletStatusTransition new status for Venmo Account

      • getVenmoAccountStatusTransition

        public HyperwalletStatusTransition getVenmoAccountStatusTransition​(String userToken,
                                                                   String venmoAccountToken,
                                                                   String statusTransitionToken)
        Get Venmo Account Status Transition
        Parameters:
        userToken - User token
        venmoAccountToken - Venmo account token
        statusTransitionToken - Status transition token
        Returns:
        HyperwalletStatusTransition

      • listVenmoAccountStatusTransitions

        public HyperwalletList<HyperwalletStatusTransition> listVenmoAccountStatusTransitions​(String userToken,
                                                                                      String venmoAccountToken)
        List All Venmo Account Status Transition information
        Parameters:
        userToken - User token
        venmoAccountToken - Venmo account token
        Returns:
        HyperwalletList of HyperwalletStatusTransition

      • createBankAccount

        public HyperwalletBankAccount createBankAccount​(HyperwalletBankAccount bankAccount)
        Create Bank Account
        Parameters:
        bankAccount - bank account representation
        Returns:
        HyperwalletBankAccount created bank account for the specicic user

      • getBankAccount

        public HyperwalletBankAccount getBankAccount​(String userToken,
                                             String transferMethodToken)
        Get Bank Account
        Parameters:
        userToken - User token assigned
        transferMethodToken - Bank account token assigned
        Returns:
        HyperwalletBankAccount bank account information

      • updateBankAccount

        public HyperwalletBankAccount updateBankAccount​(HyperwalletBankAccount bankAccount)
        Update Bank Account
        Parameters:
        bankAccount - Bank Account to update.
        Returns:
        HyperwalletBankAccount updated Bank Account

      • listBankAccounts

        public HyperwalletList<HyperwalletBankAccount> listBankAccounts​(String userToken)
        List Bank Accounts
        Parameters:
        userToken - User token assigned
        Returns:
        HyperwalletList of HyperwalletBankAccount

      • deactivateBankAccount

        public HyperwalletStatusTransition deactivateBankAccount​(String userToken,
                                                         String bankAccountToken)
        Deactivate Bank Account
        Parameters:
        userToken - User token
        bankAccountToken - Bank Account token
        Returns:
        HyperwalletStatusTransition deactivated bank account

      • createBankAccountStatusTransition

        public HyperwalletStatusTransition createBankAccountStatusTransition​(String userToken,
                                                                     String bankAccountToken,
                                                                     HyperwalletStatusTransition transition)
        Create Bank Account Status Transition
        Parameters:
        userToken - User token
        bankAccountToken - Bank Account token
        transition - Status transition information
        Returns:
        HyperwalletStatusTransition

      • getBankAccountStatusTransition

        public HyperwalletStatusTransition getBankAccountStatusTransition​(String userToken,
                                                                  String bankAccountToken,
                                                                  String statusTransitionToken)
        Get Bank Account Status Transition
        Parameters:
        userToken - User token
        bankAccountToken - Bank Account token
        statusTransitionToken - Status transition token
        Returns:
        HyperwalletStatusTransition

      • listBankAccountStatusTransitions

        public HyperwalletList<HyperwalletStatusTransition> listBankAccountStatusTransitions​(String userToken,
                                                                                     String bankAccountToken)
        List All Bank Account Status Transition
        Parameters:
        userToken - User token
        bankAccountToken - Bank Account token
        Returns:
        HyperwalletList of HyperwalletStatusTransition

      • listBalancesForUser

        public HyperwalletList<HyperwalletBalance> listBalancesForUser​(String userToken)
        List all User's Balances
        Parameters:
        userToken - User token assigned
        Returns:
        HyperwalletList of HyperwalletBalance

      • listBalancesForAccount

        public HyperwalletList<HyperwalletBalance> listBalancesForAccount​(String programToken,
                                                                  String accountToken)
        List all Program account balances
        Parameters:
        accountToken - Account token assigned
        programToken - Program token assigned
        Returns:
        HyperwalletList of HyperwalletBalance

      • listBalancesForAccount

        public HyperwalletList<HyperwalletBalance> listBalancesForAccount​(String programToken,
                                                                  String accountToken,
                                                                  HyperwalletBalanceListOptions options)
        List all Program account balances
        Parameters:
        accountToken - Account token assigned
        programToken - Program token assigned
        options - List filter option
        Returns:
        HyperwalletList list of HyperwalletBalance

      • listBalancesForPrepaidCard

        public HyperwalletList<HyperwalletBalance> listBalancesForPrepaidCard​(String userToken,
                                                                      String prepaidCardToken)
        List all User's Prepaid Card Balances
        Parameters:
        userToken - User token assigned
        prepaidCardToken - Prepaid Card token assigned from User's Prepaid Card
        Returns:
        HyperwalletList of HyperwalletBalances

      • listBalancesForPrepaidCard

        public HyperwalletList<HyperwalletBalance> listBalancesForPrepaidCard​(String userToken,
                                                                      String prepaidCardToken,
                                                                      HyperwalletBalanceListOptions options)
        List all User's Prepaid Card Balances
        Parameters:
        userToken - User token assigned
        prepaidCardToken - Prepaid Card token assigned from User's Prepaid Card
        options - List filter option
        Returns:
        HyperwalletList of HyperwalletBalances

      • createPayment

        public HyperwalletPayment createPayment​(HyperwalletPayment payment)
        Create Payment
        Parameters:
        payment - Payment
        Returns:
        HyperwalletPayment created payment information

      • getPayment

        public HyperwalletPayment getPayment​(String paymentToken)
        Get Payment
        Parameters:
        paymentToken - Payment token
        Returns:
        HyperwalletPayment

      • createPaymentStatusTransition

        public HyperwalletStatusTransition createPaymentStatusTransition​(String paymentToken,
                                                                 HyperwalletStatusTransition transition)
        Create Payment Status Transition
        Parameters:
        paymentToken - Payment token
        transition - Status transition information
        Returns:
        HyperwalletStatusTransition new status for Payment

      • getPaymentStatusTransition

        public HyperwalletStatusTransition getPaymentStatusTransition​(String paymentToken,
                                                              String statusTransitionToken)
        Get Payment Status Transition
        Parameters:
        paymentToken - Payment token
        statusTransitionToken - Status transition token
        Returns:
        HyperwalletStatusTransition

      • listPaymentStatusTransitions

        public HyperwalletList<HyperwalletStatusTransition> listPaymentStatusTransitions​(String paymentToken)
        List All Payment Status Transition information
        Parameters:
        paymentToken - Payment token
        Returns:
        HyperwalletList of HyperwalletStatusTransition

      • getProgram

        public HyperwalletProgram getProgram​(String programToken)
        Get Program
        Parameters:
        programToken - Program token
        Returns:
        HyperwalletProgram

      • getProgramAccount

        public HyperwalletAccount getProgramAccount​(String programToken,
                                            String accountToken)
        Get Programs Account
        Parameters:
        programToken - Program token
        accountToken - Program account token
        Returns:
        HyperwalletAccount

      • listTransferMethodConfigurations

        public HyperwalletList<HyperwalletTransferMethodConfiguration> listTransferMethodConfigurations​(String userToken)
        List all Transfer Method Configuration associated with User
        Parameters:
        userToken - User token
        Returns:
        HyperwalletList of HyperwalletTransferMethodConfiguration

      • listReceiptsForProgramAccount

        public HyperwalletList<HyperwalletReceipt> listReceiptsForProgramAccount​(String programToken,
                                                                         String accountToken)
        List all program account receipts
        Parameters:
        programToken - Program token
        accountToken - Program account token
        Returns:
        HyperwalletList of HyperwalletReceipt

      • listReceiptsForUser

        public HyperwalletList<HyperwalletReceipt> listReceiptsForUser​(String userToken)
        List all user receipts
        Parameters:
        userToken - User token
        Returns:
        HyperwalletList of HyperwalletReceipt

      • listReceiptsForPrepaidCard

        public HyperwalletList<HyperwalletReceipt> listReceiptsForPrepaidCard​(String userToken,
                                                                      String prepaidCardToken)
        List all prepaid card receipts
        Parameters:
        userToken - User token
        prepaidCardToken - Prepaid card token
        Returns:
        HyperwalletList of HyperwalletReceipt

      • getWebhookEvent

        public HyperwalletWebhookNotification getWebhookEvent​(String webhookToken)
        Retrieve webhook event notification
        Parameters:
        webhookToken - Webhook token
        Returns:
        HyperwalletWebhookNotification

      • createTransferMethod

        public HyperwalletTransferMethod createTransferMethod​(String jsonCacheToken,
                                                      HyperwalletTransferMethod transferMethod)
        Create a Transfer Method
        Parameters:
        jsonCacheToken - String JSON cache token
        transferMethod - TransferMethod object to create
        Returns:
        HyperwalletTransferMethod Transfer Method object created

      • createTransferMethod

        public HyperwalletTransferMethod createTransferMethod​(String jsonCacheToken,
                                                      String userToken)
        Create a Transfer Method
        Parameters:
        jsonCacheToken - String JSON cache token
        userToken - String user token
        Returns:
        HyperwalletTransferMethod Transfer Method object created

      • uploadUserDocuments

        public HyperwalletUser uploadUserDocuments​(String userToken,
                                           List<HyperwalletVerificationDocument> uploadData)
        Upload documents
        Parameters:
        userToken - userToken for which documents to be uploaded
        uploadData - HyperwalletVerificationDocument to get uploaded
        Returns:
        HyperwalletUser user object with document upload status