Class WithdrawalsApi

Hierarchy

  • WithdrawalsApi
    • WithdrawalsApi

Constructors

constructor

Properties

basePath axios configuration

Methods

createWithdrawal createWithdrawalV2 getSignableWithdrawal getSignableWithdrawalV2 getWithdrawal listWithdrawals

Constructors

constructor

  • Parameters

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

    Returns x.WithdrawalsApi

Properties

Protected basePath

basePath: string

Protected axios

axios: AxiosInstance

Protected configuration

configuration: undefined | Configuration

Methods

createWithdrawal

  • Creates a withdrawal. Use https://docs.x.immutable.com/reference/#/operations/getSignableWithdrawal to get request body params. This endpoint will be deprecated once StarkEx contract gets upgraded to v4, check https://docs.immutable.com/x/reference/#/operations/createWithdrawalV2.

    Parameters

    • requestParameters: WithdrawalsApiCreateWithdrawalRequest

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<AxiosResponse<CreateWithdrawalResponse, any>>

    Summary

    Creates a withdrawal

    Throws

    Memberof

    WithdrawalsApi

createWithdrawalV2

  • Creates a withdrawal. Use https://docs.immutable.com/x/reference/#/operations/getSignableWithdrawalV2 to get request body params.

    Parameters

    • requestParameters: WithdrawalsApiCreateWithdrawalV2Request

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<AxiosResponse<CreateWithdrawalResponse, any>>

    Summary

    Creates a withdrawal of a token for when StarkEx contract that is higher than v3

    Throws

    Memberof

    WithdrawalsApi

getSignableWithdrawal

  • Gets details of a signable withdrawal. This endpoint will be deprecated once StarkEx contract gets upgraded to v4, check https://docs.immutable.com/x/reference/#/operations/getSignableWithdrawalV2.

    Parameters

    • requestParameters: WithdrawalsApiGetSignableWithdrawalRequest

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<AxiosResponse<GetSignableWithdrawalResponse, any>>

    Summary

    Gets details of a signable withdrawal

    Throws

    Memberof

    WithdrawalsApi

getSignableWithdrawalV2

  • Gets details of a signable withdrawal

    Parameters

    • requestParameters: WithdrawalsApiGetSignableWithdrawalV2Request

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<AxiosResponse<GetSignableWithdrawalResponseV2, any>>

    Summary

    Gets details of a signable withdrawal for starkex contracts that are higher than v3

    Throws

    Memberof

    WithdrawalsApi

getWithdrawal

  • Gets details of withdrawal with the given ID

    Parameters

    • requestParameters: WithdrawalsApiGetWithdrawalRequest

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<AxiosResponse<Withdrawal, any>>

    Summary

    Gets details of withdrawal with the given ID

    Throws

    Memberof

    WithdrawalsApi

listWithdrawals

  • Get a list of withdrawals

    Parameters

    • Optional requestParameters: WithdrawalsApiListWithdrawalsRequest

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<AxiosResponse<ListWithdrawalsResponse, any>>

    Summary

    Get a list of withdrawals

    Throws

    Memberof

    WithdrawalsApi

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc