Send Currency Token by ID
Sends a specified amount of a currency token to a recipient wallet. This call is asynchronous — the handler enqueues a SendCurrencyToken (type 3) blockchain transaction and returns HTTP 204 immediately. The transfer only settles once the wallet pipeline confirms the transaction. Poll Get Currency Token Transactions by ID to observe completion.
Request
POST /v2/admin/currency-tokens/{currencyTokenID}/send
Parameters
| Name | Type | In | Description |
|---|---|---|---|
currencyTokenID | string | path | Required. The ID of the currency token to send |
Headers
| Name | Description |
|---|---|
Content-Type | application/json |
Authorization | Required. Bearer token for authentication |
Body (JSON)
| Field | Type | Required | Description |
|---|---|---|---|
amount | number | Yes | Amount to send |
recipient_wallet | string | Yes | Recipient wallet address |
Example
curl --location 'http://localhost:3453/v2/admin/currency-tokens/:id/send' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <token>' \
--data '{
"amount": 2000,
"recipient_wallet": "0x11111"
}'
Response
{
"transaction_id": "6a8b5e13f9129816a6cc7a12"
}
Response Fields
| Field | Type | Description |
|---|---|---|
transaction_id | string | The currency-token transaction started by this call. Poll it with Get Currency Token Transactions by ID until its status reaches 3 (Done) or 4 (Error) |
The 200 means the send was queued, not that it finished. This call used to answer with an empty body, leaving nothing to follow the settlement with.
Status Codes
| Status Code | Description |
|---|---|
| 200 | Success - the send has been queued |
| 400 | Bad Request - invalid input, unknown currency token, or preconditions failed |
| 401 | Unauthorized - invalid or missing authentication token |
| 500 | Internal Server Error |