Type alias TransferAPIClient

TransferAPIClient: {
    broadcastTransfer(walletId, addressId, transferId, broadcastTransferRequest, options?): AxiosPromise<Transfer>;
    createTransfer(walletId, addressId, createTransferRequest, options?): AxiosPromise<Transfer>;
    getTransfer(walletId, addressId, transferId, options?): AxiosPromise<Transfer>;
    listTransfers(walletId, addressId, limit?, page?, options?): AxiosPromise<TransferList>;
}

TransferAPI client type definition.

Type declaration

  • broadcastTransfer:function
    • broadcastTransfer(walletId, addressId, transferId, broadcastTransferRequest, options?): AxiosPromise<Transfer>

    • Broadcasts a transfer.

      Parameters

      • walletId: string

        The ID of the wallet the address belongs to.

      • addressId: string

        The ID of the address the transfer belongs to.

      • transferId: string

        The ID of the transfer to broadcast.

      • broadcastTransferRequest: BroadcastTransferRequest

        The request body.

      • Optional options: AxiosRequestConfig<any>

        Axios request options.

      Returns AxiosPromise<Transfer>

      • A promise resolving to the Transfer model.

      Throws

      If the request fails.

  • createTransfer:function
    • createTransfer(walletId, addressId, createTransferRequest, options?): AxiosPromise<Transfer>

    • Creates a Transfer.

      Parameters

      • walletId: string

        The ID of the wallet the address belongs to.

      • addressId: string

        The ID of the address the transfer belongs to.

      • createTransferRequest: CreateTransferRequest

        The request body.

      • Optional options: AxiosRequestConfig<any>

        Axios request options.

      Returns AxiosPromise<Transfer>

      • A promise resolving to the Transfer model.

      Throws

      If the request fails.

  • getTransfer:function
    • getTransfer(walletId, addressId, transferId, options?): AxiosPromise<Transfer>

    • Retrieves a Transfer.

      Parameters

      • walletId: string

        The ID of the wallet the address belongs to.

      • addressId: string

        The ID of the address the transfer belongs to.

      • transferId: string

        The ID of the transfer to retrieve.

      • Optional options: AxiosRequestConfig<any>

        Axios request options.

      Returns AxiosPromise<Transfer>

      • A promise resolving to the Transfer model.

      Throws

      If the request fails.

  • listTransfers:function
    • listTransfers(walletId, addressId, limit?, page?, options?): AxiosPromise<TransferList>

    • Lists Transfers.

      Parameters

      • walletId: string

        The ID of the wallet the address belongs to.

      • addressId: string

        The ID of the address the transfers belong to.

      • Optional limit: number

        The maximum number of transfers to return.

      • Optional page: string

        The cursor for pagination across multiple pages of Transfers.

      • Optional options: AxiosRequestConfig<any>

        Axios request options.

      Returns AxiosPromise<TransferList>

      • A promise resolving to the Transfer list.

      Throws

      If the request fails.

Settings

Member Visibility

Theme