Interface TransfersApiInterface

TransfersApi - interface

Export

TransfersApi

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

Implemented by

Methods

broadcastTransfer createTransfer getTransfer listTransfers

Methods

broadcastTransfer

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

  • Broadcast 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
    • Optional options: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<Transfer>

    Summary

    Broadcast a transfer

    Throws

    Memberof

    TransfersApiInterface

createTransfer

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

  • Create a new transfer

    Parameters

    • walletId: string

      The ID of the wallet the source address belongs to

    • addressId: string

      The ID of the address to transfer from

    • createTransferRequest: CreateTransferRequest
    • Optional options: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<Transfer>

    Summary

    Create a new transfer for an address

    Throws

    Memberof

    TransfersApiInterface

getTransfer

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

  • Get a transfer by ID

    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 fetch

    • Optional options: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<Transfer>

    Summary

    Get a transfer by ID

    Throws

    Memberof

    TransfersApiInterface

listTransfers

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

  • List transfers for an address.

    Parameters

    • walletId: string

      The ID of the wallet the address belongs to

    • addressId: string

      The ID of the address to list transfers 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<TransferList>

    Summary

    List transfers for an address.

    Throws

    Memberof

    TransfersApiInterface

Settings

Member Visibility

Theme

On This Page

broadcastTransfercreateTransfergetTransferlistTransfers