Interface RestRequestWithdrawFunds

API parameters for conducting a withdrawal.

See

interface RestRequestWithdrawFunds {
    nonce: string;
    wallet: string;
    quantity: string;
    maximumGasFee: string;
    bridgeAdapterAddress: string;
    bridgeAdapterPayload: string;
}

Hierarchy (view full)

Properties

nonce wallet quantity maximumGasFee bridgeAdapterAddress bridgeAdapterPayload

Properties

nonce

nonce: string

User data and trade endpoints requests must include a nonce.

  • MUST be a version 1 UUID
  • Nonces may be supplied with or without hyphens.

Remarks

Version 1 UUIDs encode a timestamp in addition to other unique information, and thus serve both to prevent replay attacks as well as to enforce request timing. As a result, nonces MUST be generated at the time of a request.

wallet

wallet: string

The wallet address to use for the request.

quantity

quantity: string

Withdrawal amount in asset terms, fees are taken from this value

maximumGasFee

maximumGasFee: string

Maximum acceptable fee that can be deducted from withdrawn quantity in asset terms

bridgeAdapterAddress

bridgeAdapterAddress: string

Address of cross-chain bridge adapter contract to withdraw funds to. If zero, withdraws directly to wallet

bridgeAdapterPayload

bridgeAdapterPayload: string

If bridgeAdapterAddress is non-zero this should be the ABI-encoded arguments for the specific adapter

Settings

Member Visibility

Theme

On This Page

noncewalletquantitymaximumGasFeebridgeAdapterAddressbridgeAdapterPayload