Add currency member

Adds a new wallet to a currency as one of the currency's member.


Call URL

/currencies/(currencyAddress)/members

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

Call request body parameters

Field Type Required/Optional Description Accepted values
memberWalletAddress string Required The wallet address of the new member. Any valid wallet address

Sample Call Request

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

Parameters:

{
    "memberWalletAddress":"0x34d86f8b9ece5ad06ef757d1c21c4373026d3345"
}

Call responses

Success response

Field Type Description Respond Values
status string Status of the API call. "success"
message string Information about the status. "add-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
"missing memberWalletAddress" memberWalletAddress was not provided as a parameter in the API call body.
"invalid memberWalletAddress" memberWalletAddress provided was not in the correct format.
"memberWalletAddress already a currency member" memberWalletAddress to be added is already a currency member.
"currency member limit reached" The current number of currency member has reached the allowed limit. Please increase your currency member limit to add more currency members.

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

Sample Call Response

{
   "status":"success",
   "message":"add-currency-member initiated",
   "transactionHash":"0x5d7529c42ecf539fa2ab825d677030b236dc0d8e9e7de9d51d2150259a5ed020"
}

results matching ""

    No results matching ""