Sign in
hydra

Recover a deposit the head never absorbed. (admin access required)

Changed on

A hydra-node only considers a deposit while it is inside its window, so a deposit can confirm on L1 and never reach the head. This asks the node to return it to the wallet it came from; it is refused before the deposit deadline has passed.

post/hydra/head/topup/recover

Request

  • Base URL: ./../api/v1/ (relative, and the document was published on a file host, not at the API’s origin)
  • URL: ./../api/v1/hydra/head/topup/recover
  • Auth: API key in header token

Request body

topupIdstring required

The deposit to recover

Example request

{
  "topupId": "cuid_v2_auto_generated"
}

Response

Recovery request

status'success' required

Example response

{
  "status": "success",
  "data": {
    "depositTxHash": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
    "requested": true,
    "reason": null
  }
}

Changes