Skip to navigation
API ReferenceSavings

Purchase or redeem savings

Subscribe funds into Flexible Simple Earn Savings or redeem funds back to the funding account. Rate cannot be set higher than 365% and only supports two decimal places when purchasing.

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 side: purchase or redeem.

Allowed values:
ratestringOptional
Annual lending rate, only applicable to purchase. Range 0.01 to 3.65, two decimal places supported.

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