Skip to main content
POST
/
prepare-transactions
/
burnToken
burnToken
curl --request POST \
  --url https://api.sandbox.brickken.com/prepare-transactions/burnToken \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "method": "burnToken",
  "signerAddress": "<string>",
  "chainId": "<string>",
  "tokenSymbol": "<string>",
  "amount": "<string>",
  "investorEmail": "<string>"
}
'
{
  "transactions": [
    {}
  ],
  "txId": "<string>"
}
Prepares unsigned transactions for burning tokens from the signer’s balance. This endpoint is equivalent to calling /prepare-transactions with method=burnToken.

​
Request Body

ParameterTypeRequiredDescription
signerAddressstringYesAddress that will sign the transaction
chainIdstringYesBlockchain network identifier (hex format)
methodstringYesTransaction method type (should be “burnToken”)
tokenSymbolstringYesSymbol of the token to burn
amountstringYesAmount of tokens to burn
investorEmailstringYesEmail of the investor burning tokens

​
Example Request

{
  "signerAddress": "0x742d35Cc6634C0532925a3b8D4C9db96c4b4d8b",
  "chainId": "aa36a7",
  "method": "burnToken",
  "tokenSymbol": "PROP1",
  "amount": "100",
  "investorEmail": "[email protected]"
}

​
Response

Returns an array of unsigned transactions that need to be signed and a transaction ID for tracking. 
{
  "transactions": [
    {
      "from": "0x742d35Cc6634C0532925a3b8D4C9db96c4b4d8b",
      "to": "0xTargetAddress",
      "value": {"type": "BigNumber", "hex": "0x00"},
      "nonce": 1,
      "chainId": 11155111,
      "data": "0x...",
      "type": 2,
      "maxPriorityFeePerGas": {"type": "BigNumber", "hex": "0x..."},
      "maxFeePerGas": {"type": "BigNumber", "hex": "0x..."},
      "gasLimit": {"type": "BigNumber", "hex": "0x..."}
    }
  ],
  "txId": "unique-transaction-id"
}

Authorizations

​
x-api-key
string
header
required

Body

application/json

Request body for burnToken method.

​
method
string

The operation to be performed.

Example:

"burnToken"

​
signerAddress
string
​
chainId
string
​
tokenSymbol
string
​
amount
string
​
investorEmail
string

Email of the investor

Response

200 - application/json

Successful response

​
transactions
object[]
required
​
txId
string
required