POST api/Minter/{id}

Mints native assets both fungible and non-fungible tokens (NFT) based on the given parameters.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

The generated Token Id

string

Required

Body Parameters

Json string containing Access Id and asset attributes.

MinterPayload
NameDescriptionTypeAdditional information
accessId

Pre-assigned Access ID

string

None.

isNFT

Set this to true if you want to mint an NFT. If false, a fungible token will be minted instead. If true, the Metadata parameter is required.

boolean

None.

policyId

Cardano-assigned Policy Id (you can find out your Policy Id at Token Central - Policy Maker page). Make sure the Policy was created for the type of token that will be minted (NFT or not).

string

None.

tokenSymbol

This is the Short Name (20 characters max) of your asset which should contain only alphanumeric characters (no spaces and special characters allowed). This must be a unique identifier of your asset created for the specified Policy Id. If the Token Symbol or Name that you pass already exists in the blockchain, the quantity of that same token will simply be increased, thus turning the asset if it's an NFT into a fungible token.

string

None.

quantity

The amount of tokens that will be minted or burned. If minting or burning an NFT, this should always be assigned a value of 1.

integer

None.

receiverAddress

The wallet address where the asset will be minted and sent to. If blank, this will default to the your primary wallet address. Note that minting an asset into another wallet address requires an attachment of at least 1.7 ADA plus the applicable blockchain fee of approximately 0.20 ADA. This is not needed when burning assets.

string

None.

metadata

Metadata parameter is only required if you are minting an NFT. If not this will be ignored. This is not needed when burning assets. The Metadata must be a 2-dimensional string array which contains the key-value pairs that describe your NFT. Example, you need to pass the metadata as Json array like this: "metadata": [ { "key": "description", "value": "Sample Description" }, { "key": "url", "value": "https://..." }, { "key": "id", "value": "Id Number" } ]

Collection of Metadata

None.

Request Formats

application/json, text/json

Sample:
For Fungible Tokens (Minting and Reminting)

{
	"accessId": "7d689f2d-e7de-5c7d-bb2d-aa785e21d055",
	"isNFT": false,
	"policyId": "356e8545176656f3f580fa1a063c20d253206d8fe7d562b6a4de0681",
	"tokenSymbol": "MYASSET",
	"quantity": 100000000,
	"receiverAddress": ""
}

For Non-Fungible Tokens (NFT)

{
	"accessId": "7d689f2d-e7de-5c7d-bb2d-aa785e21d055",
	"isNFT": true,
	"policyId": "356e8545176656f3f580fa1a063c20d253206d8fe7d562b6a4de0681",
	"tokenSymbol": "MY1STNFT",
	"quantity": 1,
	"receiverAddress": "",
	"metadata": [ 
		{ "key": "name", "value": "My First NFT" },
		{ "key": "description", "value": "My first Cardano NFT minted on Futurbnk." },
		{ "key": "id", "value": "2023-0001" }
		{ "key": "whatever", "value": "You can add as many attributes as you want." }
	]
}

text/plain, text/xml, application/xml, application/x-www-form-urlencoded

Sample:
Not applicable.

Response Information

Resource Description

Returns the Transaction Reference Number which can be verified the status of if the asset was successfully minted or not.

IHttpActionResult

None.

Response Formats

text/plain

Sample:
1234

application/json, text/json, text/xml, application/xml

Sample:
Not applicable.