Prepare Transactions
Description: This endpoint prepares unsigned transactions for various blockchain operations. The operation is determined by the method field in the request body. Supported methods include: newTokenization, mintToken, whitelist, burnToken, approve, transferTo, transferFrom, dividendDistribution, newSto, newInvest, closeOffer and claimTokens.
Headers:
x-api-key:YOUR_API_KEYContent-Type:application/json
Common Request Body Parameters:
method(string): Operation to perform.signerAddress(string): Address initiating the transaction.chainId(string): Chain ID in hex (e.g., “aa36a7”).gasLimit(string, optional): Optional gas limit.rpcUrl(string, optional): Optional RPC URL.
Method: newTokenization
Prepares a new tokenization transaction.
Additional Request Body Parameters:
url(string): Token documentation URL.name(string): Token name.symbol(string): Token symbol (max 5 characters).tokenizerEmail(string): The email of the tokenizer.supplyCap(string, optional): Max token supply.preMints(array, optional): Pre-mint configurations.initialHolders(array, optional): Initial holder configurations.
Method: mintToken
Prepares minting tokens to users.
Additional Request Body Parameters:
tokenSymbol(string): Symbol of the token.userToMint(array of objects): Each object includes:email(string)investorAddress(string)amount(string)needWhitelist(boolean)
Method: whitelist
Whitelists or blacklists users.
Additional Request Body Parameters:
tokenSymbol(string): Symbol of the token.userToWhitelist(array of objects): Each includes:whitelistStatus(string): “true” or “false”.investorAddress(string)
Method: burnToken
Burns tokens from the signer’s balance.
Additional Request Body Parameters:
tokenSymbol(string): Symbol of the token.amount(string): Amount to burn.
Method: transferFrom
Transfers tokens from one address to another (with prior approval).
Additional Request Body Parameters:
tokenSymbol(string): Symbol of the token.from(string): Sender address.to(string): Receiver address.amount(string): Amount to transfer.
Method: transferTo
Transfers tokens from signerAddress to another address.
Additional Request Body Parameters:
tokenSymbol(string): Symbol of the token.to(string): Receiver address.amount(string): Amount to transfer.
Method: approve
Approves a spender to use tokens.
Additional Request Body Parameters:
tokenSymbol(string): Token to approve (can include BKN, USDT, USDC).spenderAddress(string): Address being approved.amount(string): Allowance amount.
Method: dividendDistribution
Distributes paymentToken dividends to holders of tokenSymbol.
Additional Request Body Parameters:
tokenSymbol(string)amount(string): Amount of payment token to distribute.
Note: Amounts are in whole units (e.g., 10 for 10 USDT).
Method: newSto
Creates a new STO (Security Token Offering).
Additional Request Body Parameters:
tokenizerEmail(string)tokenAmount(string)offeringName(string)startDate(string)endDate(string)acceptedCoin(string)minRaiseUSD(string)maxRaiseUSD(string)minInvestment(string)maxInvestment(string)signerAddress(string)
Common Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
chainId | string | Yes | Blockchain network identifier (hex format) |
method | string | Yes | Transaction method type |
signerAddress | string | Yes | Address that will sign the transaction |
Supported Methods
newTokenization
Creates a new tokenized asset.newSto
Creates a new Security Token Offering.newInvest
Makes an investment in an STO.claimTokens
Claims tokens from a completed STO.mintToken
Mints additional tokens to specified addresses.whitelist
Manages whitelist status for addresses.approve
Approves another address to spend tokens on behalf of the signer.burnToken
Burns tokens from the signer’s address.transferFrom
Transfers tokens from one address to another (requires approval).transferTo
Transfers tokens from signer’s address to another address.dividendDistribution
Distributes dividends to token holders.Response Format
The response includes the transaction details, metadata, and a unique transaction ID that must be saved for use with the/send-transactions endpoint.
Important: The txId is NOT a blockchain transaction hash - it’s an internal identifier used to link the prepared transactions with the send operation.
Response Fields
| Field | Type | Description |
|---|---|---|
transactions | array | Array of unsigned transaction objects ready for signing |
info | object | Metadata about the operation including emails and token symbol |
txId | string | Unique identifier for this transaction batch (required for /send-transactions) |
- Sign each transaction in the
transactionsarray - Submit the signed transactions along with the
txIdto/send-transactions
Authorizations
Body
The operation to be performed. Supported methods: newTokenization (create tokenized asset), newSto (create STO), newInvest (invest in STO), claimTokens (claim from completed STO), mintToken (mint additional tokens), whitelist (manage whitelist), approve (approve spending), burnToken (burn tokens), transferFrom (transfer with approval), transferTo (transfer from signer), dividendDistribution (distribute dividends), closeOffer (close active STO).
newTokenization, newSto, newInvest, claimTokens, mintToken, whitelist, approve, burnToken, transferFrom, transferTo, dividendDistribution, closeOffer "newTokenization"
The address of the user initiating the transaction.
"0xSignerAddress"
The blockchain network's chain ID in hexadecimal format (e.g., "aa36a7" for Sepolia testnet).
"aa36a7"
The token symbol (max 5 characters).
"BKN"
Type of token. Allowed values: EQUITY, DEBT, PRIVATE_CREDIT, FUNDS, RWA_TOKEN, PROFIT_SHARING.
EQUITY, DEBT, PRIVATE_CREDIT, FUNDS, RWA_TOKEN, PROFIT_SHARING "EQUITY"
The email of the user.
Accepted payment token symbol (used in newSto).
"USDT"
Amount for various operations (approve, burnToken, transferFrom, transferTo, dividendDistribution).
"100"
End date of the STO (used in newSto).
"2025-10-02T00:00:00.000Z"
Source address for transfer (used in transferFrom).
"0x123..."
An amount of gas units as limits. If not specified, it will be automatically estimated.
"2000000 but can be omitted"
Array of initial token holders (used in newTokenization).
Amount to invest (used in newInvest).
"10"
Address of the investor (used in newInvest, claimTokens, mintToken).
"0x742d35Cc6634C0532925a3b8D4C9db96c4b4d8b"
Email of the investor (used in newInvest, claimTokens, whitelist).
Maximum investment amount (used in newSto).
"100"
Maximum raise amount in USD (used in newSto).
"100"
Minimum investment amount (used in newSto).
"10"
Minimum raise amount in USD (used in newSto).
"10"
Name of the token.
"Brickken"
New investor information (used in whitelist and mintToken).
Name of the STO offering (used in newSto).
"FE Test STO 5"
Symbol of the payment token (used in newInvest, claimTokens).
"USDT"
Array of pre-mint configurations (used in newTokenization).
The RPC URL of the blockchain network. If not provided, a default RPC URL for the specified chain ID will be used.
"{URL_TO_RPC} but can be omitted"
Address of the spender being approved (used in approve).
"0x456..."
Start date of the STO (used in newSto).
"2025-08-26T17:30:00.000Z"
Max token supply.
"10"
Destination address for transfer (used in transferFrom, transferTo).
"0x456..."
Amount of tokens for STO (used in newSto).
"1000"
The address of the tokenizer (used in newTokenization).
"0x742d35Cc6634C0532925a3b8D4C9db96c4b4d8b"
URL associated with tokenization documents (required for newTokenization).
"https://example.com/token-docs"
Array of users to mint tokens to (used in mintToken).
Array of users to whitelist/blacklist (used in whitelist).
Response
Successful response
Array of unsigned transaction objects ready for signing
Unique identifier for this transaction batch (required for /send-transactions). This is NOT a blockchain transaction hash.
"0x46adea7bdf49c576a760102e0d6bc9ecd650b3998588cd3d7f576a7973426aad"
Metadata about the operation