Create Stake

Create a new stake.

POST /staking/stakes

Create Stake

cURL

curl --request POST \
  --url https://api.dfns.io/staking/stakes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-DFNS-USERACTION: <api-key>' \
  --data '
{
  "externalId": "ext-123",
  "walletId": "wa-4g991-s29to-9hrq4nbuto6ih33b",
  "protocol": "Ethereum",
  "provider": "Figment",
  "amount": "32000000000000000000"
}
'

200

{
  "id": "<string>",
  "walletId": "<string>",
  "status": "Active",
  "requester": {
    "userId": "us-6b58p-r53sr-rlrd3l5cj3uc4ome",
    "tokenId": "to-202a0-cdo33-o65mbt6q758lvvnt"
  },
  "requestBody": {
    "protocol": "Babylon",
    "walletId": "<string>",
    "provider": "Figment",
    "amount": "<string>",
    "duration": 123,
    "externalId": "<string>"
  },
  "dateCreated": "<string>",
  "protocol": "Babylon",
  "data": {
    "finalityProviders": [
      "<string>"
    ],
    "covenantPubkeys": [
      "<string>"
    ],
    "magicBytes": "<string>",
    "covenantThreshold": 123,
    "minUnbondingTime": 123,
    "lockHeight": 123
  },
  "actions": [
    {
      "id": "<string>",
      "stakeId": "<string>",
      "kind": "Stake",
      "requester": {
        "userId": "us-6b58p-r53sr-rlrd3l5cj3uc4ome",
        "tokenId": "to-202a0-cdo33-o65mbt6q758lvvnt"
      },
      "requestBody": {
        "protocol": "Babylon",
        "walletId": "<string>",
        "provider": "Figment",
        "amount": "<string>",
        "duration": 123,
        "externalId": "<string>"
      },
      "dateCreated": "<string>",
      "transactionId": "<string>",
      "signatureId": "<string>",
      "transactionHash": "<string>",
      "failureReason": "<string>"
    }
  ],
  "provider": "Figment"
}

Authentication

✅ Organization User (CustomerEmployee)
❌ Delegated User (EndUser)
✅ Service Account

Required Permissions

Stakes:Create: Always required.

Authorizations

Authorization · string · header · required

Bearer Token: Used to authenticate API requests. More details how to generate the token: Authentication flows

X-DFNS-USERACTION · string · header · required

User Action Signature: Used to sign the change-inducing API requests. More details how to generate the token: User Action Signing flows

Body

application/json

Ethereum

Iota

protocol · enum<string> · required

Available options: Ethereum

walletId · string · required

Id of the Dfns wallet making the deposit (wa-...).

provider · enum<string> · required

Staking Provider

Available options: Figment

amount · string · required

Transaction amount denominated in min units

externalId · string

Response

200 - application/json

Success

Babylon

Iota

Ethereum

id · string · required

walletId · string · required

status · enum<string> · required

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 · required

protocol · enum<string> · required

Available options: Babylon

data · object · required

Show child attributes

actions · object[] · required

Show child attributes

provider · enum<string>

Available options: Figment