Skip to main content
POST
/
tenant
/
{tenantId}
/
token_management
/
deployed_contract
/
burn
Initiates a burn operation for a deployed token, creating a transaction proposal if required.
curl --request POST \
  --url https://api.example.com/tenant/{tenantId}/token_management/deployed_contract/burn \
  --header 'Content-Type: application/json' \
  --data '
{
  "deployedTokenConfigurationId": 512,
  "recipientWalletTenantId": 2048,
  "tenantId": 1024,
  "actorUserId": "9f060a6b-1571-4a2f-8cfb-3fc6bf5a4e51",
  "assetUsdBaseRates": {
    "USD": 1
  },
  "smartContractTemplateMethodRequestModel": {
    "name": "burn",
    "parameters": [
      {
        "name": "from",
        "value": "0x1234567890abcdef1234567890abcdef12345678",
        "blockchainType": "address",
        "blockchainName": "Ethereum",
        "order": 0
      },
      {
        "name": "amount",
        "value": "500000000000000000",
        "blockchainType": "uint256",
        "blockchainName": "Ethereum",
        "order": 1
      }
    ]
  }
}
'
{
  "isSuccess": true,
  "isFailure": false,
  "error": null,
  "value": {
    "id": 42,
    "name": "Example"
  }
}

Path Parameters

​
tenantId
integer<int64>
required

Identifier of the tenant.

Body

application/json

Request containing burn operation details.

Request to burn (destroy) tokens from a wallet.

​
deployedTokenConfigurationId
integer<int64>

Identifier of the deployed token configuration to burn from.

Example:

512

​
recipientWalletTenantId
integer<int64>

Identifier of the wallet-tenant relationship from which tokens will be burned.

Example:

2048

​
tenantId
integer<int64>

Identifier of the tenant performing the burn operation.

Example:

1024

​
actorUserId
string

Identifier of the user initiating the burn operation.

Example:

"9f060a6b-1571-4a2f-8cfb-3fc6bf5a4e51"

​
assetUsdBaseRates
object

Exchange rates for converting asset values to USD.

Example:
{ "USD": 1 }
​
smartContractTemplateMethodRequestModel
object

Smart contract method invocation details for the burn operation.

Example:

"{\"name\": \"burn\", \"parameters\": [...]}"

Response

200 - application/json

Burn operation initiated successfully.

Wrapper for API operation results containing success status, error information, and return value.

​
isSuccess
boolean

True if the operation completed successfully, false otherwise.

Example:

true

​
isFailure
boolean

True if the operation failed, false otherwise.

Example:

false

​
error
object

Error information returned when the operation fails.

Example:
{
  "code": "ValidationError",
  "message": "The request parameters failed validation.",
  "info": [
    "The Name field is required.",
    "The Id field must be greater than 0."
  ]
}
​
value
object

The result value returned when the operation is successful.

Example:
{
  "deployedTokenConfigurationTransactionPublicId": "550e8400-e29b-41d4-a716-446655440000"
}