Skip to main content
POST
/
tokens
/
{tokenId}
/
revoke
Revoke API token for your authenticated platform.
curl --request POST \
  --url https://{publicHost}/tokens/{tokenId}/revoke \
  --header 'Authorization: Basic <encoded-value>'
{
  "id": "Token:019542f5-b3e7-1d02-0000-000000000001",
  "name": "Operations token",
  "permissions": [
    "VIEW",
    "TRANSACT",
    "MANAGE"
  ],
  "clientId": "01947d2284054f890000e63bca4810df",
  "createdAt": "2026-04-05T12:00:00Z",
  "updatedAt": "2026-04-05T12:05:00Z",
  "status": "REVOKED",
  "revokedAt": "2026-04-05T12:05:00Z"
}

Authorizations

​
Authorization
string
header
required

Integration-key Basic Auth (clientId:clientSecret) as documented in docs/public/AUTHENTICATION.md.

Path Parameters

​
tokenId
string
required

Token identifier returned by the token create/list/detail surfaces. The public token entity routes accept the public Token:<id> form and the raw runtime token id.

Response

Token revoked. Client secret remains omitted on revoke responses.

​
id
string
required

Stable public API-token identifier.

​
name
string
required

Human-readable token name.

​
permissions
string[]
required

Permissions granted to this token. VIEW reads platform configuration, customers, tokens, and transactions, TRANSACT creates quotes, executes payments, and runs transfer actions, and MANAGE updates platform configuration, API tokens, and customer records.

​
clientId
string
required

Client identifier used for Basic Auth.

​
createdAt
string<date-time>
required

Creation timestamp.

​
updatedAt
string<date-time>
required

Last update timestamp.

​
status
string
required

Current token lifecycle state.

​
revokedAt
string<date-time> | null
required

Revocation timestamp. null while the token is still active.