Class ExchangesApi

Hierarchy

  • ExchangesApi
    • ExchangesApi

Constructors

constructor

Properties

basePath axios configuration

Methods

createExchange createExchangeTransfer getExchange getExchangeSignableTransfer getExchanges

Constructors

constructor

  • Parameters

    • Optional configuration: Configuration
    • Optional basePath: string
    • Optional axios: AxiosInstance

    Returns ExchangesApi

Properties

Protected basePath

basePath: string

Protected axios

axios: AxiosInstance

Protected configuration

configuration: undefined | Configuration

Methods

createExchange

  • Receive wallet_address, provider, type and widget information to create a base exchange transaction and return widget URL

    Parameters

    • requestParameters: ExchangesApiCreateExchangeRequest

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<AxiosResponse<ExchangeCreateExchangeAndURLResponse, any>>

    Summary

    Create an exchange with URL

    Throws

    Memberof

    ExchangesApi

createExchangeTransfer

  • Accepts a transfer request and updates the transfer_status after processing transfer (offramp)

    Parameters

    • requestParameters: ExchangesApiCreateExchangeTransferRequest

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<AxiosResponse<CreateTransferResponseV1, any>>

    Summary

    Accepts a transfer request and updates the transfer_status after processing transfer (offramp)

    Throws

    Memberof

    ExchangesApi

getExchange

  • Get an exchange by ID

    Parameters

    • requestParameters: ExchangesApiGetExchangeRequest

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<AxiosResponse<Exchange, any>>

    Summary

    Get an exchange by ID

    Throws

    Memberof

    ExchangesApi

getExchangeSignableTransfer

  • Send a request for signable-transfer-details (offramp)

    Parameters

    • requestParameters: ExchangesApiGetExchangeSignableTransferRequest

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<AxiosResponse<GetSignableTransferResponseV1, any>>

    Summary

    Send a request for signable-transfer-details (offramp)

    Throws

    Memberof

    ExchangesApi

getExchanges

  • Returns a list of exchanges based on the request

    Parameters

    • Optional requestParameters: ExchangesApiGetExchangesRequest

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<AxiosResponse<GetTransactionsResponse, any>>

    Summary

    Returns a list of exchanges based on the request

    Throws

    Memberof

    ExchangesApi

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc