Please Remember...
This is a fictional example and not real documentation. The purpose is to demonstrate my technical writing.
← api overview | api reference
API Reference: Burn Token
- Description: Destroys tokens from a holder's wallet. Typically used on maturity, cancellation, or redemption.
- Method:
POST - Endpoint:
/api/tokens/burn - How-To: How to Burn a Token
- Explanation: Token Lifecycle in Practice: Burning
Request Body Parameters
| Field | Type | Required | Description |
|---|---|---|---|
asset_id |
String | ✅ | ID of the asset to burn |
amount |
Number | ✅ | Number of tokens to destroy |
holder_wallet_address |
String | ✅ | Wallet address where tokens are held |
Example Request
{
"asset_id": "UKGILT2030",
"amount": 500,
"holder_wallet_address": "0xFEDCBA9876543210ABCD"
}
Success Response
{
"status": "success",
"asset_id": "UKGILT2030",
"amount_burned": 500,
"holder_wallet_address": "0xFEDCBA9876543210ABCD",
"transaction_id": "TX-90002"
}
Error Responses
| Status Code | Error Code | Message |
|---|---|---|
| 400 | INVALID_BURN_AMOUNT | Amount exceeds token holdings |
| 404 | ASSET_OR_WALLET_NOT_FOUND | Asset or wallet does not exist |
| 409 | BURN_CONFLICT | Conflict during burn operation |
| 500 | INTERNAL_ERROR | Unexpected server error |
What comes next?
Related Reading
- Post-Trade Automation: Learn about post-trade automation and how it compares with traditional post-trade workflows.
- Token Lifecycle: Learn how tokens are minted, transferred, queried, and burned throughout their lifecycle.
- How-To Guides: Step-by-step examples with code snippets for each major token operation.
- Glossary of Key Concepts: Definitions and explanations of common terminology used throughout the docs.