tokenBurn

POST 
/api/v1/recipes/tokens/burn/

Burn tokens from a contract address

Request

application/json

Body

required

contractId stringrequired

The contractId of the token contract

from stringrequired

The address from which the tokens will be burnt.

amount stringrequired

The amount of tokens to burn in wei format.

Responses

201

Default Response

application/json

Schema

Schema

error booleanrequired

Possible values: [false]

statusCode numberrequired

Possible values: [201]

data objectrequired

id stringrequired

hash stringrequired

from stringrequired

to stringrequired

value stringrequired

blockchainId integerrequired

vaultId stringrequired

contractId stringrequired

status stringrequired

Possible values: [TO_BE_SENT, FAILED_TO_SEND, SENT, CONFIRMED, FAILED]

Example (from schema)

{
  "error": false,
  "statusCode": 201,
  "data": {
    "id": "string",
    "hash": "string",
    "from": "string",
    "to": "string",
    "value": "string",
    "blockchainId": 0,
    "vaultId": "string",
    "contractId": "string",
    "status": "TO_BE_SENT"
  }
}

400

Default Response

application/json

Schema

Schema

error booleanrequired

Possible values: [true]

statusCode numberrequired

Possible values: [400]

code stringrequired

Possible values: [errors.recipe.invalidAmount, errors.contract.invalidArgs, errors.contract.invalidValue, errors.insufficientFunds, errors.failedToEstimateTransaction]

data required

Example (from schema)

{
  "error": true,
  "statusCode": 400,
  "code": "errors.recipe.invalidAmount",
  "data": {}
}

404

Default Response

application/json

Schema

Schema

error booleanrequired

Possible values: [true]

statusCode numberrequired

Possible values: [404]

code stringrequired

Possible values: [errors.contract.notFound, errors.contract.notDeployed, errors.vault.notFound, errors.contract.functionNotFound]

data required

Example (from schema)

{
  "error": true,
  "statusCode": 404,
  "code": "errors.contract.notFound",
  "data": {}
}

503

Default Response

application/json

Schema

Schema

error booleanrequired

Possible values: [true]

statusCode numberrequired

Possible values: [503]

code stringrequired

Possible values: [errors.contract.failedToSend]

data required

Example (from schema)

{
  "error": true,
  "statusCode": 503,
  "code": "errors.contract.failedToSend",
  "data": {}
}

Loading...