Class TransfersApi

Hierarchy

  • TransfersApi
    • TransfersApi

Constructors

constructor

Properties

basePath axios configuration

Methods

createTransfer createTransferV1 getSignableTransfer getSignableTransferV1 getTransfer listTransfers

Constructors

constructor

  • new TransfersApi(configuration?, basePath?, axios?): TransfersApi

  • Parameters

    • Optionalconfiguration: Configuration
    • OptionalbasePath: string
    • Optionalaxios: AxiosInstance

    Returns TransfersApi

Properties

ProtectedbasePath

basePath: string

Protectedaxios

axios: AxiosInstance

Protectedconfiguration

configuration: undefined | Configuration

Methods

createTransfer

  • createTransfer(requestParameters, options?): Promise<AxiosResponse<CreateTransferResponseV2, any>>

  • Create a new transfer request. Use https://docs.x.immutable.com/reference#/operations/getSignableTransfer to get request body params.

    Parameters

    • requestParameters: TransfersApiCreateTransferRequest

      Request parameters.

    • Optionaloptions: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<AxiosResponse<CreateTransferResponseV2, any>>

    Summary

    Creates a transfer of multiple tokens between two parties

    Throws

    Memberof

    TransfersApi

createTransferV1

  • createTransferV1(requestParameters, options?): Promise<AxiosResponse<CreateTransferResponseV1, any>>

  • Create a new transfer request. Use https://docs.x.immutable.com/reference#/operations/getSignableTransferV1 to get request body params.

    Parameters

    • requestParameters: TransfersApiCreateTransferV1Request

      Request parameters.

    • Optionaloptions: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<AxiosResponse<CreateTransferResponseV1, any>>

    Summary

    Creates a transfer of tokens between two parties

    Throws

    Memberof

    TransfersApi

getSignableTransfer

  • getSignableTransfer(requestParameters, options?): Promise<AxiosResponse<GetSignableTransferResponseV2, any>>

  • Gets bulk details of a signable transfer

    Parameters

    • requestParameters: TransfersApiGetSignableTransferRequest

      Request parameters.

    • Optionaloptions: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<AxiosResponse<GetSignableTransferResponseV2, any>>

    Summary

    Gets bulk details of a signable transfer

    Throws

    Memberof

    TransfersApi

getSignableTransferV1

  • getSignableTransferV1(requestParameters, options?): Promise<AxiosResponse<GetSignableTransferResponseV1, any>>

  • Gets details of a signable transfer

    Parameters

    • requestParameters: TransfersApiGetSignableTransferV1Request

      Request parameters.

    • Optionaloptions: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<AxiosResponse<GetSignableTransferResponseV1, any>>

    Summary

    Gets details of a signable transfer

    Throws

    Memberof

    TransfersApi

getTransfer

  • getTransfer(requestParameters, options?): Promise<AxiosResponse<Transfer, any>>

  • Get details of a transfer with the given ID

    Parameters

    • requestParameters: TransfersApiGetTransferRequest

      Request parameters.

    • Optionaloptions: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<AxiosResponse<Transfer, any>>

    Summary

    Get details of a transfer with the given ID

    Throws

    Memberof

    TransfersApi

listTransfers

  • listTransfers(requestParameters?, options?): Promise<AxiosResponse<ListTransfersResponse, any>>

  • Get a list of transfers

    Parameters

    • OptionalrequestParameters: TransfersApiListTransfersRequest

      Request parameters.

    • Optionaloptions: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<AxiosResponse<ListTransfersResponse, any>>

    Summary

    Get a list of transfers

    Throws

    Memberof

    TransfersApi

Settings

Member Visibility

On This Page

Constructors
Properties
Methods