Skip to navigation
API ReferenceFlexible Loan

Adjust collateral

Add collateral to or reduce collateral from an active Flexible Loan position.

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.
typeenumRequired

Adjustment type: add collateral or reduce collateral.

Allowed values:
collateralCcystringRequired
Collateral currency, e.g. BTC.
collateralAmtstringRequired
Amount of collateral to add or reduce.
ordIdstringOptional
Loan order ID. Used when multiple active loans exist.

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