Mint tokens

Mint new tokens. amount is in token units. Send to when the token's capabilities include mint-to. The mint needs approval in io.sign. Building first is optional: omit transaction to build and submit in one call, or build with POST .../mint/build, review the result, and send it unchanged as transaction.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
length ≥ 1

Token ID.

Body Params
string
length ≥ 1

Recipient of the minted tokens. Required when the token's capabilities include mint-to. Liquid tokens do not accept it and return 400: a Liquid mint goes to the issuing vault, and you distribute the tokens with a transfer afterwards.

string
required
length ≥ 1

Amount to mint in token units as a decimal string, for example 1.5. Not base units.

string
length ≤ 512
string
length between 1 and 64
^\S+$

User or machine to record as the originator, in the operation's onBehalfOf and, for a machine caller, on the io.sign request. initiatedBy keeps the caller. Defaults to the caller. A machine can name any user or machine. A person can name only themselves, otherwise the call returns 403.

boolean
Defaults to false

Set to true to simulate the transaction, as sent by the signing vault, before anything is signed. A predicted revert returns 422 SIMULATION_REVERTED, for example when the recipient is not on the allowlist, the vault does not hold the role, or the token is paused. On io.chain this is the only revert check before signing. On public chains a transaction that would revert is refused even without this flag. If the simulation cannot run, the call returns 503 SIMULATION_UNAVAILABLE and nothing is built or submitted. Defaults to false.

transaction
object

The unsigned transaction from the matching /build endpoint, sent unchanged. Omit it to build and submit in one call.

date-time

When the io.sign approval expires if it is not signed (ISO 8601). Must be between 10 minutes and 24 hours from now. Omit it to use the io.sign default.

Headers
string
length between 1 and 255

Key that makes this call safe to retry. Repeating the key with the same body returns the original response without running the operation again. Reusing the key with a different body is refused. Keys are scoped to you and this operation, so the same key on another operation does not collide. Keys expire some time after the original call completes. An empty or whitespace-only value is rejected. Maximum length: 255 characters.

Responses

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json