Skip to main content
These endpoints expose the pause/unpause and freeze/unfreeze controls offered by some QRC standards. Pause halts all token activity globally. Freeze halts activity for a single account. Both are privileged operations that always require approval.

​
Capability matrix

Standardpausefreeze
QRC-20Template-dependentTemplate-dependent
QRC-721Template-dependentTemplate-dependent
QRC-1155Template-dependentTemplate-dependent
QRC-1400Yes (controller)Yes (per-investor)
QRC-3643YesYes (per-identity)
QRC-4626Template-dependentNo
QRC-3525Template-dependentNo

​
POST /v1/tokens/{tokenId}/pause

Pause all transfers, mints, and burns on the token contract.
AspectDetail
AuthenticationBearer API key
Required permissionstokens:pause plus the on-chain PAUSER role
IdempotencyIdempotency-Key header required
Approval policyRequired
Blockchain effectContract call to pause()
Webhook eventstoken.paused, token.operation_failed

​
Example response (202)

{
  "operationId": "op_pause_111",
  "tokenId": "token_abc123",
  "operationType": "PAUSE",
  "status": "PENDING_AUTHORIZATION",
  "transactionRequestId": "txreq_006",
  "createdAt": "2026-04-27T10:18:00Z"
}

​
POST /v1/tokens/{tokenId}/unpause

Resume activity. Webhook events: token.unpaused, token.operation_failed. Same request envelope as pause.

​
POST /v1/tokens/{tokenId}/freeze

Freeze a single account so it cannot send or receive the token. | Required permissions | tokens:freeze plus the on-chain FREEZER role | | Webhook events | token.frozen, token.operation_failed |

​
Request body

{
  "subject": { "type": "address", "address": "0x9a8e5e21…" },
  "reason": "compliance hold — case_2026_0427",
  "idempotencyKey": "freeze-2026-04-27-001"
}

​
POST /v1/tokens/{tokenId}/unfreeze

Release a freeze. Webhook events: token.unfrozen, token.operation_failed.

​
Errors

CodeTypeMeaning
1703TOKEN_NOT_DEPLOYEDToken has no on-chain contractAddress.
1704TOKEN_OPERATION_NOT_ALLOWEDStandard or template does not support pause or freeze.
1708TOKEN_ROLE_REQUIREDCaller lacks the on-chain PAUSER or FREEZER role.
1200POLICY_DENIEDApproval policy denied the operation.
1201APPROVAL_REQUIREDApproval is required and was not yet granted.
1601IDEMPOTENCY_CONFLICTSame Idempotency-Key reused with different body.