Skip to main content
POST
/
prepare-transactions
/
dividendDistribution
dividendDistribution
curl --request POST \
  --url https://api.sandbox.brickken.com/prepare-transactions/dividendDistribution \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "method": "dividendDistribution",
  "signerAddress": "<string>",
  "chainId": "<string>",
  "tokenSymbol": "<string>",
  "amount": "<string>"
}
'
{
  "transactions": [
    {}
  ],
  "txId": "<string>"
}
Prepares unsigned transactions for distributing payment token dividends to holders of a specific token. This endpoint is equivalent to calling /prepare-transactions with method=dividendDistribution.

Request Body

ParameterTypeRequiredDescription
signerAddressstringYesAddress that will sign the transaction
chainIdstringYesBlockchain network identifier (hex format)
methodstringYesTransaction method type (should be “dividendDistribution”)
tokenSymbolstringYesSymbol of the token for dividend distribution
amountstringYesAmount of payment tokens to distribute

Example Request

{
  "signerAddress": "0x742d35Cc6634C0532925a3b8D4C9db96c4b4d8b",
  "chainId": "aa36a7",
  "method": "dividendDistribution",
  "tokenSymbol": "PROP1",
  "amount": "1000"
}

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

  • Amounts are specified in whole units (e.g., 10 for 10 USDT)
  • The signer must have sufficient balance of the payment token
  • Only the tokenizer can distribute dividends for their tokens

Authorizations

x-api-key
string
header
required

Body

application/json

Request body for dividendDistribution method.

method
string

The operation to be performed.

Example:

"dividendDistribution"

signerAddress
string
chainId
string
tokenSymbol
string
amount
string

Response

200 - application/json

Successful response

transactions
object[]
required
txId
string
required