Please Remember...
This is a fictional example and not real documentation. The purpose is to demonstrate my technical writing.
← check token balance | api reference
API Reference: Mint Token
- Description: Creates and assigns a new token to a recipient wallet.
- Method:
POST - Endpoint:
/api/tokens/mint - How-To: How to Mint a Token
- Explanation: Token Lifecycle in Practice: Minting
Request Body Parameters
| Field | Type | Required | Description |
|---|---|---|---|
asset_id |
String | ✅ | Unique identifier for the asset being minted |
amount |
Number | ✅ | Number of tokens to mint |
recipient_wallet_address |
String | ✅ | Wallet address that will receive the tokens |
Example Request
{
"asset_id": "UKGILT2030",
"amount": 100,
"recipient_wallet_address": "0xA1B2C3D4E5F6A7B8C9D0"
}
Success Response
{
"status": "success",
"token_id": "TOKEN-12345",
"asset_id": "UKGILT2030",
"amount": 100,
"assigned_to": "0xA1B2C3D4E5F6A7B8C9D0"
}
Error Responses
| Status Code | Error Code | Message |
|---|---|---|
| 400 | INVALID_INPUT | One or more required fields are missing |
| 404 | ASSET_NOT_FOUND | Asset ID does not exist |
| 409 | DUPLICATE_MINT | Token for this asset already exists |
| 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.