Interface FundOperationApiClient

interface FundOperationApiClient {
    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>;
}

Methods

createFundOperation(walletId, addressId, createFundOperationRequest, options?): AxiosPromise<FundOperation>
Create a fund operation
Parameters
- walletId: string
  The ID of the wallet to create the fund operation for
- addressId: string
  The ID of the address to create the fund operation for
- createFundOperationRequest: CreateFundOperationRequest
  The request body containing the fund operation details
- Optional options: RawAxiosRequestConfig
  Axios request options
Returns AxiosPromise<FundOperation>
Throws
If the request fails
- Defined in src/coinbase/types.ts:1743

createFundQuote(walletId, addressId, createFundQuoteRequest, options?): AxiosPromise<FundQuote>
Create a fund operation quote
Parameters
- walletId: string
  The ID of the wallet the address belongs to.
- addressId: string
  The ID of the address to create the fund operation quote for.
- createFundQuoteRequest: CreateFundQuoteRequest
  The request body containing the fund operation quote details.
- Optional options: RawAxiosRequestConfig
  Axios request options.
Returns AxiosPromise<FundQuote>
Throws
If the request fails.
- Defined in src/coinbase/types.ts:1759

getFundOperation(walletId, addressId, fundOperationId, options?): AxiosPromise<FundOperation>
Get a fund operation
Parameters
- walletId: string
  The ID of the wallet the address belongs to.
- addressId: string
  The ID of the address the fund operation belongs to.
- fundOperationId: string
  The ID of the fund operation to retrieve
- Optional options: RawAxiosRequestConfig
  Axios request options
Returns AxiosPromise<FundOperation>
Throws
If the request fails
- Defined in src/coinbase/types.ts:1727

listFundOperations(walletId, addressId, limit?, page?, options?): AxiosPromise<FundOperationList>
List fund operations
Parameters
- walletId: string
  The ID of the wallet the address belongs to.
- addressId: string
  The ID 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'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
  Axios request options
Returns AxiosPromise<FundOperationList>
Throws
If the request fails
- Defined in src/coinbase/types.ts:1710