Skip to main content

Deploy Currency Token

Deploys the on-chain contract for an existing currency token. The currency token must already be created before deployment. This call is asynchronous — the handler enqueues a DeployCurrencyToken (type 1) blockchain transaction and returns HTTP 200 immediately. Poll Get Currency Token Transactions by ID to observe completion.

Request

POST /v2/admin/currency-tokens/{id}/deploy

Parameters

NameTypeInDescription
idstringpathRequired. Currency token ID

Headers

NameDescription
AuthorizationRequired. Bearer token for authentication

Example

curl --request POST \
--url '\{\{baseUrl\}\}/v2/admin/currency-tokens/68fe8c129367fd414b227c7a/deploy' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...'

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 deploy 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 deploy has been queued
400Bad Request - invalid input, unknown currency token, or preconditions failed
401Unauthorized - invalid or missing authentication token
500Internal Server Error