Skip to main content
Field-level reference for the core resources exposed by the Token Management API.

Token

A QRC token tracked by Qustody.
FieldTypeDescription
idstringQustody token ID (token_…).
standardstringOne of QRC-20, QRC-721, QRC-1155, QRC-1400, QRC-3643, QRC-4626, QRC-3525.
templateIdstringTemplate used to instantiate the contract (nullable for custom contracts).
namestringHuman-readable name.
symbolstringOn-chain symbol.
decimalsintegerDecimals (fungible standards only).
networkstringquantum-chain-mainnet, quantum-chain-testnet, or a registered network ID.
contractAddressstringOn-chain contract address; null until deployment is COMPLETED.
statusstringDRAFT, DEPLOYING, DEPLOYED, PAUSED, RETIRED, FAILED.
adminVaultAccountIdstringVault account that holds administrative on-chain roles.
approvalPolicyIdstringPolicy applied to privileged operations.
supplyPolicyobject{ mintable, burnable, maxSupply }.
complianceConfigIdstringReference to the compliance configuration (regulated standards).
tagsstring[]User-defined metadata tags.
createdAtstringRFC 3339 timestamp.
updatedAtstringRFC 3339 timestamp.

TokenStandard

Descriptor for a single QRC standard.
FieldTypeDescription
standardstringThe QRC standard identifier.
descriptionstringPlain-language description.
supportedOperationsstring[]Operations this standard exposes.
requiredFieldsstring[]Configuration fields required at token creation.
optionalFieldsstring[]Configuration fields permitted but not required.
financeUseCasestringTypical use case in institutional finance.
implementationStatusstringimplemented, partially-implemented, proposed, to-verify.

TokenTemplate

A pre-validated contract template Qustody can instantiate.
FieldTypeDescription
templateIdstringStable template ID (tpl_qrc20_v1).
standardstringThe QRC standard this template targets.
namestringHuman-readable template name.
versionstringSemVer-style version of the template.
constructorFieldsobject[]{ name, type, required, default? } entries describing the constructor.
supportedOperationsstring[]Operations the template enables.
featuresobject{ mintable, burnable, pausable, freezable, roleBased } flags.
bytecodeHashstringKeccak-256 hash of the deployment bytecode (audit anchor).
abiHashstringKeccak-256 hash of the canonical ABI.
implementationStatusstringSame enum as TokenStandard.implementationStatus.

TokenOperation

A single privileged action against a token.
FieldTypeDescription
operationIdstringQustody operation ID (op_…).
tokenIdstringThe token this operation targets.
operationTypestringSee enum below.
statusstringSee enum below.
transactionRequestIdstringUnderlying Qustody transaction.
blockchainTransactionHashstring0x… once broadcast; null while in earlier states.
amountstringuint256 decimal string (mint/burn/transfer).
recipientobjectResolved recipient descriptor (mint/transfer).
fromobjectResolved source descriptor (burn/transfer).
rolestringRole identifier (role grant/revoke).
requestedBystringQustody user ID that submitted the operation.
approvedBystring[]Qustody user IDs that approved the operation.
createdAtstringRFC 3339 timestamp.
updatedAtstringRFC 3339 timestamp.
failureReasonstringPlain-language explanation when status = FAILED.

operationType enum

CREATE_TOKEN, DEPLOY_TOKEN, MINT, BURN, TRANSFER, GRANT_ROLE, REVOKE_ROLE, PAUSE, UNPAUSE, FREEZE, UNFREEZE, UPDATE_COMPLIANCE, ALLOWLIST_ADD, ALLOWLIST_REMOVE.

status enum

Aligned with the existing transaction state machine: SUBMITTED, QUEUED, PENDING_AUTHORIZATION, APPROVED, REJECTED, PENDING_SIGNATURE, SIGNED, BROADCASTING, CONFIRMING, COMPLETED, FAILED, CANCELLED.