Skip to navigation
API ReferenceOn Chain Earn

Redeem product

Redeem an active staking or DeFi order, optionally allowing early redemption where the product supports it.

Authentication

OK-ACCESS-KEYstring
Your API key.
OK-ACCESS-SIGNstring

Base64-encoded HMAC-SHA256 signature of the prehash string.

OK-ACCESS-TIMESTAMPstring

ISO 8601 UTC timestamp, e.g. 2020-12-08T09:08:57.715Z.

OK-ACCESS-PASSPHRASEstring
The passphrase you set when creating the API key.

Request

This endpoint expects an object.
ordIdstringRequired
Order ID to redeem.
protocolTypeenumRequired
Protocol type.
Allowed values:
allowEarlyRedeembooleanOptional
Whether to allow early redemption. Default is false.

Response

Successful response
codestringOptional

Result code. 0 means success; any other value is an error code.

msgstringOptional
Error message. Empty on success.
datalist of objectsOptional