Remove currency member

Removes an existing currency member's wallet from a currency.


Call URL

/currencies/(currencyAddress)/members/(memberWalletAddress)

Type : DELETE


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
memberWalletAddress string Required The wallet address of the member to be removed. Any valid wallet address

Sample Call Request

https://api.tetrium.io/tokenize/currencies/0x29341b674091d600c227B137a457b0573515A7A8/members/0x34d86f8b9ece5ad06ef757d1c21c4373026d3345

Call responses

Success response

Field Type Description Respond Values
status string Status of the API call. "success"
message string Information about the status. "remove-currency-member initiated"
transactionHash string The hash of the transaction. To be used to verify the transaction's sealing status. Any string

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.
"invalid memberWalletAddress" memberWalletAddress provided was not in the correct format.
"memberWalletAddress not a currency member" memberWalletAddress to be removed is not a currency member.
"user cannot remove itself" memberWalletAddress is identical to wallet-address. A wallet cannot remove itself from a currency.

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

Sample Call Response

{
   "status":"success",
   "message":"remove-currency-member initiated",
   "transactionHash":"0x81b4d4fca22427cfeefa0bcdaf0c41cdee969432ba44904f0845d4046286cf7c"
}

results matching ""

    No results matching ""