Skip to main content
POST
/
prepare-transactions
/
claimTokens
claimTokens
curl --request POST \
  --url https://api.sandbox.brickken.com/prepare-transactions/claimTokens \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "method": "claimTokens",
  "chainId": "<string>",
  "investorAddress": "<string>",
  "tokenSymbol": "<string>",
  "investorEmail": "<string>",
  "paymentTokenSymbol": "<string>"
}
'
{
  "transactions": [
    {}
  ],
  "txId": "<string>"
}
Prepares unsigned transactions for claiming tokens from a completed Security Token Offering (STO) investment. This endpoint is equivalent to calling /prepare-transactions with method=claimTokens.

​
Request Body

ParameterTypeRequiredDescription
signerAddressstringYesAddress that will sign the transaction
chainIdstringYesBlockchain network identifier (hex format)
methodstringYesTransaction method type (should be “claimTokens”)
tokenSymbolstringYesSymbol of the token to claim
investorAddressstringYesAddress of the investor claiming tokens
investorEmailstringYesEmail of the investor
paymentTokenSymbolstringYesSymbol of the payment token used in the STO

​
Example Request

{
  "signerAddress": "0x742d35Cc6634C0532925a3b8D4C9db96c4b4d8b",
  "chainId": "aa36a7",
  "method": "claimTokens",
  "tokenSymbol": "PROP1",
  "investorAddress": "0x456...",
  "investorEmail": "[email protected]",
  "paymentTokenSymbol": "USDT"
}

​
Response

Returns an array of unsigned transactions that need to be signed and a transaction ID for tracking. 
{
  "transactions": [
    {
      "from": "0x742d35Cc6634C0532925a3b8D4C9db96c4b4d8b",
      "to": "0xTargetAddress",
      "value": {"type": "BigNumber", "hex": "0x00"},
      "nonce": 1,
      "chainId": 11155111,
      "data": "0x...",
      "type": 2,
      "maxPriorityFeePerGas": {"type": "BigNumber", "hex": "0x..."},
      "maxFeePerGas": {"type": "BigNumber", "hex": "0x..."},
      "gasLimit": {"type": "BigNumber", "hex": "0x..."}
    }
  ],
  "txId": "unique-transaction-id"
}

​
Notes

  • Tokens can only be claimed after the STO has ended successfully
  • The investor must have participated in the STO
  • Each investor can only claim their allocated tokens once
  • The claiming process transfers the purchased tokens to the investor’s address

Authorizations

​
x-api-key
string
header
required

Body

application/json

Request body for claimTokens method.

​
method
string

The operation to be performed.

Example:

"claimTokens"

​
chainId
string
​
investorAddress
string
​
tokenSymbol
string
​
investorEmail
string
​
paymentTokenSymbol
string

Response

200 - application/json

Successful response

​
transactions
object[]
required
​
txId
string
required