GET: Interaction Status

When a request to update a contract, token or add a new token is received, it is queued in the system to be broadcast to the network.

This endpoint returns the status and accompanying information about a contract interaction.

https://api.hypermint.com/v1/interaction/:interactionId

Gets On-Chain Interaction Status

Parameters

Header

Parameter	Description
HM_ACCESS_KEY	HyperMint Access Key
HM_ACCESS_KEY_SECRET	HyperMint Access Key Secret

Responses

Code	Meaning
🟢 200: OK	Responds with interaction status
🟠 404: Not Found	Unable to find details for the give contract ID

interface InteractionStatusResponse {
    id: string;
    createdAt: string;
    updatedAt: string;
    type: NFTContractInteractionType;
    status: NetworkInteractionStatus;
    statusReason?: string;
    transactionHash?: string;
    feeAmount: number;
    feePrice: number;
    feeTotal: number;
    feeUSDCost: number;
    sentAt?: Date;
    nonce: number;
    gasEstimation: number;
    params: any[];
    update: NFTContractUpdate;
}

enum NFTContractInteractionType {
    SetNameAndSymbol = 'Set name and symbol',
    SetAllowBuy = 'Set allow buy',
    SetMetadataURL = 'Set metadata URL',
    SetDates = 'Set dates',
    SetERC721TokenPriceAndTotalSupply = 'Set ERC721 token price and total supply',
    SetERC1155TokenPriceAndTotalSupply = 'Set ERC1155 token price and total supply',
    AddERC1155Tokens = 'Add ERC1155 tokens'
}

enum NetworkInteractionStatus {
    Pending = 'Pending',
    Sent = 'Sent',
    Complete = 'Complete',
    Failed = 'Failed'
}

interface NFTContractUpdate {
    name?: string;
    symbol?: string;
    allowBuyOnNetwork?: boolean;
    metadataUrl?: string;
    presaleAt?: Date;
    publicSaleAt?: Date;
    saleClosesAt?: Date;
    erc1155?: {
        priceAndTotalSupplyUpdate?: {
            id: number;
            price: number;
            totalSupply: number;
        };
        newTokens?: {
            id: number;
            price: number;
            totalSupply: number;
        }[];
    };
    erc721?: {
        priceAndTotalSupplyUpdate?: {
            price: number;
            totalSupply: number;
        };
    };
}

Feedback

Something not quite right, unclear or can't find what you are looking for? Please let us know at support.moonpay.com and we will get back to you as soon as we can.