Deactivate a currency

Deactivates an existing currency in Tetrium.

Note: Deactivating a currency will make all functions related to the specific currency non-functional. Please proceed with caution. However, please take note that the data of the currency will still exist in Tetrium, as they have already been "hard-stamped" into Tetrium private blockchain during the sealing processes.


Call URL

/currencies/(currencyAddress)/deactivation

Type : POST


Call request header parameters

Field Type Required/Optional Description Accepted values
wallet-address string Required The sender's wallet address. Any valid wallet address
wallet-key string Required The key of the sender's wallet. Any valid wallet key that unlocks the sender's wallet

Call request URL parameters

Field Type Required/Optional Description Accepted values
currencyAddress string Required The address of the involved currency. Any valid currency address

Sample Call Request

https://api.tetrium.io/tokenize/currencies/0x29341b674091d600c227B137a457b0573515A7A8/deactivation

Call responses

Success response

Field Type Description Respond Values
status string Status of the API call. "success"
message string Information about the status. "deactivate-currency completed"

Error response

Field Type Description Respond Values
status string Status of the API call. "fail"
error string Information about the error. (See below)

Information contained in error:

Error Messages Description
"invalid currencyAddress" currencyAddress provided was not in the correct format.
"currency is currently inactive" The currency is already deactivated.

For any other errors, please refer to List of Common Error Messages

Sample Call Response

{
   "status":"success",
   "message":"deactivate-currency completed"
}

results matching ""

    No results matching ""