Unstake a crypto asset

The endpoint allows users to retrieve their previously staked cryptocurrency from the network, specifying parameters such as the staking identifier, the asset and the amount to unstake, and returns details of the unstaking transaction.

SecuritybearerAuth
Request
header Parameters
bp-user-id
required
string <uuid>
idempotency-key
required
string <= 128 characters

A unique identifier for the stake request. The asset is only staked once regardless of how many requests are made for the same user and with the same idempotency key.

Example: lorem ipsum
Request Body schema: application/json

The unstake action details.

asset_id
required
integer

Asset Id

amount
required
string <double>

The amount to be unstaked.

Responses
200

Success Response (Subsequent Idempotent Request).

201

Success Response (Created)

202

The staking operation has been initiated and is pending.

400

Bad Request

401

Unauthorized

403

Forbidden

422

Validation Error

429

Too Many Requests

500

Internal Error

503

Maintenance or Service unavailable

post/v1/staking/unstake
Request samples
application/json
{
  • "asset_id": 1,
  • "amount": "1.99"
}
Response samples
application/json
{
  • "data": {
    }
}