BRbrale
Orders

Burn Tokens

Changed on

Burn (destroy) tokens from an address. Only available for tokenization/self-attested accounts.

post/accounts/{account_id}/tokens/burns

Request

  • Base URL
    https://api.brale.xyz
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://auth.brale.xyz/oauth2/token scopes: self_attested_tokens:burn

Path parameters

account_idstring required

ID of the resource

Example:2VZvtmVc2j3gQ80CTlcuQXbGrwC

Account ID

Request body

amountstring required

Amount to burn as a decimal string

notestring

Example request

{
  "amount": "1000",
  "note": "Monthly burn for Q1 2024",
  "source": {
    "address_id": "2zbcDT1E1K6xjuYT",
    "transfer_type": "solana",
    "value_type": "eSDR"
  }
}

Response

OK

amountstring

Amount burned

created_atstring date-time
idstring

Order ID

statusstring

Transaction status

updated_atstring date-time

Changes

  • d934fd29acc3Revision changes
    • breaking

      media type application/vnd.api+json was changed to a more general media type application/json for the response status

    • breaking

      media type application/vnd.api+json was changed to a more general media type application/json for the response status

    • breaking

      media type application/vnd.api+json was changed to a more general media type application/json for the response status

    • warning

      the request property's maxLength was set to 255

    • info

      added the new optional request property /

    • info

      added the optional property / to the response with the status

  • 4f67c6cbfdb8Revision changes
    • info

      endpoint added