• FundApi - axios parameter creator

    Parameters

    Returns {
        createFundOperation: ((walletId, addressId, createFundOperationRequest, options?) => Promise<RequestArgs>);
        createFundQuote: ((walletId, addressId, createFundQuoteRequest, options?) => Promise<RequestArgs>);
        getFundOperation: ((walletId, addressId, fundOperationId, options?) => Promise<RequestArgs>);
        listFundOperations: ((walletId, addressId, limit?, page?, options?) => Promise<RequestArgs>);
    }

    • createFundOperation: ((walletId, addressId, createFundOperationRequest, options?) => Promise<RequestArgs>)

      Create a new fund operation with an address.

      Summary

      Create a new fund operation.

      Throws

        • (walletId, addressId, createFundOperationRequest, options?): Promise<RequestArgs>
        • 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 Promise<RequestArgs>

    • createFundQuote: ((walletId, addressId, createFundQuoteRequest, options?) => Promise<RequestArgs>)

      Create a new fund operation with an address.

      Summary

      Create a Fund Operation quote.

      Throws

        • (walletId, addressId, createFundQuoteRequest, options?): Promise<RequestArgs>
        • 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 Promise<RequestArgs>

    • getFundOperation: ((walletId, addressId, fundOperationId, options?) => Promise<RequestArgs>)

      Get fund operation.

      Summary

      Get fund operation.

      Throws

        • (walletId, addressId, fundOperationId, options?): Promise<RequestArgs>
        • 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 Promise<RequestArgs>

    • listFundOperations: ((walletId, addressId, limit?, page?, options?) => Promise<RequestArgs>)

      List fund operations for an address.

      Summary

      List fund operations for an address.

      Throws

        • (walletId, addressId, limit?, page?, options?): Promise<RequestArgs>
        • 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 Promise<RequestArgs>

    Export