Class ExchangesApi

Hierarchy

  • ExchangesApi
    • ExchangesApi

Constructors

constructor

Properties

basePath axios configuration

Methods

createExchange createExchangeTransfer getExchange getExchangeSignableTransfer getExchanges

Constructors

constructor

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

  • Parameters

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

    Returns ExchangesApi

Properties

ProtectedbasePath

basePath: string

Protectedaxios

axios: AxiosInstance

Protectedconfiguration

configuration: undefined | Configuration

Methods

createExchange

  • createExchange(requestParameters, options?): Promise<AxiosResponse<ExchangeCreateExchangeAndURLResponse, any>>

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

    Parameters

    • requestParameters: ExchangesApiCreateExchangeRequest

      Request parameters.

    • Optionaloptions: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<AxiosResponse<ExchangeCreateExchangeAndURLResponse, any>>

    Summary

    Create an exchange with URL

    Throws

    Memberof

    ExchangesApi

createExchangeTransfer

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

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

    Parameters

    • requestParameters: ExchangesApiCreateExchangeTransferRequest

      Request parameters.

    • Optionaloptions: 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

  • getExchange(requestParameters, options?): Promise<AxiosResponse<Exchange, any>>

  • Get an exchange by ID

    Parameters

    • requestParameters: ExchangesApiGetExchangeRequest

      Request parameters.

    • Optionaloptions: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<AxiosResponse<Exchange, any>>

    Summary

    Get an exchange by ID

    Throws

    Memberof

    ExchangesApi

getExchangeSignableTransfer

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

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

    Parameters

    • requestParameters: ExchangesApiGetExchangeSignableTransferRequest

      Request parameters.

    • Optionaloptions: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<AxiosResponse<GetSignableTransferResponseV1, any>>

    Summary

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

    Throws

    Memberof

    ExchangesApi

getExchanges

  • getExchanges(requestParameters?, options?): Promise<AxiosResponse<GetTransactionsResponse, any>>

  • Returns a list of exchanges based on the request

    Parameters

    • OptionalrequestParameters: ExchangesApiGetExchangesRequest

      Request parameters.

    • Optionaloptions: 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

On This Page

Constructors
Properties
Methods