Retrieves details of a gift card based on the gift card name provided. The response includes the starting balance, ending balance, and currency. 
Returns an error message if the gift card is not found or has an empty balance.


Gift Card Balance

Successfully retrieved gift card details or error message

Unauthorized access, invalid or missing access token

Retrieve details of a gift card

Documentation - MineStoreCMS

Welcome to MineStoreCMS Documentation. Here you will find all the information you need to get started with MineStoreCMS starting from installation to customization.

Introduction

Learn how to connect your Minecraft servers to MineStoreCMS.

Adding Minecraft Server

Categories are used to organize your packages into different sections. You can create categories for different types of packages like ranks, items, or permissions. You can also create subcategories to further organize your packages.

Variables

Create and collect taxes from your customers based on their location.

Taxes

Create and manage your team members and assign them to specific tasks.

Teams

You can easily create links to external websites or internal pages. This feature is useful for directing users to specific pages or resources.

Links

You can create custom pages to display additional information on your webstore such as Terms of Service, Privacy Policy, or Contact Us.

Custom Pages

You can make a public staff page to display information about your staff team members on your webstore.

Staff Page

You can enable user profiles to display information about clients on your webstore. Profiles will show the users avatar, username, amount spent, recent purchases, and more.

User Profiles

You can create and manage announcements to inform your users about important updates, promotions, or events.

Announcements

You can create and manage featured deals to showcase packages on the home page.

Featured Deals

You can choose packages to promote during the checkout process with special discounts to increase sales and revenue.

Promoted Packages

You can create and manage donation goals to set targets and encourage donations from your customers.

Donation Goals

Track and manage player referrals to your webstore.

Player Referrals

You can let your customers purchase items using virtual currency that they earned on your Minecraft server.

Virtual Currency

You can enable the "In-Game Auth Verification" feature to verify the player's identity before logging in to the webstore.

In-Game Auth Verification

You can add multiple languages to your webstore to reach a wider audience.

Multiple Languages

Global Commands is the way how you can run same command everytime when purchase is made.

Global Commands

Learn how to protect your admin profile with a password and two-factor authentication.

Admin Profile

Sync your Discord server with your webstore to manage roles and permissions.

Discord Bot

Patrons Module allows you to make a page for your patrons to display their names and avatars.

Patrons

Learn how to add a Cloudflare rule to avoid rate limiting & IP blocking issues from your Minecraft Server.

Adding Cloudflare Rule

Learn more about MineStoreCMS REST API Endpoints and how to use them.

Validate the provided username and return an authentication token if valid.

Authorization

Initiate Authorization

Check Authorization

Get user details including virtual currency balance if applicable.

Get User

Checks if the site is under maintenance, verifies if the user's IP is allowed, and checks if the country of the user's IP is banned. Also tracks visits to the site.

Check Accessibility

Fetch the latest announcement that is marked as an index announcement.

Fetch the current configuration settings of the website, including header, footer, recent donators, top player, donation goals, and more.

Webstore Settings

Fetch a page using the provided URL. Returns the page data if found.

Custom Page

Retrieve detailed profile information for a specific user by username.

Profile Page

Retrieve staff information grouped by player group for staff page.

Retrieves the list of patrons based on their contributions.

Patrons Page

Retrieves a hierarchical list of categories along with their subcategories. 
The list is filtered to include only categories that are not deleted and are enabled.
Each category includes its image URL, description, and URL, as well as a nested list of its active subcategories.


Categories List

This endpoint retrieves details of a specific category, including its items and subcategories. It also handles limits, discounts, and custom price options for the items.

Category Packages

Get detailed information about a specific item, including price adjustments, limits, and promotional prices.

Get Item (Authorized)

Fetch details of a specific item for guests, including price, discount, availability, and limits.

Get Item (Guest)

Returns a list of featured deals, with item details, prices, discounts, and availability. The result depends on the user's authorization status.
- If the user is not logged in, the response will include featured items without user-specific limits.
- If the user is logged in, the response will include user-specific details such as quantity limits and cumulative category pricing.


Fetches the user's cart and items, including any associated promotions, coupons, gifts, and referral codes.

Cart Data

Validates and applies a coupon or gift card to the user's cart if eligible. Provides appropriate messages based on the coupon or gift card status.

Apply Coupon & Giftcard

Fetches the list of selectable servers associated with items in the user's cart. Only items that allow server selection and are of type 'CMD_SERVER' are included.

Selecting Servers List

Fetches a list of promoted items available in the cart along with their details such as price, availability, and quantity limits.

Generates a Discord OAuth URL for user authentication. Requires Discord integration to be enabled and configured. You should setCookie for the discord_username, discord_id, discord_linked after successful auth callback (example available in our default template).

Get Discord OAuth URL

Fetches a list of payment methods available based on the cart's content and subscription status.

Available Methods

Handles the payment creation process, including validation, checking for sales, handling virtual currency, and processing payments through various methods.

Create Payment

Retrieves the current status of a payment. Rate limited to 18 requests per minute per IP address.

Check Status

Official Website

Legacy Docs (2.x)

API Reference

Dashboard

Support

Before you start installing MineStoreCMS, make sure your Virtual Server (VPS) meets the following requirements.

Requirements

After you purchased a VPS, you need to configure the DNS settings to point your domain to the VPS IP address.

Pointing Domain to VPS

