Get Token Deposits

Returns one page of a token's rental income distributions, newest first. Each row is one distribution started by Rent Token, with the on-chain transaction behind it and the documents attached to it. The individual payouts of a distribution are in Get Token Rents, joined by external_id.

Required permission: token:transactions:view

Request

GET /v2/admin/tokens/{token_id}/deposits?page=1&per_page=20

Parameters

Name	Type	In	Description
token_id	string	path	Required. Token id.
page	integer	query	Required. Page number, starting at 1.
per_page	integer	query	Required. Page size, 1 to 100.

Headers

Name	Description
Authorization	Required. Bearer <access_token>

Example

curl --request GET \
  --url '{{baseUrl}}/v2/admin/tokens/67d8774e903bfcbe7eb5d93e/deposits?page=1&per_page=20' \
  --header 'Authorization: Bearer <access_token>'

Response

{
  "data": [
    {
      "id": "6a8b6f02f9129816a6cc7b30",
      "token_id": "67d8774e903bfcbe7eb5d93e",
      "external_id": 3,
      "status": 0,
      "contract_created_at": "2025-05-01T10:00:12.381Z",
      "total_price": {
        "id": "68fe8c129367fd414b227c7a",
        "amount": "18",
        "decimal": 6,
        "symbol": "USDT",
        "address": "0x073c0196e516a0e77b1c804d1825fb1bad23895d"
      },
      "per_price": {
        "id": "68fe8c129367fd414b227c7a",
        "amount": "0.1",
        "decimal": 6,
        "symbol": "USDT",
        "address": "0x073c0196e516a0e77b1c804d1825fb1bad23895d"
      },
      "transaction": {
        "id": "6a8b5e13f9129816a6cc7a12",
        "node_id": "67d6c447f47ff3adafda700d",
        "user_id": "",
        "token_id": "67d8774e903bfcbe7eb5d93e",
        "hash": "0x998a217061da05cf1bf1998470613a488b10908f0964e76a123c4063f91d77c4",
        "type": 3,
        "status": 3,
        "error": null,
        "is_api": true,
        "created_at": "2025-05-01T09:59:58.104Z"
      },
      "documents": [
        {
          "id": "6a8b6f02f9129816a6cc7b31",
          "name": "invoice-2025-04.pdf",
          "url": "https://bucket.s3.amazonaws.com/dev/deposit/6a8b6f02f9129816a6cc7b30/invoice.pdf?X-Amz-Expires=900&X-Amz-Signature=...",
          "type": 1,
          "hash": "9a8b7c6d5e4f3a2b1c0d9e8f7a6b5c4d3e2f1a0b9c8d7e6f5a4b3c2d1e0f9a8b",
          "tx_hash": null,
          "created_at": "2025-05-01T09:59:57.950Z"
        }
      ],
      "created_at": "2025-05-01T10:00:12.381Z"
    }
  ],
  "total": 1,
  "page": 1,
  "per_page": 20
}

Response Fields

Field	Type	Description
data[].id	string	Deposit (distribution) id.
data[].token_id	string	Token id.
data[].external_id	integer	The distribution's id on chain. The payouts in Get Token Rents carry the same value.
data[].status	integer	0 settled (the money moved), 1 pending on-chain confirmation, 2 canceled because the transaction failed.
data[].contract_created_at	string	When the distribution was recorded on chain.
data[].total_price	price	Total paid out by the distribution.
data[].per_price	price	Paid per token.
data[].transaction	object | null	The TokenRent transaction behind the distribution, in the shape of a List Token Transactions row: read its status, hash and error. null when the distribution predates the link to its transaction and no match is found.
data[].documents[]	array	Documents attached to the distribution (invoices, receipts): id, name, url, type, hash, tx_hash and created_at. Removed documents are left out; always an array.
data[].created_at	string	When the row was created.
total	integer	Number of distributions.
page	integer	Page number sent in the request.
per_page	integer	Page size sent in the request.

documents[].url is a signed link that opens the document for 15 minutes and is minted on every read; do not store it. A price is {id, amount, decimal, symbol, address} with amount as a decimal string; see Amounts and Percentages.

Errors

Status	Code	Description
400	10015	Validation failed (page or per_page missing or out of range) — see details
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.