- Collections
- Create a collection
- Parameters
- Response
- Get a collection
- Parameters
- Response
- Tokens
- Get Owned Tokens (Requires session)
- Get Tokens by Owner
- Parameters
- Response
- OpenSea compliant metadata
- Parameters
- Purchase & Mint
- Complete Purchase
- Parameters
- Chain Mint
- Parameters
- Verification
- SMS Verification
- Parameters
- Claim (Transfer from Escrow to MetaMask)
- Claim - Initialize (Step 1)
- Parameters
- Claim - Finalize Transfer
- Parameters
- Postman Examples
Collections
Create a collection
/v0/collections/create POST
Parameters
Key | Description |
title | Title of the new collection |
description | Description of the new collection, should support HTML codes |
link | An optional link to lockable bonus content. This is any external URL supplied by the artist |
rate | The mint price in USD. Maximum of two decimal places |
maxMint | The maximum amount of NFTs in this particular collection before it sells out |
owner | UUID of the owner of the collection (this will come from session at a later date) |
Response
{
"title": "My Pix 2",
"description": "My Pix is a collection of neat pics.",
"link": "https://mysecretplace.com",
"rate": "50.00",
"maxMint": "10",
"uuid": "f93a8da6-1caf-45ea-9187-e6c516a884ba"
}Get a collection
/v0/collections/:collection GET
Parameters
Key | Description |
collection | UUID of the collection |
Response
{
"title": "My Pix",
"description": "My Pix is a collection of neat pics.",
"link": "https://mysecretplace.com",
"rate": "50.00",
"maxMint": "10",
"uuid": "aede9e6b-f57a-4961-b9fc-a10b26ae4073"
}Tokens
Get Owned Tokens (Requires session)
/v0/tokens/self GET
Get Tokens by Owner
/v0/tokens/:owner GET
Parameters
Key | Description |
owner | The UUID of the owner |
Response
TODO
OpenSea compliant metadata
/v0/nft/meta/:contract/:token GET
Parameters
Key | Description |
contract | The contract address for the collection. For MVP, we always use the contract 0xdabc3A9a7e8d6448eD7846195f93278CE3A9c61B |
token | Token ID for a specific collection |
Purchase & Mint
Complete Purchase
/v0/payment/checkoutv2 POST
Parameters
Key | Description |
nfts | Array of NFTs to purchase |
mobileNumber | Mobile number capable of receiving SMS |
successURL | Callback URL on successful payment |
cancelURL | Callback URL on cancelled or unsuccessful payment |
Chain Mint
/v0/minter/chain-mint/:owner/:token GET
On-chain minting, only to be called after a successful payment. This will be part of a queue and further locked down later on.
Parameters
Keys | Description |
owner | UUID of the new owner of the token |
collection | UUID of the collection to mint from |
Verification
SMS Verification
/v0/sms/verify POST
Used to receive a one-time code to authenticate important transactions
Parameters
Key | Description |
phone | An SMS number, for example 15551234 |
Claim (Transfer from Escrow to MetaMask)
Claim - Initialize (Step 1)
/v0/minter/claim/init/:owner GET
Parameters
Key | Description |
owner | UUID of the owner of the NFT about to be claimed |
Claim - Finalize Transfer
v0/minter/claim/final POST
Parameters
Key | Description |
contract | The contract address of the NFT collection. |
owner | The owner of the NFT |
token | The unique sequence of the NFT to claim |
smsCode | SMS code sent via the initial claim process |
Postman Examples
NFT Mints.postman_collection.json6.0KB