Please Remember...
This is a fictional example and not real documentation. The purpose is to demonstrate my technical writing.
← mint token | api reference
API Reference: Transfer Token
- Description: Transfers tokens from one wallet to another.
- Method:
POST - Endpoint:
/api/tokens/transfer - How-To: How to Transfer Tokens
- Explanation: Token Lifecycle in Practice: Transferring
Request Body Parameters
| Field | Type | Required | Description |
|---|---|---|---|
asset_id |
String | ✅ | ID of the asset to transfer |
amount |
Number | ✅ | Number of tokens to transfer |
from_wallet |
String | ✅ | Sender’s wallet address |
to_wallet |
String | ✅ | Receiver’s wallet address |
Example Request
{
"asset_id": "UKGILT2030",
"amount": 100,
"from_wallet": "0xA1B2C3D4E5F6A7B8C9D0",
"to_wallet": "0xFEDCBA9876543210ABCD"
}
Success Response
{
"status": "success",
"asset_id": "UKGILT2030",
"amount_transferred": 100,
"from_wallet": "0xA1B2C3D4E5F6A7B8C9D0",
"to_wallet": "0xFEDCBA9876543210ABCD",
"transaction_id": "TX-90001"
}
Error Responses
| Status Code | Error Code | Message |
|---|---|---|
| 400 | INSUFFICIENT_FUNDS | Not enough tokens in sender’s wallet |
| 404 | WALLET_NOT_FOUND | One or both wallets do not exist |
| 409 | TRANSFER_CONFLICT | Conflict occurred (e.g., simultaneous transfers) |
| 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.