HomeAPI ReferenceToken OperationsPause · ERC-20 / ERC-721 / ERC-3643 / Title-fraction
POST/tokenization/{id}/operations

Pause · ERC-20 / ERC-721 / ERC-3643 / Title-fraction

Outcome - Stops every transfer of the token until it is unpaused. erc20-v1 and erc721-v1: the token must have been created with canPause true; the owner signs. ERC-3643: an agent signs; erc3643-v1 tokens start paused. Signer: erc20-v1 and erc721-v1: RoxCustody signs with the token's owner; do not send a signer. ERC-3643 (erc3643-v1, title-fraction-v1): an agent signs; name one ACTIVE agent in params, as signerWalletAddress or signerWalletId (from Get Token Roles), exactly one of the two. Templates: erc20-v1, erc721-v1, erc3643-v1, title-fraction-v1.

Path Parameters

idnumber

Token ID

Body Parameters

operationstringrequired

Always PAUSE for this operation.

paramsobjectrequired

The operation details, including its signer

Show child parameters (2)
signerWalletAddressstringERC-3643: one of the two

Address of the wallet that signs. Give signerWalletAddress or signerWalletId, not both.

signerWalletIdnumberERC-3643: one of the two

ID of that wallet: its wallet of the token (walletId from Get Token Roles). Give signerWalletAddress or signerWalletId, not both.

idempotencyKeystring

Your unique key for this request. Repeating it with the same body returns the first transaction; with a different body it returns 409.

Responses

Response attributes

messagestring

Success message

dataobject

The transaction created

Show child attributes (2)
transactionIdnumber

ID of the transaction (type TOKEN_OPERATION). Follow it with Get Transaction Details or the transaction webhooks: the operation is done when it is COMPLETED.

dataobject

What the operation does, as shown on the transaction everywhere (API and webhooks)

Show child attributes (3)
operationstring

The operation

securityTokenobject

The token

Show child attributes (1)
idnumber

Token ID

movementsarray

Empty: pausing moves no tokens

Show child attributes (6)
typestring

MINT (tokens created: has to), BURN (tokens destroyed: has from) or TRANSFER (has from and to)

fromstring

Address the tokens leave. Absent on MINT.

tostring

Address the tokens reach. Absent on BURN.

amountstring

Fungible tokens: amount in whole units (for example "10.5"). Absent for an NFT.

nftTokenIdstring

ERC-721: the NFT that moves. Absent for fungible tokens.

metadataUrlstring

ERC-721 MINT: the metadata URL of the new NFT

statusnumber

HTTP status code

Was this page helpful?