Staking - DFNS documentation

{
  "id": "stk-0pmu3-tog2k-fdtn0teii2i4r13f",
  "walletId": "wa-5pfuu-9euek-h0odgb6snva8ph3k",
  "requester": {
    "userId": "us-6b58p-r53sr-rlrd3l5cj3uc4ome",
    "tokenId": "to-202a0-cdo33-o65mbt6q758lvvnt"
  },
  "requestBody": {
    "protocol": "Babylon",
    "walletId": "wa-5pfuu-9euek-h0odgb6snva8ph3k",
    "provider": "Figment",
    "amount": "<string>",
    "duration": 123,
    "externalId": "<string>"
  },
  "dateCreated": "2023-04-14T20:41:28.715Z",
  "protocol": "Babylon",
  "data": {
    "finalityProviders": [
      "<string>"
    ],
    "covenantPubkeys": [
      "<string>"
    ],
    "magicBytes": "<string>",
    "covenantThreshold": 123,
    "minUnbondingTime": 123,
    "lockHeight": 123
  },
  "provider": "Figment"
}

See an introduction including the list of supported providers and chains on the staking feature page, or watch the video tutorial for dashboard users.

Flow overview

Create a stake

Provide the wallet, provider, and amount. This implicitly creates a Stake action.POST/staking/stakes Create Stake

Monitor the stake

Check stake status and view earned rewards.GET/staking/stakes/{stakeId} Get StakeGET/staking/stakes/{stakeId}/rewards Get Stake Rewards

Manage the stake

Deposit more, Withdraw, or perform other provider-specific actions.POST/staking/stakes/{stakeId}/actions Create Stake Action

Staking rewards (APR) are dynamic and determined by real-time network conditions. Refer to the staking provider for current rates.

Stake object

Babylon
Iota
Ethereum

string

required

Required string length: 1 - 64

Pattern: ^stk-[a-z0-9]{5}-[a-z0-9]{5}-[a-z0-9]{14,16}$

Example:

"stk-0pmu3-tog2k-fdtn0teii2i4r13f"

walletId

string

required

Wallet id.

Required string length: 1 - 64

Pattern: ^wa-[a-z0-9]{5}-[a-z0-9]{5}-[a-z0-9]{14,16}$

Example:

"wa-5pfuu-9euek-h0odgb6snva8ph3k"

status

enum<string>

required

Status of the stake position.

Status	Definition
`Staking`	The stake is being created and funds are being delegated to the validator.
`Active`	The stake is active and earning rewards.
`Unbonding`	The stake is in the process of being unbonded (cooldown period).
`Unbond`	The stake has been unbonded and is ready for withdrawal.
`Withdrawing`	The staked funds are in the process of being withdrawn.
`Withdrawn`	The staked funds have been fully withdrawn.
`Failed`	The staking operation failed.

Available options:

Active,

Failed,

Staking,

Unbonding,

Unbond,

Withdrawing,

Withdrawn

requester

object

required

The user who initiated the request.

Show child attributes

requestBody

Babylon · object

required

Babylon
Ethereum
Iota

Show child attributes

dateCreated

string<date-time>

required

ISO 8601 date (must be UTC). When the stake was created.

Example:

"2023-04-14T20:41:28.715Z"

protocol

enum<string>

required

Available options:

Babylon

data

object

required

Show child attributes

provider

enum<string>

The staking infrastructure provider used to manage the stake.

Available options:

Figment

Last modified on May 12, 2026

Create Allocation Action

List Stakes

⌘I

​Flow overview

​Stake object

Flow overview

Stake object