Skip to navigation
API ReferenceFunding

Savings purchase/redemption

Subscribe to or redeem from the Simple Earn Flexible (savings) product for a currency. Only the assets in the funding account can be used for subscription.

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.
ccystringRequired
Currency, e.g. BTC.
amtstringRequired

Purchase/redemption amount.

sideenumRequired

Action type: purchase or redempt.

Allowed values:
ratestringRequired

Annual lending rate. Only applicable to side=purchase. Range 0.01 to 3.65, precision 0.0001.

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