Skip to main content

Get Token Transaction By ID

Returns one transaction of a token. This is the read to poll after any asynchronous token endpoint: call it with the transaction_id the endpoint answered with until status is 3 (Done) or 4 (Error). A transaction of another token is reported as not found.

Required permission: token:transactions:view

Request​

GET /v2/admin/tokens/{token_id}/transactions/{transaction_id}

Parameters​

NameTypeInDescription
token_idstringpathRequired. Token id.
transaction_idstringpathRequired. Transaction id.

Headers​

NameDescription
AuthorizationRequired. Bearer <access_token>

Example​

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

Response​

{
"id": "6a8b5e13f9129816a6cc7a12",
"node_id": "67d6c447f47ff3adafda700d",
"supervisor_id": "665b372f3a72d7d0791596ba",
"token_id": "67d8774e903bfcbe7eb5d93e",
"network_id": "6740e0a20000000000000103",
"external_id": "c3f1a9e2-7d4b-4c55-9b1e-2a6f0d8e4b17",
"correlation_id": "4f9c2d1e-8a7b-4c3d-9e2f-1a0b9c8d7e6f",
"data": {
"is_open_to_otc": true
},
"environment": 0,
"type": 12,
"status": 3,
"triggered": 0,
"hash": "0x998a217061da05cf1bf1998470613a488b10908f0964e76a123c4063f91d77c4",
"error": null,
"message": null,
"is_api": false,
"updated_at": "2025-03-17T19:26:42.180Z",
"created_at": "2025-03-17T19:26:07.042Z"
}

Response Fields​

FieldTypeDescription
idstringTransaction id.
node_idstringNode of the token.
supervisor_idstringSupervisor who started the operation. Absent when an API client started it.
token_idstringToken id.
network_idstringNetwork the transaction runs on (the token's network).
external_idstringRequest id of the custody wallet call.
correlation_idstringId of the flow that created the transaction, shared by its request, events and settlement. Absent on older rows.
dataobject | nullType-specific values, for example document_id for AddDocumentToToken, or the requested flag (is_public, is_open_to_otc, is_open_to_secondary_market) for the market toggles.
environmentinteger0 default, 1 OTC, 2 secondary market.
typeintegerTransaction type, see type Enum.
statusinteger1 Started, 2 InProgress, 3 Done, 4 Error, 5 PendingReceipt. See status Enum.
triggeredinteger0 started by a request, 1 started by the system (a scheduled job).
hashstring | nullOn-chain transaction hash, once the transaction is sent.
errorstring | nullFailure reason when status is 4.
messagestring | nullInformational message attached while processing.
is_apibooleanThe operation came through the partner API from an API client.
updated_atstringLast change (RFC 3339).
created_atstringCreation time (RFC 3339).

This read returns more fields than a row of List Token Transactions.

Errors​

StatusCodeDescription
40010016token_id or transaction_id is not a valid id
40010001Token not found (token domain 5)
40310005The caller's node does not cover the token's node (node domain 2)
40010001Transaction not found, or it belongs to another token (token transaction domain 8)

See Errors for the error format and common codes.