Skip to main content

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

NameTypeInDescription
currencyTokenIDstringpathRequired. The ID of the currency token to send

Headers

NameDescription
Content-Typeapplication/json
AuthorizationRequired. Bearer token for authentication

Body (JSON)

FieldTypeRequiredDescription
amountnumberYesAmount to send
recipient_walletstringYesRecipient 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

  • Status: 204 No Content
  • Body: none

Status Codes

Status CodeDescription
204No Content - Send successful
400Bad Request - Invalid input
401Unauthorized - Invalid or missing authentication token
404Not Found - Currency token does not exist
500Internal Server Error