Passive Token
Stops a token. The token must be in status 6 (Listed) or 5 (Delisted). The call is asynchronous: it queues a PassiveToken transaction (type 7) and answers with its id. Poll Get Token Transaction By ID: when it reaches 3 (Done) the token is in status 7 (Passive).
Required permission: token:stop-selling
Request
POST /v2/admin/tokens/{token_id}/passive
Parameters
| Name | Type | In | Description |
|---|---|---|---|
token_id | string | path | Required. Token id. |
Headers
| Name | Description |
|---|---|
Authorization | Required. Bearer <access_token> |
Example
curl --request POST \
--url '{{baseUrl}}/v2/admin/tokens/67d8774e903bfcbe7eb5d93e/passive' \
--header 'Authorization: Bearer <access_token>'
Response
{
"transaction_id": "6a8b5e13f9129816a6cc7a12"
}
Response Fields
| Field | Type | Description |
|---|---|---|
transaction_id | string | The PassiveToken transaction. Poll it with Get Token Transaction By ID. |
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) |
| 400 | 10003 | The token is neither listed nor delisted (token domain 5, message token is not listed) |
A failure after acceptance ends the transaction in status 4 (Error) with the reason in its error field. See Errors for the error format and common codes.