Get Deposit Transaction

Returns the on-chain transaction behind one rental income distribution: its hash when it settled, its error when it did not. It is the same object a row of Get Token Deposits carries under transaction, read directly by deposit id. The response is null when the distribution predates the link to its transaction and no match is found. A deposit of another token is reported as not found.

Required permission: token:transactions:view

Request

GET /v2/admin/tokens/{token_id}/deposits/{deposit_id}/transaction

Parameters

Name	Type	In	Description
token_id	string	path	Required. Token id.
deposit_id	string	path	Required. Deposit (distribution) id.

Headers

Name	Description
Authorization	Required. Bearer <access_token>

Example

curl --request GET \
  --url '{{baseUrl}}/v2/admin/tokens/67d8774e903bfcbe7eb5d93e/deposits/6a8b6f02f9129816a6cc7b30/transaction' \
  --header 'Authorization: Bearer <access_token>'

Response

{
  "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"
}

Response Fields

Field	Type	Description
id	string	Transaction id.
node_id	string	Node of the token.
user_id	string	Not filled for token transactions: always "".
token_id	string	Token id.
hash	string | null	On-chain transaction hash.
type	integer	3 (TokenRent).
status	integer	1 Started, 2 InProgress, 3 Done, 4 Error, 5 PendingReceipt.
error	string | null	Failure reason when status is 4.
is_api	boolean	The distribution was started through the partner API by an API client.
created_at	string	Creation time (RFC 3339).

Errors

Status	Code	Description
400	10016	token_id or deposit_id is not a valid id
400	10001	Token not found, or the deposit does not exist or belongs to another token (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.