@paysafe/paysafe-wallet-saas-web
    Preparing search index...

    Class Wallet

    The main class for performing Wallet operations.

    Index

    Methods

    authenticate configure getAuthenticationService getAuthorizationHistoryService getCardService getCurrencyExchangeService getCustomerDataVerificationService getCustomerVerificationService getDepositService getFeaturesService getPaymentInstrumentService getPreferencesService getProfileService getStrongCustomerAuthenticationService getTransactionHistoryService getTransferService getTrustedEntitiesService getVirtualPaymentInstrumentService getWalletCheckoutService getWalletSetupService getWithdrawalService getInstance

    Methods

    • Authenticates the user with the provided authentication configuration. This method configures the Wallet API to allow access to user resources.

      Parameters

      Returns Promise<AuthenticationResult>

      A Promise that resolves to the result of the authentication.

      If the authentication configuration is invalid.

      // Example usage:
      const authenticationConfiguration = {
        accessToken: 'user_access_token'
      };

      wallet.authenticate(authenticationConfiguration)
        .then((result) => {
          console.log('User authenticated successfully:', result);
        })
        .catch((error) => {
          console.error('Error during user authentication:', error.message);
        });

    • Configures the SDK with the provided configuration.

      Parameters

      Returns Promise<ConfigurationResult>

      A Promise that resolves to the result of the configuration.

      If the provided configuration is invalid.

      // Example usage:
      const sdkConfiguration = {
        apiEnvironment: ApiEnvironment.TEST,
        configToken: 'configToken'
      };

      wallet.configure(sdkConfiguration)
        .then((result) => {
          console.log('SDK configured successfully:', result);
        })
        .catch((error) => {
          console.error('Error configuring the SDK:', error.message);
        });

    • Retrieves the authentication service instance.

      Returns AuthenticationService

      The authentication service instance.

      If there is no valid SDK configuration or if API access is not validated.

      // Example usage
      const authenticationService = wallet.getAuthenticationService();

    • Retrieves the authorization history service instance.

      Returns AuthorizationHistoryService

      The authorization history service instance.

      If there is no valid SDK configuration or if API access is not validated.

      // Example usage
      const authorizationHistoryService = wallet.getAuthorizationHistoryService();

    • Retrieves the card service instance.

      Returns CardService

      The card service instance.

      If there is no valid SDK configuration or if API access is not validated.

      // Example usage
      const cardService = wallet.getCardService();

    • Retrieves the currency exchange service instance.

      Returns CurrencyExchangeService

      The currency exchange service instance.

      If there is no valid SDK configuration or if API access is not validated.

      // Example usage
      const currencyExchangeService = wallet.getCurrencyExchangeService();

    • Retrieves the customer data verification service instance.

      Returns CustomerDataVerificationService

      The customer data verification service instance.

      If there is no valid SDK configuration or if API access is not validated.

      // Example usage:
      const customerDataVerificationService = wallet.getCustomerDataVerificationService();

    • Retrieves the customer verification service instance.

      Returns CustomerVerificationService

      The customer verification service instance.

      If there is no valid SDK configuration or if API access is not validated.

      // Example usage
      const customerVerificationService = wallet.getCustomerVerificationService();

    • Retrieves the deposit service instance.

      Returns DepositService

      The deposit service instance.

      If there is no valid SDK configuration or if API access is not validated.

      // Example usage
      const depositService = wallet.getDepositService();

    • Retrieves the features service instance.

      Returns FeaturesService

      The features service instance.

      If there is no valid SDK configuration or if API access is not validated.

      // Example usage
      const featuresService = wallet.getFeaturesService();

    • Retrieves the payment instrument service instance.

      Returns PaymentInstrumentService

      The payment instrument service instance.

      If there is no valid SDK configuration or if API access is not validated.

      // Example usage
      const paymentInstrumentService = wallet.getPaymentInstrumentService();

    • Retrieves the user preferences service instance.

      Returns PreferencesService

      The user preferences service instance.

      If there is no valid SDK configuration or if API access is not validated.

      // Example usage
      const preferencesService = wallet.getPreferencesService();

    • Retrieves the profile service instance.

      Returns ProfileService

      The profile service instance.

      If there is no valid SDK configuration or if API access is not validated.

      // Example usage:
      const profileService = wallet.getProfileService();

    • Retrieves the strong customer authentication service instance.

      Returns StrongCustomerAuthenticationService

      The strong customer authentication service instance.

      If there is no valid SDK configuration or if API access is not validated.

      // Example usage
      const strongCustomerAuthenticationService = wallet.getStrongCustomerAuthenticationService();

    • Retrieves the transaction history service instance.

      Returns TransactionHistoryService

      The transaction history service instance.

      If there is no valid SDK configuration or if API access is not validated.

      // Example usage
      const transactionHistoryService = wallet.getTransactionHistoryService();

    • Retrieves the transfer service instance.

      Returns TransferService

      The transfer service instance.

      If there is no valid SDK configuration or if API access is not validated.

      // Example usage
      const transferService = wallet.getTransferService();

    • Retrieves the trusted entities service instance.

      Returns TrustedEntitiesService

      The trusted entities service instance.

      If there is no valid SDK configuration or if API access is not validated.

      // Example usage
      const trustedEntitiesService = wallet.getTrustedEntitiesService();

    • Retrieves the virtual payment instrument service instance.

      Returns VirtualPaymentInstrumentService

      The virtual payment instrument service instance.

      If there is no valid SDK configuration or if API access is not validated.

      // Example usage
      const virtualPaymentInstrumentService = wallet.getVirtualPaymentInstrumentService();

    • Retrieves the wallet checkout service instance.

      Returns WalletCheckoutService

      The wallet checkout service instance.

      If there is no valid SDK configuration or if API access is not validated.

      // Example usage
      const walletCheckoutService = wallet.getWalletCheckoutService();

    • Retrieves the wallet setup service instance.

      Returns WalletSetupService

      The wallet setup service instance.

      If there is no valid SDK configuration or if API access is not validated.

      // Example usage
      const walletSetupService = wallet.getWalletSetupService();

    • Retrieves the withdrawal service instance.

      Returns WithdrawalService

      The withdrawal service instance.

      If there is no valid SDK configuration or if API access is not validated.

      // Example usage
      const withdrawalService = wallet.getWithdrawalService();
    • Function

      Retrieves the singleton instance of the Wallet class.

      Returns Wallet

      The singleton instance of the Wallet class.

      // Usage:
      const wallet = Wallet.getInstance();

    Settings

    Member Visibility

    On This Page

    Methods