Sign in
hydra

List withdrawals from a head. (admin access required)

Changed on

Withdrawals out of this head, newest first. approvedAt is the point of no return: the head has signed the removal and the funds have left it, whether or not L1 has them yet. finalizedAt is when they became spendable on L1.

get/hydra/head/withdraw

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/withdraw
  • Auth: API key in header token

Query parameters

headIdstring required

The Hydra head whose withdrawals to list

limitinteger

Response

Withdrawals

status'success' required

Example response

{
  "status": "success",
  "data": {
    "withdrawals": [
      {
        "id": "cuid_v2_auto_generated",
        "createdAt": "1970-01-01T00:00:00.000Z",
        "updatedAt": "1970-01-01T00:00:00.000Z",
        "status": "Approved",
        "splitTxId": "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb",
        "decommitTxId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
        "l1TxId": null,
        "requestedLovelace": "10000000",
        "requestedAssets": {},
        "settledLovelace": null,
        "settledAssets": null,
        "destinationAddress": "addr_test1...",
        "failureReason": null,
        "approvedAt": "1970-01-01T00:00:00.000Z",
        "finalizedAt": null
      }
    ]
  }
}

Changes