Get Burn Payouts

Lists what a settled burn owes each wallet and how far each claim got. When the Burn Token transaction settles, one payout is recorded per (investor, wallet) that held the token: the wallet's quantity times the token price the pool was funded at. Investors claim their payouts themselves. Before the burn settles, the summary counts are 0, its amounts null, and data is empty. The list is not paginated; rows are oldest first.

Required permission: token:transactions:view

Request

GET /v2/admin/tokens/{token_id}/burn-payouts

Parameters

Name	Type	In	Description
token_id	string	path	Required. Token id.

Headers

Name	Description
Authorization	Required. Bearer <access_token>

Example

curl --request GET \
  --url '{{baseUrl}}/v2/admin/tokens/67d8774e903bfcbe7eb5d93e/burn-payouts' \
  --header 'Authorization: Bearer <access_token>'

Response

{
  "summary": {
    "token_id": "67d8774e903bfcbe7eb5d93e",
    "investor_count": 2,
    "total_quantity": 30,
    "total_amount": {
      "id": "68fe8c129367fd414b227c7a",
      "amount": "288",
      "decimal": 6,
      "symbol": "USDT",
      "address": "0x073c0196e516a0e77b1c804d1825fb1bad23895d"
    },
    "claimed_count": 1,
    "claimed_amount": {
      "id": "68fe8c129367fd414b227c7a",
      "amount": "96",
      "decimal": 6,
      "symbol": "USDT",
      "address": "0x073c0196e516a0e77b1c804d1825fb1bad23895d"
    }
  },
  "data": [
    {
      "id": "6a9c11d4e2b7f0a3c5d8e901",
      "user_id": "6a2f0b7e1c9d4e3f2a1b0c9d",
      "user_email": "investor@example.com",
      "user_name": "Ayse Yilmaz",
      "wallet_id": "6a2f0b9a1c9d4e3f2a1b0ca1",
      "wallet_address": "0x4f2a9c8e1b7d6a5f3e2c1b0a9f8e7d6c5b4a3f2e",
      "quantity": 10,
      "per_price": {
        "id": "68fe8c129367fd414b227c7a",
        "amount": "9.6",
        "decimal": 6,
        "symbol": "USDT",
        "address": "0x073c0196e516a0e77b1c804d1825fb1bad23895d"
      },
      "amount": {
        "id": "68fe8c129367fd414b227c7a",
        "amount": "96",
        "decimal": 6,
        "symbol": "USDT",
        "address": "0x073c0196e516a0e77b1c804d1825fb1bad23895d"
      },
      "status": 2,
      "paid_amount": {
        "id": "68fe8c129367fd414b227c7a",
        "amount": "96",
        "decimal": 6,
        "symbol": "USDT",
        "address": "0x073c0196e516a0e77b1c804d1825fb1bad23895d"
      },
      "claimed_at": "2025-09-02T08:15:40.211Z",
      "transaction_id": "6a9c2a07e2b7f0a3c5d8e9a4",
      "tx_hash": "0x7c3e9a1f5b2d8c4e6a0f9b3d7e1c5a8f2b6d0e4c9a3f7b1e5d8c2a6f0b4e9d3c",
      "created_at": "2025-09-01T12:00:03.540Z"
    }
  ]
}

Response Fields

Field	Type	Description
summary.token_id	string	Token id.
summary.investor_count	integer	Number of payout rows (one per wallet).
summary.total_quantity	integer	Tokens burned across all rows.
summary.total_amount	price | null	Total owed across all rows; null when there are none.
summary.claimed_count	integer	Rows whose claim the chain confirmed.
summary.claimed_amount	price | null	Total of the claimed rows; null when none is claimed.
data[].id	string	Payout id.
data[].user_id	string	Holder's user id.
data[].user_email	string	Holder's email.
data[].user_name	string	Holder's name and surname; "" when none is on record.
data[].wallet_id	string	Wallet that held the tokens and is owed the payout.
data[].wallet_address	string	That wallet's address; "" when it cannot be read.
data[].quantity	integer	Tokens the wallet held when the burn settled.
data[].per_price	price | null	Paid per token.
data[].amount	price | null	Owed to the wallet: per_price × quantity.
data[].status	integer	Claim status: 0 claimable, 1 pending (claim in flight), 2 claimed, 3 error (claimable again).
data[].paid_amount	price | null	What the chain actually paid, once the claim is seen on chain.
data[].claimed_at	string | null	When the claim was paid.
data[].transaction_id	string | null	The latest claim transaction (custody claims).
data[].tx_hash	string | null	Hash of the claim that paid it.
data[].created_at	string	When the payout was recorded (the burn's settlement).

A price is {id, amount, decimal, symbol, address} with amount as a decimal string; see Amounts and Percentages.

Errors

Status	Code	Description
400	10016	token_id is not a valid id
400	10001	Token not found (token domain 5)
403	10005	The caller's node does not cover the token's node (node domain 2)

See Errors for the error format and common codes.