• FundApi - factory interface

    Parameters

    • Optional configuration: Configuration
    • Optional basePath: string
    • Optional axios: AxiosInstance

    Returns {
        createFundOperation(walletId, addressId, createFundOperationRequest, options?): AxiosPromise<FundOperation>;
        createFundQuote(walletId, addressId, createFundQuoteRequest, options?): AxiosPromise<FundQuote>;
        getFundOperation(walletId, addressId, fundOperationId, options?): AxiosPromise<FundOperation>;
        listFundOperations(walletId, addressId, limit?, page?, options?): AxiosPromise<FundOperationList>;
    }

    • createFundOperation:function
      • Create a new fund operation with an address.

        Parameters

        • walletId: string

          The ID of the wallet the address belongs to.

        • addressId: string

          The onchain address to be funded.

        • createFundOperationRequest: CreateFundOperationRequest
        • Optional options: RawAxiosRequestConfig

          Override http request option.

        Returns AxiosPromise<FundOperation>

        Summary

        Create a new fund operation.

        Throws

    • createFundQuote:function
      • Create a new fund operation with an address.

        Parameters

        • walletId: string

          The ID of the wallet the address belongs to.

        • addressId: string

          The onchain address to be funded.

        • createFundQuoteRequest: CreateFundQuoteRequest
        • Optional options: RawAxiosRequestConfig

          Override http request option.

        Returns AxiosPromise<FundQuote>

        Summary

        Create a Fund Operation quote.

        Throws

    • getFundOperation:function
      • Get fund operation.

        Parameters

        • walletId: string

          The ID of the wallet the address belongs to.

        • addressId: string

          The onchain address of the address that created the fund operation.

        • fundOperationId: string

          The ID of the fund operation to fetch.

        • Optional options: RawAxiosRequestConfig

          Override http request option.

        Returns AxiosPromise<FundOperation>

        Summary

        Get fund operation.

        Throws

    • listFundOperations:function
      • List fund operations for an address.

        Parameters

        • walletId: string

          The ID of the wallet the address belongs to.

        • addressId: string

          The onchain address of the address to list fund operations for.

        • Optional limit: number

          A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

        • Optional page: string

          A cursor for pagination across multiple pages of results. Don&#39;t include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.

        • Optional options: RawAxiosRequestConfig

          Override http request option.

        Returns AxiosPromise<FundOperationList>

        Summary

        List fund operations for an address.

        Throws

    Export