MineStoreCMS provides an easy-to-use installer that allows you to install webstore on your server with a few simple commands.

Installation

Configure your webstore by following the steps in the documentation after installation.

Webstore Setup

Check most common installation issues and how to resolve them.

Installation Issues

Packages are the products that you can sell on your webstore. They can be digital products like ranks, items, or permissions. You can also sell gift cards at your webstore. To have a better understanding of packages, you can refer to the documentation below.

Packages

You can enable the "Cumulative Packages" feature to offer discounts to users based on the packages they have previously purchased.

Cumulative Packages

Gift card packages are a type of package that you can sell on your webstore. When a customer purchases a gift card, they receive a code that can be redeemed on the webstore. You can set the value of the gift card and the duration of the code.

Giftcard Package

Hybrid Packages are a combination of Gift card and Minecraft Commands packages. Learn how to create a Hybrid Package in the Admin Panel.

Hybrid Package

You can also make a subscription package that allows customers to pay for the package periodically. You can set the period of charging the customer and the duration of the package.

Subscription Package

Learn how to attach Discord roles to packages.

Discord Roles

This article explains how to add commands to the package that will be executed when the package is purchased or any other event happened.

Package's Commands

You can let customers pay for packages using the "Pay What You Want" feature. You can set the minimum price of the package and let customers pay more than the minimum price.

Pay What You Want

This article will guide you on how to allow customers to select the server when purchasing a package.

Allow to Select Server

You can let customers pay for packages using virtual currency. You can set the price of the package in virtual currency and specify the server to charge the virtual currency.

Configure your webstore settings, including the store name, logo, and favicon.

General Settings

Configure your SMTP settings to send emails to your customers about purchases or gift cards.

Email Settings

Manage the primary and additional currencies for your webstore to make your customers experience more convenient.

Currency Management

Manage your Discord settings to integrate your webstore with Discord.

Discord Settings

Prevent access to view your webstore packages and categories while you perform maintenance tasks.

Maintenance Mode

Learn how to integrate PayNow Checkout that provides a seamless payment experience for your customers and chargeback protection for your business.

Onboarding Guide

Frequently asked questions about PayNow Checkout integration with MineStoreCMS.

PayNow FAQ

Frequently asked questions about PayNow Checkout & MineStoreCMS technical aspect integration.

Technical Issues

You can configure the PayPal IPN settings to receive instant payment notifications for successful transactions.

PayPal IPN

We do not recommend using this payment gateway. Please use the PayPal IPN payment gateway for better security and reliability.

PayPal Legacy

Stripe is a popular payment gateway that allows you to accept credit card payments on your webstore.

Stripe

Accept payments with Skrill Quick Checkout. This payment gateway also supports Paysafecard payment method.

Skrill (Paysafecard)

Accept payments all across Latin America and South America with MercadoPago. This payment method is perfect for Latin American and South American countries.

MercadoPago

Accept payments across the Europe with GoPay. This payment method is perfect for Czech Republic countries.

GoPay

Accept multiple worldwide and local payment methods with Terminal3. This payment method is perfect for Asian countries.

Terminal3 (Paymentwall)

Accept payments all across Europe with Mollie. This payment method is perfect for European countries.

Mollie

Accept payments across the Europe with PayU. This payment method is perfect for European countries.

PayU (Europe)

Cordarium is a business-free payment gateway that allows you to accept crypto payments in the easiest way possible.

Cordarium

Accept cryptocurrency payments with Coinbase Commerce.

Coinbase

Accept cryptocurrency payments with CoinPayments.

CoinPayments

Accept payments in India with PayTM. This payment method is perfect for Indian countries.

PayTM (India)

Accept payments in India with CashFree. This payment method is perfect for Indian countries.

CashFree (India)

Accept payments in India with Razorpay. This payment method is perfect for Indian countries.

Razorpay (India)

Accept payments in India with PayU. This payment method is perfect for Indian countries.

PayU (India)

HotPay (Poland)

Accept payments in Indonesia with Midtrans.

Midtrans (Indonesia)

Accept payments in Turkey with PayTR. This payment method is perfect for Turkey

PayTR (Turkey)

Accept payments in Ukraine and CIS countries with Interkassa. This payment method is perfect for Ukrainian and CIS countries.

Interkassa

Accept payments in Russia and CIS countries with Unitpay. This payment method is perfect for Russian and CIS countries.

Unitpay

Accept payments in Russia and CIS countries with Enot.io. This payment method is perfect for Russian and CIS countries.

Enot.io

Accept payments in Russia and CIS countries with Free-Kassa. This payment method is perfect for Russian and CIS countries.

Free-Kassa

Accept payments in Russia and CIS countries with Qiwi. This payment method is perfect for Russian and CIS countries.

Qiwi

Learn how to prevent chargebacks by setting up trigger blocks and preventing potentially fraudulent transactions.

Chargeback Prevention

Learn how to manage chargebacks and increase your chances of winning disputes.

Chargebacks

Set up spending limits for your customers to prevent fraud for anomalous big transactions.

Spending Limit

Learn how to enable the IP Checking module to prevent fraud by checking the IP address of the buyer.

IP Checking

Learn about the key features of the Transactions module.

API Documentation

Authentication Endpoints

In-Game Authentication

User Endpoints

CMS Endpoints

Packages Endpoints

Cart Endpoints

Payment Endpoints

Gift Card Balance

Body

Response