Skip to navigation
TRANSFERS AND STAKINGRequests: DOT

Create a DOT bond request

This endpoint creates a bond request for DOT. You can select to automatically restake your rewards or to receive them in your address. Required role: RequestCreator. This API can be made idempotent by generating an ID for the Request beforehand and passing it as the externalRequestId attribute

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
fromAddressIdstringRequiredformat: "uint64"
amountstringOptional
restakeRewardsbooleanOptional
feeLimitstringOptional
commentstringOptional
useAllFundsbooleanOptional
transactionReferencestringOptional

Deprecated: use externalRequestId instead

externalRequestIdstringOptional
Identifier for the request in the user's system. This must be unique. Attempting to create a request with an existing externalRequestId will do nothing and return the originally created request

Response

A successful response.
resultobjectOptional

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error
503
Service Unavailable Error