ZEzerohash
Staking

Cancel a stake

Changed on

Cancel a pending stake request before it is fully processed.

post/stakes/{stake_id}/cancel

Request

  • Base URL
    https://api.cert.zerohash.com
  • URL
    https://api.cert.zerohash.com/stakes/{stake_id}/cancel
  • Auth
    API key in header X-SCX-API-KEY and API key in header X-SCX-PASSPHRASE

Path parameters

stake_idstring required
Example:c761fc96-5c44-40d4-8eb2-3fcd5d06754e

The unique identifier of the stake to cancel

Headers

X-SCX-SIGNEDstring required

HMAC-SHA256 signature of the request, base64-encoded. See the Authentication guide for the exact signing formula.

X-SCX-TIMESTAMPstring required
Example:1678901234

Current Unix timestamp in seconds. Must be within 60 seconds of server time or the request is rejected.

X-Request-Idstring uuid

Optional client-supplied request ID used for tracing and idempotency. Must be a UUID v4. When omitted, zerohash generates one and returns it in the response X-Request-Id header.

Response

Stake cancellation submitted, or the stake was already canceled. Canceling an already-canceled stake is idempotent and returns the same 200.

request_idstring

Request identifier

Example response

{
  "request_id": "8bb7e203-13e0-4208-80bc-e9fdb7faa13e",
  "message": {
    "stake_id": "c761fc96-5c44-40d4-8eb2-3fcd5d06754e"
  }
}

Changes

  • 47cf70ae701cRevision changes
    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status