Brickken APIInstall

Summary

Prepare unsigned blockchain transactions for tokenization or investment actions

Inputs

• chainId (required) — Blockchain network to use; production networks: Ethereum (1), Base (2105), BNB (38), Polygon (89); sandbox: Sepolia (aa36a7), Polygon Amoy (13882)
• customChainId (required) — Custom chain ID (hex or decimal) when using a non‑standard network
• method — Transaction method to prepare, e.g., newTokenization, mintToken, newSto, transferFrom, etc.
• paymentTokenSymbol — Symbol of the payment token (e.g., USDT, USDC)
• signerAddress — EOA address of the transaction signer
• investorAddress — Investor wallet address (used for investment/claim actions)
• tokenSymbol — Symbol of the token being created
• tokenizerEmail — Email address of the tokenizer creating the asset
• url — URL to documentation or legal documents associated with the tokenization
• name (required) — Full name of the token (e.g., "Real Estate Property Token")
• supplyCap — Maximum number of tokens that can be minted (leave empty for unlimited)
• tokenType — Type of the token (e.g., EQUITY, DEBT, RWA_TOKEN)
• acceptedCoin (required) — Accepted payment coin (e.g., USDT, USDC, or NATIVE for chain native coin)
• tokenAmount (required) — Total number of tokens offered in the STO
• offeringName (required) — Name of the STO offering
• startDate — Start date of the offering
• endDate — End date of the offering
• minRaiseUSD — Minimum fundraising amount in USD
• maxRaiseUSD — Maximum fundraising amount in USD
• minInvestment (required) — Minimum investment amount in payment token units
• maxInvestment (required) — Maximum investment amount in payment token units
• investorEmail — Email address of the investor
• amount — Amount of tokens involved in the transaction
• from — Source address for transfer operations
• to — Destination address for transfer operations
• spenderAddress — Address of the spender for approval operations
• tokenizerAddressApprove — Tokenizer address required for certain approve flows
• preMints — Collection of pre‑mint configurations for specific addresses
• initialHolders — Collection of initial holder configurations with allocations
• userToMintInputMode — Input mode for defining users to mint (fields or JSON)
• userToMint — Collection of user minting details
• userToMintJson — JSON string representing an array of users to mint
• userToWhitelistInputMode — Input mode for whitelist users (fields or JSON)
• userToWhitelist — Collection of whitelist user details
• userToWhitelistJson — JSON string representing an array of users to whitelist
• requestOptions — Options for request batching, SSL validation, proxy, and timeout

Output shape

a single record (object) with prepared transaction details

Contains the transaction ID and unsigned payload; additional fields may appear depending on the method; errors return standard error envelopes.

Examples

Example 1: Prepare an STO token issuance

Chain ID = 1 (Ethereum Mainnet), Method = newSto, Accepted Coin = USDT, Token Amount = 5000000, Offering Name = "Global Real Estate Fund", Min Investment = 100, Max Investment = 500000, Start Date = 2025-01-01T00:00:00Z, End Date = 2025-03-31T23:59:59Z

Example 2: Mint tokens to multiple investors

Method = mintToken, userToMintInputMode = fields, define three users with Amount, Investor Address, Need KYC = true, Surname = Doe

Example 3: Whitelist additional investors

Method = whitelist, userToWhitelistInputMode = json, provide JSON array with investorAddress and whitelistStatus = true