Skip to main content

Mint Currency Token by ID

Mints additional amount for the specified currency token. This call is asynchronous — the handler enqueues a MintCurrencyToken (type 2) blockchain transaction and returns HTTP 204 immediately. The on-chain supply only increases once the wallet pipeline confirms the transaction. Poll Get Currency Token Transactions by ID to observe completion.

Request

POST /v2/admin/currency-tokens/{currencyTokenID}/mint

Parameters

NameTypeInDescription
currencyTokenIDstringpathRequired. The ID of the currency token to mint

Headers

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

Body (JSON)

FieldTypeRequiredDescription
amountnumberYesAmount to mint

Example

curl --location 'http://localhost:3453/v2/admin/currency-tokens/:id/mint' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <token>' \
--data '{
"amount": 2000
}'

Response

{
"transaction_id": "6a8b5e13f9129816a6cc7a12"
}

Response Fields

FieldTypeDescription
transaction_idstringThe 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 mint 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 CodeDescription
200Success - the mint has been queued
400Bad Request - invalid input, unknown currency token, or preconditions failed
401Unauthorized - invalid or missing authentication token
500Internal Server Error