Binance Web3 Connector JS
    Preparing search index...

    Interface BuildDeFiRedeemTransactionRequest

    Request parameters for buildDeFiRedeemTransaction operation in DefiTransactionApi. BuildDeFiRedeemTransactionRequest

    interface BuildDeFiRedeemTransactionRequest {
        address: string;
        investmentId: string;
        nonce?: string;
        ratio?: string;
        recvWindow?: number | bigint;
        simulate?: boolean;
        slippageBps?: string;
        token?: BuildDeFiRedeemTransactionRequestToken;
    }
    Index
    address investmentId nonce? ratio? recvWindow? simulate? slippageBps? token?
    address: string

    User wallet address (the signer / sender).

    DefiTransactionApiBuildDeFiRedeemTransaction

    investmentId: string

    Investment product ID (chain-agnostic). The service resolves the chain from this ID.

    DefiTransactionApiBuildDeFiRedeemTransaction

    nonce?: string

    Unique request identifier for anti-replay; falls back to X-OC-SIGN if omitted.

    DefiTransactionApiBuildDeFiRedeemTransaction

    ratio?: string

    Redeem ratio, mutually exclusive with token. Omitted / blank → exact-amount redeem via token (tokenAddress + amount, position not queried). Present → must parse as a decimal in (0, 1]; the service queries the on-chain position under investmentId and scales each token amount by ratio (floored to decimals). \"1\" = full (max) redeem; in this mode token is ignored.

    DefiTransactionApiBuildDeFiRedeemTransaction

    recvWindow?: number | bigint

    Allowed time deviation in milliseconds (default: 5000, max: 60000).

    DefiTransactionApiBuildDeFiRedeemTransaction

    simulate?: boolean

    When true, the response also includes a preview object. Default false. If the simulated transaction reverts, the request returns an error code instead of a 200 with preview.success=false: 40485 when the redeem amount exceeds the current position, 40484 for any other revert (see Error Codes).

    DefiTransactionApiBuildDeFiRedeemTransaction

    slippageBps?: string

    Slippage tolerance in basis points (e.g. 300 = 3%).

    DefiTransactionApiBuildDeFiRedeemTransaction

    token?: BuildDeFiRedeemTransactionRequestToken

    DefiTransactionApiBuildDeFiRedeemTransaction

    Settings
    Member Visibility

    On This Page
    Properties