REST APIStakeGo Account Staking

POST

Create a finalized staking request based on previously previewed data for a given asset and Go Account.

Path Params

  • coin string enum required
    The staking asset.
    OFCSOLOFCSUI
  • accountId string required
    Account ID to fetch the staking request for.

Body Params

ONE OF

  • clientId string nullable

    up to 256 characters

  • amount string big-integer required
    Amount to stake, must be a positive value
  • type string enum
    Must always be STAKE
    STAKE
  • frontTransferSendRequest object nullable
    Optional transfer request to initiate before staking
    frontTransferSendRequest object
    • halfSigned object required
      halfSigned object
      • coin string required
        The coin type, e.g. "ofctsui"
      • recipients array of objects required
        List of recipient addresses and amounts
        recipients object
        • address string required
          Destination address for the withdrawal
        • amount string big-integer required
          Amount to send
      • fromAccount string required
        Source account id
      • nonce string uuid required
        Unique identifier for the transaction
      • timestamp string date-time required
        ISO 8601 timestamp when the half-signed payload was created
      • feeString string required
        Fee amount as a string
      • shortCircuitBlockchainTransfer boolean
        Indicates whether to short-circuit blockchain transfer

        Defaults to false

      • isIntraJXTransfer boolean
        Indicates whether the transfer is intra-JX

        Defaults to false

      • payload string required
        Raw JSON payload string representing the unsigned transaction data
      • signature string required
        Signature of the payload
    • comment string nullable
    • sequenceId string nullable
    • goStakingRequestId string nullable

Responses

200
Staking request successfully created

Response Body

object

  • id string uuid required
  • clientId string
  • status string enum required
    Coarse-grained status for staking requests.
    NEWPENDINGFAILEDREJECTEDCONFIRMEDCOOLDOWNWARMUPUNSUPPORTED
  • type string enum
    Type of staking request. STAKE to delegate, UNSTAKE to undelegate. UNSUPPORTED is a fallback.

    Defaults to STAKE

    STAKEUNSTAKEUNSUPPORTED
  • coin string
  • goAccountId string required
  • error string
  • amount string big-integer required
  • createdDate string date-time required
  • statusModifiedDate string date-time
  • properties object required
    properties object
    • amount string
      Amount to stake or unstake, in base units
  • source string enum
    MANUALAUTO_STAKE
400
Bad Request

Response Body

object

  • error string
  • errorName string
  • reqId string
  • context object
401
Unauthorized

Response Body

object

  • error string
  • errorName string
  • reqId string
  • context object
403
Forbidden

Response Body

object

  • error string
  • errorName string
  • reqId string
  • context object
500
Server Error - Transient error please try again

Response Body

object

  • error string
  • errorName string
  • reqId string
  • context object