Function TransfersApiAxiosParamCreator

Returns {
    broadcastTransfer: ((walletId, addressId, transferId, broadcastTransferRequest, options?) => Promise<RequestArgs>);
    createTransfer: ((walletId, addressId, createTransferRequest, options?) => Promise<RequestArgs>);
    getTransfer: ((walletId, addressId, transferId, options?) => Promise<RequestArgs>);
    listTransfers: ((walletId, addressId, limit?, page?, options?) => Promise<RequestArgs>);
}

• broadcastTransfer: ((walletId, addressId, transferId, broadcastTransferRequest, options?) => Promise<RequestArgs>)

  Broadcast a transfer

  Summary

  Broadcast a transfer

  Throws

  • • (walletId, addressId, transferId, broadcastTransferRequest, options?): Promise<RequestArgs>

    • 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 Promise<RequestArgs>

• createTransfer: ((walletId, addressId, createTransferRequest, options?) => Promise<RequestArgs>)

  Create a new transfer

  Summary

  Create a new transfer for an address

  Throws

  • • (walletId, addressId, createTransferRequest, options?): Promise<RequestArgs>

    • 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 Promise<RequestArgs>

• getTransfer: ((walletId, addressId, transferId, options?) => Promise<RequestArgs>)

  Get a transfer by ID

  Summary

  Get a transfer by ID

  Throws

  • • (walletId, addressId, transferId, options?): Promise<RequestArgs>

    • 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 Promise<RequestArgs>

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

  List transfers for an address.

  Summary

  List transfers 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 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 Promise<RequestArgs>