Binance Web3 Connector JS
    Preparing search index...

    Interface BuildDeFiClaimTransactionRequest

    Request parameters for buildDeFiClaimTransaction operation in DefiTransactionApi. BuildDeFiClaimTransactionRequest

    interface BuildDeFiClaimTransactionRequest {
        address: string;
        binanceChainId?: string;
        claimType: BuildDeFiClaimTransactionClaimTypeEnum;
        defiProtocolId?: string;
        investmentId?: string;
        nftId?: string;
        nonce?: string;
        recvWindow?: number | bigint;
        redemptionId?: string;
        simulate?: boolean;
        tokenAddressList?: string[];
    }
    Index
    address binanceChainId? claimType defiProtocolId? investmentId? nftId? nonce? recvWindow? redemptionId? simulate? tokenAddressList?
    address: string

    User wallet address (the signer / sender).

    DefiTransactionApiBuildDeFiClaimTransaction

    binanceChainId?: string

    Binance chain ID. For REWARD_PROTOCOL (which does not use investmentId) this is the only chain signal and is required. For all other claim types the chain is resolved from investmentId and any client-supplied value is silently ignored — the call still executes on the investmentId chain, so a different chainId does not redirect the claim.

    DefiTransactionApiBuildDeFiClaimTransaction

    claimType: BuildDeFiClaimTransactionClaimTypeEnum

    Claim routing type. Determines which companion fields are required: - REWARD_PROTOCOL: protocol-level rewards (e.g. Aave incentive, Radiant) — requires defiProtocolId + binanceChainId - REWARD_INVESTMENT: per-investment rewards — requires investmentId - LP_FEE: Uniswap V3/V4 LP fees — requires investmentId + nftId - REDEMPTION: redeem principal (Lista / Aster / Solv etc.) — requires investmentId + redemptionId Protocol constraints — not every claimType is valid for every protocol; an invalid combination is rejected (40453 or 40454): - REWARD_PROTOCOL is not supported for LP (liquidity-pool) protocols in this release. - REWARD_INVESTMENT is not supported for PancakeSwap V3 farming positions; use LP_FEE to claim farming incentives there. - LP_FEE applies only to concentrated-liquidity (V3/V4) LP positions. - REDEMPTION applies only to protocols with a redemption / lock-up flow (Lista, Aster, Solv). The valid claimTypes for a specific position are returned in that position's positionDetail.claimTypes (see the position list) — branch on that rather than hard-coding the mapping. Note: error messages may surface the protocol id with a chain prefix (e.g. bsc_pancakeswap4); the canonical id in API fields is the un-prefixed form (e.g. pancakeswap4).

    DefiTransactionApiBuildDeFiClaimTransaction

    defiProtocolId?: string

    Required for REWARD_PROTOCOL (e.g. pancakeswap3).

    DefiTransactionApiBuildDeFiClaimTransaction

    investmentId?: string

    Required for REWARD_INVESTMENT, LP_FEE, and REDEMPTION. Not used for REWARD_PROTOCOL (which keys off defiProtocolId).

    DefiTransactionApiBuildDeFiClaimTransaction

    nftId?: string

    Required for LP_FEE. The NFT token ID as a decimal string (e.g. \"7225901\" or \"#7225901\"). The # prefix returned by the position list may be passed as-is — the service strips it automatically.

    DefiTransactionApiBuildDeFiClaimTransaction

    nonce?: string

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

    DefiTransactionApiBuildDeFiClaimTransaction

    recvWindow?: number | bigint

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

    DefiTransactionApiBuildDeFiClaimTransaction

    redemptionId?: string

    Required for REDEMPTION. Maps to the redemptionId returned in the position list (the on-line position index).

    DefiTransactionApiBuildDeFiClaimTransaction

    simulate?: boolean

    When true, the response also includes a preview object. Default false. If the simulated transaction reverts, the request returns 40485 for a specific classified revert reason or 40484 for any other revert (see Error Codes).

    DefiTransactionApiBuildDeFiClaimTransaction

    tokenAddressList?: string[]

    Optional token address filter to narrow the claim scope.

    DefiTransactionApiBuildDeFiClaimTransaction

    Settings
    Member Visibility

    On This Page
    Properties