Redeem by Earn Holding ID

This endpoint allows initiating redemption by holding ID. If the current holding is fully redeemed or in the process of being redeemed, it indicates that the holding does not exist.

HTTP REQUEST

DELETE /api/v1/earn/orders

Example

DELETE /api/v1/earn/orders?orderId=13100&fromAccountType=MAIN&amount=1&confirmPunishRedeem=1

{
  "code": "200000",
  "data": {
    "orderTxId": "1293359",
    "deliverTime": 1716965967000,
    "status": "SUCCESS",
    "amount": "2"
  }
}

API Permissions

This endpoint requires earn permission.

REQUEST URL

This endpoint supports Spot URL.

REQUEST RATE LIMIT

Earn weight: 5

PARAMETERS

Param	Type	Mandatory	Description
orderId	String	Yes	Holding ID
amount	String	Yes	Redemption amount
fromAccountType	String	No	Account type: MAIN (funding account), TRADE (spot trading account). This parameter is valid only when orderId=ETH2
confirmPunishRedeem	String	No	Confirmation field for early redemption penalty: 1 (confirm early redemption, and the current holding will be fully redeemed). This parameter is valid only for fixed-term products

RESPONSES

Param	Description
orderTxId	Redemption order ID
deliverTime	Expected deliver time (milliseconds)
status	Redemption status: SUCCESS (successful), PENDING (redemption pending)
amount	Redemption amount credited