Create a transaction to close a staking position

Security(Ledger_API_Key and Ledger_API_User) or Ledger_API_Key and Ledger_API_User and Ledger_Store_Auth_Token) or Ledger_API_User or Ledger_API_User and Ledger_Store_Auth_Token)

Request

path Parameters

account_id

required

integer

The account's ID

Request Body schema: application/json

attributes of the stake to undelegate

account_name	string or null Default: null The account's name.
gas_limit	string or null^[0-9]*(\.[0-9]+)?$ Default: null The gas limit of the transaction
max_fees required	string^[0-9]*(\.[0-9]+)?$ Max fees represent the highest possible fee amount you will pay to broadcast this transaction. The final fees, calculated once the transaction is approved by the last Operator, might be lower, but will never exceed that amount. We recommend estimating max fees through our fee estimation endpoint prior to creating the transaction request. See https://help.vault.ledger.com/developer-portal/content/transactions/tx/ for details.For Solana and Polkadot, `max_fees` field must be ignored.
speed required	string The speed of the transaction
storage_limit	string or null^[0-9]*(\.[0-9]+)?$ Default: null The storage limit of the transaction

Responses

200

Vault stake object

400

Invalid staking parameters

post/tezos/accounts/{account_id}/stake/actions/undelegate

Request samples

Payload

application/json

{"account_name": "Staking Account",
"gas_limit": "8758675",
"max_fees": "5478",
"speed": "NORMAL",
"storage_limit": "65764"
}

Response samples

application/json

{"amount": 10000,
"blockchain_state": {"activated_at": "2023-02-06T02:48:59+00:00",
"activated_cycle": 575,
"active_balance": "322254",
"baker_address": "2S4wKimi4PHKjdTYdzqN5HcEcNBM4Hv9db9QWKaZCxEr",
"delegated_at": "2023-01-19T15:18:29+00:00",
"delegated_block": "3071075",
"delegated_cycle": 568,
"gross_apy": "38.33349571462074",
"rewards": "6958",
"state": "active",
"updated_at": "2023-03-10T17:38:41+00:00"
},
"created_by": 42,
"created_on": "2023-02-01T16:37:15Z",
"creation_tx": 42,
"id": 42,
"last_request": 42,
"stake_uid": "36f0e48508f2f37e5fa15dcca43b1fa027485cf56cd974c1b67f43e82b9f121b-2cEjgbKkWASHgu6aRgxAzrGAKVfwesXvHhfQNZ7QinSD",
"status": "PENDING",
"total_reward": "10000",
"validator": "4QUZQ4c7bZuJ4o4L8tYAEGnePFV27SUFEVmC7BYfsXRp"
}