Skip to main content

Stake / Redeem

info

API key needs "Earn" permission

note

In times of high demand for loans in the market for a specific cryptocurrency, the redemption of the principal may encounter delays and is expected to be processed within 48 hours. Once the redemption request is initiated, it cannot be canceled, and your principal will continue to earn interest until the process is completed.

HTTP Request

POST /v5/earn/place-order

Request Parameters

ParameterRequiredTypeComments
categorytruestringFlexibleSaving
Remarks: this phase only supports flexible savings
orderTypetruestringStake, Redeem
accountTypetruestringFUND, UNIFIED
amounttruestring
  • Stake amount needs to satisfy minStake and maxStake
  • Both stake and redeem amount need to satify precision requirement
  • cointruestringCoin name
    productIdtruestringProduct ID
    orderLinkIdtruestringCustomised order ID, used to prevent from replay
  • support up to 36 characters
  • The same orderLinkId can't be used in 30 mins
  • Response Parameters

    ParameterTypeComments
    orderIdstringOrder ID
    orderLinkIdstringOrder link ID

    Request Example

    POST /v5/earn/place-order HTTP/1.1
    Host: api-testnet.bybit.com
    X-BAPI-SIGN: XXXXXX
    X-BAPI-API-KEY: XXXXXX
    X-BAPI-TIMESTAMP: 1739936605822
    X-BAPI-RECV-WINDOW: 5000
    Content-Type: application/json
    Content-Length: 190

    {
    "category": "FlexibleSaving",
    "orderType": "Redeem",
    "accountType": "FUND",
    "amount": "0.35",
    "coin": "BTC",
    "productId": "430",
    "orderLinkId": "btc-earn-001"
    }

    Response Example

    {
    "retCode": 0,
    "retMsg": "",
    "result": {
    "orderId": "0572b030-6a0b-423f-88c4-b6ce31c0c82d",
    "orderLinkId": "btc-earn-001"
    },
    "retExtInfo": {},
    "time": 1739936607117
    }