Class WalletsApi

WalletsApi - object-oriented interface export WalletsApi

Hierarchy (view full)

Constructors

constructor

Properties

axios basePath configuration

Methods

apiWalletsBalancesGet apiWalletsGet apiWalletsKeyEnablePost apiWalletsKeyGet apiWalletsKeyPaymentMethodsPost apiWalletsKeyPaymentMethodsPut apiWalletsKeyPaymentPayoutDefaultPost apiWalletsKeyPaymentPayoutMethodsPost apiWalletsKeyPayoutMethodsPost verifyBankAccount

Constructors

constructor

Properties

Protectedaxios

axios: AxiosInstance = globalAxios

ProtectedbasePath

basePath: string = BASE_PATH

Protectedconfiguration

configuration: undefined | Configuration

Methods

apiWalletsBalancesGet

  • apiWalletsBalancesGet(options?): Promise<AxiosResponse<Balance, any>>

  • summary Get the balance for all wallets.

    Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<Balance, any>>

    Throws

    memberof WalletsApi

apiWalletsGet

  • apiWalletsGet(options?): Promise<AxiosResponse<Wallet[], any>>

  • summary Get all wallets

    Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<Wallet[], any>>

    Throws

    memberof WalletsApi

apiWalletsKeyEnablePost

  • apiWalletsKeyEnablePost(key, walletEnableDeets?, options?): Promise<AxiosResponse<Wallet, any>>

  • 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 Promise<AxiosResponse<Wallet, any>>

    Throws

    memberof WalletsApi

apiWalletsKeyGet

  • apiWalletsKeyGet(key, options?): Promise<AxiosResponse<Wallet, any>>

  • summary Get a single wallet

    Parameters

    • key: string

      The key/identifier for the wallet

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<Wallet, any>>

    Throws

    memberof WalletsApi

apiWalletsKeyPaymentMethodsPost

  • apiWalletsKeyPaymentMethodsPost(key, paymentMethodCreateDeets?, options?): Promise<AxiosResponse<void, any>>

  • 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 Promise<AxiosResponse<void, any>>

    Throws

    memberof WalletsApi

apiWalletsKeyPaymentMethodsPut

  • apiWalletsKeyPaymentMethodsPut(key, paymentMethodUpdateDeets?, options?): Promise<AxiosResponse<void, any>>

  • 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 Promise<AxiosResponse<void, any>>

    Throws

    memberof WalletsApi

apiWalletsKeyPaymentPayoutDefaultPost

  • apiWalletsKeyPaymentPayoutDefaultPost(key, payoutMethodDefaultUpdateDeets?, options?): Promise<AxiosResponse<void, any>>

  • summary Set Wallet Default Payout Method

    Parameters

    Returns Promise<AxiosResponse<void, any>>

    Throws

    memberof WalletsApi

apiWalletsKeyPaymentPayoutMethodsPost

  • apiWalletsKeyPaymentPayoutMethodsPost(key, paymentPayoutMethodCreateDeets?, options?): Promise<AxiosResponse<void, any>>

  • 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 Promise<AxiosResponse<void, any>>

    Throws

    memberof WalletsApi

apiWalletsKeyPayoutMethodsPost

  • apiWalletsKeyPayoutMethodsPost(key, payoutMethodCreateDeets?, options?): Promise<AxiosResponse<void, any>>

  • 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 Promise<AxiosResponse<void, any>>

    Throws

    memberof WalletsApi

verifyBankAccount

  • verifyBankAccount(key, id, paymentMethodVerifyDeets?, options?): Promise<AxiosResponse<PaymentMethod, any>>

  • summary Verify customer bank account

    Parameters

    • key: string
    • id: string
    • OptionalpaymentMethodVerifyDeets: PaymentMethodVerifyDeets
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<PaymentMethod, any>>

    Throws

    memberof WalletsApi

Settings

Member Visibility

On This Page

Constructors
Properties
Methods