Function WalletsApiFactory

WalletsApi - factory interface export

  • WalletsApiFactory(configuration?, basePath?, axios?): {
        apiWalletsBalanceGet(options?: RawAxiosRequestConfig): AxiosPromise<Balance>;
        apiWalletsGet(options?: RawAxiosRequestConfig): AxiosPromise<Wallet[]>;
        apiWalletsKeyEnablePost(key: string, walletEnableDeets?: WalletEnableDeets, options?: RawAxiosRequestConfig): AxiosPromise<Wallet>;
        apiWalletsKeyGet(key: string, options?: RawAxiosRequestConfig): AxiosPromise<Wallet>;
        apiWalletsKeyPaymentMethodsPost(key: string, paymentMethodCreateDeets?: PaymentMethodCreateDeets, options?: RawAxiosRequestConfig): AxiosPromise<void>;
        apiWalletsKeyPaymentMethodsPut(key: string, paymentMethodUpdateDeets?: PaymentMethodUpdateDeets, options?: RawAxiosRequestConfig): AxiosPromise<void>;
        apiWalletsKeyPaymentPayoutDefaultPost(key: string, payoutMethodDefaultUpdateDeets?: PayoutMethodDefaultUpdateDeets, options?: RawAxiosRequestConfig): AxiosPromise<void>;
        apiWalletsKeyPaymentPayoutMethodsPost(key: string, paymentPayoutMethodCreateDeets?: PaymentPayoutMethodCreateDeets, options?: RawAxiosRequestConfig): AxiosPromise<void>;
        apiWalletsKeyPayoutMethodsPost(key: string, payoutMethodCreateDeets?: PayoutMethodCreateDeets, options?: RawAxiosRequestConfig): AxiosPromise<void>;
    }

  • Parameters

    • Optionalconfiguration: Configuration
    • OptionalbasePath: string
    • Optionalaxios: AxiosInstance

    Returns {
        apiWalletsBalanceGet(options?: RawAxiosRequestConfig): AxiosPromise<Balance>;
        apiWalletsGet(options?: RawAxiosRequestConfig): AxiosPromise<Wallet[]>;
        apiWalletsKeyEnablePost(key: string, walletEnableDeets?: WalletEnableDeets, options?: RawAxiosRequestConfig): AxiosPromise<Wallet>;
        apiWalletsKeyGet(key: string, options?: RawAxiosRequestConfig): AxiosPromise<Wallet>;
        apiWalletsKeyPaymentMethodsPost(key: string, paymentMethodCreateDeets?: PaymentMethodCreateDeets, options?: RawAxiosRequestConfig): AxiosPromise<void>;
        apiWalletsKeyPaymentMethodsPut(key: string, paymentMethodUpdateDeets?: PaymentMethodUpdateDeets, options?: RawAxiosRequestConfig): AxiosPromise<void>;
        apiWalletsKeyPaymentPayoutDefaultPost(key: string, payoutMethodDefaultUpdateDeets?: PayoutMethodDefaultUpdateDeets, options?: RawAxiosRequestConfig): AxiosPromise<void>;
        apiWalletsKeyPaymentPayoutMethodsPost(key: string, paymentPayoutMethodCreateDeets?: PaymentPayoutMethodCreateDeets, options?: RawAxiosRequestConfig): AxiosPromise<void>;
        apiWalletsKeyPayoutMethodsPost(key: string, payoutMethodCreateDeets?: PayoutMethodCreateDeets, options?: RawAxiosRequestConfig): AxiosPromise<void>;
    }

    • apiWalletsBalanceGet:function
      • apiWalletsBalanceGet(options?): AxiosPromise<Balance>

      • summary Get the balance for all wallets

        Parameters

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns AxiosPromise<Balance>

        Throws

    • apiWalletsGet:function
      • apiWalletsGet(options?): AxiosPromise<Wallet[]>

      • summary Get all wallets

        Parameters

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns AxiosPromise<Wallet[]>

        Throws

    • apiWalletsKeyEnablePost:function
      • apiWalletsKeyEnablePost(key, walletEnableDeets?, options?): AxiosPromise<Wallet>

      • summary Enable a wallet

        Parameters

        • key: string

          The wallet key/identifier

        • OptionalwalletEnableDeets: WalletEnableDeets

          Details for the wallet to enable

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns AxiosPromise<Wallet>

        Throws

    • apiWalletsKeyGet:function
      • apiWalletsKeyGet(key, options?): AxiosPromise<Wallet>

      • summary Get a single wallet

        Parameters

        • key: string

          The key/identifier for the wallet

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns AxiosPromise<Wallet>

        Throws

    • apiWalletsKeyPaymentMethodsPost:function
      • apiWalletsKeyPaymentMethodsPost(key, paymentMethodCreateDeets?, options?): AxiosPromise<void>

      • summary Add a payment method to a wallet

        Parameters

        • key: string

          The wallet key

        • OptionalpaymentMethodCreateDeets: PaymentMethodCreateDeets

          The payment method details

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns AxiosPromise<void>

        Throws

    • apiWalletsKeyPaymentMethodsPut:function
      • apiWalletsKeyPaymentMethodsPut(key, paymentMethodUpdateDeets?, options?): AxiosPromise<void>

      • summary Update a card or bank payment method.

        Parameters

        • key: string

          The wallet key

        • OptionalpaymentMethodUpdateDeets: PaymentMethodUpdateDeets

          Payment method update details

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns AxiosPromise<void>

        Throws

    • apiWalletsKeyPaymentPayoutDefaultPost:function
      • apiWalletsKeyPaymentPayoutDefaultPost(key, payoutMethodDefaultUpdateDeets?, options?): AxiosPromise<void>

      • summary Set Wallet Default Payout Method

        Parameters

        Returns AxiosPromise<void>

        Throws

    • apiWalletsKeyPaymentPayoutMethodsPost:function
      • apiWalletsKeyPaymentPayoutMethodsPost(key, paymentPayoutMethodCreateDeets?, options?): AxiosPromise<void>

      • summary Add a payment/payout both method to a wallet

        Parameters

        • key: string

          The wallet key

        • OptionalpaymentPayoutMethodCreateDeets: PaymentPayoutMethodCreateDeets

          The payment method details

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns AxiosPromise<void>

        Throws

    • apiWalletsKeyPayoutMethodsPost:function
      • apiWalletsKeyPayoutMethodsPost(key, payoutMethodCreateDeets?, options?): AxiosPromise<void>

      • summary Add a payout method to a wallet

        Parameters

        • key: string

          The wallet key

        • OptionalpayoutMethodCreateDeets: PayoutMethodCreateDeets

          The payout method details

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns AxiosPromise<void>

        Throws

Settings

Member Visibility